Skip to content

Commit 0b8b825

Browse files
committed
docs: add section landing pages and fix broken index links
1 parent 4b57052 commit 0b8b825

6 files changed

Lines changed: 80 additions & 1 deletion

File tree

docs/api/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
orphan: true
3+
---
4+
5+
# API Reference
6+
7+
Complete API documentation for DeepTab, organised by module: the public estimators,
8+
configuration dataclasses, data utilities, distribution families, metrics, and the
9+
underlying Lightning training modules.
10+
11+
- **[Models](models/index)**: Classifier, Regressor, and LSS classes
12+
- **[Configs](configs/index)**: Configuration dataclasses
13+
- **[Data](data/index)**: Datasets, data modules, and schemas
14+
- **[Distributions](distributions/index)**: LSS distribution families
15+
- **[Metrics](metrics/index)**: Task-aware metric classes
16+
- **[Training](training/index)**: Lightning modules for advanced use

docs/core_concepts/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
orphan: true
3+
---
4+
5+
# Core Concepts
6+
7+
These pages explain how DeepTab works under the hood: the scikit-learn interface,
8+
the split-config system, the training and evaluation pipeline, observability, and
9+
deployment-safe inference.
10+
11+
- **[sklearn API](sklearn_api)**: The fit/predict/evaluate interface
12+
- **[Model Tiers](model_tiers)**: Stable versus experimental models
13+
- **[Custom Models](custom_models)**: Building your own architectures
14+
- **[Config System](config_system)**: Split configuration for model, preprocessing, and training
15+
- **[Observability](observability)**: Lifecycle events, structured logging, and experiment tracking
16+
- **[Training and Evaluation](training_and_evaluation)**: The fit pipeline, metrics, and reproducibility
17+
- **[Model Operations](model_operations)**: Serialisation and inspection
18+
- **[Inference](inference)**: Deployment-safe prediction with `InferenceModel`

docs/developer_guide/release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ git push --follow-tags origin release/vX.Y.Z
217217
```
218218

219219
```{note}
220-
`--follow-tags` pushes the annotated `vX.Y.ZrcN` tag along with the branch in one step, which triggers `publish-testpypi.yml`. See **[Tag and publish a release candidate](#7-tag-and-publish-a-release-candidate)** below if you prefer to push the tag separately.
220+
`--follow-tags` pushes the annotated `vX.Y.ZrcN` tag along with the branch in one step, which triggers `publish-testpypi.yml`. See step 7, **Tag and publish a release candidate**, below if you prefer to push the tag separately.
221221
```
222222

223223
### 6b. Stable bump

docs/getting_started/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
orphan: true
3+
---
4+
5+
# Getting Started
6+
7+
New to DeepTab? Start here. These pages take you from installation to your first
8+
trained model, and answer the most common questions along the way.
9+
10+
- **[Overview](overview)**: What DeepTab is and when to use it
11+
- **[Installation](installation)**: Setup, GPU support, and optional kernels
12+
- **[Quickstart](quickstart)**: Train your first models in a few minutes
13+
- **[FAQ](faq)**: Common questions, v1 support, and troubleshooting

docs/model_zoo/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
orphan: true
3+
---
4+
5+
# Model Zoo
6+
7+
DeepTab ships 15 stable architectures plus experimental models, all behind the same
8+
`fit`/`predict`/`evaluate` interface. Use these pages to compare models, understand
9+
their efficiency trade-offs, and find recommended configurations.
10+
11+
- **[Stable Models](stable/index)**: Production-ready architectures
12+
- **[Experimental Models](experimental/index)**: Architectures under evaluation for promotion
13+
- **[Comparison Tables](comparison_tables)**: Side-by-side model comparison and selection guidance
14+
- **[Efficiency](efficiency)**: Runtime and memory characteristics
15+
- **[Recommended Configs](recommended_configs)**: Sensible starting configurations per model

docs/tutorials/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
orphan: true
3+
---
4+
5+
# Tutorials
6+
7+
End-to-end, runnable walkthroughs covering common modeling workflows with DeepTab.
8+
Each tutorial is Colab-ready and works through a complete problem from data to results.
9+
10+
- **[Skewed-Target Regression](skewed_regression)**: Regression on a right-skewed target
11+
- **[Imbalanced Classification](imbalance_classification)**: An end-to-end classification workflow
12+
- **[Uncertainty Quantification](uncertainty_quantification)**: Prediction intervals with LSS models
13+
- **[Hyperparameter Optimisation](hpo)**: Tuning models efficiently
14+
- **[Advanced Training and Inference](advanced_training)**: Optimizers, schedulers, and production inference
15+
- **[Observability and Logging](observability)**: Run directories and experiment trackers
16+
- **[Model Efficiency](model_efficiency)**: Runtime and memory benchmarking
17+
- **[Experimental Models](experimental)**: Working with cutting-edge architectures

0 commit comments

Comments
 (0)