adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add docstring to store_backtest_stats

Browse Source
This commit is contained in:
Matthias 2020-08-18 16:15:24 +02:00
parent 4eb17b4daf
commit 668d167adc
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
freqtrade/optimize/optimize_reports.py
View File

@ -16,7 +16,13 @@ logger = logging.getLogger(__name__)
def store_backtest_stats(recordfilename: Path, stats: Dict[str, DataFrame]) -> None: def store_backtest_stats(recordfilename: Path, stats: Dict[str, DataFrame]) -> None:
"""
Stores backtest results
:param recordfilename: Path object, which can either be a filename or a directory.
Filenames will be appended with a timestamp right before the suffix
while for diectories, <directory>/backtest-result-<datetime>.json will be used as filename
:param stats: Dataframe containing the backtesting statistics
"""
if recordfilename.is_dir(): if recordfilename.is_dir():
filename = (recordfilename / filename = (recordfilename /
f'backtest-result-{datetime.now().strftime("%Y-%m-%d_%H-%M-%S")}.json') f'backtest-result-{datetime.now().strftime("%Y-%m-%d_%H-%M-%S")}.json')