add get_data.py docs

microsoft · Nov 19, 2020 · 2e50264 · 2e50264
1 parent d019183
commit 2e50264
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/scripts/README.md b/scripts/README.md
@@ -0,0 +1,29 @@
+# Download Qlib Data
+
+
+## Download CN Data
+
+```bash
+python get_data.py qlib_data --target_dir ~/.qlib/qlib_data/cn_data --region cn
+```
+
+## Downlaod US Data
+
+> The US stock code contains 'PRN', and the directory cannot be created on Windows system
+
+```bash
+python get_data.py qlib_data --target_dir ~/.qlib/qlib_data/us_data --region us
+```
+
+## Download CN Simple Data
+
+```bash
+python get_data.py qlib_data --name qlib_data_simple --target_dir ~/.qlib/qlib_data/cn_data --region cn
+```
+
+## Help
+
+```bash
+python get_data.py qlib_data --help
+```
+