QuantStats · quantstats.reports

QuantStats报告生成:7种 tearsheet 与 HTML 绩效报告

quantstats.reports 可生成 7 种报告 tearsheet,从基础指标、基础绘图到完整 HTML 报告。qs.reports.html(stock, benchmark) 一键把指标与图打包成 HTML 文件,适合汇报与存档。

metrics
plots
basic
full/html

QuantStats reports 报告类型示意;基于官方 README,非实际报告截图。

Report types

7 种报告 tearsheet 对照表

官方 README 提供 metrics / plots / basic / full / html 五个入口,其中 metrics 与 plots 各含 basic / full 两档,展开为 7 种输出形态。

报告方法内容适用场景输出形态
基础指标qs.reports.metrics(mode='basic')核心收益/风险指标子集快速扫一眼关键指标指标表(精简)
完整指标qs.reports.metrics(mode='full')全量绩效与风险指标深度指标审查/审计指标表(完整)
基础绘图qs.reports.plots(mode='basic')核心绩效图(净值/回撤等)快速看图图表(精简)
完整绘图qs.reports.plots(mode='full')全量绩效图(含滚动/分布等)全面可视化分析图表(完整)
基础报告qs.reports.basic()基础指标 + 基础绘图日常快速复盘指标 + 图(精简组合)
完整报告qs.reports.full()完整指标 + 完整绘图全面绩效评估指标 + 图(完整组合)
HTML 报告qs.reports.html(stock, benchmark)完整 HTML tearsheet 文件汇报/存档/分享HTML 文件
Steps

生成 HTML 报告分步流程

1. 导入库:import quantstats as qs,确保已按安装页装好依赖。

2. 取收益序列:stock = qs.utils.download_returns('META'),返回一个 pandas Series 日收益序列(也可传入自备的收益序列)。

3. 生成 HTML 报告:qs.reports.html(stock, 'SPY'),benchmark 可为 ticker 字符串或 pandas Series。

4. 查看输出:默认生成一份 HTML tearsheet 文件,浏览器打开即可看到指标总览、净值曲线、回撤与基准对比等区块。

What's inside

一份完整 HTML tearsheet 通常包含哪些区块

以下为 QuantStats 报告常见的内容组成,具体区块与顺序以官方生成的报告为准。

区块说明来源方法
指标总览夏普/索提诺/最大回撤/波动率等关键指标一览stats 模块
净值曲线策略(与基准)的累计净值走势plots.returns / snapshot
回撤图历史回撤区间与最大回撤位置plots.drawdown / drawdowns_periods
月度收益逐月收益热力或表格plots.monthly_heatmap / stats.monthly_returns
滚动指标滚动夏普/波动率,观察绩效稳定性plots.rolling_sharpe / rolling_volatility
基准对比策略与基准的相对表现(需传 benchmark)benchmark 参数 / information_ratio
Benchmark

报告中的基准对比

qs.reports.html 的第二个参数 benchmark 可传入基准 ticker(如 'SPY')或 pandas Series。传入后,报告会同时展示策略与基准的净值曲线、回撤与相对绩效,是衡量「跑赢大盘」的关键一步。详细见基准对比页
Save & share

保存与分享

1. 控制输出路径:通过 savefig 或相关参数指定报告/图表的保存路径与文件名(具体参数名以官方实现为准)。

2. TeX 输出:官方 README 提及 HTML 与 TeX 两类报告相关能力,如需 LaTeX 嵌入可用对应入口(以官方文档为准)。

3. 分享:HTML 报告为自包含文件,可直接发给团队或在浏览器打印为 PDF 存档。

注意:savefig 等参数名、TeX 输出的确切用法会随版本变化,请以官方 README / 仓库文档为准,不要在未核验时写死参数。
Scenarios

适用场景

策略复盘

回测结束后用 qs.reports.html 一键产出完整绩效报告,把指标、净值、回撤、基准对比集中在一页,快速定位策略的收益来源与风险暴露。

组合汇报

向客户或团队汇报组合绩效时,直接给出一份带基准对比的 HTML 报告,比散落的数字表格更直观、更易留存。

存档审计

把绩效指标与图表打包成自包含 HTML 文件存档,便于事后追溯某段时间的策略表现与当时的基准对比。

FAQ

常见问题

HTML 报告怎么保存?

qs.reports.html 会生成 HTML tearsheet 文件,可用 savefig 等参数控制输出路径;确切参数名以官方 README / 仓库文档为准。若需 PDF,可在浏览器打开后打印为 PDF。

benchmark 参数必填吗?

不必。传入基准 ticker(如 'SPY')或 pandas Series 时报告含基准对比,不传则仅展示策略自身绩效,具体以官方实现为准。

能导出 PDF 吗?

官方 README 提及 HTML 与 TeX 相关能力;PDF 通常需自行转换(如浏览器打印 HTML),没有直接 PDF 出口的公开说明,以官方文档为准。

报告结果能直接用于实盘吗?

不能。报告仅代表历史收益序列表现,不构成收益保证或投资建议;实盘需自行核验数据、成本与风险。

QuantStats 报告和 EasyClaw 有什么不同?

QuantStats 生成的是自包含 HTML/TeX 绩效报告(tearsheet);EasyClaw 内置的量化研究 Skill 输出自然语言结论与图表,无对应的 HTML tearsheet 生成技能。两者无已证实集成,是独立路线。

先看基准对比,再出完整报告

了解 benchmark 参数与相对绩效指标,让报告更有说服力。