# Thulium Documentation

Welcome to the Thulium documentation. This guide covers everything from
installation to advanced model training.

## Getting Started

| Guide | Description |
|-------|-------------|
| [Installation](getting_started.md#installation) | Install Thulium |
| [Quick Start](getting_started.md#quick-start) | Recognize your first document |
| [Configuration](getting_started.md#configuration) | Configure pipelines |

## API Reference

| Module | Description |
|--------|-------------|
| [High-Level API](api/reference.md) | `recognize_image`, `HTRPipeline` |
| [CLI Usage](api/cli_usage.md) | Command-line interface |

## Models

| Guide | Description |
|-------|-------------|
| [Model Zoo](models/model_zoo.md) | Pretrained model catalog |
| [Language Support](models/language_support.md) | 52+ supported languages |

## Training

| Guide | Description |
|-------|-------------|
| [Training Guide](training/training_guide.md) | Train custom models |
| [Self-Supervised](training/self_supervised.md) | SSL pretraining techniques |

## Evaluation

| Guide | Description |
|-------|-------------|
| [Metrics](evaluation/metrics.md) | CER, WER, SER definitions |
| [Benchmarks](evaluation/benchmarks.md) | Performance benchmarks |
| [Robustness](evaluation/robustness.md) | Noise and degradation testing |

## Explainability (XAI)

| Guide | Description |
|-------|-------------|
| [Attention & Saliency](xai/attention_and_saliency.md) | Visualization tools |
| [Error Analysis](xai/error_analysis.md) | Detailed error analysis |

## Architecture

| Guide | Description |
|-------|-------------|
| [System Overview](architecture.md) | Architecture and design |
| [Theory](theory/htr_foundations.md) | HTR fundamentals |

## Development

| Guide | Description |
|-------|-------------|
| [Development Guide](development/dev_guide.md) | Developer setup |
| [Style Guide](development/style_guide.md) | Code style standards |

---

## Quick Links

- [GitHub Repository](https://github.com/thulium-dev/thulium)
- [PyPI Package](https://pypi.org/project/thulium/)
- [Issue Tracker](https://github.com/thulium-dev/thulium/issues)
