Update README.md
Browse files
README.md
CHANGED
|
@@ -12,23 +12,25 @@
|
|
| 12 |
</p>
|
| 13 |
|
| 14 |
## β‘ Introduction
|
|
|
|
| 15 |
|
| 16 |
-
|
|
|
|
| 17 |
|
| 18 |
- **Modular Design** β Swap neuron models, encodings, or attention blocks with a few lines of code.
|
| 19 |
- **Multi-Task Ready** β Shared backbone, task-specific heads; evaluate *once*, report *everywhere*.
|
| 20 |
- **Cross-Framework Compatibility** β Runs on BrainCog, SpikingJelly, or BrainPy with a thin adapter layer.
|
| 21 |
-
- **End-to-End Reproducibility** β Version-locked configs and CI scripts guarantee βone-commandβ reruns.
|
| 22 |
|
| 23 |
-
### π Task-Specific READMEs
|
| 24 |
|
| 25 |
| Task | Documentation |
|
| 26 |
|------|---------------|
|
| 27 |
| Classification | [cls/Readme.md](cls/Readme.md) |
|
| 28 |
| Segmentation | [seg/Readme.md](seg/Readme.md) |
|
| 29 |
| Detection | [det/Readme.md](det/Readme.md) |
|
| 30 |
-
|
| 31 |
-
## π Key Features of STEP
|
| 32 |
|
| 33 |
<p align="center">
|
| 34 |
<img src="imgs/bench.png" alt="mp" style="width: 75%; max-width: 600px; min-width: 200px;" />
|
|
@@ -55,7 +57,7 @@ Built on top of **[BrainCog](https://github.com/BrainCog-X/Brain-Cog)**, this re
|
|
| 55 |
> **TL;DR** STEP lowers the barrier to building, training, and fairly benchmarking Spiking Transformers, accelerating progress toward practical neuromorphic vision systems.
|
| 56 |
## Repository Structure
|
| 57 |
|
| 58 |
-
```plaintext
|
| 59 |
Spiking-Transformer-Benchmark/
|
| 60 |
βββ cls/ # Classification submodule
|
| 61 |
β βββ README.md
|
|
@@ -73,7 +75,7 @@ Spiking-Transformer-Benchmark/
|
|
| 73 |
β βββ mmdet
|
| 74 |
β βββ ...
|
| 75 |
βββ README.md
|
| 76 |
-
```
|
| 77 |
|
| 78 |
## π Quick Start
|
| 79 |
|
|
@@ -82,7 +84,7 @@ To get started, clone the repository and install the required dependencies:
|
|
| 82 |
```bash
|
| 83 |
git clone https://github.com/Fancyssc/STEP.git
|
| 84 |
```
|
| 85 |
-
|
| 86 |
### BrainCog Installation
|
| 87 |
For the BrainCog framework, we recommend installing it via GitHub. You can use the following command in your terminal to install it from GitHub:
|
| 88 |
```angular2html
|
|
@@ -93,7 +95,7 @@ pip install git+https://github.com/braincog-X/Brain-Cog.git
|
|
| 93 |
For the **seg** and **cls** tasks, different environment requirements apply. Please refer to the corresponding README files in each subdirectory for details.
|
| 94 |
|
| 95 |
> **Prerequisites**: Python 3.8 or above, PyTorch, and BrainCog.
|
| 96 |
-
|
| 97 |
|
| 98 |
## Contact & Collaboration
|
| 99 |
|
|
|
|
| 12 |
</p>
|
| 13 |
|
| 14 |
## β‘ Introduction
|
| 15 |
+
This repository is the official **checkpoint repository** for STEP. It is intended solely for storing the model checkpoints, training logs, and corresponding configuration files (.yaml) used in STEP, to facilitate usage, reproduction, and comparison of Spiking Transformer models by researchers and interested users.
|
| 16 |
|
| 17 |
+
For the complete STEP framework, including source code and tutorials, please refer to the [official GitHub repository](https://github.com/Fancyssc/STEP).
|
| 18 |
+
<!-- Built on top of **[BrainCog](https://github.com/BrainCog-X/Brain-Cog)**, this repository reproduces state-of-the-art Spiking Transformer models and offers a unified pipeline for **classification, segmentation, and object detection**. By standardizing data loaders, training routines, and logging, it enables fair, reproducible comparisons while remaining easy to extend with new models or tasks.
|
| 19 |
|
| 20 |
- **Modular Design** β Swap neuron models, encodings, or attention blocks with a few lines of code.
|
| 21 |
- **Multi-Task Ready** β Shared backbone, task-specific heads; evaluate *once*, report *everywhere*.
|
| 22 |
- **Cross-Framework Compatibility** β Runs on BrainCog, SpikingJelly, or BrainPy with a thin adapter layer.
|
| 23 |
+
- **End-to-End Reproducibility** β Version-locked configs and CI scripts guarantee βone-commandβ reruns. -->
|
| 24 |
|
| 25 |
+
<!-- ### π Task-Specific READMEs
|
| 26 |
|
| 27 |
| Task | Documentation |
|
| 28 |
|------|---------------|
|
| 29 |
| Classification | [cls/Readme.md](cls/Readme.md) |
|
| 30 |
| Segmentation | [seg/Readme.md](seg/Readme.md) |
|
| 31 |
| Detection | [det/Readme.md](det/Readme.md) |
|
| 32 |
+
-->
|
| 33 |
+
<!-- ## π Key Features of STEP
|
| 34 |
|
| 35 |
<p align="center">
|
| 36 |
<img src="imgs/bench.png" alt="mp" style="width: 75%; max-width: 600px; min-width: 200px;" />
|
|
|
|
| 57 |
> **TL;DR** STEP lowers the barrier to building, training, and fairly benchmarking Spiking Transformers, accelerating progress toward practical neuromorphic vision systems.
|
| 58 |
## Repository Structure
|
| 59 |
|
| 60 |
+
<!-- ```plaintext
|
| 61 |
Spiking-Transformer-Benchmark/
|
| 62 |
βββ cls/ # Classification submodule
|
| 63 |
β βββ README.md
|
|
|
|
| 75 |
β βββ mmdet
|
| 76 |
β βββ ...
|
| 77 |
βββ README.md
|
| 78 |
+
``` --> -->
|
| 79 |
|
| 80 |
## π Quick Start
|
| 81 |
|
|
|
|
| 84 |
```bash
|
| 85 |
git clone https://github.com/Fancyssc/STEP.git
|
| 86 |
```
|
| 87 |
+
<!--
|
| 88 |
### BrainCog Installation
|
| 89 |
For the BrainCog framework, we recommend installing it via GitHub. You can use the following command in your terminal to install it from GitHub:
|
| 90 |
```angular2html
|
|
|
|
| 95 |
For the **seg** and **cls** tasks, different environment requirements apply. Please refer to the corresponding README files in each subdirectory for details.
|
| 96 |
|
| 97 |
> **Prerequisites**: Python 3.8 or above, PyTorch, and BrainCog.
|
| 98 |
+
-->
|
| 99 |
|
| 100 |
## Contact & Collaboration
|
| 101 |
|