***********
femtodriver
***********

Femtodriver compiles models for SPU-001 and allows developers to run them in simulation as well as on hardware to obtain model outputs, along with key execution metrics.

Femtodriver can:
 * Generate program files from your models to run on the EVK SPU-001
 * Pass inputs through your compiled model to test specific behaviour
 * Compare the simulation and hardware metrics/outputs for a specific input
 * Run simulations to get metrics such as the estimated power consumption of your model
 * Enable custom input preprocessing and output postprocessing stages
 * Measure the time necessary to compute a frame of the model for a specific SPU-001 configuration (available soon)
 * Measure SPU-001 power consumption while running the model (available soon)

There are 2 ways to use femtodriver:
 * Using the `CLI <usage/cli.html>`_
 * Using the `Python API <usage/python_api.html>`_

They provide similar capabilities,
but using the python API may work with your existing model development workflow.
There are other capabilities which are documented in the :code:`--help` flag of the femtodriver CLI.

.. toctree::
   :maxdepth: 1
   :caption: Installation

   ./install/install.rst

.. toctree::
   :maxdepth: 1
   :caption: File Formats

   ./fformats/formats.rst

.. toctree::
   :maxdepth: 1
   :caption: Usage

   ./usage/python_api.rst
   ./usage/cli.rst

.. toctree::
   :maxdepth: 1
   :caption: Release notes

   ./changes/changes.rst

License
=======

By using this software package, you agree to abide by the terms and conditions in the license agreement found `here <https://femtosense.ai/legal/eula/>`_.