Skip to content

Commit 2127b26

Browse files
committed
DOC: Add TODO (lower-triangular) to lib.plot_heatmaps()
1 parent e896573 commit 2127b26

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

backtesting/lib.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,13 @@ def plot_heatmaps(heatmap: pd.Series,
129129
aggregated by 'max' function by default. This can be tweaked
130130
with `agg` parameter, which accepts any argument pandas knows
131131
how to aggregate by.
132+
133+
.. todo::
134+
Lay heatmaps out lower-triangular instead of in a simple grid.
135+
Like [`skopt.plots.plot_objective()`][plot_objective] does.
136+
137+
[plot_objective]: \
138+
https://scikit-optimize.github.io/stable/modules/plots.html#plot-objective
132139
"""
133140
return _plot_heatmaps(heatmap, agg, ncols, filename, plot_width, open_browser)
134141

0 commit comments

Comments
 (0)