Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/fern/versions/latest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,8 @@ navigation:
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
Expand Down
24 changes: 21 additions & 3 deletions docs/studio/agents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,20 @@ description: ""
---
Use **Agents** in the NeMo Studio workspace sidebar to review and operate agent workflows managed by NeMo Platform.

## Current Agent Experience

New agents use the Platform-managed `nemo-agents-spec-v1` `agent.yaml` format. NeMo Platform translates this durable configuration into the NVIDIA Agent Intelligence Toolkit Fabric runtime configuration when it deploys the agent. Fabric is the execution layer; `nemo-agents-spec-v1` remains the configuration contract that you author and store.

This Fabric-first path is recommended for new agents. Studio can also display legacy `nat-workflow-v1` agents, so the fields shown on the **Details** tab depend on the agent's config format. Create a sample `nemo-agents-spec-v1` agent with **Create Example Agent**, or register your own agent through the `nemo agents` CLI or Agents API. Studio does not currently provide a general-purpose editor for authoring an arbitrary `agent.yaml`.

## Agent List

The Agents table shows the agents in the selected workspace, including their deployment state and creation time. Select an agent to open its details page.

| Action | Where | Result |
|--------|-------|--------|
| Review details | Select an agent | Opens the agent details page with deployment, log, chat, evaluation, and configuration views. |
| Create a sample agent | **Create Example Agent** | Creates a Platform-managed example agent in the current workspace. |
| Deploy an agent | Row actions > **Deploy** | Creates a deployment for the selected agent. |
| Clone an agent | Row actions > **Clone** | Creates a copy of the agent definition with a new name. |
| Chat with a deployment | Agent details page > **Chat** tab | Opens chat for a running deployment. |
Expand All @@ -22,13 +29,24 @@ The Agents table shows the agents in the selected workspace, including their dep

## Agent Details

The agent details page has five tabs:
The agent details page has the following tabs:

- **Overview**, when enabled, summarizes the agent, models, and recent activity.
- **Deployments** lists active and historical deployments for the agent. Use this tab to deploy the agent, open chat for a running deployment, view logs, or delete a deployment.
- **Logs** shows deployment logs.
- **Chat** opens an interactive chat with a running deployment.
- **Evaluations** shows recent evaluation jobs for the agent and lets you start a new evaluation.
- **Details** shows stored agent metadata and configuration, including workflow, model, tool, and additional config fields.
- **Evaluations** shows active jobs, completed evaluations, and experiments scoped to this agent, and lets you start a new evaluation.
- **Details** shows the config format and the stored agent configuration. For `nemo-agents-spec-v1`, this includes the Fabric-first harness, named models, instructions, skills, MCP servers, environment, telemetry, and other fields present in `agent.yaml`. Legacy NAT agents show their workflow, LLM, and function configuration instead.

## Evaluate an Agent

Agent evaluations are not a separate item under the **Agents** navigation parent. To open them, use this path:

1. Select **Agents** in the workspace sidebar.
2. Select an agent.
3. Select the **Evaluations** tab.

Select **Run evaluation** to start an evaluation for the current agent. The tab keeps active jobs visible and lets you switch between **Completed Evaluations** and **Experiments**. This agent-scoped view differs from **Models > Model Evaluations**, which shows model evaluation results.

Agents are created and updated through the `nemo agents` CLI or Agents API. NeMo Studio reflects the current workspace state after the platform services refresh.

Expand Down
2 changes: 1 addition & 1 deletion docs/studio/data-designer-build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This page walks through the full workflow:

## View jobs

Navigate to **Data Designer** in the workspace sidebar to open the jobs list. The list shows every Data Designer job in the current workspace with its status, and supports searching by name, filtering by status, and narrowing by creation or update date range.
Navigate to **Data > Datasets > Data Designer** in the workspace sidebar to open the jobs list. The list shows every Data Designer job in the current workspace with its status, and supports searching by name, filtering by status, and narrowing by creation or update date range.

