Skip to content

docs: cherry-pick model-call capture guide to r0.5.0 - #2416

Merged
ritaneves merged 3 commits into
r0.5.0from
rfneves/model-call-cap-docs-r0.5.0
Aug 10, 2026
Merged

ritaneves merged 3 commits into
r0.5.0from
rfneves/model-call-cap-docs-r0.5.0

Conversation

@ritaneves

@ritaneves ritaneves commented Aug 7, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Release-branch companion to primary PR #2415 for NVBug 6534797.

  • cherry-pick the model-call capture documentation improvements onto r0.5.0
  • apply the workflow, examples, agent-observation scope, and discoverability card to both latest and v0.5.0
  • preserve release-line-specific documentation while resolving the cherry-pick conflicts
  • explicitly identify the raw CaptureStore example as synthetic while documenting its exact persisted field shape

Validation

  • pytest -q tests/unit_tests/test_fern_docs_links.py β€” 13 tests and 15 subtests passed
  • ruff check tests/unit_tests/test_fern_docs_links.py
  • git diff --check origin/r0.5.0...HEAD

@copy-pr-bot

copy-pr-bot Bot commented Aug 7, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

ritaneves added a commit that referenced this pull request Aug 10, 2026
## Summary

- add a copy-paste model call capture workflow from environment startup
through inspecting `ng_model_call_capture`
- show representative attachment and CaptureStore JSONL output,
including gaps and the full metrics shape
- lead with the consumer workflow and move custom-agent correlation
helpers into an advanced section
- clarify that agent observations are currently emitted by the Claude
Code agent
- add model call capture to the model-server landing-page card grid
- keep the `latest` and `v0.5.0` documentation copies aligned

## Why

Addresses NVBug 6534797. The existing page described capture internals
but did not show readers how to enable capture in a real Gym run, where
to find the result, or the complete output shape.

## Validation

- `pytest -q tests/unit_tests/test_fern_docs_links.py`
- `ruff check tests/unit_tests/test_fern_docs_links.py`
- `git diff --check`

Release cherry-pick companion: #2416

---------

Signed-off-by: Rita Fernandes Neves <rfernandesne@nvidia.com>
@ritaneves
ritaneves marked this pull request as ready for review August 10, 2026 15:47
Signed-off-by: Rita Fernandes Neves <rfernandesne@nvidia.com>
Signed-off-by: Rita Fernandes Neves <rfernandesne@nvidia.com>
Signed-off-by: Rita Fernandes Neves <rfernandesne@nvidia.com>
@ritaneves
ritaneves force-pushed the rfneves/model-call-cap-docs-r0.5.0 branch from 74969c4 to 0ca3fc1 Compare August 10, 2026 15:50
@ritaneves
ritaneves merged commit f8d4318 into r0.5.0 Aug 10, 2026
45 checks passed
@ritaneves
ritaneves deleted the rfneves/model-call-cap-docs-r0.5.0 branch August 10, 2026 15:59

This branch was previously deployed

1 inactive deployment
public β€” 0ca3fc18 Deployed Aug 10, 2026 by copy-pr-bot[bot] via release / finalize / notify #1254
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