Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,26 @@ A unified, extensible framework for text classification with categorical variabl

## 📦 Installation

### From Pypi (recommended)

```bash
# With uv

uv add torchTextClassifiers

# For using huggingface tokenizers
uv add torchTextClassifiers --extra huggingface

# With pip

pip install torchTextclassifiers

# For using huggingface tokenizers
pip install torchTextclassifiers[huggingface]
```


### From Source
```bash
# Clone the repository
git clone https://github.com/InseeFrLab/torchTextClassifiers.git
Expand Down
21 changes: 21 additions & 0 deletions docs/source/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ multiclass_classification
mixed_features
explainability
multilabel_classification
mlflow_integration
```

## Overview
Expand Down Expand Up @@ -116,6 +117,22 @@ Assign multiple labels to each text sample for complex classification scenarios.
**Difficulty:** Advanced | **Time:** 30 minutes
:::

:::{grid-item-card} {fas}`chart-line` MLflow Integration
:link: mlflow_integration
:link-type: doc

Track experiments and deploy models with MLflow for production-ready ML pipelines.

**What you'll learn:**
- Log training metrics per epoch
- Create portable pyfunc models
- Export models without package dependency
- Flexible inference input formats
- Use MLflow UI for visualization

**Difficulty:** Advanced | **Time:** 25 minutes
:::

::::

## Learning Path
Expand All @@ -129,6 +146,7 @@ graph LR
C --> D[Mixed Features]
C --> F[Multilabel Classification]
D --> E[Explainability]
D --> G[MLflow Integration]
F --> E

style A fill:#e3f2fd
Expand All @@ -137,13 +155,15 @@ graph LR
style D fill:#64b5f6
style E fill:#1976d2
style F fill:#42a5f5
style G fill:#4caf50
```

1. **Start with**: {doc}`../getting_started/quickstart` - Get familiar with the basics
2. **Then**: {doc}`basic_classification` - Understand the complete workflow
3. **Next**: {doc}`multiclass_classification` - Handle multiple classes
4. **Branch out**: {doc}`mixed_features` for categorical features OR {doc}`multilabel_classification` for multiple labels
5. **Master**: {doc}`explainability` - Understand your model's predictions
6. **Deploy**: {doc}`mlflow_integration` - Track experiments and deploy to production

## Tutorial Format

Expand Down Expand Up @@ -238,6 +258,7 @@ All tutorials are based on runnable examples in the repository:
- [examples/using_additional_features.py](https://github.com/InseeFrLab/torchTextClassifiers/blob/main/examples/using_additional_features.py)
- [examples/advanced_training.py](https://github.com/InseeFrLab/torchTextClassifiers/blob/main/examples/advanced_training.py)
- [examples/simple_explainability_example.py](https://github.com/InseeFrLab/torchTextClassifiers/blob/main/examples/simple_explainability_example.py)
- [examples/mlflow_logging_example.py](https://github.com/InseeFrLab/torchTextClassifiers/blob/main/examples/mlflow_logging_example.py)

### Jupyter Notebooks

Expand Down
Loading