Engine Documentation

Welcome to the Onyx Engine documentation!

The Onyx Engine is your team’s workspace for managing and collaborating on AI physics models trained directly from your hardware’s data. AI solves real-world accuracy for controls teams’ critical physics models. The Onyx Engine platform can serve as your team’s virtual AI engineer.

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.

Engine Platform

• Getting Started
  • Sign Up and Create Your Account
  • Features Overview
  • Example Dataset
• System
  • System Overview
    • Node Graph
    • Details
    • Inspector
    • Lineage Notes
  • System Table
    • Table Columns
• Uploading a dataset
  • Collecting Data
    • What kind of data do I need to collect?
    • How much data do I need?
    • Can I upload multiple files?
  • Uploading
• Datasets
  • Viewing a dataset
    • Raw Datasets
  • Processing a dataset for AI training
  • Fixing dataset processing issues
• Training Models
  • Training an AI model
  • Model Features and Configuration
  • Jobs
• Settings
  • Profile
  • Team
  • API Keys
  • License

Python API

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

API Reference

• onyxengine
• onyxengine.data
  • OnyxDataset
• onyxengine.modeling
  • Models
  • Model Simulation
  • Model Training