liuyu/qlib
1
0
Fork 0
mirror of https://github.com/microsoft/qlib.git synced 2026-07-15 00:36:55 +08:00
Code Activity

Add more docs about initialization (#880)

Browse Source 
* Add more docs about initialization

* Update initialization.rst
This commit is contained in:
you-n-g
2022-01-21 14:08:04 +08:00
committed by GitHub
parent da48f42f3f
commit 5b5c99fe75
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/start/initialization.rst
View File

@@ -37,7 +37,8 @@ Initialize Qlib before calling other APIs: run following code in python.
Parameters Parameters
------------------- -------------------
Besides `provider_uri` and `region`, `qlib.init` has other parameters. The following are several important parameters of `qlib.init`: Besides `provider_uri` and `region`, `qlib.init` has other parameters.
The following are several important parameters of `qlib.init` (`Qlib` has a lot of config. Only part of parameters are limited here. More detailed setting can be found `here <https://github.com/microsoft/qlib/blob/main/qlib/config.py>`_):
- `provider_uri` - `provider_uri`
Type: str. The URI of the Qlib data. For example, it could be the location where the data loaded by ``get_data.py`` are stored. Type: str. The URI of the Qlib data. For example, it could be the location where the data loaded by ``get_data.py`` are stored.
@@ -88,3 +89,5 @@ Besides `provider_uri` and `region`, `qlib.init` has other parameters. The follo
"task_url": "mongodb://localhost:27017/", # your mongo url "task_url": "mongodb://localhost:27017/", # your mongo url
"task_db_name": "rolling_db", # the database name of Task Management "task_db_name": "rolling_db", # the database name of Task Management
}) })
- `logging_level`: The logging level for the system.
- `kernels`: The number of processes used when calculating features in Qlib's expression engine. It is very helpful to set it to 1 when you are debuggin an expression calculating exception