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

Update serial.rst

Browse Source
This commit is contained in:
bxdd
2021-02-05 12:15:55 +08:00
committed by you-n-g
parent 914637b3ef
commit ca6c2ffc27
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/advanced/serial.rst
View File

@@ -12,7 +12,7 @@ Introduction
Serializable Class 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. 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 Example
@@ -23,7 +23,7 @@ Specifically, ``qlib.data.dataset.DatasetH`` is one of them. Users can serialize
.. code-block:: Python .. code-block:: Python
##=============dump dataset============= ##=============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============= ##=============reload dataset=============
with open("dataset.pkl", "rb") as file_dataset: with open("dataset.pkl", "rb") as file_dataset: