Skip to content

Latest commit

 

History

History
 
 

.devcontainer

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
cuda11.8-conda
cuda11.8-conda
 
 
cuda11.8-pip
cuda11.8-pip
 
 
cuda12.5-conda
cuda12.5-conda
 
 
cuda12.5-pip
cuda12.5-pip
 
 
Dockerfile
Dockerfile
 
 
README.md
README.md
 
 

README.md

RAFT Development Containers

This directory contains devcontainer configurations for using VSCode to develop in a container via the Remote Containers extension or GitHub Codespaces.

This container is a turnkey development environment for building and testing the RAFT C++ and Python libraries.

Table of Contents

Prerequisites

Host bind mounts

By default, the following directories are bind-mounted into the devcontainer:

  • ${repo}:/home/coder/cuvs
  • ${repo}/../.aws:/home/coder/.aws
  • ${repo}/../.local:/home/coder/.local
  • ${repo}/../.cache:/home/coder/.cache
  • ${repo}/../.conda:/home/coder/.conda
  • ${repo}/../.config:/home/coder/.config

This ensures caches, configurations, dependencies, and your commits are persisted on the host across container runs.

Launch a Dev Container

To launch a devcontainer from VSCode, open the RAFT repo and select the "Reopen in Container" button in the bottom right:

Alternatively, open the VSCode command palette (typically cmd/ctrl + shift + P) and run the "Rebuild and Reopen in Container" command.

Using the devcontainer

On startup, the devcontainer creates or updates the conda/pip environment using cuvs/dependencies.yaml.

The container includes convenience functions to clean, configure, and build the various RAFT components:

$ clean-cuvs-cpp # only cleans the C++ build dir
$ clean-pylibcuvs-python # only cleans the Python build dir
$ clean-cuvs # cleans both C++ and Python build dirs

$ configure-cuvs-cpp # only configures cuvs C++ lib

$ build-cuvs-cpp # only builds cuvs C++ lib
$ build-pylibcuvs-python # only builds cuvs Python lib
$ build-cuvs # builds both C++ and Python libs
  • The C++ build script is a small wrapper around cmake -S ~/cuvs/cpp -B ~/cuvs/cpp/build and cmake --build ~/cuvs/cpp/build
  • The Python build script is a small wrapper around pip install --editable ~/cuvs/cpp

Unlike build.sh, these convenience scripts don't install the libraries after building them. Instead, they automatically inject the correct arguments to build the C++ libraries from source and use their build dirs as package roots:

$ cmake -S ~/cuvs/cpp -B ~/cuvs/cpp/build
$ CMAKE_ARGS="-Dcuvs_ROOT=~/cuvs/cpp/build" \ # <-- this argument is automatic
  pip install -e ~/cuvs/cpp