Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs_amd/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"docs_header_version": "26.03"
}
html_theme = "rocm_docs_theme"
html_theme_options = {"flavor": "rocm-ds", "repository_url": "https://github.com/ROCm-DS/hipVS/"}
html_theme_options = {"flavor": "rocm-ds", "repository_url": "https://github.com/AMD-Ecosystem/hipVS/"}

extensions = [
"rocm_docs",
Expand Down
2 changes: 1 addition & 1 deletion docs_amd/how-to/using-hipVS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

.. meta::
:description: hipVS documentation and API reference library
:keywords: Machine-Learning, Vector Search, Primitives,GPU, RAPIDS, ROCm-DS
:keywords: Machine-Learning, Vector Search, Primitives,GPU, RAPIDS, AMD Data Science

Using hipVS examples
=====================
Expand Down
8 changes: 4 additions & 4 deletions docs_amd/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@

.. meta::
:description: hipVS documentation and API reference library
:keywords: Nearest-Neighbors, Information-Retrieval, Similarity-Search, GPU, Distance, RAPIDS, ROCm-DS
:keywords: Nearest-Neighbors, Information-Retrieval, Similarity-Search, GPU, Distance, RAPIDS, AMD Data Science

.. _hipvs:

********************************************************************
hipVS documentation
********************************************************************

hipVS is a GPU-accelerated vector search library for AMD GPUs, enabling high-performance approximate and exact nearest-neighbor (ANN) search and clustering workloads. It is part of the AMD ROCm™ Data Science toolkit (ROCm-DS), an open-source software collection for high-performance data science applications. Forked from the RAPIDS® cuVS project and aligned with RAPIDS 25.10, hipVS brings state-of-the-art vector similarity capabilities to the :doc:`ROCm <rocm:index>`/:doc:`HIP <hip:index>` software stack and AMD platforms. It is designed to minimize porting friction for users familiar with cuVS by maintaining consistent directory structure, file organization, and API naming. For more information, see :doc:`What is hipVS? <./what-is-hipVS>`
hipVS is a GPU-accelerated vector search library for AMD GPUs, enabling high-performance approximate and exact nearest-neighbor (ANN) search and clustering workloads. It is part of the AMD Data Science toolkit, an open-source software collection for high-performance data science applications. Forked from the RAPIDS® cuVS project and aligned with RAPIDS 25.10, hipVS brings state-of-the-art vector similarity capabilities to the :doc:`ROCm <rocm:index>`/:doc:`HIP <hip:index>` software stack and AMD platforms. It is designed to minimize porting friction for users familiar with cuVS by maintaining consistent directory structure, file organization, and API naming. For more information, see :doc:`What is hipVS? <./what-is-hipVS>`

Key Features in hipVS v1.0.0:

Expand All @@ -46,7 +46,7 @@ Key Features in hipVS v1.0.0:
* Optimized GPU performance for fast index building, low-latency queries, and high-throughput search.
* Interoperability with other ROCm-DS components such as hipRAFT, hipDF, and hipGRAPH for end-to-end data-science and AI pipelines.

The hipVS code is open and hosted at `https://github.com/ROCm-DS/hipVS <https://github.com/ROCm-DS/hipVS>`_.
The hipVS code is open and hosted at `https://github.com/AMD-Ecosystem/hipVS <https://github.com/AMD-Ecosystem/hipVS>`_.

.. grid:: 2
:gutter: 3
Expand All @@ -69,6 +69,6 @@ The hipVS code is open and hosted at `https://github.com/ROCm-DS/hipVS <https://
* :ref:`Rust API reference <hipvs-rust>`


To contribute to the documentation refer to `Contributing to ROCm-DS <https://rocm.docs.amd.com/projects/rocm-ds/en/latest/contribute/contributing.html>`_.
To contribute to the documentation refer to `Contributing to AMD Data Science <https://rocm.docs.amd.com/projects/rocm-ds/en/latest/contribute/contributing.html>`_.

You can find licensing information on the `Licensing <https://rocm.docs.amd.com/projects/rocm-ds/en/latest/about/license.html>`_ page.
12 changes: 6 additions & 6 deletions docs_amd/install/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@

.. meta::
:description: hipVS documentation and API reference library
:keywords: Machine-Learning, Vector Search, Primitives,GPU, RAPIDS, ROCm-DS
:keywords: Machine-Learning, Vector Search, Primitives,GPU, RAPIDS, AMD Data Science

.. _build-hipvs:

**************************
Building hipVS from source
**************************

hipVS currently provides C++, C, Python and Rust APIs. The following instructions provide steps to build and test hipVS from source files provided in the `https://github.com/ROCm-DS/hipVS <https://github.com/ROCm-DS/hipVS>`_ repository. To install hipVS for end users, see :doc:`Installing hipVS <./install>`.
hipVS currently provides C++, C, Python and Rust APIs. The following instructions provide steps to build and test hipVS from source files provided in the `https://github.com/AMD-Ecosystem/hipVS <https://github.com/AMD-Ecosystem/hipVS>`_ repository. To install hipVS for end users, see :doc:`Installing hipVS <./install>`.

See :ref:`sys-req` for information regarding supported operating systems, ROCm versions,
and AMD GPUs before building and installing hipVS.
Expand Down Expand Up @@ -72,11 +72,11 @@ hipVS builds against the AMD ROCm software stack, that is, the ROCm runtime, HIP
- Tested with 0.3.26
* - **Additional Required Dependencies**
-
* - **\*** `hipMM <https://github.com/ROCm-DS/hipMM>`_
* - **\*** `hipMM <https://github.com/AMD-Ecosystem/hipMM>`_
- 4.0.0
* - **\*** `hipCollections <https://github.com/ROCm/hipCollections>`_
- 0.4.0
* - **\*** `hipRAFT <https://github.com/ROCm-DS/hipRAFT>`_
* - **\*** `hipRAFT <https://github.com/AMD-Ecosystem/hipRAFT>`_
- 1.0.0
* - **\*** `hipCUB <https://github.com/ROCm/hipCUB>`_
- Version that comes bundled with ROCm ≥ 7.2.3
Expand All @@ -99,7 +99,7 @@ hipVS builds against the AMD ROCm software stack, that is, the ROCm runtime, HIP

.. note::

``*`` - If not found locally the CMake build system will attempt to download a compatible version using `ROCmDS-cmake <https://github.com/ROCm-DS/ROCmDS-cmake>`_.
``*`` - If not found locally the CMake build system will attempt to download a compatible version using `ROCmDS-cmake <https://github.com/AMD-Ecosystem/ROCmDS-cmake>`_.

``**`` - The ``OpenMP`` toolchain is automatically installed as part of the standard ROCm installation and is available under ``/opt/rocm-{version}/llvm``.

Expand Down Expand Up @@ -163,7 +163,7 @@ Building and installing using build.sh

A utility script ``<HIPVS_ROOT>/build.sh`` is provided and is the entry-point to building various components.

``build.sh`` uses `ROCmDS-cmake <https://github.com/ROCm-DS/ROCmDS-cmake>`_, which will automatically download any dependencies that are not already installed.
``build.sh`` uses `ROCmDS-cmake <https://github.com/AMD-Ecosystem/ROCmDS-cmake>`_, which will automatically download any dependencies that are not already installed.

The following will download the required dependencies, build and install the hipVS CMake package to the configured CMake install prefix.

Expand Down
2 changes: 1 addition & 1 deletion docs_amd/install/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

.. meta::
:description: hipVS documentation and API reference library
:keywords: Machine-Learning, Vector Search, Primitives,GPU, RAPIDS, ROCm-DS
:keywords: Machine-Learning, Vector Search, Primitives,GPU, RAPIDS, AMD Data Science

****************
Installing hipVS
Expand Down
2 changes: 1 addition & 1 deletion docs_amd/install/system-requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

.. meta::
:description: hipVS documentation and API reference library
:keywords: Nearest-Neighbors, Information-Retrieval, Similarity-Search, GPU, Distance, RAPIDS, ROCm-DS
:keywords: Nearest-Neighbors, Information-Retrieval, Similarity-Search, GPU, Distance, RAPIDS, AMD Data Science

.. _sys-req:

Expand Down
2 changes: 1 addition & 1 deletion docs_amd/reference/reference-c.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. meta::
:description: hipVS documentation and API reference library
:keywords: Nearest-Neighbors, Information-Retrieval, Similarity-Search, GPU, Distance, RAPIDS, ROCm-DS
:keywords: Nearest-Neighbors, Information-Retrieval, Similarity-Search, GPU, Distance, RAPIDS, AMD Data Science

.. _hipvs-c:

Expand Down
2 changes: 1 addition & 1 deletion docs_amd/reference/reference-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

.. meta::
:description: hipVS documentation and API reference library
:keywords: Nearest-Neighbors, Information-Retrieval, Similarity-Search, GPU, Distance, RAPIDS, ROCm-DS
:keywords: Nearest-Neighbors, Information-Retrieval, Similarity-Search, GPU, Distance, RAPIDS, AMD Data Science

.. _hipvs-cpp:

Expand Down
2 changes: 1 addition & 1 deletion docs_amd/reference/reference-python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

.. meta::
:description: hipVS documentation and API reference library
:keywords: Nearest-Neighbors, Information-Retrieval, Similarity-Search, GPU, Distance, RAPIDS, ROCm-DS
:keywords: Nearest-Neighbors, Information-Retrieval, Similarity-Search, GPU, Distance, RAPIDS, AMD Data Science

.. _hipvs-python:

Expand Down
2 changes: 1 addition & 1 deletion docs_amd/sphinx/requirements.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
rocm-docs-core==1.27.0
rocm-docs-core==1.38.0
doxysphinx
myst-parser
sphinx-autoapi
Loading
Loading