Skip to main content

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:

  1. Add to ml/pyproject.toml dev deps: sphinx, sphinx-markdown-builder
  2. Create ml/docs/conf.py
  3. 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:

ModulePurpose
ml.modelsModel training and evaluation
ml.servingModel serving API
ml.pipelineML pipeline integration
ml.evaluationModel evaluation metrics