Skip to content

Commit

Permalink
Add new options to tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancescMartiEscofetQC committed Jul 19, 2024
1 parent 950dda3 commit 46a88cc
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/examples/example_gridsearch.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,26 @@
"gs.results_"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"What if I run out of memory?\n",
"----------------------------\n",
"\n",
"If you're conducting an optimization task over a large grid with a substantial dataset,\n",
"it is possible that memory usage issues may arise. To try to solve these, you can minimize\n",
"memory usage by adjusting your settings.\n",
"\n",
"In that case you can set ``store_raw_results=False``, the grid search will then operate\n",
"with a generator rather than a list, significantly reducing memory usage.\n",
"\n",
"If the ``results_ DataFrame`` is what you're after, you can simply set ``store_results=True``.\n",
"However, if you aim to iterate over the {class}`~metalearners.metalearner.MetaLearner` objects,\n",
"you can set ``store_results=False``. Consequently, ``raw_results_`` will become a generator\n",
"object yielding {class}`~metalearners.grid_search.GSResult`."
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down

0 comments on commit 46a88cc

Please sign in to comment.