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

Fix typos and comments. (#815)

Browse Source 
* Fix typos and comments.

* Add comma before and.
This commit is contained in:
Chia-hung Tai
2022-01-09 21:13:25 +08:00
committed by GitHub
parent 6c1332f604
commit bcf18c14de
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
qlib/__init__.py
View File

@@ -19,11 +19,17 @@ def init(default_conf="client", **kwargs):
Parameters
----------
default_conf: str
the default value is client. Accepted values: client/server.
**kwargs :
clear_mem_cache: str
the default value is True;
Will the memory cache be clear.
It is often used to improve performance when init will be called for multiple times
skip_if_reg: bool: str
the default value is True;
When using the recorder, skip_if_reg can set to True to avoid loss of recorder.
"""
from .config import C
from .data.cache import H
@@ -180,7 +186,7 @@ def get_project_path(config_name="config.yaml", cur_path: Union[Path, str, None]
- There is a file named `config.yaml` in qlib.
For example:
If your project file system stucuture follows such a pattern
If your project file system structure follows such a pattern
<project_path>/
- config.yaml
@@ -225,7 +231,7 @@ def auto_init(**kwargs):
Here are two examples of the configuration
Example 1)
If you want create a new project-specific config based on a shared configure, you can use `conf_type: ref`
If you want to create a new project-specific config based on a shared configure, you can use `conf_type: ref`
.. code-block:: yaml
@@ -241,7 +247,7 @@ def auto_init(**kwargs):
default_exp_name: "Experiment"
Example 2)
If you want to create simple a stand alone config, you can use following config(a.k.a `conf_type: origin`)
If you want to create simple a standalone config, you can use following config(a.k.a. `conf_type: origin`)
.. code-block:: python
@@ -271,8 +277,8 @@ def auto_init(**kwargs):
init_from_yaml_conf(conf_pp, **kwargs)
elif conf_type == "ref":
# This config type will be more convenient in following scenario
# - There is a shared configure file and you don't want to edit it inplace.
# - The shared configure may be updated later and you don't want to copy it.
# - There is a shared configure file, and you don't want to edit it inplace.
# - The shared configure may be updated later, and you don't want to copy it.
# - You have some customized config.
qlib_conf_path = conf.get("qlib_cfg", None)