diff --git a/README.md b/README.md index e86eafda2..428ab04a9 100755 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ -#
 cuVS: Vector Search on the GPU
+#
 cuVS: Vector Search and Clustering on the GPU
+ +### NOTE: cuVS is currently being + +## Contents +
+ +1. [Useful Resources](#useful-resources) +2. [What is cuVS?](#what-is-cuvs) +3. [Getting Started](#getting-started) +4. [Installing cuVS](#installing) +5. [Contributing](#contributing) +6. [References](#references) + +
+ +## Useful Resources + +- [cuVS Reference Documentation](https://docs.rapids.ai/api/cuvs/stable/): API Documentation. +- [cuVS Getting Started](./docs/source/quick_start.md): Getting started with RAFT. +- [Build and Install cuVS](./docs/source/build.md): Instructions for installing and building cuVS. +- [Example Notebooks](./notebooks): Example jupyer notebooks +- [RAPIDS Community](https://rapids.ai/community.html): Get help, contribute, and collaborate. +- [GitHub repository](https://github.com/rapidsai/cuvs): Download the cuVS source code. +- [Issue tracker](https://github.com/rapidsai/cuvs/issues): Report issues or request features. + +## What is cuVS? + +cuVS contains many algorithms for running approximate nearest neighbors and clustering on the GPU. + +## Getting Started + + + +## Installing cuVS + +## Contributing + +## References diff --git a/ci/build_python.sh b/ci/build_python.sh index a54c3dcaa..525d21c51 100755 --- a/ci/build_python.sh +++ b/ci/build_python.sh @@ -34,24 +34,3 @@ rapids-conda-retry mambabuild \ --no-test \ --channel "${CPP_CHANNEL}" \ conda/recipes/cuvs - - -# Build ann-bench for each cuda and python version -rapids-conda-retry mambabuild \ ---no-test \ ---channel "${CPP_CHANNEL}" \ ---channel "${RAPIDS_CONDA_BLD_OUTPUT_DIR}" \ -conda/recipes/cuda-ann-bench - -# Build ann-bench-cpu only in CUDA 11 jobs since it only depends on python -# version -RAPIDS_CUDA_MAJOR="${RAPIDS_CUDA_VERSION%%.*}" -if [[ ${RAPIDS_CUDA_MAJOR} == "11" ]]; then - rapids-conda-retry mambabuild \ - --no-test \ - --channel "${CPP_CHANNEL}" \ - --channel "${RAPIDS_CONDA_BLD_OUTPUT_DIR}" \ - conda/recipes/cuda-ann-bench-cpu -fi - -rapids-upload-conda-to-s3 python diff --git a/ci/build_wheel_cuvs.sh b/ci/build_wheel_cuvs.sh index 9d2f96996..b4765be38 100755 --- a/ci/build_wheel_cuvs.sh +++ b/ci/build_wheel_cuvs.sh @@ -1,9 +1,9 @@ #!/bin/bash -# Copyright (c) 2023, NVIDIA CORPORATION. +# Copyright (c) 2023-2024, NVIDIA CORPORATION. set -euo pipefail # Set up skbuild options. Enable sccache in skbuild config options export SKBUILD_CONFIGURE_OPTIONS="-DRAFT_BUILD_WHEELS=ON -DDETECT_CONDA_ENV=OFF -DFIND_RAFT_CPP=OFF" -ci/build_wheel.sh cuvs python/cuvs +#ci/build_wheel.sh cuvs python/cuvs diff --git a/ci/test_python.sh b/ci/test_python.sh index a65469928..9f0c9d6ee 100755 --- a/ci/test_python.sh +++ b/ci/test_python.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Copyright (c) 2022-2023, NVIDIA CORPORATION. +# Copyright (c) 2022-2024, NVIDIA CORPORATION. set -euo pipefail @@ -31,7 +31,7 @@ rapids-print-env rapids-mamba-retry install \ --channel "${CPP_CHANNEL}" \ --channel "${PYTHON_CHANNEL}" \ - libcuvs cuvs + libcuvs #cuvs rapids-logger "Check GPU usage" nvidia-smi @@ -40,17 +40,17 @@ EXITCODE=0 trap "EXITCODE=1" ERR set +e -rapids-logger "pytest cuvs" -pushd python/cuvs/cuvs -pytest \ - --cache-clear \ - --junitxml="${RAPIDS_TESTS_DIR}/junit-cuvs.xml" \ - --cov-config=../.coveragerc \ - --cov=cuvs \ - --cov-report=xml:"${RAPIDS_COVERAGE_DIR}/cuvs-coverage.xml" \ - --cov-report=term \ - test -popd +#rapids-logger "pytest cuvs" +#pushd python/cuvs/cuvs +#pytest \ +# --cache-clear \ +# --junitxml="${RAPIDS_TESTS_DIR}/junit-cuvs.xml" \ +# --cov-config=../.coveragerc \ +# --cov=cuvs \ +# --cov-report=xml:"${RAPIDS_COVERAGE_DIR}/cuvs-coverage.xml" \ +# --cov-report=term \ +# test +#popd rapids-logger "Test script exiting with value: $EXITCODE" exit ${EXITCODE} diff --git a/ci/test_wheel_cuvs.sh b/ci/test_wheel_cuvs.sh index 6b213d399..de7501915 100755 --- a/ci/test_wheel_cuvs.sh +++ b/ci/test_wheel_cuvs.sh @@ -1,5 +1,5 @@ #!/bin/bash -# Copyright (c) 2023, NVIDIA CORPORATION. +# Copyright (c) 2023-2024, NVIDIA CORPORATION. set -euo pipefail @@ -7,12 +7,12 @@ mkdir -p ./dist RAPIDS_PY_CUDA_SUFFIX="$(rapids-wheel-ctk-name-gen ${RAPIDS_CUDA_VERSION})" RAPIDS_PY_WHEEL_NAME="cuvs_${RAPIDS_PY_CUDA_SUFFIX}" rapids-download-wheels-from-s3 ./dist -# echo to expand wildcard before adding `[extra]` requires for pip -python -m pip install $(echo ./dist/cuvs*.whl)[test] - -# Run smoke tests for aarch64 pull requests -if [[ "$(arch)" == "aarch64" && "${RAPIDS_BUILD_TYPE}" == "pull-request" ]]; then - python ./ci/wheel_smoke_test_cuvs.py -else - python -m pytest ./python/cuvs/cuvs/test -fi +## echo to expand wildcard before adding `[extra]` requires for pip +#python -m pip install $(echo ./dist/cuvs*.whl)[test] +# +## Run smoke tests for aarch64 pull requests +#if [[ "$(arch)" == "aarch64" && "${RAPIDS_BUILD_TYPE}" == "pull-request" ]]; then +# python ./ci/wheel_smoke_test_cuvs.py +#else +# python -m pytest ./python/cuvs/cuvs/test +#fi diff --git a/docs/source/index.rst b/docs/source/index.rst index a161efb42..bf9790610 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,9 +1,5 @@ -cuVS: GPU-accelerated Vector Search -=================================== - -.. image:: ../../img/raft-tech-stack-vss.png - :width: 800 - :alt: cuVS Tech Stack +cuVS: Vector Search and Clustering on the GPU +============================================= Useful Resources ################ @@ -19,7 +15,7 @@ Useful Resources What is cuVS? ############# -cuVS is a library for vector search on the GPU. +cuVS is a library for vector search and clustering on the GPU. .. toctree:: :maxdepth: 1