NRDK: Neural Radar Development Kit¶

GitHub issues

The Neural Radar Development Kit (NRDK) is an open-source and MIT-licensed Python library and framework for developing, training, and evaluating machine learning models on radar spectrum and multimodal sensor data.

Built around typed, high modular interfaces, the NRDK is designed to reduce the barrier of entry to learning on spectrum via out-of-the-box reference implementations for red-rover data and the I/Q-1M Dataset, while also providing an easy path towards customization and extensions for other radar and data collection systems.

nrdk

neural radar development kit core framework
> nrdk ...

cli tools for working with NRDK output conventions
grt

reference implementation for Towards Foundational Models for Single-Chip Radar
nrdk.tss

statistical testing for time series performance metrics

Setup¶

The NRDK is intended to be used as a library; we recommend installing it as a submodule:

As SubmoduleWith Rover SupportVia uv + pyproject.tomlFor Development

git submodule add git@github.com:RadarML/nrdk.git
uv pip install -e ./nrdk

git submodule add git@github.com:RadarML/nrdk.git
uv pip install -e ./nrdk[roverd]

[project]
dependencies = ["nrdk[roverd]"]

[tool.uv.extensions]
nrdk = { path = "./nrdk", editable = true }

git clone git@github.com:RadarML/nrdk.git
cd nrdk
uv sync --all-extras --frozen
uv run pre-commit install

Extras

The NRDK library also includes the following extras:

nrdk[roverd]: support for loading and processing data using the roverd format (i.e., as collected by the red-rover system).
nrdk[docs]: a mkdocs + mkdocs-material + mdocstrings-python documentation stack.
nrdk[dev]: linters, testing, pre-commit hooks, etc.

Development¶

After setting up nrdk for development (see above — don't forget to install the pre-commit hooks!), you can start contributing!

# Run all tests
uv run pytest --cov=src/nrdk --cov-report=html tests

# Build & serve documentation locally
uv run --extra docs mkdocs serve

Note that all code must pass our pre-commit hooks (ruff + pyright + pytest), which you can also run manually:

uv run pre-commit run --all-files

NRDK: Neural Radar Development Kit¶

Setup¶

Development¶

See Also¶