Path-Integrating Recurrent Neural Networks (piRNNs)

Recurrent Neural Networks that perform path integration:

Source: ScienceDirect Article

Multi-timescale Recurrent Neural Networks:

Getting Started

Clone the repository & navigate to the directory:

git clone https://github.com/geometric-intelligence/pirnns.git
cd pirnns

Install Poetry

This project uses Poetry to manage dependencies.

1. Install Poetry (if you don't have it already):

curl -sSL https://install.python-poetry.org | python3 -

2. Make sure that Poetry is accessible in your PATH. For example, add the following to your .zshrc file:

export PATH="~/.local/bin:$PATH"

3. Check that Poetry is installed correctly:

poetry --version

Setup the environment

1. Install dependencies

poetry install

2. Install the poetry shell plugin

poetry self add poetry-plugin-shell

3. Activate the virtual environment

poetry shell

Start coding!

python my_script.py

Before sending a PR, make sure to format, lint, type check, and test the code:

black .
ruff check --fix .
mypy .
pytest .