fix docs examples for ForwardBackwardOutput metrics access#37
Open
lokashrinav wants to merge 1 commit intothinking-machines-lab:mainfrom
Open
fix docs examples for ForwardBackwardOutput metrics access#37lokashrinav wants to merge 1 commit intothinking-machines-lab:mainfrom
lokashrinav wants to merge 1 commit intothinking-machines-lab:mainfrom
Conversation
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
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.
Summary
This updates
TrainingClientdocumentation examples to reflect the actualForwardBackwardOutputshape.ForwardBackwardOutputdoes not expose a.lossattribute. Accessingresult.lossraises anAttributeError.For built-in cross-entropy examples, loss is available under:
result.metrics["loss:sum"]For custom loss examples, metrics are user-defined, so the docs now show printing the full
result.metricsmap instead of assuming aloss:sumkey always exists.What changed
.lossusage in standard forward/forward_backward examples withmetrics["loss:sum"]result.metrics(without assumingloss:sum)Why
Running the documented examples as written currently fails with:
AttributeError: 'ForwardBackwardOutput' object has no attribute 'loss'This PR aligns the docs with the real API surface and avoids misleading assumptions in custom-loss workflows.
Reproduction