docs(_debug): document debug_args training setting#829
Merged
Conversation
gabrielfruet
force-pushed
the
gabriel-trn-2255-implement-debugunderflowoverflow-from-huggingface
branch
from
June 30, 2026 17:31
e20e8aa to
e18239b
Compare
Base automatically changed from
gabriel-trn-2255-implement-debugunderflowoverflow-from-huggingface
to
main
July 1, 2026 12:39
…gs kwarg
Adds:
- Field(description=...) on all 4 DebugUnderflowOverflowArgs fields (enabled, max_frames_to_save, trace_batch_nums, abort_after_batch_num).
- debug_args entry in all 7 train_* docstrings (image_classification, image_classification_multihead, instance_segmentation, object_detection, panoptic_segmentation, semantic_segmentation, semantic_segmentation_multihead). Notes incompatibility with torch_compile_args={'disable': False}.
- Top-table row + new 'Debug' section in docs/source/settings/train_settings.md with sub-table documenting underflow_overflow.* (enabled, max_frames_to_save, trace_batch_nums, abort_after_batch_num) and a {warning} about the torch.compile conflict.
gabrielfruet
force-pushed
the
gabriel-trn-2255-document-debug-args
branch
from
July 3, 2026 17:39
e305a82 to
a12ab6f
Compare
Contributor
Author
|
/review |
yutong-xiang-97
approved these changes
Jul 7, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Follow-up to #814.
Adds the reference docs for the new
debug_argstraining setting:docs/source/settings/train_settings.md, with a note about thetorch_compile_args={"disable": False}conflict.The
Field(description=...)entries onDebugUnderflowOverflowArgsand thedebug_args:kwarg docstring entries on thetrain_*()functions live in PR #814 alongside the code.