From f5ef451ca93e9466b019b7ab1a0e2c103af321d1 Mon Sep 17 00:00:00 2001 From: "Corey J. Nolet" Date: Wed, 13 Mar 2024 19:25:06 -0400 Subject: [PATCH] Adding cuVS note to more places in docs --- README.md | 2 +- docs/source/cpp_api/cluster.rst | 5 +++++ docs/source/cpp_api/neighbors.rst | 5 +++++ docs/source/index.rst | 5 ++--- docs/source/pylibraft_api/cluster.rst | 5 +++++ docs/source/pylibraft_api/neighbors.rst | 5 +++++ 6 files changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3db4f412c0..7833a5cfa3 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ #
 RAFT: Reusable Accelerated Functions and Tools for Vector Search and More
-> [!NOTE] +> [!IMPORTANT] > The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called [cuVS](https://github.com/rapidsai/cuvs). We will continue to support the vector search algorithms in RAFT during this move, but will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.08 (August) release. ![RAFT tech stack](img/raft-tech-stack-vss.png) diff --git a/docs/source/cpp_api/cluster.rst b/docs/source/cpp_api/cluster.rst index b0485992b3..e32760afcd 100644 --- a/docs/source/cpp_api/cluster.rst +++ b/docs/source/cpp_api/cluster.rst @@ -4,6 +4,11 @@ Cluster This page provides C++ API references for the publicly-exposed elements of the `raft/cluster` headers. RAFT provides fundamental clustering algorithms which are, themselves, considered reusable building blocks for other algorithms. +.. note:: + + The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called `cuVS `_. We will continue to support the vector search algorithms in RAFT during this move, will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.08 (August) release. + + .. role:: py(code) :language: c++ :class: highlight diff --git a/docs/source/cpp_api/neighbors.rst b/docs/source/cpp_api/neighbors.rst index 876f68b1bf..2fce8a3184 100644 --- a/docs/source/cpp_api/neighbors.rst +++ b/docs/source/cpp_api/neighbors.rst @@ -3,6 +3,11 @@ Neighbors This page provides C++ class references for the publicly-exposed elements of the neighbors package. +.. note:: + + The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called `cuVS `_. We will continue to support the vector search algorithms in RAFT during this move, will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.08 (August) release. + + .. role:: py(code) :language: c++ :class: highlight diff --git a/docs/source/index.rst b/docs/source/index.rst index 51ab2f113c..4934aab99c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,10 +1,9 @@ RAPIDS RAFT: Reusable Accelerated Functions and Tools for Vector Search and More ================================================================================ -.. raw:: html - - NOTICE: The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called cuVS. We will continue to support the vector search algorithms in RAFT during this move, will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.08 (August) release. +.. note:: + The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called `cuVS `_. We will continue to support the vector search algorithms in RAFT during this move, will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.08 (August) release. .. image:: ../../img/raft-tech-stack-vss.png :width: 800 diff --git a/docs/source/pylibraft_api/cluster.rst b/docs/source/pylibraft_api/cluster.rst index 085297fe34..4e57c841f0 100644 --- a/docs/source/pylibraft_api/cluster.rst +++ b/docs/source/pylibraft_api/cluster.rst @@ -3,6 +3,11 @@ Cluster This page provides pylibraft class references for the publicly-exposed elements of the `pylibraft.cluster` package. +.. note:: + + The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called `cuVS `_. We will continue to support the vector search algorithms in RAFT during this move, will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.08 (August) release. + + .. role:: py(code) :language: python :class: highlight diff --git a/docs/source/pylibraft_api/neighbors.rst b/docs/source/pylibraft_api/neighbors.rst index e9e890fccb..2eb8df5df2 100644 --- a/docs/source/pylibraft_api/neighbors.rst +++ b/docs/source/pylibraft_api/neighbors.rst @@ -3,6 +3,11 @@ Neighbors This page provides pylibraft class references for the publicly-exposed elements of the neighbors package. +.. note:: + + The vector search and clustering algorithms in RAFT are being migrated to a new library dedicated to vector search called `cuVS `_. We will continue to support the vector search algorithms in RAFT during this move, will no longer update them after the RAPIDS 24.06 (June) release. We plan to complete the migration by RAPIDS 24.08 (August) release. + + .. role:: py(code) :language: python :class: highlight