18. API reference¶
This page links to the Python API modules and helps you navigate the reference. For workflows, start with Quickstart.
18.1 What it is for¶
This section documents the public Python API across ModSSC bricks. Each page includes a short overview, runnable examples, and mkdocstrings output. [1]
18.2 Examples¶
Load a dataset and inspect its spec:
from modssc.data_loader import load_dataset, dataset_info
ds = load_dataset("toy", download=True)
print(dataset_info("toy").as_dict())
Run a simple evaluation:
import numpy as np
from modssc.evaluation import evaluate
print(evaluate(np.array([0, 1]), np.array([0, 1]), ["accuracy"]))
These APIs are defined in src/modssc/data_loader/ and src/modssc/evaluation/. [2][3]