Skip to content

Commit fb5b834

Browse files
committed
docs: update docs
1 parent 9ca4901 commit fb5b834

File tree

3 files changed

+14
-10
lines changed

3 files changed

+14
-10
lines changed

docs/source/api.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,15 @@ FastText Classifier
3535
Configuration and Factory
3636
~~~~~~~~~~~~~~~~~~~~~~~~~~
3737

38-
.. automodule:: torchTextClassifiers.classifiers.fasttext.fasttext
38+
.. automodule:: torchTextClassifiers.classifiers.fasttext.core
39+
:members:
40+
:undoc-members:
41+
:show-inheritance:
42+
43+
Wrapper Interface
44+
~~~~~~~~~~~~~~~~~
45+
46+
.. automodule:: torchTextClassifiers.classifiers.fasttext.wrapper
3947
:members:
4048
:undoc-members:
4149
:show-inheritance:

docs/source/index.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
torchTextClassifiers Documentation
1+
**torchTextClassifiers** Documentation
22
====================================
33

4-
Welcome to torchTextClassifiers, a unified framework for text classification with PyTorch Lightning integration.
4+
Welcome to **torchTextClassifiers**, a unified framework for text classification with PyTorch Lightning integration.
55

66
.. image:: https://img.shields.io/badge/python-3.8%2B-blue.svg
77
:target: https://python.org
@@ -18,17 +18,18 @@ Welcome to torchTextClassifiers, a unified framework for text classification wit
1818
Overview
1919
--------
2020

21-
torchTextClassifiers provides a comprehensive, extensible framework for building and training
21+
**torchTextClassifiers** provides a comprehensive, extensible framework for building and training
2222
text classification models. It offers a unified API that abstracts away the complexity
2323
of different model architectures while providing flexibility for advanced users.
2424

2525
🚀 **Key Features:**
2626

2727
* **Unified API**: Consistent interface across different model types
2828
* **PyTorch Lightning Integration**: Production-ready training with automatic GPU handling
29-
* **FastText Implementation**: Fast and efficient text classification
3029
* **Mixed Features Support**: Handle both text and categorical data
3130
* **Extensible Architecture**: Easy to add new model types
31+
* **Explainability**: Add explainability support (depends on classifier types)
32+
3233

3334
Quick Start
3435
-----------

docs/source/installation.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,9 @@ Core dependencies that will be automatically installed:
2121
- PyTorch >= 1.9.0
2222
- PyTorch Lightning >= 1.6.0
2323
- NumPy >= 1.19.0
24-
- Pandas >= 1.3.0
25-
- scikit-learn >= 1.0.0
2624

2725
Optional dependencies for enhanced functionality:
2826

29-
- Jupyter >= 1.0.0 (for notebook examples)
30-
- Matplotlib >= 3.3.0 (for visualization)
31-
- Seaborn >= 0.11.0 (for plotting)
3227

3328
Installation Methods
3429
--------------------

0 commit comments

Comments
 (0)