LENS documentation
==================

.. image:: _static/logo.png
   :alt: locational encoding with neuromorphic systems showing an iris with an event-based ring with spiking neural network flairs
   :align: center
   :width: 400px

Welcome to the LENS (Locational Encoding with Neuromorphic Systems) documentation. LENS is an event-based, neuromorphic visual place recognition system
to perform accurate, fast, and energy-efficient robotic localization. 

LENS was developed for the SynSense `SPECK™ <https://www.synsense.ai/products/speck-2/>`_, a combined neuromorphic processor and integrated dynamic vision sensor
for ultra energy-efficient and compact place recognition. However, LENS is fully compatible with conventional compute hardware for benchmark and custom event-based
localization datasets.

To get started, follow the steps below in `Getting Started` to install and run the demo for LENS.

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

   installation
   quickstart
   attributions

.. toctree::
   :maxdepth: 2
   :caption: Model Training:

   train_overview
   train_params
   train_setup

.. toctree::
   :maxdepth: 2
   :caption: Model Evaluation:

   eval_overview
   eval_params
   eval_setup

.. toctree::
   :maxdepth: 2
   :caption: Optimization:

   optimizer_overview
   optimizer_setup

.. toctree::
   :maxdepth: 2
   :caption: SPECK deployment:

   sp_overview
   sp_functions
   sp_dataset
   sp_setup
   sp_onchip

.. toctree::
   :maxdepth: 2
   :caption: Modules Reference:

   LENS
   LENS.src
   LENS.tools