Skip to content

docs: clarify Python SDK output and credentials - #111

Merged
rapids-bot[bot] merged 2 commits into
mainfrom
docs/clarify-python-sdk-output
Jul 24, 2026
Merged

docs: clarify Python SDK output and credentials#111
rapids-bot[bot] merged 2 commits into
mainfrom
docs/clarify-python-sdk-output

Conversation

@zhongxuanwang-nv

@zhongxuanwang-nv zhongxuanwang-nv commented Jul 24, 2026

Copy link
Copy Markdown
Member

Overview

Clarify the Python SDK examples so users export the required NVIDIA-hosted
model credential and print the adapter response instead of the RunOutput
object identity.

This issue predates #103; that PR changes links in docs/sdk/python.mdx but
does not change the affected credential or output examples. This PR therefore
targets main directly.

Details

  • Add the required NVIDIA_API_KEY export before the first Hermes example.
  • Print result.output.response in both affected examples.
  • Breaking changes: none.

Validation

  • just docs (passed; the unauthenticated Fern redirects check was skipped)
  • uv run --no-sync pre-commit run --files docs/sdk/python.mdx
  • git diff --check

Where 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 #103

  • I 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

  • Documentation
    • Updated the Python SDK “Start With One Run” example to instruct exporting NVIDIA_API_KEY before running.
    • Adjusted output display in both “Start With One Run” and “Single-Invocation Runs” to print only result.output.response (instead of the full output).

Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The Python SDK guide adds instructions to export NVIDIA_API_KEY and updates two examples to print result.output.response instead of the full output object.

Changes

Python SDK documentation

Layer / File(s) Summary
Credential setup and response output
docs/sdk/python.mdx
Adds NVIDIA_API_KEY export instructions and narrows output printing in the “Start With One Run” and “Single-Invocation Runs” examples.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title uses a valid Conventional Commits docs prefix and accurately summarizes the Python SDK documentation changes.
Description check ✅ Passed The description includes the required Overview, reviewer start point, related issue, and confirmation checkboxes, with enough implementation detail.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/clarify-python-sdk-output

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
@zhongxuanwang-nv
zhongxuanwang-nv marked this pull request as ready for review July 24, 2026 00:16
@zhongxuanwang-nv
zhongxuanwang-nv requested review from a team as code owners July 24, 2026 00:16
@zhongxuanwang-nv zhongxuanwang-nv self-assigned this Jul 24, 2026
@AnuradhaKaruppiah

Copy link
Copy Markdown
Collaborator

/merge

@rapids-bot
rapids-bot Bot merged commit e6cd337 into main Jul 24, 2026
35 of 36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants