train.py

Go to the documentation of this file.

# Copyright (c) 2025-present Aquin Labs Private Limited. All Rights Reserved.
# This file is part of the Aquin Engine. Unauthorized copying, modification,
# distribution, or use of this file, via any medium, is strictly prohibited.
# Proprietary and confidential. See LICENSE for terms.
 
"""SDK: train from a Recipe (same engine as `aquin train`)."""
 
from __future__ import annotations
 
from pathlib import Path
from typing import Any
 
from aquin.recipe.schema import RunRecord
from aquin.recipe.store import load_run
from aquin.recipe.train import train_recipe as _train
 
 
def run(recipe: str | Path, *, dry_run: bool = False) -> dict[str, Any]:
    """Execute a Recipe YAML/JSON. Returns the RunRecord as a dict."""
    record = _train(recipe, dry_run=dry_run)
    return record.to_dict()
 
 
def show(run_id: str) -> dict[str, Any]:
    """Load a saved run (gate, checkpoint, inspect)."""
    return load_run(run_id).to_dict()
 
 
def train_recipe(recipe: str | Path, **kwargs: Any) -> RunRecord:
    return _train(recipe, **kwargs)