Skip to content

Commit

Permalink
Add text about reusage in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancescMartiEscofetQC committed Jul 4, 2024
1 parent 3b841e5 commit a7be0cd
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion metalearners/grid_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,15 @@ class MetaLearnerGridSearch:
Importantly, ``random_state`` must be passed through the ``random_state`` parameter
and not through ``metalearner_params``.
``base_learner_grid`` keys should be the names of all the base models contained in the :class:`~metalearners.metalearners.MetaLearner`
``base_learner_grid`` keys should be the names of the needed base models contained in the :class:`~metalearners.metalearners.MetaLearner`
defined by ``metalearner_factory``, for information about this names check
:meth:`~metalearners.metalearner.MetaLearner.nuisance_model_specifications` and
:meth:`~metalearners.metalearner.MetaLearner.treatment_model_specifications`. The
values should be sequences of model factories.
If models are reused, they should be passed through ``metalearner_params`` and they
should not be in ``base_learner_grid``.
``param_grid`` should contain the parameters grid for each type of model used by the
base learners defined in ``base_learner_grid``. The keys should be strings with the
model class name. An example for optimizing over the :class:`metalearners.DRLearner`
Expand Down

0 comments on commit a7be0cd

Please sign in to comment.