Repository navigation
docs: add inference providers page and improve configure model index - #1289
Merged
lbliii merged 8 commits intoJun 16, 2026
Merged
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
cwing-nvidia
force-pushed
the
cwing/docs-inference-providers
branch
from
May 11, 2026 01:56
518ba89 to
fb8a7bf
Compare
6 tasks
- Add inference-providers.mdx with setup, usage example, config reference - Rewrite model-server/index.mdx: rename to Configure Model, simplify intro, add training badge to vLLM card, remove implementation details Signed-off-by: Chris Wing <cwing@nvidia.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Signed-off-by: Chris Wing <cwing@nvidia.com>
cwing-nvidia
force-pushed
the
cwing/docs-inference-providers
branch
from
June 1, 2026 06:07
fb8a7bf to
71bc397
Compare
Use env.yaml only for secrets (no CLI override tab), move configuration reference above the usage example, and drop the redundant reasoning section. Signed-off-by: Chris Wing <cwing@nvidia.com>
cwing-nvidia
marked this pull request as ready for review
June 1, 2026 06:25
cwing-nvidia
changed the title
Signed-off-by: Chris Wing <cwing@nvidia.com>
Brings the docs branch up to date with the restructured Fern docs on the updated base. Conflict resolution: - latest.yml: keep the GA-alias symlink (-> v0.3.0.yml); move the nav title change into the editable trunk nav. - main.yml: rename the model-server nav title to "Configure Model". - model-server/index.mdx: keep the rewritten page (adds Inference Providers card) and apply main's cross-page link de-prefixing (/latest/... -> /...). - inference-providers.mdx: de-prefix the vLLM link to match. Signed-off-by: Chris Wing <cwing@nvidia.com>
marta-sd
reviewed
Jun 10, 2026
marta-sd
left a comment
marta-sd
left a comment
Contributor
There was a problem hiding this comment.
Thanks @cwing-nvidia , I added one small comment
|
|
||
| | Parameter | Type | Default | Description | | ||
| |-----------|------|---------|-------------| | ||
| | `base_url` | `str` | — | **Required.** Provider's OpenAI-compatible API base URL. | |
Contributor
There was a problem hiding this comment.
Could you please add a short note why in the env.yaml the keys have policy prefixes while in this table they don't? It might be confusing for the users.
Contributor
There was a problem hiding this comment.
Good call — added a short note above the Configuration Reference table (commit b964230) explaining that the policy_* keys in env.yaml are NeMo Gym's shared credential variables and that each provider config maps them onto the server fields: policy_base_url → base_url, policy_api_key → api_key, policy_model_name → model.
Contributor
Author
There was a problem hiding this comment.
Removed the inline note; the policy_ prefix confusion is a repo-wide convention issue, now tracked in #1658
Add dedicated pages for the OpenAI and Azure OpenAI model servers, link them from the model-server index, and clarify the inference-providers page (supported APIs, fixed-model behavior). Reorder page positions to fit the new pages. Signed-off-by: Chris Wing <cwing@nvidia.com>
2 tasks
… (#1624) ## Summary Stacked on top of #1289. Applies an NVIDIA technical-writing style-guide sweep (`::r` / `doc-style-guide`) to the model-server pages that PR adds or updates. ### Fixes (8) | File | Fix | |------|-----| | `index.mdx` | `e.g.` → `for example`; `via` → `through` (cloud API card) | | `inference-providers.mdx` | `don't` → `do not`; `isn't` → `is not`; added introductory comma in usage example | | `azure-openai.mdx` | `don't` → `do not`; `e.g.` → `for example` (config table) | | `openai.mdx` | `it's`/`that's` → `it is`/`that is`; `don't` → `do not`; `e.g.` → `for example` (config table) | Two categories: **Latinisms** (`e.g.`) and **contractions**, both disallowed by NVIDIA technical style. No semantic changes. ### Not changed (intentional) - Spaced em dashes — consistent house style across the pages; left as-is. - `RL` left unexpanded — minor, deferred. ## Test plan - [ ] `fern docs dev` renders all four pages - [ ] No broken links / component regressions 🤖 Generated with [Claude Code](https://claude.com/claude-code) Signed-off-by: Lawrence Lane <llane@nvidia.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
🌿 Preview your docs: https://nvidia-preview-cwing-docs-inference-providers.docs.buildwithfern.com/nemo/gym Here are the markdown pages you've updated: |
lbliii
approved these changes
Jun 16, 2026
…1289 review) Address review feedback: clarify why env.yaml keys use the policy_ prefix while the Configuration Reference table fields do not. The policy_* keys are NeMo Gym's shared credential variables; each provider config interpolates them onto the server's own fields (policy_base_url -> base_url, policy_api_key -> api_key, policy_model_name -> model). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Lawrence Lane <llane@nvidia.com>
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
inference-providers.mdx— docs page for theinference_providerserver covering setup, config reference, usage examplemodel-server/index.mdx— rename to "Configure Model", simplify intro to focus on Responses API middleware story, add cloud/self-hosted/training badges, remove implementation detailsNotes
mcqaenvironment chosen in the updated quickstart (docs: improve getting started #1283)inference_providerserver code and provider configs)Test plan
fern docs dev— verify both pages render correctly