docs: clarify Python SDK output and credentials - #111
Merged
Conversation
Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
WalkthroughThe Python SDK guide adds instructions to export ChangesPython SDK documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
|
Fern docs preview: https://nvidia-preview-pull-request-111.docs.buildwithfern.com/nemo/fabric |
Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
AnuradhaKaruppiah
approved these changes
Jul 24, 2026
Collaborator
|
/merge |
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.
Overview
Clarify the Python SDK examples so users export the required NVIDIA-hosted
model credential and print the adapter response instead of the
RunOutputobject identity.
This issue predates #103; that PR changes links in
docs/sdk/python.mdxbutdoes not change the affected credential or output examples. This PR therefore
targets
maindirectly.Details
NVIDIA_API_KEYexport before the first Hermes example.result.output.responsein both affected examples.Validation
just docs(passed; the unauthenticated Fern redirects check was skipped)uv run --no-sync pre-commit run --files docs/sdk/python.mdxgit diff --checkWhere should the reviewer start?
Start with
docs/sdk/python.mdx, under Start With One Run.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Relates to docs: Reafactor the
README.md#103I confirm this contribution is my own work, or I have the right to submit it under this project's license.
I searched existing issues and open pull requests, and this does not duplicate existing work.
Summary by CodeRabbit
NVIDIA_API_KEYbefore running.result.output.response(instead of the full output).