API Reference

pip install onyxengine

# Initialize the client
from onyxengine import Onyx

onyx = Onyx()  # Uses ONYX_API_KEY env var
# Or explicitly: onyx = Onyx(api_key="your_api_key")

# Client methods
onyx.save_dataset(...)
onyx.load_dataset(...)
onyx.save_model(...)
onyx.load_model(...)
onyx.train_model(...)
onyx.optimize_model(...)
onyx.get_object_metadata(...)

# Data classes
from onyxengine.data import OnyxDataset

# Modeling classes
from onyxengine.modeling import (
    # Feature classes
    Input,
    Output,

    # Model configs
    MLPConfig,
    RNNConfig,
    TransformerConfig,

    # Training configs
    TrainingConfig,
    OptimizationConfig,

    # Optimizers
    AdamWConfig,
    SGDConfig,

    # Learning rate schedulers
    CosineDecayWithWarmupConfig,
    CosineAnnealingWarmRestartsConfig,

    # Optimization configs (for hyperparameter search)
    MLPOptConfig,
    RNNOptConfig,
    TransformerOptConfig,
    AdamWOptConfig,
    SGDOptConfig,
    CosineDecayWithWarmupOptConfig,
    CosineAnnealingWarmRestartsOptConfig,
)

from typing import List, Dict, Optional, Union, Literal

# Example function signature
def load_model(
    name: str,
    version_id: Optional[str] = None,
    mode: Literal["online", "offline"] = "online"
) -> Union[MLP, RNN, Transformer]:
    ...

from onyxengine import Onyx

onyx = Onyx()

try:
    model = onyx.load_model('nonexistent_model')
except Exception as e:
    print(f"Error: {e}")
    # "Onyx Engine API error: Model [nonexistent_model: None] not found in the Engine."