.. _reference:

=========
Reference
=========

Quick-lookup reference documentation for the NeurEco Python API and CLI.

.. tip::

   Looking to learn NeurEco? Start with the :ref:`Solutions Guide <solutions-guide>` for tutorials and workflows.
   This Reference section is for looking up specific methods, parameters, and syntax.

.. toctree::
   :maxdepth: 1
   :caption: API Reference

   python-api
   tabular-api
   dynamic-api
   pfs-api
   exceptions

.. toctree::
   :maxdepth: 1
   :caption: CLI Reference

   cli

Quick Links
===========

**Python API**

.. list-table::
   :header-rows: 1
   :widths: 25 35 40

   * - Module
     - Import
     - Classes
   * - :ref:`Tabular <tabular-api-ref>`
     - ``from NeurEco import NeurEcoTabular as tab``
     - ``Regressor``, ``Classifier``, ``Compressor``
   * - :ref:`Dynamic <dynamic-api-ref>`
     - ``from NeurEco import NeurEcoDynamic as dyn``
     - ``ODE``, ``ConvolutiveDynamic``
   * - :ref:`PFS <pfs-api-ref>`
     - ``from NeurEco import NeurEcoFrequential as freq``
     - ``PFS``

**Common Operations**

.. code-block:: python

   # Build a model
   model = tab.Regressor()
   config = tab.RegressorBuildConfig(input_data=X, output_data=Y)
   model.build(config)

   # Evaluate
   predictions = model.evaluate(X_test)

   # Compute error
   error = model.compute_error(predictions, Y_test)

   # Save/Load
   model.save("my_model.ednn")
   model.load("my_model.ednn")

   # Export
   model.export_onnx("my_model.onnx")

   # Cleanup
   model.delete()

**File Extensions**

.. list-table::
   :header-rows: 1
   :widths: 30 30 40

   * - Solution
     - Extension
     - Example
   * - Tabular
     - ``.ednn``
     - ``regressor.ednn``
   * - Dynamic (ODE)
     - ``.ernn``
     - ``ode_model.ernn``
   * - Dynamic (Convolutional)
     - ``.ecnn``
     - ``conv_model.ecnn``
   * - PFS
     - ``.efnn``
     - ``pfs_model.efnn``