Add FAQ section about OOM. #1385
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Thank you for your PR. I have two comments.
-
How about adding a keyword
OOMto this section? It can be seen in the titles of existing issues, and I think it improves searchability. But, not a strong opinion.
https://github.com/optuna/optuna/search?q=oom&type=Issues -
Do we mention the
ChainerMNStudy? It has nogc_after_trialorcallbacks, and we need to callgc.collect()in objective functions. On the other hand, it may be too specific to most of the users.
|
Thanks for your feedback, I addressed both your points. PTAL. |
toshihikoyanase
approved these changes
Jun 22, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Follow-up to #1380.
Now that we don't do any GC collection sweep by default, OOM might become an issue for certain users (as described in tickets that can be tracked from the above PR). A section in the FAQ might alleviate some of the problem.
Description of the changes
Introduces a section in the FAQ about OOM, and adds a reference to it from the API reference for
gc_after_trial.