Skip to content
Closed
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
e8353bf
Document installing the nemo-relay CLI tool
dagardner-nv Jul 20, 2026
6d751ad
Fix docs url
dagardner-nv Jul 20, 2026
6319666
Refer to the nemo-relay CLI install doc for the adapters that need it…
dagardner-nv Jul 20, 2026
83096a2
Rename sections
dagardner-nv Jul 20, 2026
ef94f33
Guide the user towards the notebooks, add Google Colab link
dagardner-nv Jul 20, 2026
b6fa5d9
Guide the user to the SDK Guide and the other examples from the noteb…
dagardner-nv Jul 20, 2026
5801f92
Guide the user to the examples after the SDK doc
dagardner-nv Jul 20, 2026
0c8d708
Remove YAML specific references from the Code Concepts section
dagardner-nv Jul 20, 2026
c1e84a1
Always refer to Hermes Agent as Hermes Agent not just 'Hermes'
dagardner-nv Jul 20, 2026
a7b3840
The Codex adapter doesn't have SDK in the name
dagardner-nv Jul 20, 2026
6351c68
Formatting
dagardner-nv Jul 20, 2026
edc9588
Fix anchor tag
dagardner-nv Jul 20, 2026
e9e3576
Formatting
dagardner-nv Jul 20, 2026
f3d271e
Merge branch 'main' of github.com:NVIDIA/NeMo-Fabric into david-more-…
dagardner-nv Jul 20, 2026
1803817
NeMo Fabric, not Fabric
dagardner-nv Jul 21, 2026
d549136
Add a code rabbit check for the product name
dagardner-nv Jul 21, 2026
0158c68
NeMo Fabric not 'Fabric'
dagardner-nv Jul 21, 2026
83545f6
Clean-up
dagardner-nv Jul 21, 2026
3c9dd77
Product naming
dagardner-nv Jul 21, 2026
2db34ea
Product naming
dagardner-nv Jul 21, 2026
bcfc827
Slim down sentence about adapter packages
dagardner-nv Jul 21, 2026
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
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ flowchart TB
Harness -. harness telemetry .-> Relay
```

## Quick Start: Hermes Agent
## Building and Installing

This path installs Fabric, installs Hermes Agent in a separate Python environment,
and runs one input through the Hermes Agent adapter.
Expand Down Expand Up @@ -81,6 +81,8 @@ just build-all
just wheels
```

## Quick Start: Hermes Agent

Install Hermes into its own environment (the nemo-fabric[hermes] extra will install Hermes Agent, and the Hermes Agent adapter but not Fabric itself):

