NRDK: Neural Radar Development Kit¶

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
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 SupportDevelopment

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,grt]

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

Tip

If authenticating with a github token (i.e., https), translate all ssh://git@github.com authentication to https://github.com with

git config --global url."https://github.com/".insteadOf ssh://git@github.com/

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[grt]: extra dependencies for our GRT reference implementation, which uses a hydra-based configuration system.
nrdk[docs]: a mkdocs + mkdocs-material + mdocstrings-python documentation stack.
nrdk[dev]: linters, testing, pre-commit hooks, etc.

NRDK: Neural Radar Development Kit¶

Setup¶

See Also¶