Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ config = FabricConfig(
models={
"default": ModelConfig(
provider="nvidia",
model="nvidia/nemotron-3-nano-30b-a3b",
model="nvidia/nemotron-3-nano-omni-30b-a3b-reasoning",
api_key_env="NVIDIA_API_KEY",
base_url="https://integrate.api.nvidia.com/v1",
)
Expand Down
6 changes: 3 additions & 3 deletions adapters/claude/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The following table shows which components each installation provides:

For split runtime and adapter environments, configure `ADAPTER_PYTHON` and use
matching NeMo Fabric release versions. Refer to the
[installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install#install-an-adapter-and-harness-without-the-runtime).
[installation guide](https://docs.nvidia.com/nemo/fabric/getting-started/install#install-an-adapter-and-harness-without-the-runtime).

The `full` extra is equivalent to `harness`. Relay is optional for ordinary
runs. Relay telemetry and `Runtime.invoke_stream()` require the external CLI
Expand Down Expand Up @@ -58,7 +58,7 @@ Unset unused `ANTHROPIC_API_KEY` and `ANTHROPIC_AUTH_TOKEN` variables before
using WIF. Anthropic credential resolution treats an empty variable as selected,
so an empty API credential prevents fallback to a federation profile.

Refer to the [Claude adapter authentication guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/integrations/harness/claude)
Refer to the [Claude adapter authentication guide](https://docs.nvidia.com/nemo/fabric/integrations/harness-integrations/claude-code)
for mode selection, required WIF variables, and the Relay boundary. Package
installation is verified by the adapter wheel and module-entrypoint tests.

Expand Down Expand Up @@ -122,7 +122,7 @@ by the SDK and is not persisted as a NeMo Fabric artifact.

Relay requires a separately installed NeMo Relay 0.6.x CLI on `PATH`; the Python
`nemo-relay` package does not provide the executable. Follow the
[NeMo Relay installation instructions](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install#install-nemo-relay).
[NeMo Relay installation instructions](https://docs.nvidia.com/nemo/fabric/getting-started/install#install-nemo-relay).

Enable Relay through the normalized NeMo Fabric configuration:

Expand Down
4 changes: 2 additions & 2 deletions adapters/claude/pypi.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ Installation can be performed using the `nemo-fabric` meta package with the `cla

The `full` extra is equivalent to `harness`. NeMo Relay is optional for ordinary
runs. NeMo Relay telemetry and streaming require the `nemo-relay` CLI tool.
Refer to the [NeMo Relay installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install#nemo-relay-cli) for instructions.
Refer to the [NeMo Relay installation guide](https://docs.nvidia.com/nemo/fabric/getting-started/install#nemo-relay-cli) for instructions.

Refer to the [installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install) for more details.
Refer to the [installation guide](https://docs.nvidia.com/nemo/fabric/getting-started/install) for more details.
2 changes: 1 addition & 1 deletion adapters/claude/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ full = [
Repository = "https://github.com/NVIDIA/NeMo-Fabric"
Homepage = "https://github.com/NVIDIA/NeMo-Fabric"
Issues = "https://github.com/NVIDIA/NeMo-Fabric/issues"
Documentation = "https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric"
Documentation = "https://docs.nvidia.com/nemo/fabric"

[tool.setuptools.packages.find]
where = ["src"]
Expand Down
4 changes: 2 additions & 2 deletions adapters/codex/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The following table shows which components each installation provides:
For an environment-managed SDK, use `openai-codex==0.144.4`. For split runtime
and adapter environments, configure `ADAPTER_PYTHON` and use matching NeMo
Fabric release versions. Refer to the
[installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install#install-an-adapter-and-harness-without-the-runtime).
[installation guide](https://docs.nvidia.com/nemo/fabric/getting-started/install#install-an-adapter-and-harness-without-the-runtime).

The `full` extra is equivalent to `harness`. Relay is optional for ordinary
runs. Relay telemetry and `Runtime.invoke_stream()` require the external CLI
Expand Down Expand Up @@ -147,7 +147,7 @@ Codex state variables, the selected model's `api_key_env`, and explicit

Relay requires a separately installed NeMo Relay 0.6.x CLI on `PATH`; the Python
`nemo-relay` package does not provide the executable. Follow the
[NeMo Relay installation instructions](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install#install-nemo-relay).
[NeMo Relay installation instructions](https://docs.nvidia.com/nemo/fabric/getting-started/install#install-nemo-relay).

Enable Relay with `FabricConfig.enable_relay(...)`. The adapter starts the
installed `nemo-relay` CLI as a supervised sidecar; do not start the gateway
Expand Down
4 changes: 2 additions & 2 deletions adapters/codex/pypi.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ Installation can be performed using the `nemo-fabric` meta package with the `cod

The `full` extra is equivalent to `harness`. NeMo Relay is optional for ordinary
runs. NeMo Relay telemetry and streaming require the `nemo-relay` CLI tool.
Refer to the [NeMo Relay installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install#nemo-relay-cli) for instructions.
Refer to the [NeMo Relay installation guide](https://docs.nvidia.com/nemo/fabric/getting-started/install#nemo-relay-cli) for instructions.

Refer to the [installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install) for more details.
Refer to the [installation guide](https://docs.nvidia.com/nemo/fabric/getting-started/install) for more details.
2 changes: 1 addition & 1 deletion adapters/codex/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ full = [
Repository = "https://github.com/NVIDIA/NeMo-Fabric"
Homepage = "https://github.com/NVIDIA/NeMo-Fabric"
Issues = "https://github.com/NVIDIA/NeMo-Fabric/issues"
Documentation = "https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric"
Documentation = "https://docs.nvidia.com/nemo/fabric"

[tool.setuptools.packages.find]
where = ["src"]
Expand Down
2 changes: 1 addition & 1 deletion adapters/common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Install the package directly when developing an adapter:
pip install nemo-fabric-adapters-common
```

Refer to the [NeMo Fabric documentation](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric)
Refer to the [NeMo Fabric documentation](https://docs.nvidia.com/nemo/fabric)
for adapter and configuration guidance. Source code is available in the
[NVIDIA NeMo Fabric repository](https://github.com/NVIDIA/nemo-fabric/).

Expand Down
2 changes: 1 addition & 1 deletion adapters/common/pypi.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ Install the package directly when developing an adapter:
pip install nemo-fabric-adapters-common
```

Refer to the [NeMo Fabric documentation](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric)
Refer to the [NeMo Fabric documentation](https://docs.nvidia.com/nemo/fabric)
for adapter and configuration guidance. Source code is available in the
[NVIDIA NeMo Fabric repository](https://github.com/NVIDIA/NeMo-Fabric).
2 changes: 1 addition & 1 deletion adapters/common/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ requires-python = ">=3.11"
Repository = "https://github.com/NVIDIA/NeMo-Fabric"
Homepage = "https://github.com/NVIDIA/NeMo-Fabric"
Issues = "https://github.com/NVIDIA/NeMo-Fabric/issues"
Documentation = "https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric"
Documentation = "https://docs.nvidia.com/nemo/fabric"

[tool.setuptools.packages.find]
where = ["src"]
Expand Down
2 changes: 1 addition & 1 deletion adapters/deepagents/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ For an environment-managed stack, use `deepagents>=0.6.12,<0.7.0`,
`langchain>=1.3,<2.0`, and `langgraph>=1.2,<2.0`. For split runtime and adapter
environments, configure `ADAPTER_PYTHON` and use matching NeMo Fabric release
versions. Refer to the
[installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install#install-an-adapter-and-harness-without-the-runtime).
[installation guide](https://docs.nvidia.com/nemo/fabric/getting-started/install#install-an-adapter-and-harness-without-the-runtime).

## Model and Authentication

Expand Down
2 changes: 1 addition & 1 deletion adapters/deepagents/pypi.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ NeMo Relay is optional for ordinary runs. NeMo Relay telemetry and streaming
require one of the installations in the table that includes the NeMo Relay
Python package.

Refer to the [installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install) for more details.
Refer to the [installation guide](https://docs.nvidia.com/nemo/fabric/getting-started/install) for more details.
2 changes: 1 addition & 1 deletion adapters/deepagents/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ full = [
Repository = "https://github.com/NVIDIA/NeMo-Fabric"
Homepage = "https://github.com/NVIDIA/NeMo-Fabric"
Issues = "https://github.com/NVIDIA/NeMo-Fabric/issues"
Documentation = "https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric"
Documentation = "https://docs.nvidia.com/nemo/fabric"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Fix the package documentation URL in both adapter manifests.

The exact no-slash URL returns 404. Use the slash-terminated documentation root or the canonical overview page. ()

  • adapters/deepagents/pyproject.toml#L56-L56: add the trailing slash to Documentation.
  • adapters/hermes/pyproject.toml#L48-L48: add the trailing slash to Documentation.
📍 Affects 2 files
  • adapters/deepagents/pyproject.toml#L56-L56 (this comment)
  • adapters/hermes/pyproject.toml#L48-L48
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@adapters/deepagents/pyproject.toml` at line 56, Update the Documentation URL
in adapters/deepagents/pyproject.toml at lines 56-56 and
adapters/hermes/pyproject.toml at lines 48-48 to use the slash-terminated NVIDIA
NeMo Fabric documentation root, preserving the existing URL otherwise.

Source: MCP tools


[tool.setuptools.packages.find]
where = ["src"]
Expand Down
2 changes: 1 addition & 1 deletion adapters/hermes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ table shows which components each installation provides:
For an environment-managed harness, use `hermes-agent>=0.17.0`. For split
runtime and adapter environments, configure `ADAPTER_PYTHON` and use matching
NeMo Fabric release versions. Refer to the
[installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install#install-an-adapter-and-harness-without-the-runtime).
[installation guide](https://docs.nvidia.com/nemo/fabric/getting-started/install#install-an-adapter-and-harness-without-the-runtime).

Relay is optional for ordinary runs. Relay telemetry and
`Runtime.invoke_stream()` require one of the installations in the table that
Expand Down
2 changes: 1 addition & 1 deletion adapters/hermes/pypi.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ NeMo Relay is optional for ordinary runs. NeMo Relay telemetry and streaming
require one of the installations in the table that includes the NeMo Relay
Python package.

Refer to the [installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install) for more details.
Refer to the [installation guide](https://docs.nvidia.com/nemo/fabric/getting-started/install) for more details.
2 changes: 1 addition & 1 deletion adapters/hermes/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ full = [
Repository = "https://github.com/NVIDIA/NeMo-Fabric"
Homepage = "https://github.com/NVIDIA/NeMo-Fabric"
Issues = "https://github.com/NVIDIA/NeMo-Fabric/issues"
Documentation = "https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric"
Documentation = "https://docs.nvidia.com/nemo/fabric"

[tool.setuptools.packages.find]
where = ["src"]
Expand Down
4 changes: 2 additions & 2 deletions crates/fabric-cli/src/presets.rs
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ fn hermes() -> FabricConfig {
"nvidia.fabric.hermes",
Some(model(
"nvidia",
"nvidia/nemotron-3-nano-30b-a3b",
"nvidia/nemotron-3-nano-omni-30b-a3b-reasoning",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Should Fix: Add Exact Default-Model Assertions.

adapter_presets_use_nvidia_credentials does not verify these changed model defaults. Add assertions for the Hermes and Deep Agents identifiers.

Proposed test
+        for (name, expected_model) in [
+            ("hermes", "nvidia/nemotron-3-nano-omni-30b-a3b-reasoning"),
+            ("deepagents", "nvidia/nemotron-3-nano-omni-30b-a3b-reasoning"),
+        ] {
+            let config = find(name)
+                .expect("catalog preset")
+                .config()
+                .expect("construct catalog config");
+            let model = config.models.get("default").expect("default model");
+            assert_eq!(model.model, expected_model);
+        }

As per coding guidelines: “Run the relevant Rust and Python test suites for every affected language surface.”

Also applies to: 243-243

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@crates/fabric-cli/src/presets.rs` at line 187, Update the
adapter_presets_use_nvidia_credentials test to assert the exact default model
identifiers for both the Hermes and Deep Agents presets, including the changed
NVIDIA model values. Preserve the existing credential assertions and run the
relevant Rust and Python test suites.

Source: Coding guidelines

Some("NVIDIA_API_KEY"),
Some(NVIDIA_API_CATALOG_BASE_URL),
)),
Expand Down Expand Up @@ -240,7 +240,7 @@ fn deepagents() -> FabricConfig {
"nvidia.fabric.langchain.deepagents",
Some(model(
"nvidia",
"nvidia/nemotron-3-nano-30b-a3b",
"nvidia/nemotron-3-nano-omni-30b-a3b-reasoning",
Some("NVIDIA_API_KEY"),
Some(NVIDIA_API_CATALOG_BASE_URL),
)),
Expand Down
2 changes: 1 addition & 1 deletion crates/fabric-cli/src/scaffold.rs
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ mod tests {
};
let source = fs::read_to_string(launcher).expect("read launcher");
assert!(source.contains("nvidia.fabric.hermes"));
assert!(source.contains("nvidia/nemotron-3-nano-30b-a3b"));
assert!(source.contains("nvidia/nemotron-3-nano-omni-30b-a3b-reasoning"));
assert!(source.contains("https://integrate.api.nvidia.com/v1"));
if language == Language::Rust {
let manifest =
Expand Down
160 changes: 37 additions & 123 deletions docs/about-nemo-fabric/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
---
title: "NVIDIA NeMo Fabric"
title: "NVIDIA NeMo Fabric Documentation"
slug: "/about-nemo-fabric/overview"
description: "Configure, plan, run, and observe agent harnesses through one typed execution contract."
template-library-version: "1.0.0"
---
{/* SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0 */}

NeMo Fabric is the harness-management layer that turns multiple agent runtimes
NVIDIA NeMo Fabric is the harness-management layer that turns multiple agent runtimes
into one configurable, observable execution surface. Applications use the same
versioned config, lifecycle, result, artifact, and telemetry contracts whether
the selected harness is Hermes Agent, Codex, or a custom adapter.
the selected harness is [Hermes Agent](https://hermes-agent.nousresearch.com/docs/),
[Codex SDK](https://openai.com/codex/), or a custom adapter.

NeMo Fabric owns the seam between an application and its harness. It resolves
configuration, selects an adapter, drives the runtime lifecycle,
Expand All @@ -19,25 +21,42 @@ into the caller.
## What NeMo Fabric Gives You

<CardGroup cols={2}>
<Card title="Typed configuration">
<Card title="Typed Configuration">
Construct a complete, versioned `FabricConfig` in Python. Applications
create variants with ordinary functions and typed copies.
</Card>
<Card title="Harness-neutral execution">
<Card title="Harness-Neutral Execution">
Plan and invoke different harnesses through one Rust core, CLI, and Python
SDK instead of embedding harness launch logic in every consumer.
</Card>
<Card title="Typed lifecycle contracts">
<Card title="Typed Lifecycle Contracts">
Resolve configs, inspect capabilities, run single-invocation jobs, and hold
multi-turn runtimes with typed requests, plans, handles, and results.
</Card>
<Card title="Normalized evidence">
<Card title="Normalized Evidence">
Collect output, errors, lifecycle events, artifact manifests, and telemetry
references in stable contracts suitable for platforms and evaluations.
</Card>
</CardGroup>

## How NeMo Fabric Fits

## Choose Your Interface

Use the following table to choose the NeMo Fabric interface that best fits how
your application works with harnesses:

| Interface | Use it when | Start with |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Should Fix: Use Title Case for Table Headers.

Change Use it when to Use It When. Change Start with to Start With.

As per coding guidelines: “Use consistent title case for technical-document headings and table headers.”

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/about-nemo-fabric/overview.mdx` at line 48, Update the table header row
by changing “Use it when” to “Use It When” and “Start with” to “Start With,”
preserving the existing table structure and wording otherwise.

Source: Coding guidelines

| --- | --- | --- |
| Python SDK | Your application owns job config, runtime lifecycle, or multi-turn state | [Client API](../reference/api/python-library-reference/nemo_fabric.client.md) |
| Runtime API | You need multiple ordered turns over one live harness runtime | [Runtime](../reference/api/python-library-reference/nemo_fabric.runtime.md) |
| Streaming API | You need live ATOF records generated by NeMo Relay during a runtime turn | [Streaming](../reference/api/python-library-reference/nemo_fabric.streaming.md) |
| `nemo-fabric` CLI | You are experimenting with harnesses, running maintained examples, or troubleshooting configs | [Experimentation CLI](../experimentation/cli.mdx) |
| JSON Schema | You are building editors, validation, code generation, or another language binding | Committed schemas in the [repository](https://github.com/NVIDIA/NeMo-Fabric/tree/main/schemas) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Should Fix: Use the Repository Name as Link Text.

Replace [repository] with [NVIDIA/NeMo-Fabric]. Generic link text does not identify the destination.

As per coding guidelines: “Link GitHub repositories using owner/repository link text.”

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/about-nemo-fabric/overview.mdx` at line 54, Update the JSON Schema row
in the overview documentation to use “NVIDIA/NeMo-Fabric” as the repository link
text, preserving the existing repository URL and surrounding table content.

Source: Coding guidelines


Use `FabricConfig` as the canonical configuration contract. CLI selectors
obtain complete typed configs from built-in presets or maintained examples.

## Core Workflow

```text
Application or evaluation harness
Expand All @@ -55,87 +74,6 @@ Hermes Agent | Codex | custom harness
RunResult + artifacts + events + telemetry references
```

The experimentation CLI and its catalogs live in the Rust `fabric-cli` crate
and are installed separately from the Python SDK. Built-in presets and
maintained examples produce a complete `FabricConfig` before using the same
run-plan contract. Adapters own harness-specific preparation and invocation;
consumers own the request and returned evidence.

## Quick Start

Install `just` 1.50.0+ if it is not already available.

```bash
cargo install just --locked
```

Refer to the [official installation guide](https://just.systems/man/en/installation.html)
for more details.

Ensure that the Cargo bin directory is in your `PATH`:

```bash
export PATH="$HOME/.cargo/bin:$PATH"
```

Create a Python virtual environment and activate it (replace `3.13` with your preferred Python version):

```bash
uv venv -p 3.13 --seed .venv
source .venv/bin/activate
```

Build the Python SDK and install the Rust CLI from a source checkout:

```bash
just build-all
```

Run the example through the Python SDK:

```python
import asyncio
from examples.code_review_agent import BASE_DIR, hermes_config
from nemo_fabric import Fabric


async def main() -> None:
config = hermes_config()
client = Fabric()
result = await client.run(
config,
base_dir=BASE_DIR,
input="Reply with exactly: fabric works",
)

print(result.status)


asyncio.run(main())
```

Harness installation and credential requirements differ by adapter. The
[repository quick start](https://github.com/NVIDIA/NeMo-Fabric#quick-start-hermes-agent)
contains the complete Hermes Agent environment recipe.

Refer to the [Python SDK guide](../sdk/python.mdx) for planning,
diagnostics, typed requests, multi-turn runtimes, and NVIDIA NeMo Relay streaming.

## Choose Your Interface

| Interface | Use it when | Start with |
| --- | --- | --- |
| Python SDK | Your application owns job config, runtime lifecycle, or multi-turn state | [Client API](../reference/api/python-library-reference/nemo_fabric.client.md) |
| Runtime API | You need multiple ordered turns over one live harness runtime | [Runtime](../reference/api/python-library-reference/nemo_fabric.runtime.md) |
| Streaming API | You need live ATOF records generated by NeMo Relay during a runtime turn | [Streaming](../reference/api/python-library-reference/nemo_fabric.streaming.md) |
| `nemo-fabric` CLI | You are experimenting with harnesses, running maintained examples, or troubleshooting configs | [Experimentation CLI](../experimentation/cli.mdx) |
| JSON Schema | You are building editors, validation, code generation, or another language binding | Committed schemas in the [repository](https://github.com/NVIDIA/NeMo-Fabric/tree/main/schemas) |

Use `FabricConfig` as the canonical configuration contract. CLI selectors
obtain complete typed configs from built-in presets or maintained examples.

## Core Workflow

1. **Configure** a typed `FabricConfig` with a harness adapter,
environment, models, tools, skills, MCP, and telemetry.
2. **Create variants** from deep copies to vary harness, model, environment, or
Expand All @@ -148,38 +86,14 @@ obtain complete typed configs from built-in presets or maintained examples.
5. **Consume evidence** from `RunResult`: output, structured failure details,
artifacts, events, and telemetry references.

## Next Steps
## Learn More

<CardGroup cols={2}>
<Card
title="Client API"
href="/reference/api/python-library-reference/client"
>
Resolve, plan, diagnose, run, and start stateful runtimes.
</Card>
<Card
title="Runtime"
href="/reference/api/python-library-reference/runtime"
>
Invoke multiple ordered turns and stop runtime handles safely.
</Card>
<Card
title="Streaming"
href="/reference/api/python-library-reference/streaming"
>
Consume live, raw NeMo Relay ATOF records and retrieve the terminal run result.
</Card>
<Card
title="Types"
href="/reference/api/python-library-reference/types"
>
Explore all mutable config objects and immutable request, plan, result,
artifact, telemetry, and runtime models.
</Card>
<Card
title="Errors"
href="/reference/api/python-library-reference/errors"
>
Handle config, capability, lifecycle, state, and native-extension failures.
</Card>
</CardGroup>
Continue exploring NeMo Fabric through these resources.

- **Installation** — [Installation](../getting-started/install.mdx) to set up the runtime and adapters.
- **Quickstart** — [Quickstart](../getting-started/quickstart.mdx) to build from
source and run the maintained SDK example.
Comment on lines +94 to +95

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Must Fix: Correct the Quickstart Description.

The Quickstart installs the package and runs an SDK example. It does not build from source. Replace “to build from source and run” with “to install NVIDIA NeMo Fabric and run.” The published Quickstart uses pip install for setup. (docs.nvidia.com)

As per coding guidelines: “Treat incorrect or stale commands, package names, paths, APIs, support claims, procedures, examples, terminology, or public behavior documentation as blocking issues.”

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/about-nemo-fabric/overview.mdx` around lines 94 - 95, Update the
Quickstart entry in the overview documentation to describe installing NVIDIA
NeMo Fabric and running the maintained SDK example, replacing the inaccurate
“build from source” wording while preserving the existing link and example
reference.

Sources: Coding guidelines, Path instructions

- **Python SDK** — [Python SDK](../sdk/python.mdx) for planning, diagnostics,
typed requests, and multi-turn runtimes.
- **API Reference** — [Client API](../reference/api/python-library-reference/nemo_fabric.client.md)
to resolve, plan, diagnose, run, and start stateful runtimes.
Loading
Loading