From ca6c2ffc279c463fb31d6a53b631626d9fecbd82 Mon Sep 17 00:00:00 2001 From: bxdd <45119470+bxdd@users.noreply.github.com> Date: Fri, 5 Feb 2021 12:15:55 +0800 Subject: [PATCH] Update serial.rst --- docs/advanced/serial.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/advanced/serial.rst b/docs/advanced/serial.rst index a0e6480b9..05d5f37c7 100644 --- a/docs/advanced/serial.rst +++ b/docs/advanced/serial.rst @@ -12,7 +12,7 @@ Introduction Serializable Class ======================== -``Qlib`` provides a base class ``qlib.utils.serial.Serializable``, whose state can be dumped in or loaded from disk in `pickle` format. +``Qlib`` provides a base class ``qlib.utils.serial.Serializable``, whose state can be dumped into or loaded from disk in `pickle` format. When users dump the state of the ``Serializable`` instance, the attributes of the instance whose name **does not** start with `_` will be saved on the disk. Example @@ -23,7 +23,7 @@ Specifically, ``qlib.data.dataset.DatasetH`` is one of them. Users can serialize .. code-block:: Python ##=============dump dataset============= - dataset.to_pickle(path="dataset.pkl") # dataset is the instance of qlib.data.dataset.DatasetH + dataset.to_pickle(path="dataset.pkl") # dataset is an instance of qlib.data.dataset.DatasetH ##=============reload dataset============= with open("dataset.pkl", "rb") as file_dataset: