Neuromorphic Intermediate Representation
Project description
NIRTorch
PyTorch helpers for the Neuromorphic Intermediate Representation (NIR). This is a no frills python package to enable torch based libraries to translate to NIR.
Installation
pip install nirtorch
Usage
NIRTorch is typically only interfaced by library/hardwarae developers.
NIRTorch provides the extract_nir_graph
function that takes as input a torch.nn.Module
and a means to map Torch modules into NIR nodes.
An NIR node is an element in the NIR compute graph, corresponding to neuromorphic ODEs.
Here is an example from the Norse library:
def _extract_norse_module(module: torch.nn.Module) -> Optional[nir.NIRNode]:
if isinstance(module, LIFBoxCell):
return nir.LIF(
tau=module.p.tau_mem_inv,
v_th=module.p.v_th,
v_leak=module.p.v_leak,
r=torch.ones_like(module.p.v_leak),
)
elif isinstance(module, torch.nn.Linear):
return nir.Linear(module.weight, module.bias)
elif ...
return None
def to_nir(
module: torch.nn.Module, sample_data: torch.Tensor, model_name: str = "norse"
) -> nir.NIRNode:
return extract_nir_graph(
module, _extract_norse_module, sample_data, model_name=model_name
)
Acknowledgements
If you use NIR torch in your work, please cite the following Zenodo reference
@software{nir2023,
author = {Abreu, Steven and
Bauer, Felix and
Eshraghian, Jason and
Jobst, Matthias and
Lenz, Gregor and
Pedersen, Jens Egholm and
Sheik, Sadique},
title = {Neuromorphic Intermediate Representation},
month = jul,
year = 2023,
publisher = {Zenodo},
version = {0.0.1},
doi = {10.5281/zenodo.8105042},
url = {https://doi.org/10.5281/zenodo.8105042}
}
For developers
If you want to make sure that your code is linted correctly on your local machine, use pre-commit to automatically perform checks before every git commit. To use it, first install the package in your environment
pip install pre-commit
and then install the pre-commit hooks that are listed in the root of this repository
pre-commit install
Next time you commit some changes, all the checks will be run!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file nirtorch-1.0.tar.gz
.
File metadata
- Download URL: nirtorch-1.0.tar.gz
- Upload date:
- Size: 18.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0a7c485c0cb523a257a68b881c83d3710a471ad896188879a1bb722d47db2bf |
|
MD5 | 6887742a99149ad7b5c5644f8fefa571 |
|
BLAKE2b-256 | fd1b27cb50acf5a0afcca55f238e32ea2a1ed9c5b58225346170682cd58fcfd6 |
File details
Details for the file nirtorch-1.0-py3-none-any.whl
.
File metadata
- Download URL: nirtorch-1.0-py3-none-any.whl
- Upload date:
- Size: 13.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72f4898a18ceb91d5a9b66515db2bb4a5893a8d11a77b48d9bbe058228995b02 |
|
MD5 | 3f352af0eee0e737f73057087161a15f |
|
BLAKE2b-256 | cd7492cc684fd83636b072318693676877af0d80c4e136067237f147f9a18d6f |