feat: add "--notes" to backtest command

closes #11847
This commit is contained in:
Matthias
2025-06-08 12:42:26 +02:00
parent b874ceaf2f
commit e0f147e076
5 changed files with 15 additions and 1 deletions

View File

@@ -57,6 +57,7 @@ ARGS_BACKTEST = [
"backtest_breakdown",
"backtest_cache",
"freqai_backtest_live_models",
"backtest_notes",
]
ARGS_HYPEROPT = [

View File

@@ -204,6 +204,11 @@ AVAILABLE_CLI_OPTIONS = {
help="Export backtest results (default: trades).",
choices=constants.EXPORT_OPTIONS,
),
"backtest_notes": Arg(
"--notes",
help="Add notes to the backtest results.",
metavar="TEXT",
),
"exportfilename": Arg(
"--export-filename",
"--backtest-filename",

View File

@@ -310,6 +310,7 @@ class Configuration:
("backtest_cache", "Parameter --cache={} detected ..."),
("disableparamexport", "Parameter --disableparamexport detected: {} ..."),
("freqai_backtest_live_models", "Parameter --freqai-backtest-live-models detected ..."),
("backtest_notes", "Parameter --notes detected: {} ..."),
]
self._args_to_config_loop(config, configurations)

View File

@@ -1822,7 +1822,11 @@ class Backtesting:
# Update old results with new ones.
if len(self.all_bt_content) > 0:
results = generate_backtest_stats(
data, self.all_bt_content, min_date=min_date, max_date=max_date
data,
self.all_bt_content,
min_date=min_date,
max_date=max_date,
notes=self.config.get("backtest_notes"),
)
if self.results:
self.results["metadata"].update(results["metadata"])

View File

@@ -669,6 +669,7 @@ def generate_backtest_stats(
all_results: dict[str, BacktestContentType],
min_date: datetime,
max_date: datetime,
notes: str | None = None,
) -> BacktestResultType:
"""
:param btdata: Backtest data
@@ -694,6 +695,8 @@ def generate_backtest_stats(
"backtest_start_ts": int(min_date.timestamp()),
"backtest_end_ts": int(max_date.timestamp()),
}
if notes:
metadata[strategy]["notes"] = notes
result["strategy"][strategy] = strat_stats
strategy_results = generate_strategy_comparison(bt_stats=result["strategy"])