doc: add tutorials

Dengyu-Wu · Jun 28, 2024 · baf6f0c · baf6f0c
1 parent 93102a1
commit baf6f0c
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/docs/Tutorials/examples.rst b/docs/Tutorials/examples.rst
@@ -0,0 +1,11 @@
+## Examples
+
+### Training
+
+```sh
+sh scripts/DirectTraining/tet/training.sh
+```
+### Evaluation
+```sh
+sh scripts/DirectTraining/tet/evaluation.sh
+```
diff --git a/docs/Tutorials/installation.rst b/docs/Tutorials/installation.rst
@@ -0,0 +1,10 @@
+# Installation
+
+1. Clone the repo
+```sh
+git clone https://github.com/Dengyu-Wu/snncutoff.git
+```
+
+2. Install Pytorch
+```sh
+pip install -r requirements. txt 
diff --git a/docs/Tutorials/quick_start.rst b/docs/Tutorials/quick_start.rst
@@ -0,0 +1,6 @@
+Quick start
+===============
+
+.. toctree::
+   Installation
+   Examples