OpenGait release(pre-beta version).

doc/how_to_create_your_model.md

@@ -0,0 +1,4 @@
+# How to Create Your Own Model
+This section of documentation will be **refined in the future**. For now, you can refer these files: [default config](config/default.yaml), [baseline config](config/baseline.yaml), [loss aggregator](../lib/modeling/loss_aggregator.py), [base_model](../lib/modeling/base_model.py), and [baseline model](../lib/modeling/models/baseline.py).
+
+Then, you can write your own model in `lib\modeling\models`, and use it in configuration file.

doc/prepare_dataset.md

@@ -0,0 +1,34 @@
+# Prepare dataset
+Suppose you have downloaded the original dataset, we need to preprocess the data and save it as pickle file. Remember to set your path to the root of processed dataset in [config/*.yaml](config/).
+
+## Preprocess
+**CASIA-B**
+
+- Original
+    ```
+    CASIA-B
+        001 (subject)
+            bg-01 (type)
+                000 (view)
+                    001-bg-01-000-001.png (frame)
+                    001-bg-01-000-002.png (frame)
+                    ......
+                ......
+            ......
+        ......
+    ```
+- Run `python misc/pretreatment.py --input_path CASIA-B --output_path CASIA-B-pkl`
+- Processed
+    ```
+    CASIA-B-pkl
+        001 (subject)
+            bg-01 (type)
+                    000 (view)
+                        000.pkl (contains all frames)
+                ......
+            ......
+        ......
+    ```
+
+## Split dataset
+You can use the partition file in [misc/partitions](misc/partitions/) directly, or you can create yours. Remember to set your path to the partition file in [config/*.yaml](config/).