1
0
mirror of https://github.com/microsoft/qlib.git synced 2026-07-05 03:50:57 +08:00

Fix the Errors/Warnings when building Qlib's documentation (#1381)

* Fix the Errors/Warnings when building Qlib's documentation

* Fix

* Fix

* Empty

* Test CI

* Add doc compiling checking to CI

* Fix

* Tries to be consistent with Makefile

Co-authored-by: you-n-g <you-n-g@users.noreply.github.com>
This commit is contained in:
Maxim Smolskiy
2022-12-05 04:29:03 +03:00
committed by GitHub
parent 6a47416a2d
commit 5b73b80293
26 changed files with 127 additions and 78 deletions

View File

@@ -141,8 +141,10 @@ class MemCache:
Parameters
----------
mem_cache_size_limit: cache max size.
limit_type: length or sizeof; length(call fun: len), size(call fun: sys.getsizeof).
mem_cache_size_limit:
cache max size.
limit_type:
length or sizeof; length(call fun: len), size(call fun: sys.getsizeof).
"""
size_limit = C.mem_cache_size_limit if mem_cache_size_limit is None else mem_cache_size_limit
@@ -858,7 +860,7 @@ class DiskDatasetCache(DatasetCache):
"""gen_dataset_cache
.. note:: This function does not consider the cache read write lock. Please
Acquire the lock outside this function
acquire the lock outside this function
The format the cache contains 3 parts(followed by typical filename).
@@ -874,10 +876,10 @@ class DiskDatasetCache(DatasetCache):
1999-11-12 00:00:00 2 3
...
.. note:: The start is closed. The end is open!!!!!
.. note:: The start is closed. The end is open!!!!!
- Each line contains two element <start_index, end_index> with a timestamp as its index.
- It indicates the `start_index`(included) and `end_index`(excluded) of the data for `timestamp`
- It indicates the `start_index` (included) and `end_index` (excluded) of the data for `timestamp`
- meta data: cache/d41366901e25de3ec47297f12e2ba11d.meta