Skip to content

Commit

Permalink
Use dashes in cuvs-bench package name. (#417)
Browse files Browse the repository at this point in the history
This attempts to rename `cuvs_bench` to `cuvs-bench` and similarly for the CPU package. This follows from this thread: rapidsai/docker#715 (comment)

Authors:
  - Bradley Dice (https://github.com/bdice)

Approvers:
  - James Lamb (https://github.com/jameslamb)
  - Dante Gama Dessavre (https://github.com/dantegd)

URL: #417
  • Loading branch information
bdice authored Oct 18, 2024
1 parent f708fe3 commit 801945f
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ if (( ${NUMARGS} == 0 )) || hasArg python; then
python -m pip install --no-build-isolation --no-deps --config-settings rapidsai.disable-cuda=true ${REPODIR}/python/cuvs
fi

# Build and (optionally) install the cuvs_bench Python package
# Build and (optionally) install the cuvs-bench Python package
if (( ${NUMARGS} == 0 )) || hasArg bench-ann; then
python -m pip install --no-build-isolation --no-deps --config-settings rapidsai.disable-cuda=true ${REPODIR}/python/cuvs_bench
fi
Expand Down
8 changes: 4 additions & 4 deletions ci/build_python.sh
Original file line number Diff line number Diff line change
Expand Up @@ -31,22 +31,22 @@ rapids-conda-retry mambabuild \
--channel "${CPP_CHANNEL}" \
conda/recipes/cuvs

# Build cuvs_bench for each cuda and python version
# Build cuvs-bench for each cuda and python version
rapids-conda-retry mambabuild \
--no-test \
--channel "${CPP_CHANNEL}" \
--channel "${RAPIDS_CONDA_BLD_OUTPUT_DIR}" \
conda/recipes/cuvs_bench
conda/recipes/cuvs-bench

# Build cuvs_bench_cpu only in CUDA 12 jobs since it only depends on python
# Build cuvs-bench-cpu only in CUDA 12 jobs since it only depends on python
# version
RAPIDS_CUDA_MAJOR="${RAPIDS_CUDA_VERSION%%.*}"
if [[ ${RAPIDS_CUDA_MAJOR} == "12" ]]; then
rapids-conda-retry mambabuild \
--no-test \
--channel "${CPP_CHANNEL}" \
--channel "${RAPIDS_CONDA_BLD_OUTPUT_DIR}" \
conda/recipes/cuvs_bench_cpu
conda/recipes/cuvs-bench-cpu
fi

rapids-upload-conda-to-s3 python
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
{% set date_string = environ['RAPIDS_DATE_STRING'] %}

package:
name: cuvs_bench_cpu
name: cuvs-bench-cpu
version: {{ version }}
script: build.sh

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
{% set date_string = environ['RAPIDS_DATE_STRING'] %}

package:
name: cuvs_bench
name: cuvs-bench
version: {{ version }}
script: build.sh

Expand Down
12 changes: 6 additions & 6 deletions docs/source/cuvs_bench/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,20 +93,20 @@ We provide images for GPU enabled systems, as well as systems without a GPU. The
- `cuvs-bench-datasets`: Contains the GPU and CPU benchmarks with million-scale datasets already included in the container. Best suited for users that want to run multiple million scale datasets already included in the image.
- `cuvs-bench-cpu`: Contains only CPU benchmarks with minimal size. Best suited for users that want the smallest containers to reproduce benchmarks on systems without a GPU.

Nightly images are located in `dockerhub <https://hub.docker.com/r/rapidsai/cuvs-ann-bench/tags>`_, meanwhile release (stable) versions are located in `NGC <https://hub.docker.com/r/rapidsai/cuvs_bench>`_, starting with release 24.10.
Nightly images are located in `dockerhub <https://hub.docker.com/r/rapidsai/cuvs-bench/tags>`_, meanwhile release (stable) versions are located in `NGC <https://hub.docker.com/r/rapidsai/cuvs-bench>`_, starting with release 24.10.

The following command pulls the nightly container for python version 10, cuda version 12, and CUVS version 23.10:
The following command pulls the nightly container for Python version 3.10, CUDA version 12.0, and cuVS version 24.10:

.. code-block:: bash
docker pull rapidsai/cuvs_bench:24.10a-cuda12.0-py3.10 #substitute cuvs_bench for the exact desired container.
docker pull rapidsai/cuvs-bench:24.10a-cuda12.0-py3.10 #substitute cuvs-bench for the exact desired container.
The CUDA and python versions can be changed for the supported values:
- Supported CUDA versions: 11.4 and 12.x
- Supported Python versions: 3.9 and 3.10.

You can see the exact versions as well in the dockerhub site:
- `cuVS bench images <https://hub.docker.com/r/rapidsai/cuvs_bench/tags>`_
- `cuVS bench images <https://hub.docker.com/r/rapidsai/cuvs-bench/tags>`_
- `cuVS bench with datasets preloaded images <https://hub.docker.com/r/rapidsai/cuvs-bench-cpu/tags>`_
- `cuVS bench CPU only images <https://hub.docker.com/r/rapidsai/cuvs-bench-datasets/tags>`_

Expand Down Expand Up @@ -583,7 +583,7 @@ A default `datasets.yaml` is provided by CUVS in `${CUVS_HOME}/python/cuvs-ann-b
dims: 128
distance: euclidean
Configuration files for ANN algorithms supported by `cuvs-bench` are provided in `${CUVS_HOME}/python/cuvs-bench/src/cuvs_bench/run/conf`. `cuvs_cagra` algorithm configuration looks like:
Configuration files for ANN algorithms supported by `cuvs-bench` are provided in `${CUVS_HOME}/python/cuvs_bench/cuvs_bench/config/algos`. `cuvs_cagra` algorithm configuration looks like:
.. code-block:: yaml
Expand Down Expand Up @@ -767,4 +767,4 @@ Add a new entry to `algos.yaml` to map the name of the algorithm to its binary e
requires_gpu: true
`executable` : specifies the name of the binary that will build/search the index. It is assumed to be available in `cuvs/cpp/build/`.
`requires_gpu` : denotes whether an algorithm requires GPU to run.
`requires_gpu` : denotes whether an algorithm requires GPU to run.

0 comments on commit 801945f

Please sign in to comment.