diff --git a/README.md b/README.md index 2ede0c2370..5b385e563e 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ Also, users can install ``Qlib`` by the source code according to the following s ## Data Preparation Load and prepare data by running the following code: ```bash - python scripts/get_data.py qlib_data_cn --target_dir ~/.qlib/qlib_data/cn_data + python scripts/get_data.py qlib_data --target_dir ~/.qlib/qlib_data/cn_data --region cn ``` This dataset is created by public data collected by [crawler scripts](scripts/data_collector/), which have been released in diff --git a/docs/component/data.rst b/docs/component/data.rst index 7c374f1ddb..819fb2c4fd 100644 --- a/docs/component/data.rst +++ b/docs/component/data.rst @@ -34,7 +34,7 @@ Qlib Format Dataset .. code-block:: bash - python scripts/get_data.py qlib_data_cn --target_dir ~/.qlib/qlib_data/cn_data + python scripts/get_data.py qlib_data --target_dir ~/.qlib/qlib_data/cn_data --region cn After running the above command, users can find china-stock data in Qlib format in the ``~/.qlib/csv_data/cn_data`` directory. diff --git a/docs/introduction/quick.rst b/docs/introduction/quick.rst index df4b84062f..9fff8cb3fe 100644 --- a/docs/introduction/quick.rst +++ b/docs/introduction/quick.rst @@ -40,7 +40,7 @@ Load and prepare data by running the following code: .. code-block:: - python scripts/get_data.py qlib_data_cn --target_dir ~/.qlib/qlib_data/cn_data + python scripts/get_data.py qlib_data --target_dir ~/.qlib/qlib_data/cn_data --region cn This dataset is created by public data collected by crawler scripts in ``scripts/data_collector/``, which have been released in the same repository. Users could create the same dataset with it. diff --git a/docs/start/initialization.rst b/docs/start/initialization.rst index e34ab82fed..9923075158 100644 --- a/docs/start/initialization.rst +++ b/docs/start/initialization.rst @@ -14,7 +14,7 @@ Please follow the steps below to initialize ``Qlib``. - Download and prepare the Data: execute the following command to download stock data. Please pay `attention` that the data is collected from `Yahoo Finance `_ and the data might not be perfect. We recommend users to prepare their own data if they have high-quality datasets. Please refer to `Data <../component/data.html#converting-csv-format-into-qlib-format>` for more information about customized dataset. .. code-block:: bash - python scripts/get_data.py qlib_data_cn --target_dir ~/.qlib/qlib_data/cn_data + python scripts/get_data.py qlib_data --target_dir ~/.qlib/qlib_data/cn_data --region cn Please refer to `Data Preparation <../component/data.html#data-preparation>`_ for more information about `get_data.py`, diff --git a/examples/train_backtest_analyze.ipynb b/examples/train_backtest_analyze.ipynb index 21d3605a60..d8987b58fe 100644 --- a/examples/train_backtest_analyze.ipynb +++ b/examples/train_backtest_analyze.ipynb @@ -31,7 +31,7 @@ "outputs": [], "source": [ "# use default data\n", - "# NOTE: need to download data from remote: python scripts/get_data.py qlib_data_cn --target_dir ~/.qlib/qlib_data/cn_data\n", + "# NOTE: need to download data from remote: python scripts/get_data.py qlib_data --target_dir ~/.qlib/qlib_data/cn_data --region cn\n", "provider_uri = \"~/.qlib/qlib_data/cn_data\" # target_dir\n", "if not exists_qlib_data(provider_uri):\n", " print(f\"Qlib data is not found in {provider_uri}\")\n", diff --git a/scripts/README.md b/scripts/README.md index 46cecfdef0..98b01e0c35 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -1,29 +1,61 @@ -# Download Qlib Data +- [Download Qlib Data](#Download-Qlib-Data) + - [Download CN Data](#Download-CN-Data) + - [Downlaod US Data](#Downlaod-US-Data) + - [Download CN Simple Data](#Download-CN-Simple-Data) + - [Help](#Help) +- [Using in Qlib](#Using-in-Qlib) + - [US data](#US-data) + - [CN data](#CN-data) -## Download CN Data + +## 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 +### Downlaod US Data -> The US stock code contains 'PRN', and the directory cannot be created on Windows system +> The US stock code contains 'PRN', and the directory cannot be created on Windows system: https://superuser.com/questions/613313/why-cant-we-make-con-prn-null-folder-in-windows ```bash python get_data.py qlib_data --target_dir ~/.qlib/qlib_data/us_data --region us ``` -## Download CN Simple Data +### 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 +### Help ```bash python get_data.py qlib_data --help ``` +## Using in Qlib +> For more information: https://qlib.readthedocs.io/en/latest/start/initialization.html + + +### US data + +```python +import qlib +from qlib.config import REG_US +provider_uri = "~/.qlib/qlib_data/us_data" # target_dir +qlib.init(provider_uri=provider_uri, region=REG_US) +``` + +### CN data + +```python +import qlib +from qlib.config import REG_CN +provider_uri = "~/.qlib/qlib_data/cn_data" # target_dir +qlib.init(provider_uri=provider_uri, region=REG_CN) +```