Help users understand why they are running out of GPU memory.
Approach
Add a try-catch block around the first probably OutOfMemoryError and suggest increasing the number of batches which is the primary way to avoid running out of memory.
No tests needed because it's just documentation.
Pre-Merge Checklists
Submitter
[x] Write a helpfully descriptive pull request title.
[x] Organize changes into logically grouped commits with descriptive commit messages.
[x] Document all new functions.
[ ] Click 'details' on the readthedocs check to view the updated docs.
[x] Write tests for new functions or explain why they are not needed.
[x] Address any complaints from pep8speaks.
Reviewer
[ ] Actually read all of the code.
[ ] Run the new code yourself; the included tests should make this easy.
[ ] Write a summary of the changes as you understand them.
Purpose
Help users understand why they are running out of GPU memory.
Approach
Add a try-catch block around the first probably OutOfMemoryError and suggest increasing the number of batches which is the primary way to avoid running out of memory.
No tests needed because it's just documentation.
Pre-Merge Checklists
Submitter
Reviewer