Skip to content

Commit

Permalink
Add explanation grid_size_
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancescMartiEscofetQC committed Jul 22, 2024
1 parent 273b864 commit 1590e94
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions metalearners/grid_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,10 @@ class MetaLearnerGridSearch:
fitting each one and just store one.
``grid_size_`` will contain the number of hyperparameter combinations after fitting.
This attribute may be useful in the case ``store_raw_results = False`` and ``store_results = False``.
In that case, the generator object returned in ``raw_results_`` doesn't trigger the fitting
of individual metalearners until explicitly requested, e.g. in a loop. This attribute
can be use to track the progress, for instance, by creating a progress bar or a similar utility.
For an illustration see :ref:`our example on Tuning hyperparameters of a MetaLearner with MetaLearnerGridSearch <example-grid-search>`.
"""
Expand Down

0 comments on commit 1590e94

Please sign in to comment.