Skip to main content

LENS Logo

PyTorch Documentation Status License: MIT QUT Centre for Robotics stars Downloads Pixi Badge Conda Version PyPI - Version GitHub repo size

This repository contains code for LENS - Locational Encoding with Neuromorphic Systems. LENS combines neuromorphic algorithms, sensors, and hardware to perform accurate, real-time robotic localization using visual place recognition (VPR).

LENS performs VPR with the SynSense SpeckTM development kits, featuring a combination of a dynamic vision sensor and neuromorphic System-on-Chip processor for real-time, energy-efficient localization.

LENS can also be used with conventional CPU, GPU, and Apple Silicon (MPS) devices to perform event-based VPR thanks to the Sinabs spiking network architecture.

For more information, please visit the LENS Documentation.

Getting started

For reproducibility and simplicity, we use pixi for package management and installation. If not already installed, please run the following command in your terminal:

curl -fsSL https://pixi.sh/install.sh | bash

You will be prompted to restart your terminal once installed. For more information, please refer to the pixi documentation.

Run the following in your terminal to clone the LENS repository and navigate to the project directory:

git clone git@github.com:AdamDHines/LENS.git
cd ~/LENS

For alternative package and dependency installation, please see the LENS documentation.

Quick demo

Get started using our demo dataset and pre-trained model to evaluate the system. Run the following in your command terminal to see the demo:

pixi run demo

Train and evaluate new model

Test out training and evaluating a new model with our ultra-fast learning method using our provided demo dataset by running the following in your command terminal:

pixi run train
pixi run evaluate

For a full guide on training and evaluating your own datasets, please visit the LENS documentation.

Optimize network hyperparameters

To get the best localization performance on benchmark or custom datasets, you can tune your network hyperparameters using Weights & Biases through our convenient optimizer script:

pixi run optimizer

For detailed instructions on setting up Weights & Biases and the optimizer, please refer to the LENS documentation.

Deployment on neuromorphic hardware

LENS was developed using a SynSense Speck2fDevKit. If you have one of these kits, deploying to it is simple. Try out LENS using our pre-trained model and datasets by deploying simulated event streams on-chip:

pixi run sim-speck

Additionally, models can be deployed onto the Speck2fDevKit for low-latency and energy efficient VPR with sequence matching in real-time:

pixi run on-speck

For more details on deployment to the Speck2fDevKit, please visit the LENS documentation.

Dataset

For all data relating to our manuscript, we have a dedicated permanent repository at https://zenodo.org/records/15392412, as well as including all data in this repository, which can found in the ./lens/data folder.

We acknowledge the Brisbane-Event-VPR dataset from https://zenodo.org/records/4302805.

License and citation

This repository is licensed under the permissive MIT License. If you use our code, please cite our paper:

@article{HinesLENS2025,
  author = {Adam D. Hines  and Michael Milford  and Tobias Fischer },
  title = {A compact neuromorphic system for ultra–energy-efficient, on-device robot localization},
  journal = {Science Robotics},
  volume = {10},
  number = {103},
  pages = {eads3968},
  year = {2025},
  doi = {10.1126/scirobotics.ads3968},
  URL = {https://www.science.org/doi/abs/10.1126/scirobotics.ads3968}
}

Issues, bugs, and feature requests

If you encounter problems whilst running the code or if you have a suggestion for a feature or improvement, please report it as an issue.

Metadata

Release files for lens-vpr 0.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lens-vpr 0.1.5
File Size Uploaded Provenance Actions
lens-vpr-0.1.5.tar.gz 49.8 kB Without provenance Details for lens-vpr-0.1.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for lens-vpr 0.1.5
File Interpreter ABI Platform Actions
lens_vpr-0.1.5-py3-none-any.whl Python 3 none any Details for lens_vpr-0.1.5-py3-none-any.whl

Total release size: 111.0 kB

Release files / lens-vpr-0.1.5.tar.gz

Download URL lens-vpr-0.1.5.tar.gz
Size 49.8 kB
Tags Source
SHA-256 checksum
How to use checksums
7cee40574c29762d709687f2e995e0d71c55d29055ea45025d18b7afa2cfa1de
BLAKE2b-256 checksum
How to use checksums
7d7ca45c8718fb40f68028ee9baab109dfe31509078594c57f6b8f8f5eef54a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.13

Release files / lens_vpr-0.1.5-py3-none-any.whl

Download URL lens_vpr-0.1.5-py3-none-any.whl
Size 61.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
716da07383fd23d6f0e795c54352e3810185d6c8ac73e18b346c1737f2c08081
BLAKE2b-256 checksum
How to use checksums
e3a02fca0c380a44f3649e21912f07954276acddd31fb0437009c376dc8cbd35
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.13

Security for lens-vpr 0.1.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page