Selecting a job opens its [details page](#view-job-details). Each row also has a quick-actions menu with **View details**, **Clone**, **Cancel** (when the job is still cancellable), and **Delete**.

Expand Down
11 changes: 9 additions & 2 deletions docs/studio/guardrails.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,16 @@
# SPDX-License-Identifier: Apache-2.0

title: "NeMo Studio Guardrail Configs"
description: ""
description: "View NeMo Guardrails configurations in Studio when the preview feature is enabled."
---
Use **Guardrails** in the NeMo Studio workspace sidebar to view and manage NeMo Guardrails configurations for the selected workspace.

<Warning>

The Guardrails Studio UI is a preview feature and is disabled by default. An administrator must set `studio.feature_flags.guardrails_enabled: true` in the platform configuration and restart Studio before **Governance > Guardrails** appears. The same feature flag controls the **Models > Virtual Models** page.

</Warning>

Use **Governance > Guardrails** in the NeMo Studio workspace sidebar to view and manage NeMo Guardrails configurations for the selected workspace.

## Guardrail Config List

Expand Down
38 changes: 30 additions & 8 deletions docs/studio/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Studio is still in early development. Many features are missing or should be exp

NeMo Studio is the web app for AI development with NVIDIA NeMo Platform. It provides a workspace-oriented UI for managing local platform resources, reviewing agents, running agent optimization workflows, monitoring agent telemetry, and working with filesets, jobs, and secrets.

The pages visible in your workspace depend on the installed plugins, enabled services, feature flags, and NeMo Platform version. A page documented here might be hidden in your deployment. Preview pages identify the feature flag that enables them.

---

## Getting Started
Expand All @@ -24,9 +26,28 @@ NeMo Studio is included with the platform. Follow the [Setup guide](/documentati

## Features

### Current Workspace Navigation

The current sidebar groups related pages under expandable parents. Selecting a parent that has its own landing page opens that page; use its chevron to expand the child entries.

| Sidebar group | Current entry point | Purpose and availability |
| --- | --- | --- |
| **Observability** | **Insights** | Review recurring agent failure patterns and optimization insights. Shown when optimization is enabled. |
| **Observability** | **Traces** | Inspect ingested traces, spans, and session details. |
| **Components** | **Agents** | Opens the agent list. Select an agent to access Deployments, Logs, Chat, Evaluations, and Details. |
| **Components** | **Models** | Opens the base-model list directly. Expand **Models** for **Fine-tune**, **Model Evaluations**, **Playground**, and **Virtual Models**, when those capabilities are enabled. |
| **Evaluations** | **Experiments** | Review experiments, evaluations, sessions, and published results across the workspace. |
| **Data** | **Datasets > Data Designer** | Build and monitor synthetic-data jobs. Other installed data plugins can appear below **Datasets**. |
| **Governance** | **Guardrails** | Manage guardrail configurations. Disabled by default; see [Studio Guardrail Configs](/documentation/studio/guardrail-configs). |
| **Governance** | **Iron Swarm** | Plugin-provided agent hardening UI. Appears only when the Iron Swarm plugin is installed; see [Studio Plugin UIs](/documentation/studio/plugins). |
| **System** | **Filesets** | Organize and manage files used by agents and jobs. |
| **System** | **Jobs** | Monitor jobs across enabled platform capabilities. |

Additional entries, including Dashboard, Safe Synthesizer, Anonymizer, deployments, and workspace settings, appear when their corresponding capability or feature flag is enabled. Because plugins contribute navigation at runtime, an installed plugin can also add pages to an existing group or add a new group.

### Agents

Use the Studio Agents area to review platform-managed NeMo Agent Toolkit workflows, inspect agent details, deploy agents, open a chat session against a running deployment, and clean up deployments that are no longer needed.
Use the Studio Agents area to review Platform-managed agents, including the current Fabric-first `nemo-agents-spec-v1` experience, inspect agent details, deploy agents, open a chat session against a running deployment, and clean up deployments that are no longer needed.

For the full workflow, see [Studio Agents](/documentation/studio/agents).

Expand All @@ -38,23 +59,23 @@ For the full workflow, see [Studio Monitor](/documentation/studio/monitor).

### Guardrails

Use **Guardrails** to view NeMo Guardrails configurations for the current workspace. The list shows each config's name, attached task model count, and rail count. Select a row to open the detail page, which displays the full configuration payload as formatted JSON.
When the preview feature is enabled, use **Governance > Guardrails** to view NeMo Guardrails configurations for the current workspace. The list shows each config's name, attached task model count, and rail count. Select a row to open the detail page, which displays the full configuration payload as formatted JSON.

Guardrail configurations are created through the `nemo guardrail` CLI or Guardrails API.

For the full workflow, see [Studio Guardrail Configs](/documentation/studio/guardrail-configs).

### Virtual Models

Use **Virtual Models** to inspect inference routes managed by the Inference Gateway. The list shows all user-created virtual models in the workspace — auto-provisioned passthrough routes are hidden. Select a row to open the details panel, which shows the default backend model when configured, and the ordered request, response, and post-response middleware pipelines attached to the route.
When the Guardrails preview feature is enabled, use **Models > Virtual Models** to inspect inference routes managed by the Inference Gateway. The list shows all user-created virtual models in the workspace — auto-provisioned passthrough routes are hidden. Select a row to open the details panel, which shows the default backend model when configured, and the ordered request, response, and post-response middleware pipelines attached to the route.

Virtual models are created through the `nemo inference virtual-models` CLI or the Inference Gateway API.

For the full workflow, see [Studio Virtual Models](/documentation/studio/virtual-models).

### Models

Use **Models \> Base Models** to browse model entities available in the current workspace. Base models include models registered in the workspace and default platform models.
Select **Models** to browse base-model entities available in the current workspace. There is no separate **Base Models** child entry in the sidebar: **Models** is both the expandable parent and the link to the base-model list. Base models include models registered in the workspace and default platform models.

The Base Models page supports searching by model name, filtering by creation or update date, sorting alphabetically or by creation time, and showing only customizable models. Select a model card to open the model details side panel.

Expand Down Expand Up @@ -90,14 +111,15 @@ For the full workflow, see [Synthesize Safe Data](/documentation/synthesize-safe

### Evaluations

**Evaluations** appears in two separate sidebar groups because it covers two distinct scopes:
Studio provides separate agent, model, and workspace evaluation views:

| Location | What it shows |
| -------- | ------------- |
| **Agents \> Evaluations** | Evaluation runs scoped to a specific agent — results tied to agent deployments and versions. |
| **Evaluate \> Evaluations** | All evaluation results across the workspace, regardless of which agent or model was evaluated. |
| **Agents > select an agent > Evaluations** | Active evaluation jobs, completed evaluations, and experiments scoped to the selected agent. |
| **Models > Model Evaluations** | Model evaluation results. |
| **Evaluations > Experiments** | Experiments and their evaluations across the workspace. |

Use **Agents \> Evaluations** when reviewing how a specific agent performed. Use **Evaluate \> Evaluations** for a broader view of evaluation history across the workspace.
Use the agent's **Evaluations** tab when reviewing how a specific agent performed. Use **Experiments** for the broader workspace history.

### Jobs

Expand Down
34 changes: 34 additions & 0 deletions docs/studio/plugins.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

title: "Plugin UIs in NeMo Studio"
description: "Find and use Studio pages contributed by installed NeMo Platform plugins."
---

NeMo Platform plugins can contribute pages to Studio at runtime. A plugin UI runs inside Studio and shares the current workspace, navigation, authentication, notifications, and visual theme. You do not open a separate application.

Plugin entries only appear when all of the following are true:

- The plugin is installed and registered with NeMo Platform.
- The plugin includes a Studio web bundle.
- Studio can load the platform's plugin manifest.

A plugin chooses where its entry appears. It can join a built-in group such as **Governance** or **Data**, or add its own sidebar group. Consequently, the navigation in one deployment can differ from another deployment of the same Studio version.

## Iron Swarm

When the Iron Swarm plugin is installed, open its Studio UI from **Governance > Iron Swarm**. The entry is supplied by the plugin and does not require a separate Studio feature flag.
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated

Iron Swarm runs an attack, defend, and validate war-game against a sandboxed copy of an agent. The UI lets you:

- View war-game runs and their status.
- Open a run to inspect progress and results.
- View, create, edit, and delete saved target manifests.
- Start a war-game from a saved manifest.

The plugin and its runtime prerequisites must be configured before a run can succeed. If **Iron Swarm** is absent, ask the platform administrator whether the plugin is installed and registered. If the entry is present but a run cannot start, check the plugin setup and health from the NeMo CLI.

## Version and Availability

Plugin UIs are released with their plugins and can evolve independently of Studio's built-in pages. When a plugin page differs from this documentation, compare the NeMo Platform version and installed plugin version, and use the plugin's CLI documentation for detailed setup and troubleshooting.
11 changes: 9 additions & 2 deletions docs/studio/virtual-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,16 @@
# SPDX-License-Identifier: Apache-2.0

title: "NeMo Studio Virtual Models"
description: ""
description: "Inspect inference routes in Studio when the Guardrails preview feature is enabled."
---
Use **Virtual Models** in the NeMo Studio workspace sidebar to inspect inference routes and their middleware pipelines for the selected workspace.

<Warning>

The Virtual Models Studio UI is a preview feature and is disabled by default. An administrator must set `studio.feature_flags.guardrails_enabled: true` in the platform configuration and restart Studio before **Models > Virtual Models** appears. This flag also enables **Governance > Guardrails**.

</Warning>

Use **Models > Virtual Models** in the NeMo Studio workspace sidebar to inspect inference routes and their middleware pipelines for the selected workspace.

## Virtual Model List

Expand Down
Loading