.. Engine documentation master file, created by
   sphinx-quickstart on Thu Nov  7 15:58:38 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

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 :ref:`installation`.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   installation
   training-models
   optimizing-models
   simulating-models

.. toctree::
   :maxdepth: 3
   :caption: API Reference:

   onyxengine
   onyxengine.data
   onyxengine.modeling