AI
==

AI runs ONNX models on the appliance through a model-agnostic tensor
interface, with client-side helpers that add per-model-family semantics
(pre-processing, detection decoding).

Models are ``*.onnx`` files in the appliance model directory
(``OLO_AI_MODEL_DIR``, default ``/app/models/ai`` in the appliance image).
The shipped YOLOX weights (``yolox_s.onnx``, ``yolox_tiny.onnx``,
``yolox_nano.onnx``) live in ``apps/appliance/models/ai/`` (Git LFS).
Load one by name, then
exchange named tensors; shape and dtype metadata comes from the model itself
via :meth:`~olo.ai.Model.info` (dynamic dimensions are reported as ``-1``).

For object detection, the :class:`~olo.ai.yolo.YoloDetector` adapter wraps a
YOLOX model with letterbox pre-processing, output decoding, and non-maximum
suppression, returning standard :class:`~olo.ai.Detection` results whose
boxes plug directly into the :doc:`vision depth helpers <vision>`.

.. tab-set::
   :sync-group: sdk-language

   .. tab-item:: Python
      :sync: python

      .. automodule:: olo.ai
         :no-members:

      **Service**

      .. autoclass:: olo.ai.Ai
         :members:

      .. autoclass:: olo.ai.Model
         :members:

      **Types**

      .. autoclass:: olo.ai.ModelInfo
         :members:

      .. autoclass:: olo.ai.TensorInfo
         :members:

      .. autoclass:: olo.ai.Detection
         :members:

      **Processing helpers**

      .. autofunction:: olo.ai.processing.letterbox

      .. autofunction:: olo.ai.processing.image_to_tensor

      .. autofunction:: olo.ai.processing.nms

      .. autofunction:: olo.ai.processing.softmax

      **YOLOX adapter**

      .. autoclass:: olo.ai.yolo.YoloDetector
         :members:

      .. autofunction:: olo.ai.yolo.decode_yolox

   .. tab-item:: TypeScript
      :sync: typescript

      Import from ``olo/ai``:

      **Service**

      - :doc:`Ai </typescript/api/generated/olo/ai/classes/Ai>`
        Async wrapper for the AI gRPC service.
      - :doc:`Model </typescript/api/generated/olo/ai/classes/Model>`
        Handle for a loaded ONNX model session.

      **Types**

      - :doc:`ModelInfo </typescript/api/generated/olo/ai/interfaces/ModelInfo>`
        Metadata for a loaded model session.
      - :doc:`TensorInfo </typescript/api/generated/olo/ai/interfaces/TensorInfo>`
        Declared model input/output.
      - :doc:`Tensor </typescript/api/generated/olo/ai/interfaces/Tensor>`
        Dense tensor backed by a typed array.
      - :doc:`Detection </typescript/api/generated/olo/ai/interfaces/Detection>`
        Standard object-detection result.

      **Processing helpers**

      - :doc:`tensor </typescript/api/generated/olo/ai/functions/tensor>`
      - :doc:`letterbox </typescript/api/generated/olo/ai/functions/letterbox>`
      - :doc:`imageToTensor </typescript/api/generated/olo/ai/functions/imageToTensor>`
      - :doc:`nms </typescript/api/generated/olo/ai/functions/nms>`
      - :doc:`softmax </typescript/api/generated/olo/ai/functions/softmax>`

      **YOLOX adapter**

      - :doc:`YoloDetector </typescript/api/generated/olo/ai/classes/YoloDetector>`
      - :doc:`decodeYolox </typescript/api/generated/olo/ai/functions/decodeYolox>`