Skip to content

add "Parameters Used" section in html report #466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

add "Parameters Used" section in html report #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03f64d1
add "Parameters Used" section in html report, user can store notes or…
none2003 Aug 24, 2025
ad9f10a
Merge branch 'ranaroussi:main' into main
none2003 Sep 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions quantstats/report.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ <h3>Key Performance Metrics</h3>
<h3>Worst 10 Drawdowns</h3>
{{dd_info}}
</div>

<div id="param">
<h3>Parameters Used</h3>
{{parameters_info}}
</div>
</div>

</div>
Expand Down
7 changes: 7 additions & 0 deletions quantstats/reports.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ def html(
figfmt="svg",
template_path=None,
match_dates=True,
parameters: dict = None,
**kwargs,
):
"""
Expand Down Expand Up @@ -158,6 +159,8 @@ def html(
Path to custom HTML template file. Uses default if None
match_dates : bool, default True
Whether to align returns and benchmark start dates
parameters : dict, optional
Strategy parameters
**kwargs
Additional keyword arguments for customization:
- strategy_title: Custom name for the strategy
Expand Down Expand Up @@ -376,6 +379,10 @@ def html(
)
tpl = tpl.replace("{{dd_info}}", dd_html_table)

if parameters:
parameters_info = _pd.DataFrame(list(parameters.items()), columns=['Parameter', 'Value'])
tpl = tpl.replace("{{parameters_info}}", _html_table(parameters_info, False))

# Get active returns setting for plots
active = kwargs.get("active_returns", False)

Expand Down