From 801945fb1acfe4ca12b4d6dd30592f824166a389 Mon Sep 17 00:00:00 2001 From: Bradley Dice Date: Fri, 18 Oct 2024 12:33:14 -0500 Subject: [PATCH] Use dashes in cuvs-bench package name. (#417) This attempts to rename `cuvs_bench` to `cuvs-bench` and similarly for the CPU package. This follows from this thread: https://github.com/rapidsai/docker/pull/715#discussion_r1805232894 Authors: - Bradley Dice (https://github.com/bdice) Approvers: - James Lamb (https://github.com/jameslamb) - Dante Gama Dessavre (https://github.com/dantegd) URL: https://github.com/rapidsai/cuvs/pull/417 --- build.sh | 2 +- ci/build_python.sh | 8 ++++---- .../{cuvs_bench_cpu => cuvs-bench-cpu}/build.sh | 0 .../conda_build_config.yaml | 0 .../{cuvs_bench_cpu => cuvs-bench-cpu}/meta.yaml | 2 +- conda/recipes/{cuvs_bench => cuvs-bench}/build.sh | 0 .../conda_build_config.yaml | 0 conda/recipes/{cuvs_bench => cuvs-bench}/meta.yaml | 2 +- docs/source/cuvs_bench/index.rst | 12 ++++++------ 9 files changed, 13 insertions(+), 13 deletions(-) rename conda/recipes/{cuvs_bench_cpu => cuvs-bench-cpu}/build.sh (100%) rename conda/recipes/{cuvs_bench_cpu => cuvs-bench-cpu}/conda_build_config.yaml (100%) rename conda/recipes/{cuvs_bench_cpu => cuvs-bench-cpu}/meta.yaml (98%) rename conda/recipes/{cuvs_bench => cuvs-bench}/build.sh (100%) rename conda/recipes/{cuvs_bench => cuvs-bench}/conda_build_config.yaml (100%) rename conda/recipes/{cuvs_bench => cuvs-bench}/meta.yaml (99%) diff --git a/build.sh b/build.sh index b787d3a41..29e8fe7c6 100755 --- a/build.sh +++ b/build.sh @@ -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 diff --git a/ci/build_python.sh b/ci/build_python.sh index 7b0c639af..deb67e91c 100755 --- a/ci/build_python.sh +++ b/ci/build_python.sh @@ -31,14 +31,14 @@ 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 @@ -46,7 +46,7 @@ if [[ ${RAPIDS_CUDA_MAJOR} == "12" ]]; then --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 diff --git a/conda/recipes/cuvs_bench_cpu/build.sh b/conda/recipes/cuvs-bench-cpu/build.sh similarity index 100% rename from conda/recipes/cuvs_bench_cpu/build.sh rename to conda/recipes/cuvs-bench-cpu/build.sh diff --git a/conda/recipes/cuvs_bench_cpu/conda_build_config.yaml b/conda/recipes/cuvs-bench-cpu/conda_build_config.yaml similarity index 100% rename from conda/recipes/cuvs_bench_cpu/conda_build_config.yaml rename to conda/recipes/cuvs-bench-cpu/conda_build_config.yaml diff --git a/conda/recipes/cuvs_bench_cpu/meta.yaml b/conda/recipes/cuvs-bench-cpu/meta.yaml similarity index 98% rename from conda/recipes/cuvs_bench_cpu/meta.yaml rename to conda/recipes/cuvs-bench-cpu/meta.yaml index 95bea92ef..02c11346f 100644 --- a/conda/recipes/cuvs_bench_cpu/meta.yaml +++ b/conda/recipes/cuvs-bench-cpu/meta.yaml @@ -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 diff --git a/conda/recipes/cuvs_bench/build.sh b/conda/recipes/cuvs-bench/build.sh similarity index 100% rename from conda/recipes/cuvs_bench/build.sh rename to conda/recipes/cuvs-bench/build.sh diff --git a/conda/recipes/cuvs_bench/conda_build_config.yaml b/conda/recipes/cuvs-bench/conda_build_config.yaml similarity index 100% rename from conda/recipes/cuvs_bench/conda_build_config.yaml rename to conda/recipes/cuvs-bench/conda_build_config.yaml diff --git a/conda/recipes/cuvs_bench/meta.yaml b/conda/recipes/cuvs-bench/meta.yaml similarity index 99% rename from conda/recipes/cuvs_bench/meta.yaml rename to conda/recipes/cuvs-bench/meta.yaml index 67d66efce..3e81edc58 100644 --- a/conda/recipes/cuvs_bench/meta.yaml +++ b/conda/recipes/cuvs-bench/meta.yaml @@ -10,7 +10,7 @@ {% set date_string = environ['RAPIDS_DATE_STRING'] %} package: - name: cuvs_bench + name: cuvs-bench version: {{ version }} script: build.sh diff --git a/docs/source/cuvs_bench/index.rst b/docs/source/cuvs_bench/index.rst index 61ac622d2..81fb7537c 100644 --- a/docs/source/cuvs_bench/index.rst +++ b/docs/source/cuvs_bench/index.rst @@ -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 `_, meanwhile release (stable) versions are located in `NGC `_, starting with release 24.10. +Nightly images are located in `dockerhub `_, meanwhile release (stable) versions are located in `NGC `_, 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 `_ +- `cuVS bench images `_ - `cuVS bench with datasets preloaded images `_ - `cuVS bench CPU only images `_ @@ -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 @@ -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. \ No newline at end of file +`requires_gpu` : denotes whether an algorithm requires GPU to run.