mirror of
https://github.com/microsoft/qlib.git
synced 2026-07-14 00:06:58 +08:00
add more doc to PortAnaRecord
This commit is contained in:
@@ -213,6 +213,11 @@ class SigAnaRecord(SignalRecord):
|
|||||||
class PortAnaRecord(SignalRecord):
|
class PortAnaRecord(SignalRecord):
|
||||||
"""
|
"""
|
||||||
This is the Portfolio Analysis Record class that generates the analysis results such as those of backtest. This class inherits the ``RecordTemp`` class.
|
This is the Portfolio Analysis Record class that generates the analysis results such as those of backtest. This class inherits the ``RecordTemp`` class.
|
||||||
|
|
||||||
|
The following files will be stored in recorder
|
||||||
|
- report_normal.pkl & positions_normal.pkl:
|
||||||
|
- The return report and detailed positions of the backtest, returned by `qlib/contrib/evaluate.py:backtest`
|
||||||
|
- port_analysis.pkl : The risk analysis of your portfolio, returned by `qlib/contrib/evaluate.py:risk_analysis`
|
||||||
"""
|
"""
|
||||||
|
|
||||||
artifact_path = "portfolio_analysis"
|
artifact_path = "portfolio_analysis"
|
||||||
|
|||||||
Reference in New Issue
Block a user