diff --git a/docs/Tutorials/examples.rst b/docs/Tutorials/examples.rst new file mode 100644 index 0000000..c1bd2cb --- /dev/null +++ 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 +``` \ No newline at end of file diff --git a/docs/Tutorials/installation.rst b/docs/Tutorials/installation.rst new file mode 100644 index 0000000..0f57b71 --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/Tutorials/quick_start.rst b/docs/Tutorials/quick_start.rst new file mode 100644 index 0000000..a85ae50 --- /dev/null +++ b/docs/Tutorials/quick_start.rst @@ -0,0 +1,6 @@ +Quick start +=============== + +.. toctree:: + Installation + Examples \ No newline at end of file