Getting Started

Prerequisites

View as Markdown

Install the tooling for the binding you plan to use.

DependencyVersionRequired For
Rust1.86 or newerRust builds, local workspace builds, and the Rust core runtime
Python3.11 or newerPython bindings, Python tests, and docs tooling
Node.js24 or newerNode.js bindings and generated Node.js API docs
uvsee Development SetupPython environments, docs builds, and repository setup
justsee Development SetupRepository development, test, build, and docs task aliases

The primary documentation track covers Rust, Python, and Node.js. Go, WebAssembly, and the raw FFI surface are experimental and source-first.

Repository Setup

Clone the repository when you need local source builds or contribution workflows:

$git clone https://github.com/NVIDIA/NeMo-Relay.git
$cd NeMo-Relay

Install development dependencies for Python and docs workflows:

$uv sync

Install Node.js dependencies when you need Node.js builds or generated Node.js API documentation:

$npm install --ignore-scripts