Skip to content

Commit

Permalink
Adding cuVS notice to README and front page of docs. (#2224)
Browse files Browse the repository at this point in the history
Authors:
  - Corey J. Nolet (https://github.com/cjnolet)

Approvers:
  - Divye Gala (https://github.com/divyegala)

URL: #2224
  • Loading branch information
cjnolet authored Mar 14, 2024
1 parent 3e67a6c commit cb80657
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# <div align="left"><img src="https://rapids.ai/assets/images/rapids_logo.png" width="90px"/>&nbsp;RAFT: Reusable Accelerated Functions and Tools for Vector Search and More</div>

> [!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)



## Contents
<hr>

Expand Down Expand Up @@ -77,6 +81,8 @@ Projects that use the RAFT ANNS algorithms for accelerating vector search includ

Please see the example [Jupyter notebook](https://github.com/rapidsai/raft/blob/HEAD/notebooks/VectorSearch_QuestionRetrieval.ipynb) to get started RAFT for vector search in Python.



### Information Retrieval

RAFT contains a catalog of reusable primitives for composing algorithms that require fast neighborhood computations, such as
Expand Down
10 changes: 10 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@
"sphinx_copybutton"
]



breathe_default_project = "RAFT"
breathe_projects = {
"RAFT": "../../cpp/doxygen/_xml/",
Expand All @@ -65,6 +67,14 @@
copyright = "2023, NVIDIA Corporation"
author = "NVIDIA Corporation"

rst_prolog = """
.. attention::
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.
"""

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ RAPIDS RAFT: Reusable Accelerated Functions and Tools for Vector Search and More
:width: 800
:alt: RAFT Tech Stack


Useful Resources
################

Expand Down

0 comments on commit cb80657

Please sign in to comment.