spikezoo 0.2.1__py3-none-any.whl → 0.2.2__py3-none-any.whl

spikezoo/utils/spike_utils.py

@@ -5,7 +5,7 @@ import os
 from .vidar_loader import load_vidar_dat_cpp
 from typing import Literal
 
-def load_vidar_dat(filename, height, width,remove_head=False, version:Literal['python','cpp'] = "cpp", out_format : Literal['array','tensor']="array",):
+def load_vidar_dat(filename, height, width,remove_head=False, version:Literal['python','cpp'] = "python", out_format : Literal['array','tensor']="array",):
     """Load the spike stream from the .dat file."""
     # Spike decode
     if version == "python":

{spikezoo-0.2.1.dist-info → spikezoo-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: spikezoo
-Version: 0.2.1
+Version: 0.2.2
 Summary: A deep learning toolbox for spike-to-image models.
 Home-page: https://github.com/chenkang455/Spike-Zoo
 Author: Kang Chen
@@ -36,12 +36,12 @@ Dynamic: requires-python
 Dynamic: summary
 
 <h2 align="center"> 
-  <a href="">Spike-Zoo: A Toolbox for Spike-to-Image Reconstruction
+  <a href="">⚡Spike-Zoo: A Toolbox for Spike-to-Image Reconstruction
   </a>
 </h2>
 
 ## 📖 About
-⚡ Spike-Zoo is the go-to library for state-of-the-art pretrained **spike-to-image** models designed to reconstruct images from spike streams. Whether you're looking for a simple inference solution or aiming to train your own spike-to-image models, ⚡Spike-Zoo is a modular toolbox that supports both, with key features including:
+⚡Spike-Zoo is the go-to library for state-of-the-art pretrained **spike-to-image** models designed to reconstruct images from spike streams. Whether you're looking for a simple inference solution or aiming to train your own spike-to-image models, ⚡Spike-Zoo is a modular toolbox that supports both, with key features including:
 
 - Fast inference with pre-trained models.
 - Training support for custom-designed spike-to-image models.
@@ -138,22 +138,51 @@ We finish the training with one 4090 GPU in `2 minutes`, achieving `34.7dB` in P
 > 🌟 We encourage users to develop their models using our framework, with the tutorial being released soon.
 
 ### 4. Others
-We provide a faster `load_vidar_dat` function implemented with `cpp` (by @zeal-ye):
+We provide a faster `load_vidar_dat` function implemented with `cpp` (by [@zeal-ye](https://github.com/zeal-ye)):
 ``` python
 import spikezoo as sz
 spike = sz.load_vidar_dat("data/scissor.dat",width = 400,height = 250,version='cpp')
 ```
 🚀 Results on [examples/test_load_dat.py](examples/test_load_dat.py) show that the `cpp` version is more than 10 times faster than the `python` version.
 
-
 ## 📅 TODO
 - [ ] Provide the tutorials.
 - [ ] Support more training settings.
 - [ ] Support more spike-based image reconstruction methods and datasets. 
 - [ ] Support the overall pipeline for spike simulation. 
 
+## 🤗 Supports
+Run the following code to find our supported models, datasets and metrics:
+``` python
+import spikezoo as sz
+print(sz.get_models())
+print(sz.get_datasets())
+print(sz.get_metrics())
+```
+**Supported Models:**
+|  Models   | Source  
+|  ----  | ----  | 
+| `tfp`,`tfi` | Spike camera and its coding methods | 
+| `spk2imgnet`  | Spk2ImgNet: Learning to Reconstruct Dynamic Scene from Continuous Spike Stream | 
+| `wgse`  | Learning Temporal-Ordered Representation for Spike Streams Based on Discrete Wavelet Transforms | 
+| `ssml`  | Self-Supervised Mutual Learning for Dynamic Scene Reconstruction of Spiking Camera | 
+| `spikeformer`  | SpikeFormer: Image Reconstruction from the Sequence of Spike Camera Based on Transformer |
+| `ssir`  | Spike Camera Image Reconstruction Using Deep Spiking Neural Networks |
+| `bsf`  | Boosting Spike Camera Image Reconstruction from a Perspective of Dealing with Spike Fluctuations |
+| `stir`  | Spatio-Temporal Interactive Learning for Efficient Image Reconstruction of Spiking Cameras |
+| `spikeclip`  | Rethinking High-speed Image Reconstruction Framework with Spike Camera |
+
+**Supported Datasets:**
+|  Datasets   | Source  
+|  ----  | ----  | 
+| `reds_small`  | Spk2ImgNet: Learning to Reconstruct Dynamic Scene from Continuous Spike Stream | 
+| `uhsr`  | Recognizing Ultra-High-Speed Moving Objects with Bio-Inspired Spike Camera | 
+| `realworld`  | `recVidarReal2019`,`momVidarReal2021` in [SpikeCV](https://github.com/Zyj061/SpikeCV) | 
+| `szdata`  | SpikeReveal: Unlocking Temporal Sequences from Real Blurry Inputs with Spike Streams | 
+
+
 ## ✨‍ Acknowledgment
-Our code is built on the open-source projects of [SpikeCV](https://spikecv.github.io/), [IQA-Pytorch](https://github.com/chaofengc/IQA-PyTorch), [BasicSR](https://github.com/XPixelGroup/BasicSR) and [NeRFStudio](https://github.com/nerfstudio-project/nerfstudio).We appreciate the effort of the contributors to these repositories. Thanks for @ruizhao26 and @Leozhangjiyuan for their help in building this project.
+Our code is built on the open-source projects of [SpikeCV](https://spikecv.github.io/), [IQA-Pytorch](https://github.com/chaofengc/IQA-PyTorch), [BasicSR](https://github.com/XPixelGroup/BasicSR) and [NeRFStudio](https://github.com/nerfstudio-project/nerfstudio).We appreciate the effort of the contributors to these repositories. Thanks for [@ruizhao26](https://github.com/ruizhao26) and [@Leozhangjiyuan](https://github.com/Leozhangjiyuan) for their help in building this project.
 
 ## 📑 Citation
 If you find our codes helpful to your research, please consider to use the following citation:

{spikezoo-0.2.1.dist-info → spikezoo-0.2.2.dist-info}/RECORD

@@ -202,10 +202,10 @@ spikezoo/utils/__init__.py,sha256=bYLlusAXwLCoY4s6nhVgviax9ioRA9aea8qgRmj2HpI,15
 spikezoo/utils/data_utils.py,sha256=mk1xeyIb7o_E1J7Z6-gtPq-rpKiMTxAWSTcvvPvVku8,2033
 spikezoo/utils/img_utils.py,sha256=0O9z58VzLxQEAuz-GGWCbpeHuHPOCpgBVjCBV9kf6sI,2257
 spikezoo/utils/other_utils.py,sha256=fKqs4zRxzQsIfmYZv02PZlVaGrmVEjq2KHTMrk_tBKY,2845
-spikezoo/utils/spike_utils.py,sha256=5pdmQUkr3Qup0kFpNGd5rPTwyut1XlJxgUnhrBx66mk,3120
+spikezoo/utils/spike_utils.py,sha256=0GY1hQCOCj0HDDwjXxrHykdjTKmPdb9rC_CexpRzwdk,3123
 spikezoo/utils/vidar_loader.cpython-39-x86_64-linux-gnu.so,sha256=uXqu7ME---cZRRU5LUcLiNrjjtlOjxNwWHyTIQ10BGg,199088
-spikezoo-0.2.1.dist-info/LICENSE.txt,sha256=ukEi8E0PKq1dQGTXHUflg3rppLymwAhr7il9x-0nPgg,1062
-spikezoo-0.2.1.dist-info/METADATA,sha256=rL0LmpUASG8v-vnNa6QlpTG3-cCBhTeQFwd0fgM0DkE,6241
-spikezoo-0.2.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-spikezoo-0.2.1.dist-info/top_level.txt,sha256=xF2iuOstrACJh43NW4dsTwIdgKfXPXAb_Xzl3M1ricM,9
-spikezoo-0.2.1.dist-info/RECORD,,
+spikezoo-0.2.2.dist-info/LICENSE.txt,sha256=ukEi8E0PKq1dQGTXHUflg3rppLymwAhr7il9x-0nPgg,1062
+spikezoo-0.2.2.dist-info/METADATA,sha256=j-XErZpa-tDx5wkFwwbOaHdcUjRuuGopldedu0hwEVk,7939
+spikezoo-0.2.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+spikezoo-0.2.2.dist-info/top_level.txt,sha256=xF2iuOstrACJh43NW4dsTwIdgKfXPXAb_Xzl3M1ricM,9
+spikezoo-0.2.2.dist-info/RECORD,,