From 13e80dc3559f46739088ae5b4c507dc4d3627aca Mon Sep 17 00:00:00 2001 From: Minghao Liu <76873720+StaryMoon@users.noreply.github.com> Date: Sat, 4 Jul 2026 17:41:33 +0800 Subject: [PATCH] Fix typos in Qlib docs and comments --- docs/component/workflow.rst | 4 ++-- docs/hidden/client.rst | 2 +- qlib/contrib/evaluate.py | 2 +- qlib/utils/__init__.py | 2 +- qlib/utils/mod.py | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/component/workflow.rst b/docs/component/workflow.rst index 3a88cde7bc6..0b1859c7b20 100644 --- a/docs/component/workflow.rst +++ b/docs/component/workflow.rst @@ -127,8 +127,8 @@ Configuration File Let's get into details of ``qrun`` in this section. Before using ``qrun``, users need to prepare a configuration file. The following content shows how to prepare each part of the configuration file. -The design logic of the configuration file is very simple. It predefines fixed workflows and provide this yaml interface to users to define how to initialize each component. -It follow the design of `init_instance_by_config `_ . It defines the initialization of each component of Qlib, which typically include the class and the initialization arguments. +The design logic of the configuration file is very simple. It predefines fixed workflows and provides this YAML interface to users to define how to initialize each component. +It follows the design of `init_instance_by_config `_ . It defines the initialization of each component of Qlib, which typically includes the class and the initialization arguments. For example, the following yaml and code are equivalent. diff --git a/docs/hidden/client.rst b/docs/hidden/client.rst index de6e2e681e8..39361beadb7 100644 --- a/docs/hidden/client.rst +++ b/docs/hidden/client.rst @@ -16,7 +16,7 @@ Client-Server is designed to solve following problems Therefore, we designed the client-server framework to solve these problems. We will maintain a server and provide the data. -You have to initialize you qlib with specific config for using the client-server framework. +You have to initialize Qlib with a specific config for using the client-server framework. Here is a typical initialization process. qlib ``init`` commonly used parameters; ``nfs-common`` must be installed on the server where the client is located, execute: ``sudo apt install nfs-common``: diff --git a/qlib/contrib/evaluate.py b/qlib/contrib/evaluate.py index d315622fcc6..545d33655ee 100644 --- a/qlib/contrib/evaluate.py +++ b/qlib/contrib/evaluate.py @@ -154,7 +154,7 @@ def backtest_daily( exchange_kwargs: dict = None, pos_type: str = "Position", ): - """initialize the strategy and executor, then executor the backtest of daily frequency + """initialize the strategy and executor, then execute the backtest of daily frequency Parameters ---------- diff --git a/qlib/utils/__init__.py b/qlib/utils/__init__.py index 2a94ebd555b..3ea67a9fbd3 100644 --- a/qlib/utils/__init__.py +++ b/qlib/utils/__init__.py @@ -1,7 +1,7 @@ # Copyright (c) Microsoft Corporation. # Licensed under the MIT License. -# TODO: this utils covers too much utilities, please seperat it into sub modules +# TODO: this utils covers too many utilities, please separate it into submodules from __future__ import division from __future__ import print_function diff --git a/qlib/utils/mod.py b/qlib/utils/mod.py index 5cb2ed3f453..acd2c56b419 100644 --- a/qlib/utils/mod.py +++ b/qlib/utils/mod.py @@ -145,8 +145,8 @@ def init_instance_by_config( This will be passed into the second parameter of isinstance. try_kwargs: Dict - Try to pass in kwargs in `try_kwargs` when initialized the instance - If error occurred, it will fail back to initialization without try_kwargs. + Try to pass in kwargs in `try_kwargs` when initializing the instance + If an error occurs, it will fall back to initialization without try_kwargs. Returns -------