Skip to content

Commit

Permalink
Fix pit docs format (microsoft#957)
Browse files Browse the repository at this point in the history
* Fix pit docs list format

* Fix pit docs format
  • Loading branch information
Chaoyingz authored Mar 11, 2022
1 parent faa99f3 commit 058f976
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/advanced/PIT.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ Qlib provides a file-based storage for PIT data.
For each feature, it contains 4 columns, i.e. date, period, value, _next.
Each row corresponds to a statement.

The meaning of each feature with filename like `XXX_a.data`
The meaning of each feature with filename like `XXX_a.data`:

- `date`: the statement's date of publication.
- `period`: the period of the statement. (e.g. it will be quarterly frequency in most of the markets)
- If it is an annual period, it will be an integer corresponding to the year
Expand Down Expand Up @@ -127,7 +128,8 @@ The statements are soted by the `date` in ascending order from the beginning of
Known limitations
Known limitations:

- Currently, the PIT database is designed for quarterly or annually factors, which can handle fundamental data of financial reports in most markets.
Qlib leverage the file name to identify the type of the data. File with name like `XXX_q.data` corresponds to quarterly data. File with name like `XXX_a.data` corresponds to annual data
- Qlib leverage the file name to identify the type of the data. File with name like `XXX_q.data` corresponds to quarterly data. File with name like `XXX_a.data` corresponds to annual data.
- The caclulation of PIT is not performed in the optimal way. There is great potential to boost the performance of PIT data calcuation.

0 comments on commit 058f976

Please sign in to comment.