diff --git a/docs/fern/versions/latest.yml b/docs/fern/versions/latest.yml index 5338d7a8ba..72a1750d2a 100644 --- a/docs/fern/versions/latest.yml +++ b/docs/fern/versions/latest.yml @@ -7,8 +7,9 @@ navigation: - page: Home path: ../../index.mdx - section: Get Started - path: ../../get-started/setup.mdx contents: + - page: Setup + path: ../../get-started/setup.mdx - section: Core Concepts path: ../../get-started/concepts/index.mdx contents: @@ -29,145 +30,96 @@ navigation: - page: Example Agent hidden: true path: ../../get-started/example-agent.mdx - - section: Self-Managed Deployment - slug: self-managed-deployment + - section: Models and Inference + path: ../../run-inference/about.mdx contents: - - section: Setup - slug: setup - path: ../../set-up/index.mdx - contents: - - section: Helm - slug: helm - path: ../../set-up/helm/index.mdx - contents: - - page: Prerequisites - path: ../../set-up/helm/prerequisites.mdx - - page: Install - path: ../../set-up/helm/install.mdx - - page: NetworkPolicy Smoke Test - path: ../../set-up/helm/network-policy-smoke-test.mdx - - page: Database Setup - path: ../../set-up/helm/database-setup.mdx - - page: Persistent Volumes - path: ../../set-up/helm/persistent-volumes.mdx - - page: File Storage - path: ../../set-up/helm/file-storage.mdx - - page: Ingress - path: ../../set-up/helm/ingress.mdx - - page: Multinode Networking - path: ../../set-up/helm/multinode-networking.mdx - - page: Volcano - path: ../../set-up/helm/volcano.mdx - - page: OpenSandbox - path: ../../set-up/helm/opensandbox.mdx - - page: OpenSandbox with Kata - slug: opensandbox-kata - path: ../../set-up/helm/opensandbox-kata.mdx - - page: OpenShift - slug: openshift - path: ../../set-up/helm/openshift.mdx - - page: Backup and Restore - path: ../../set-up/helm/backup-and-restore.mdx - - page: Jobs - slug: jobs - path: ../../set-up/manage-jobs.mdx - - page: Milvus - path: ../../set-up/milvus.mdx - - page: Observability - slug: observability - path: ../../set-up/opentelemetry.mdx - - page: Security - path: ../../set-up/security.mdx - - section: Helm - slug: helm - contents: - - page: Helm Reference - slug: helm-reference - path: ../../helm/index.mdx - - page: Config Reference - slug: config-reference - path: ../../set-up/config-reference.mdx - - section: Access Control - slug: access-control - path: ../../auth/index.mdx + - page: Run Inference + path: ../../run-inference/tutorials/run-inference.mdx + - page: Deploy Models + path: ../../run-inference/tutorials/deploy-models.mdx + - section: Agents + path: ../../agents/index.mdx contents: - - page: Overview - path: ../../auth/index.mdx - - page: Concepts - path: ../../auth/concepts.mdx - - section: Authentication - slug: authentication - path: ../../auth/authentication/index.mdx - contents: - - page: OIDC Setup - path: ../../auth/authentication/oidc.mdx - - page: Using Authentication - path: ../../auth/authentication/using-authentication.mdx - - section: Providers - slug: providers - path: ../../auth/authentication/providers/index.mdx - contents: - - page: Azure AD (Entra ID) - path: ../../auth/authentication/providers/azure-ad.mdx - - page: Generic OIDC - path: ../../auth/authentication/providers/generic.mdx - - section: Authorization - slug: authorization - path: ../../auth/authorization/index.mdx - contents: - - page: API Scopes - path: ../../auth/authorization/api-scopes.mdx - - page: Managing Access - path: ../../auth/authorization/managing-access.mdx - - page: Permissions Reference - path: ../../auth/authorization/permissions-reference.mdx - - page: Plugin Authorization - path: ../../auth/authorization/plugin-authorization.mdx - - page: Policy Engine - path: ../../auth/authorization/policy-engine.mdx - - page: Roles and Permissions - path: ../../auth/authorization/roles-and-permissions.mdx - - section: Deployment - slug: deployment - path: ../../auth/deployment/configuration.mdx + - page: Deploy Agents + path: ../../agents/deploy-agents.mdx + - page: Observe Agents + path: ../../agents/observability.mdx + - section: Optimize Agents contents: - - page: Configuration - path: ../../auth/deployment/configuration.mdx - - page: Credential Propagation - path: ../../auth/deployment/credential-propagation.mdx - - page: Gateway Integration - path: ../../auth/deployment/gateway.mdx - - page: Production Hardening - path: ../../auth/deployment/hardening.mdx - - page: Security Model - path: ../../auth/security-model.mdx - - page: Troubleshooting - path: ../../auth/troubleshooting.mdx - - section: Studio - path: ../../studio/index.mdx - contents: - - page: Agents - path: ../../studio/agents.mdx - - page: Data Designer - path: ../../studio/data-designer-build.mdx - - page: Monitor - path: ../../studio/monitor.mdx - - page: Plugin UIs - path: ../../studio/plugins.mdx - - page: Guardrail Configs - path: ../../studio/guardrails.mdx - - page: Virtual Models - path: ../../studio/virtual-models.mdx - - section: Models and Inference - path: ../../run-inference/about.mdx + - page: Run the Agent Optimizer + path: ../../agents/optimization.mdx + - page: Insight-Driven Optimization + path: ../../agents/insight-driven-optimization.mdx + - page: Secure Agents + path: ../../agents/security.mdx + - page: Plugins and Skills + path: ../../agents/plugins.mdx + - section: Evaluate Agents & Models + slug: evaluate-models + path: ../../evaluator/index.mdx contents: + - page: Dataset-Driven vs Task-Driven Evaluation + slug: dataset-driven-vs-task-driven-evaluation + path: ../../evaluator/evaluation-approaches.mdx + - section: Agent Evaluation + slug: agent-eval + path: ../../evaluator/agent-eval/index.mdx + contents: + - page: Quickstart + slug: quickstart + path: ../../evaluator/agent-eval/quickstart.mdx + - page: Evaluate a Deployed Agent over HTTP + slug: evaluate-deployed-agent + path: ../../evaluator/agent-eval/evaluate-deployed-agent.mdx + - page: Evaluate a Harbor Task Suite + slug: harbor-runner + path: ../../evaluator/agent-eval/harbor-runner.mdx + - page: Score by Component + slug: score-by-component + path: ../../evaluator/agent-eval/score-by-component.mdx + - page: Targets and Runners + slug: targets-and-runners + path: ../../evaluator/agent-eval/targets-and-runners.mdx + - page: Writing Metrics + slug: writing-metrics + path: ../../evaluator/agent-eval/writing-metrics.mdx + - page: Reading Results + slug: reading-results + path: ../../evaluator/agent-eval/reading-results.mdx - section: Tutorials - path: ../../run-inference/tutorials/index.mdx + path: ../../evaluator/tutorials/index.mdx contents: - - page: Run Inference - path: ../../run-inference/tutorials/run-inference.mdx - - page: Deploy Models - path: ../../run-inference/tutorials/deploy-models.mdx + - page: Run LLM-as-a-Judge Evaluation + path: ../../evaluator/tutorials/run-llm-judge-evaluation.mdx + - page: Define and Run Custom Python Metrics + path: ../../evaluator/tutorials/define-run-custom-python-metrics.mdx + - page: Experiments + slug: experiments + path: ../../evaluator/experiments.mdx + - page: SDK Resources + path: ../../evaluator/sdk-resources.mdx + - page: Manage Tasks & Tasksets + slug: manage-tasks-tasksets + path: ../../evaluator/manage-tasks-tasksets.mdx + - section: Metrics + path: ../../evaluator/metrics/index.mdx + contents: + - page: Manage Metrics + path: ../../evaluator/metrics/manage-metrics.mdx + - page: LLM-as-a-Judge + path: ../../evaluator/metrics/llm-as-a-judge.mdx + - page: RAG Metrics + path: ../../evaluator/metrics/rag.mdx + - page: Similarity Metrics + path: ../../evaluator/metrics/similarity.mdx + - page: Agentic Metrics + path: ../../evaluator/metrics/agentic.mdx + - page: Bring Your Own Metric + path: ../../evaluator/metrics/remote.mdx + - page: Agent Configuration + path: ../../evaluator/metrics/agent-configuration.mdx + - page: Model Configuration + path: ../../evaluator/metrics/model-configuration.mdx - section: Fine-tune Models slug: customizer-reference path: ../../customizer/index.mdx @@ -276,23 +228,6 @@ navigation: - page: Optimize Throughput path: ../../customizer/tutorials/optimize-throughput.mdx slug: optimize-throughput - - section: Agents - path: ../../agents/index.mdx - contents: - - page: Deploy Agents - path: ../../agents/deploy-agents.mdx - - page: Observe Agents - path: ../../agents/observability.mdx - - section: Optimize Agents - contents: - - page: Run the Agent Optimizer - path: ../../agents/optimization.mdx - - page: Insight-Driven Optimization - path: ../../agents/insight-driven-optimization.mdx - - page: Secure Agents - path: ../../agents/security.mdx - - page: Plugins and Skills - path: ../../agents/plugins.mdx - section: Design Synthetic Data path: ../../data-designer/index.mdx contents: @@ -386,72 +321,6 @@ navigation: path: ../../guardrails/terminology.mdx - page: Observability path: ../../guardrails/observability.mdx - - section: Evaluate Models & Agents - slug: evaluate-models - path: ../../evaluator/index.mdx - contents: - - page: Dataset-Driven vs Task-Driven Evaluation - slug: dataset-driven-vs-task-driven-evaluation - path: ../../evaluator/evaluation-approaches.mdx - - section: Agent Evaluation - slug: agent-eval - path: ../../evaluator/agent-eval/index.mdx - contents: - - page: Quickstart - slug: quickstart - path: ../../evaluator/agent-eval/quickstart.mdx - - page: Evaluate a Deployed Agent over HTTP - slug: evaluate-deployed-agent - path: ../../evaluator/agent-eval/evaluate-deployed-agent.mdx - - page: Evaluate a Harbor Task Suite - slug: harbor-runner - path: ../../evaluator/agent-eval/harbor-runner.mdx - - page: Score by Component - slug: score-by-component - path: ../../evaluator/agent-eval/score-by-component.mdx - - page: Targets and Runners - slug: targets-and-runners - path: ../../evaluator/agent-eval/targets-and-runners.mdx - - page: Writing Metrics - slug: writing-metrics - path: ../../evaluator/agent-eval/writing-metrics.mdx - - page: Reading Results - slug: reading-results - path: ../../evaluator/agent-eval/reading-results.mdx - - section: Tutorials - path: ../../evaluator/tutorials/index.mdx - contents: - - page: Run LLM-as-a-Judge Evaluation - path: ../../evaluator/tutorials/run-llm-judge-evaluation.mdx - - page: Define and Run Custom Python Metrics - path: ../../evaluator/tutorials/define-run-custom-python-metrics.mdx - - page: Experiments - slug: experiments - path: ../../evaluator/experiments.mdx - - page: SDK Resources - path: ../../evaluator/sdk-resources.mdx - - page: Manage Tasks & Tasksets - slug: manage-tasks-tasksets - path: ../../evaluator/manage-tasks-tasksets.mdx - - section: Metrics - path: ../../evaluator/metrics/index.mdx - contents: - - page: Manage Metrics - path: ../../evaluator/metrics/manage-metrics.mdx - - page: LLM-as-a-Judge - path: ../../evaluator/metrics/llm-as-a-judge.mdx - - page: RAG Metrics - path: ../../evaluator/metrics/rag.mdx - - page: Similarity Metrics - path: ../../evaluator/metrics/similarity.mdx - - page: Agentic Metrics - path: ../../evaluator/metrics/agentic.mdx - - page: Bring Your Own Metric - path: ../../evaluator/metrics/remote.mdx - - page: Agent Configuration - path: ../../evaluator/metrics/agent-configuration.mdx - - page: Model Configuration - path: ../../evaluator/metrics/model-configuration.mdx - section: Vulnerability Scanning path: ../../auditor/index.mdx contents: @@ -476,6 +345,135 @@ navigation: path: ../../auditor/targets/inference-gateway.mdx - page: Schema path: ../../auditor/targets/schema.mdx + - section: Studio + path: ../../studio/index.mdx + contents: + - page: Agents + path: ../../studio/agents.mdx + - page: Data Designer + path: ../../studio/data-designer-build.mdx + - page: Monitor + path: ../../studio/monitor.mdx + - page: Plugin UIs + path: ../../studio/plugins.mdx + - page: Guardrail Configs + path: ../../studio/guardrails.mdx + - page: Virtual Models + path: ../../studio/virtual-models.mdx + - section: Kubernetes Deployment + slug: kubernetes-deployment + contents: + - section: Setup + slug: setup + path: ../../set-up/index.mdx + contents: + - section: Helm + slug: helm + path: ../../set-up/helm/index.mdx + contents: + - page: Prerequisites + path: ../../set-up/helm/prerequisites.mdx + - page: Install + path: ../../set-up/helm/install.mdx + - page: NetworkPolicy Smoke Test + path: ../../set-up/helm/network-policy-smoke-test.mdx + - page: Database Setup + path: ../../set-up/helm/database-setup.mdx + - page: Persistent Volumes + path: ../../set-up/helm/persistent-volumes.mdx + - page: File Storage + path: ../../set-up/helm/file-storage.mdx + - page: Ingress + path: ../../set-up/helm/ingress.mdx + - page: Multinode Networking + path: ../../set-up/helm/multinode-networking.mdx + - page: Volcano + path: ../../set-up/helm/volcano.mdx + - page: OpenSandbox + path: ../../set-up/helm/opensandbox.mdx + - page: OpenSandbox with Kata + slug: opensandbox-kata + path: ../../set-up/helm/opensandbox-kata.mdx + - page: OpenShift + slug: openshift + path: ../../set-up/helm/openshift.mdx + - page: Backup and Restore + path: ../../set-up/helm/backup-and-restore.mdx + - page: Jobs + slug: jobs + path: ../../set-up/manage-jobs.mdx + - page: Milvus + path: ../../set-up/milvus.mdx + - page: Observability + slug: observability + path: ../../set-up/opentelemetry.mdx + - page: Security + path: ../../set-up/security.mdx + - section: Helm + slug: helm + contents: + - page: Helm Reference + slug: helm-reference + path: ../../helm/index.mdx + - page: Config Reference + slug: config-reference + path: ../../set-up/config-reference.mdx + - section: Access Control + slug: access-control + path: ../../auth/index.mdx + contents: + - page: Overview + path: ../../auth/index.mdx + - page: Concepts + path: ../../auth/concepts.mdx + - section: Authentication + slug: authentication + path: ../../auth/authentication/index.mdx + contents: + - page: OIDC Setup + path: ../../auth/authentication/oidc.mdx + - page: Using Authentication + path: ../../auth/authentication/using-authentication.mdx + - section: Providers + slug: providers + path: ../../auth/authentication/providers/index.mdx + contents: + - page: Azure AD (Entra ID) + path: ../../auth/authentication/providers/azure-ad.mdx + - page: Generic OIDC + path: ../../auth/authentication/providers/generic.mdx + - section: Authorization + slug: authorization + path: ../../auth/authorization/index.mdx + contents: + - page: API Scopes + path: ../../auth/authorization/api-scopes.mdx + - page: Managing Access + path: ../../auth/authorization/managing-access.mdx + - page: Permissions Reference + path: ../../auth/authorization/permissions-reference.mdx + - page: Plugin Authorization + path: ../../auth/authorization/plugin-authorization.mdx + - page: Policy Engine + path: ../../auth/authorization/policy-engine.mdx + - page: Roles and Permissions + path: ../../auth/authorization/roles-and-permissions.mdx + - section: Deployment + slug: deployment + path: ../../auth/deployment/configuration.mdx + contents: + - page: Configuration + path: ../../auth/deployment/configuration.mdx + - page: Credential Propagation + path: ../../auth/deployment/credential-propagation.mdx + - page: Gateway Integration + path: ../../auth/deployment/gateway.mdx + - page: Production Hardening + path: ../../auth/deployment/hardening.mdx + - page: Security Model + path: ../../auth/security-model.mdx + - page: Troubleshooting + path: ../../auth/troubleshooting.mdx - section: Reference contents: - section: Release Notes @@ -537,4 +535,4 @@ navigation: - page: EULA path: ../../eula.mdx - page: Acknowledgements - path: ../../acknowledgements/index.mdx + path: ../../acknowledgements/index.mdx \ No newline at end of file diff --git a/web/packages/studio/src/components/NewCustomizationForm/RewardEnvironmentSection.tsx b/web/packages/studio/src/components/NewCustomizationForm/RewardEnvironmentSection.tsx index 7b8aad14b8..ab4b8ffd05 100644 --- a/web/packages/studio/src/components/NewCustomizationForm/RewardEnvironmentSection.tsx +++ b/web/packages/studio/src/components/NewCustomizationForm/RewardEnvironmentSection.tsx @@ -9,7 +9,6 @@ import { Anchor, Banner, Block, - Button, FormField, SelectContent, SelectItem, @@ -20,12 +19,12 @@ import { Text, } from '@nvidia/foundations-react-core'; import { FormSection } from '@studio/components/NewCustomizationForm/FormSection'; +import { LINK_DOCS_GRPO_TRAINING } from '@studio/constants/links'; import { type GymEnvironmentManifest, useGymEnvironmentManifest, } from '@studio/hooks/useGymEnvironmentManifest'; import { useWorkspaceFromPath } from '@studio/hooks/useWorkspaceFromPath'; -import { getNewFilesetRoute } from '@studio/routes/utils'; import { getHumanReadableFileSize } from '@studio/util/files'; import type { CustomizationFormFields } from '@studio/util/forms/customization'; import { FC, useMemo } from 'react'; @@ -109,12 +108,8 @@ export const RewardEnvironmentSection: FC = () => { <> GRPO scores sampled responses using a NeMo Gym environment. Upload one to a fileset first, see{' '} - - Environment Requirements + + GRPO Environment Guide . @@ -160,21 +155,6 @@ export const RewardEnvironmentSection: FC = () => { - {noEnvs && ( - - - No reward environment filesets exist yet. - - - - )} - {hasSelection && !isManifestPending && ( {noConfigWarning && ( diff --git a/web/packages/studio/src/constants/links.ts b/web/packages/studio/src/constants/links.ts index d09c063847..38da77c15d 100644 --- a/web/packages/studio/src/constants/links.ts +++ b/web/packages/studio/src/constants/links.ts @@ -20,6 +20,9 @@ export const LINK_DOCS_SAFE_SYNTHESIZER = `${DOCS_BASE_URL}synthesize-safe-data` // SDK documentation links export const LINK_DOCS_SDK = `${DOCS_BASE_URL}reference/python-sdk`; +// GRPO documentation links +export const LINK_DOCS_GRPO_TRAINING = `${DOCS_BASE_URL}customizer-reference/grpo-and-reward-environments`; + // Fine Tune documentation links export const LINK_DOCS_FINE_TUNE_CONFIGURATION_DECISIONS = `${DOCS_BASE_URL}customizer-reference/tutorials/understanding-models-and-training#making-configuration-decisions`; export const LINK_DOCS_FINE_TUNE_DATASET_FORMAT_REQUIREMENTS = `${DOCS_BASE_URL}customizer-reference/models/dataset-format`;