Skip to content

Commit

Permalink
Add more docs about initialization (#880)
Browse files Browse the repository at this point in the history
* Add more docs about initialization

* Update initialization.rst
  • Loading branch information
you-n-g authored Jan 21, 2022
1 parent da48f42 commit 5b5c99f
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/start/initialization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ Initialize Qlib before calling other APIs: run following code in python.
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`
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.
Expand Down Expand Up @@ -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_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

0 comments on commit 5b5c99f

Please sign in to comment.