Engine documentation

Welcome to the Onyx Engine Python API documentation!

The onyx-engine library is an API for optimizing AI models to simulate and control hardware systems. The library is lightweight, easy to interface with, and works alongside the Onyx Engine Platform.

If you’re ready to train and optimize your first model, check out Installation.

Getting Started

• Installation
• Training Models
  • Training Script
  • Model Configuration
  • Training Configuration
  • train_model()
• Optimizing Models
  • Optimization Script
  • OptConfigs
  • optimize_model()
• Simulating Models
  • Model Simulator
  • simulate()

API Reference:

• onyxengine
  • get_object_metadata()
  • load_dataset()
  • load_model()
  • optimize_model()
  • save_dataset()
  • save_model()
  • train_model()
• onyxengine.data
  • OnyxDataset
• onyxengine.modeling
  • Model Training
    • TrainingConfig
  • Model Simulation
    • State
    • ModelSimulatorConfig
  • Models
    • MLPConfig
    • RNNConfig
    • TransformerConfig