From 46a88ccc74605bfe4a981a0ff7b57c04f4ae5bb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francesc=20Mart=C3=AD=20Escofet?= Date: Fri, 19 Jul 2024 09:11:01 +0200 Subject: [PATCH] Add new options to tutorial --- docs/examples/example_gridsearch.ipynb | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/examples/example_gridsearch.ipynb b/docs/examples/example_gridsearch.ipynb index 586c5d0..ada0a00 100644 --- a/docs/examples/example_gridsearch.ipynb +++ b/docs/examples/example_gridsearch.ipynb @@ -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": {},