-
Notifications
You must be signed in to change notification settings - Fork 18
chore: Add install guide #42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
AnuradhaKaruppiah
merged 3 commits into
NVIDIA:main
from
dagardner-nv:david-install-guide-mb
Jul 9, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| --- | ||
| title: "Install NeMo Fabric" | ||
| description: "Install guide." | ||
| --- | ||
| {/* SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 */} | ||
|
|
||
| # Install NeMo Fabric | ||
|
|
||
| ## Prerequisites: | ||
| - Rust and Cargo | ||
| - Python 3.11+ | ||
| - [uv](https://docs.astral.sh/uv/getting-started/installation/) | ||
| - `just` 1.50.0+ | ||
|
|
||
| ## Source Installation Method | ||
|
|
||
| 1. 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 | ||
| ``` | ||
|
|
||
| 2. Build the Rust core and Python libraries. | ||
| ```bash | ||
| just build-all | ||
| ``` | ||
|
|
||
| The above command will install only those dependencies that are strictly necessary for the build. | ||
| Alternately If you want to install all optional dependencies, you can run: | ||
|
|
||
| ```bash | ||
| uv sync --all-groups --all-extras | ||
| ``` | ||
|
|
||
| Then run the build command with the `no_uv=true` flag to avoid re-installing the dependencies: | ||
|
|
||
| ```bash | ||
| just build-all no_uv=true | ||
| ``` | ||
|
|
||
| ## Package Installation Method | ||
|
|
||
| Note: Fabric is currently not available on PyPI, as such for the time being wheels must first be built from source. | ||
|
|
||
| Build the wheels from source: | ||
|
|
||
| ```bash | ||
| just wheels | ||
| ``` | ||
|
|
||
| This will create wheel files in the `dist` directory. | ||
|
|
||
| ### Installing Fabric Runtime | ||
|
|
||
| This installs Fabric itself. | ||
|
|
||
| ```bash | ||
| uv pip install --find-links <path_to_dist_directory> nemo-fabric[runtime] | ||
| ``` | ||
|
|
||
| ### Installing the Fabric Adapters | ||
| This will install the Fabric adapter and it's dependencies, adapters intentionally have minimal dependencies, | ||
| and are intended to be installed in the same environment as the agent harness (which may or may not be the same environment as the Fabric runtime). | ||
|
|
||
| At time of writing, the following adapter packages are available: | ||
| * adapters-codex-cli | ||
| * adapters-hermes-cli | ||
| * adapters-hermes-sdk | ||
|
|
||
| ```bash | ||
| uv pip install --find-links <path_to_dist_directory> nemo-fabric[<adapter_name>] | ||
| ``` | ||
|
|
||
| For example, to install the Hermes SDK adapter: | ||
|
|
||
| ```bash | ||
| uv pip install --find-links <path_to_dist_directory> nemo-fabric[adapters-hermes-sdk] | ||
| ``` | ||
|
|
||
|
|
||
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.