From db1303700df6aa3da6a043139323c2a3418b81d7 Mon Sep 17 00:00:00 2001 From: Gregor Lenz Date: Sat, 21 Oct 2023 23:33:06 +0100 Subject: [PATCH] Prophesee prototype docstring updates --- docs/index.md | 2 +- tonic/prototype/datasets/prophesee.py | 27 +++++++++++---------------- 2 files changed, 12 insertions(+), 17 deletions(-) diff --git a/docs/index.md b/docs/index.md index e0abbfc..45d2744 100644 --- a/docs/index.md +++ b/docs/index.md @@ -27,7 +27,7 @@ If you want you can [run them yourself](https://mybinder.org/v2/gh/neuromorphs/t ### API reference * **{doc}`List of neuromorphic datasets`**. Vision and audio datasets. * **{doc}`List of event transformations`**. Event transforms and representations. -* **{doc}`Supported file parsers`**. For the various file formats out there. +* **{doc}Supported file parsers**. For the various file formats out there. ### Reading material * **{doc}`Introduction to neuromorphic cameras`** if you've never worked with events/spikes. diff --git a/tonic/prototype/datasets/prophesee.py b/tonic/prototype/datasets/prophesee.py index c96a238..9e992de 100644 --- a/tonic/prototype/datasets/prophesee.py +++ b/tonic/prototype/datasets/prophesee.py @@ -94,19 +94,16 @@ class Gen1AutomotiveDetection(AutomotiveDetectionBaseClass): Then, the steps to acquire the data can be as follows: - Download the torrent file for the dataset - :: + Download the torrent file for the dataset:: wget https://dataset.prophesee.ai/index.php/s/uE0QGLaFAEQnPwy/download\?path\=%2F\&files\=ATIS%20Automotive%20Detection%20Dataset.torrent -O Gen1Prophesee.torrent - Download the data using peer-to-peer connections. On Linux this can be done using `aria2c` on the command line - :: + Download the data using peer-to-peer connections. On Linux this can be done using `aria2c` on the command line:: aria2c Gen1Prophesee.torrent - This will download several 7z archives for training and testing. We'll need to unpack them manually by looping over the 7z files and feeding them to 7z - :: + This will download several 7z archives for training and testing. We'll need to unpack them manually by looping over the 7z files and feeding them to 7z:: sudo apt-get install p7zip-full for i in *.7z; do 7z x $i; done @@ -143,8 +140,7 @@ class Gen4AutomotiveDetectionMini(AutomotiveDetectionBaseClass): """`Gen4 Automotive Detection `_ - This datasets needs 'expelliarmus' installed on the system. Events have "txyp" ordering. - :: + This datasets needs 'expelliarmus' installed on the system. Events have "txyp" ordering.:: @article{de2020large, title={A large scale event-based detection dataset for automotive}, @@ -209,8 +205,7 @@ class Gen4Automotive(AutomotiveDetectionBaseClass): """`Gen4 Automotive Detection `_ - This datasets needs 'expelliarmus' installed on the system. Events have "txyp" ordering. - :: + This datasets needs 'expelliarmus' installed on the system. Events have "txyp" ordering.:: @article{de2020large, title={A large scale event-based detection dataset for automotive}, @@ -223,17 +218,17 @@ class Gen4Automotive(AutomotiveDetectionBaseClass): Then, the steps to acquire the data can be as follows: - Download the torrent file for the dataset - :: + Download the torrent file for the dataset:: + wget https://dataset.prophesee.ai/index.php/s/8HY0Bv4mOU4RzBm/download?path=%2F&files=Large_Automotive_Detection_Dataset.torrent -O Gen4Prophesee.torrent - Download the data using peer-to-peer connections. On Linux this can be done using `aria2c` on the command line - :: + Download the data using peer-to-peer connections. On Linux this can be done using `aria2c` on the command line:: + aria2c Gen4Prophesee.torrent - This will download several 7z archives for training, validation and testing. We'll need to unpack them manually by looping over the 7z files and feeding them to 7z - :: + This will download several 7z archives for training, validation and testing. We'll need to unpack them manually by looping over the 7z files and feeding them to 7z:: + sudo apt-get install p7zip-full for i in *.7z; do 7z x $i; done