Metadata-Version: 2.1
Name: taisui
Version: 0.1.1
Summary: Third-generation Artificial Intelligence SNN Universal Implementation
Home-page: https://github.com/BIT-AETAS/taisui
Author: AETAS
Author-email: leiyunlin@bit.edu.cn, gaolanyu@bit.edu.cn
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.6,<=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: torch
Requires-Dist: torchvision
Requires-Dist: torchaudio

# TAISUI

<p align="center">
  	<img alt="TAISUI" src="./docs/en/source/_static/logo.png" width=50%>
</p>

English | [中文(Chinese)](./README_zh_CN.md) 

TAISUI is a low-power, large-scale spiking neural network training and inference framework. It preserves minimal energy cosumption while providing the superior learning abilities of large spiking neural network.

The vision of TAISUI is to decode human intelligence and the mechanisms of its evolution, and to provide support for the development of brain-inspired intelligent agents in a future society where humans coexist with artificial intelligence.

- **[Documentation](https://taisui.readthedocs.io/)**
- **[Source](https://github.com/taisui/taisui/)**

## Install

TAISUI offers two installation methods.
Running the following command in your terminal will install the project:
### Install from PyPI:

```
pip install taisui
```
### Install from GitHub:

1.  Download or clone TAISUI from github
```
git clone https://github.com/taisui/taisui.git
```
2.  Enter the folder of TAISUI and install braincog locally with setuptools
```
cd taisui
python setup.py install
```

## Quickstart

The code style of TAISUI is consistent with Pytorch, allowing you to build spiking neural networks with simple code:
```
from taisui.base.neuron import LIFNode
import torch

x = torch.randn(2, 3, 5, 5)

net = torch.nn.Sequential(
    nn.Conv2d(1, 32, kernel_size=3),
    LIFNode(),
    nn.Flatten(),
    nn.Linear(54, 1)
)

y = net(x)
```

## Development plans

TAISUI is still under active development:
- [x] Large-scale deep spiking neural network training and inference
- [ ] Ultra-low energy consumption sparse spiking neural network computing
- [ ] Brain-inspired learning algorithm support
- [ ] Bionic neural network sparse structure support

## Cite

If you are using TAISUI, please consider citing it as follows:
```
@misc{TAISUI,
    title = {TAISUI},
    author = {Lei, Yunlin and Gao, Lanyu and Yang, Xu and other contributors},
    year = {2024},
    publisher = {GitHub},
    journal = {GitHub repository},
    howpublished = {\url{https://github.com/taisui/taisui}},
}
```

## About

[Beijing Institute of Technology AETAS Laboratory](https://www.aetasbit.com/)are the main developers of TAISUI.