```bash
Expand Down Expand Up @@ -119,6 +121,11 @@ under `examples/code_review_agent/artifacts/hermes/`. Its complete base
config and clone-based variants live in
`examples/code_review_agent/config.py`.

### Next Steps
- Follow the [Example Notebooks](examples/notebooks/README.md) for a guided tour of the Python SDK.
Comment thread
dagardner-nv marked this conversation as resolved.
Resolved
- Refer to the [Python SDK guide](docs/sdk/python.mdx): typed configuration, planning,
diagnostics, requests, multi-turn runtimes, parallelism, results, and errors.

## Claude Adapter

Build the local wheels and install Fabric with the independent Claude adapter:
Expand Down Expand Up @@ -184,6 +191,7 @@ the [Python SDK guide](docs/sdk/python.mdx). Exact signatures are in the

## More Workflows

- [Example Notebooks](examples/notebooks/README.md) provide a guided tour of the Python SDK.
- [Python SDK guide](docs/sdk/python.mdx): typed configuration, planning,
diagnostics, requests, multi-turn runtimes, parallelism, results, and errors.
- [Consumer integration skills](skills/README.md): repository-local coding-agent
Expand Down
6 changes: 1 addition & 5 deletions adapters/claude/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,7 @@ Refer to the [Claude adapter authentication guide](https://nvidia-nemo-fabric.do
for mode selection, required WIF variables, and the Relay boundary. Package
installation is verified by the adapter wheel and module-entrypoint tests.

Relay-enabled runs also require the external `nemo-relay` CLI. Fabric accepts
CLI versions `>=0.6.0,<0.7.0`. Install the CLI separately:

```bash
cargo install nemo-relay-cli
Relay-enabled runs also require the external `nemo-relay` CLI. Refer to the [NeMo Relay CLI](https://docs.nvidia.com/nemo/fabric/getting-started/install#nemo-relay-cli) install guide for instructions on installing the CLI tool.
Comment thread
dagardner-nv marked this conversation as resolved.
Resolved
```

The Python `nemo-relay` package does not install this executable. Refer to the
Expand Down
57 changes: 3 additions & 54 deletions adapters/codex/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,59 +102,8 @@ The adapter filters the inherited environment. It retains portable OS and
Codex state variables, the selected model's `api_key_env`, and explicit
`settings.env` values while clearing unrelated parent-process secrets.

## Relay Observability

Enable Relay through Fabric's normalized telemetry configuration. For each
Relay-enabled invocation, Fabric:

1. Resolves one external `nemo-relay` executable.
2. Generates invocation-scoped gateway and plugin configuration.
3. Starts and health-checks `nemo-relay --config ... --bind ...`.
4. Redirects the built-in OpenAI provider with request-scoped
`openai_base_url` and passes Relay hooks through the Codex SDK's `config`
argument.
5. Interrupts timed-out turns, closes the SDK runtime, and stops the gateway.

The SDK remains the Codex execution driver. Relay is a supervised sidecar and
hook forwarder; the adapter never invokes a `nemo-relay codex` wrapper. The
result reports the gateway config, URL, log, and collected Relay artifacts.

Fabric deliberately keeps Codex on its reserved built-in `openai` provider.
Defining Relay as a custom model-provider alias breaks the Python SDK's
ChatGPT-authenticated request path. Redirecting only `openai_base_url` preserves
the SDK's supported authentication and host metadata while allowing Relay to
capture Responses traffic. Fabric does not spoof the Codex CLI identity or fall
back to CLI execution. Relay routes and observes requests; it does not provide
OpenAI credentials or change the selected Codex authentication mode.

Relay-enabled runs require the external `nemo-relay` CLI in addition to the
Python package dependencies. Fabric accepts CLI versions `>=0.6.0,<0.7.0`.
Until the request-decoding fix is released, install the tested PR revision:
## Relay Integration

```bash
git clone https://github.com/NVIDIA/NeMo-Relay.git nemo-relay
git -C nemo-relay fetch origin pull/452/head
git -C nemo-relay checkout --detach 0b02e01ac10d7d678da28830feba0ebf6743a7c0
cargo install --locked --path nemo-relay/crates/cli
```

Removal of this temporary source installation is tracked in
[TODO.md](https://github.com/NVIDIA/NeMo-Fabric/blob/main/TODO.md#nemo-relay-06x-request-decoding-release).

The `nemo-relay` Python package does not install this executable. Refer to the
[NeMo Relay installation guide](https://docs.nvidia.com/nemo/relay/getting-started/installation)
for other supported installation methods.

Relay owns HTTP content decoding at the gateway boundary; Fabric does not
configure Codex request compression. The Relay `0.6.0-alpha.20260716` tag cannot
recover semantic fields from zstd-compressed SDK requests. Until a later `0.6.x`
release contains the fix, use the pinned
[NeMo Relay PR #452](https://github.com/NVIDIA/NeMo-Relay/pull/452) revision
above.

For Phoenix, native Codex OpenTelemetry targets the OTLP collector at
`http://localhost:4318/v1/traces` and provides low-level app-server spans.
Relay OpenInference provides the semantic chain, LLM, and tool hierarchy with
decoded prompt, response, and token attributes. Prefer Relay OpenInference for
agent-turn inspection.
Relay-enabled runs also require the external `nemo-relay` CLI. Refer to the
[NeMo Relay CLI](https://docs.nvidia.com/nemo/fabric/getting-started/install#nemo-relay-cli) install guide for instructions on installing the CLI tool.
Comment thread
dagardner-nv marked this conversation as resolved.
Resolved

39 changes: 39 additions & 0 deletions docs/getting-started/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,45 @@ For example, to install the Hermes Agent adapter:
pip install "nemo-fabric[adapters-hermes]"
```

### Install NeMo Relay

[NeMo Relay](https://docs.nvidia.com/nemo/relay) integration occurs in two
ways:

- [Python library](https://pypi.org/project/nemo-relay/)
- [NeMo Relay CLI](https://crates.io/crates/nemo-relay-cli)

The required integration depends on the agent harness chosen. Relay-enabled runs with
the Claude and Codex adapters require the [`nemo-relay` CLI](https://crates.io/crates/nemo-relay-cli).

#### NeMo Relay Python Library

The `relay` dependency extra installs a version of the NeMo Relay Python library known to be compatible with the
installed version of NeMo Fabric.

```bash
pip install "nemo-fabric[relay]"
```

#### NeMo Relay CLI

**Shell installation method (Linux and macOS):**

```bash
curl -fsSL https://raw.githubusercontent.com/NVIDIA/NeMo-Relay/main/install.sh | sh
```
Comment thread
dagardner-nv marked this conversation as resolved.
Resolved

**Windows PowerShell installation method:**

```powershell
irm https://raw.githubusercontent.com/NVIDIA/NeMo-Relay/main/install.ps1 | iex
```

**Cargo installation method (requires `cargo-binstall`):**

```bash
cargo binstall nemo-relay-cli
```

## Source Installation Method

Expand Down
3 changes: 3 additions & 0 deletions docs/sdk/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -507,3 +507,6 @@ the request, start a replacement runtime, fail the job, or escalate to a user.
If a harness reports capacity pressure, an adapter should surface it as a
structured error or event such as busy, rate limited, capacity exceeded, or
backpressure. The consumer decides whether to wait, retry, scale out, or fail.

## Next Steps
- Review the examples in the GitHub repo [`examples/`](https://github.com/NVIDIA/NeMo-Fabric/tree/main/examples).
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
7 changes: 5 additions & 2 deletions examples/notebooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ SPDX-License-Identifier: Apache-2.0
# Onboarding notebooks

A guided, hands-on tour of the NeMo Fabric Python SDK -- the fastest way to
learn how to configure, run, inspect, and vary an agent.
learn how to configure, run, inspect, and vary an agent. It's possible to run these workflows in Google Colab with no setup. Click here to open the notebooks in Google Colab [![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/NVIDIA/NeMo-Fabric/).
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved

| Notebook | What it covers |
| --- | --- |
Expand Down Expand Up @@ -56,4 +56,7 @@ traces write to `examples/notebooks/artifacts/`, while the variations notebook's
harness runs reuse the code-review example's builders and write under
`examples/code_review_agent/artifacts/`.

For the complete API, see the [Python SDK guide](../../docs/sdk/python.mdx).

## Next Steps
- Refer to the [Python SDK guide](../../docs/sdk/python.mdx): typed configuration, planning, diagnostics, requests, multi-turn runtimes, parallelism, results, and errors.
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
- Other examples in this repo [`examples/`](../README.md#more-workflows).
Comment thread
dagardner-nv marked this conversation as resolved.
Resolved
11 changes: 9 additions & 2 deletions pypi.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,25 @@ The adapter must be installed into the virtual environment that the harness is i

### Integrations

Harbor integration:
#### Harbor Integration

```bash
pip install "nemo-fabric[harbor]"
```

Relay integration:
#### Relay Integration

```bash
pip install "nemo-fabric[relay]"
```

This installs a version of [NeMo Relay](https://docs.nvidia.com/nemo/relay) Python library known to be compatible with the installed version of NeMo Fabric.

Some adapters, such as Claude and Codex, require the
[`nemo-relay` CLI](https://crates.io/crates/nemo-relay-cli) tool instead of the
NeMo Relay Python library. Refer to the
[NeMo Relay CLI](https://docs.nvidia.com/nemo/fabric/getting-started/install#nemo-relay-cli) install guide for instructions on installing the CLI tool.

### Python Versions

NeMo Fabric supports Python versions 3.11-3.14, however some of the integrations and adapters may have additional requirements. Specifically the Hermes adapter doesn't support Python 3.14 yet, and the Harbor integration requires Python 3.12 or later.
Expand Down