Metadata-Version: 2.3
Name: inferno-ai
Version: 0.0.3
Summary: An Extensible Spiking Neural Network Library
Project-URL: Homepage, https://github.com/mdominijanni/inferno
Project-URL: Documentation, https://inferno-ai.dev
Author-email: Marissa Dominijanni <mdomini@buffalo.edu>
License: BSD 3-Clause License
        
        Copyright (c) 2023-2024, Marissa Dominijanni
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Requires-Dist: einops~=0.7
Requires-Dist: numpy~=1.26
Provides-Extra: torch
Requires-Dist: torch==2.3.1; (sys_platform == 'darwin') and extra == 'torch'
Requires-Dist: torch==2.3.1; (sys_platform == 'linux') and extra == 'torch'
Requires-Dist: torch==2.3.1; (sys_platform == 'win32') and extra == 'torch'
Requires-Dist: torchvision==0.18.1; (sys_platform == 'darwin') and extra == 'torch'
Requires-Dist: torchvision==0.18.1; (sys_platform == 'linux') and extra == 'torch'
Requires-Dist: torchvision==0.18.1; (sys_platform == 'win32') and extra == 'torch'
Description-Content-Type: text/markdown

![Inferno Header](https://raw.githubusercontent.com/mdominijanni/inferno/dev/misc/assets/inferno-header-github.png)

Inferno is an extensible library for simulating spiking neural networks. Built on top of [PyTorch](https://github.com/pytorch/pytorch), it is designed with machine learning practitioners in mind. This project is still an early release and features may be subject to change.

## Installation
At this time, installation is only supported via pip. Future support for installation with conda is planned.

### With PyTorch (CPU Only)
```
pip install inferno-ai[torch]
```
Installation with the "torch" flag will install PyTorch 2.3.1 and the corresponding version of TorchVision.

### Without PyTorch
```
pip install inferno-ai
```
*Note: Inferno still requires PyTorch and a version of it must be installed. PyTorch will need to be installed separately if CUDA support is required. See the [instructions for installing PyTorch](https://pytorch.org/get-started/locally/) for details.*