Python API reference
Placeholder
Sphinx is not yet configured for the ML workspace. This page will be populated when Sphinx is added to ml/pyproject.toml dev dependencies and ML modules are implemented.
To enable:
- Add to
ml/pyproject.tomldev deps:sphinx,sphinx-markdown-builder - Create
ml/docs/conf.py - Run:
cd ml && sphinx-build -b markdown docs/ output/
Setup instructions
# ml/pyproject.toml
[project.optional-dependencies]
docs = [
"sphinx>=7.0",
"sphinx-markdown-builder>=0.6",
]
# ml/docs/conf.py
project = "Aucert ML"
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"]
Key modules
When generated, the reference will cover:
| Module | Purpose |
|---|---|
ml.models | Model training and evaluation |
ml.serving | Model serving API |
ml.pipeline | ML pipeline integration |
ml.evaluation | Model evaluation metrics |