diff --git a/docs_amd/conf.py b/docs_amd/conf.py index 424ca89b..c91cb36f 100644 --- a/docs_amd/conf.py +++ b/docs_amd/conf.py @@ -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", diff --git a/docs_amd/how-to/using-hipVS.rst b/docs_amd/how-to/using-hipVS.rst index 7e520e7e..27fa4a19 100644 --- a/docs_amd/how-to/using-hipVS.rst +++ b/docs_amd/how-to/using-hipVS.rst @@ -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 ===================== diff --git a/docs_amd/index.rst b/docs_amd/index.rst index 55a900de..89e0f2c4 100644 --- a/docs_amd/index.rst +++ b/docs_amd/index.rst @@ -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: @@ -31,7 +31,7 @@ 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 `/:doc:`HIP ` 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 `/:doc:`HIP ` 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: @@ -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 `_. +The hipVS code is open and hosted at `https://github.com/AMD-Ecosystem/hipVS `_. .. grid:: 2 :gutter: 3 @@ -69,6 +69,6 @@ The hipVS code is open and hosted at `https://github.com/ROCm-DS/hipVS ` -To contribute to the documentation refer to `Contributing to ROCm-DS `_. +To contribute to the documentation refer to `Contributing to AMD Data Science `_. You can find licensing information on the `Licensing `_ page. diff --git a/docs_amd/install/build.rst b/docs_amd/install/build.rst index b93deb64..f12cc6bb 100644 --- a/docs_amd/install/build.rst +++ b/docs_amd/install/build.rst @@ -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 .. _build-hipvs: @@ -31,7 +31,7 @@ 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 `_ 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 `_ 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. @@ -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 `_ + * - **\*** `hipMM `_ - 4.0.0 * - **\*** `hipCollections `_ - 0.4.0 - * - **\*** `hipRAFT `_ + * - **\*** `hipRAFT `_ - 1.0.0 * - **\*** `hipCUB `_ - Version that comes bundled with ROCm ≥ 7.2.3 @@ -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 `_. + ``*`` - If not found locally the CMake build system will attempt to download a compatible version using `ROCmDS-cmake `_. ``**`` - The ``OpenMP`` toolchain is automatically installed as part of the standard ROCm installation and is available under ``/opt/rocm-{version}/llvm``. @@ -163,7 +163,7 @@ Building and installing using build.sh A utility script ``/build.sh`` is provided and is the entry-point to building various components. -``build.sh`` uses `ROCmDS-cmake `_, which will automatically download any dependencies that are not already installed. +``build.sh`` uses `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. diff --git a/docs_amd/install/install.rst b/docs_amd/install/install.rst index f32e530e..2753c455 100644 --- a/docs_amd/install/install.rst +++ b/docs_amd/install/install.rst @@ -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 diff --git a/docs_amd/install/system-requirements.rst b/docs_amd/install/system-requirements.rst index 6279d32b..51629134 100644 --- a/docs_amd/install/system-requirements.rst +++ b/docs_amd/install/system-requirements.rst @@ -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: diff --git a/docs_amd/reference/reference-c.rst b/docs_amd/reference/reference-c.rst index a980291d..f74a2c94 100644 --- a/docs_amd/reference/reference-c.rst +++ b/docs_amd/reference/reference-c.rst @@ -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: diff --git a/docs_amd/reference/reference-cpp.rst b/docs_amd/reference/reference-cpp.rst index 9ba57f6f..2a44ed4b 100644 --- a/docs_amd/reference/reference-cpp.rst +++ b/docs_amd/reference/reference-cpp.rst @@ -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: diff --git a/docs_amd/reference/reference-python.rst b/docs_amd/reference/reference-python.rst index 43c0bb57..d3769096 100644 --- a/docs_amd/reference/reference-python.rst +++ b/docs_amd/reference/reference-python.rst @@ -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: diff --git a/docs_amd/sphinx/requirements.in b/docs_amd/sphinx/requirements.in index 58a9bb88..0bc1ca43 100644 --- a/docs_amd/sphinx/requirements.in +++ b/docs_amd/sphinx/requirements.in @@ -1,4 +1,4 @@ -rocm-docs-core==1.27.0 +rocm-docs-core==1.38.0 doxysphinx myst-parser sphinx-autoapi diff --git a/docs_amd/sphinx/requirements.txt b/docs_amd/sphinx/requirements.txt index f748347d..c1f58b11 100644 --- a/docs_amd/sphinx/requirements.txt +++ b/docs_amd/sphinx/requirements.txt @@ -1,25 +1,3 @@ -# MIT License -# -# Copyright (C) 2025 Advanced Micro Devices, Inc. All rights reserved. -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - # # This file is autogenerated by pip-compile with Python 3.12 # by the following command: @@ -30,32 +8,32 @@ accessible-pygments==0.0.5 # via pydata-sphinx-theme alabaster==1.0.0 # via sphinx -astroid==4.0.1 +astroid==4.1.2 # via sphinx-autoapi -asttokens==3.0.0 +asttokens==3.0.2 # via stack-data -attrs==25.4.0 +attrs==26.1.0 # via # jsonschema # jupyter-cache # referencing -babel==2.17.0 +babel==2.18.0 # via # pydata-sphinx-theme # sphinx -beautifulsoup4==4.14.2 +beautifulsoup4==4.15.0 # via pydata-sphinx-theme breathe==4.36.0 # via rocm-docs-core -certifi==2025.10.5 +certifi==2026.7.22 # via requests -cffi==2.0.0 +cffi==2.1.0 # via # cryptography # pynacl -charset-normalizer==3.4.4 +charset-normalizer==3.4.9 # via requests -click==8.3.0 +click==8.4.2 # via # click-log # doxysphinx @@ -65,13 +43,13 @@ click-log==0.4.0 # via doxysphinx comm==0.2.3 # via ipykernel -cryptography==46.0.3 +cryptography==49.0.0 # via pyjwt -debugpy==1.8.17 +debugpy==1.8.21 # via ipykernel -decorator==5.2.1 +decorator==5.3.1 # via ipython -docutils==0.21.2 +docutils==0.22.4 # via # myst-parser # pydata-sphinx-theme @@ -80,46 +58,46 @@ doxysphinx==3.3.14 # via -r requirements.in executing==2.2.1 # via stack-data -fastjsonschema==2.21.2 +fastjsonschema==2.22.1 # via # nbformat # rocm-docs-core gitdb==4.0.12 # via gitpython -gitpython==3.1.45 +gitpython==3.1.57 # via rocm-docs-core -greenlet==3.2.4 +greenlet==3.5.4 # via sqlalchemy -idna==3.11 +idna==3.18 # via requests -imagesize==1.4.1 +imagesize==2.0.0 # via sphinx -importlib-metadata==8.7.0 +importlib-metadata==9.0.0 # via # jupyter-cache # myst-nb -ipykernel==7.0.1 +ipykernel==7.3.0 # via myst-nb -ipython==9.6.0 +ipython==9.15.0 # via # ipykernel # myst-nb ipython-pygments-lexers==1.1.1 # via ipython -jedi==0.19.2 +jedi==0.20.0 # via ipython jinja2==3.1.6 # via # myst-parser # sphinx # sphinx-autoapi -jsonschema==4.25.1 +jsonschema==4.26.0 # via nbformat jsonschema-specifications==2025.9.1 # via jsonschema jupyter-cache==1.0.1 # via myst-nb -jupyter-client==8.6.3 +jupyter-client==8.9.1 # via # ipykernel # nbclient @@ -133,29 +111,29 @@ libsass==0.22.0 # via doxysphinx lxml==5.2.1 # via doxysphinx -markdown-it-py==3.0.0 +markdown-it-py==4.2.0 # via # mdit-py-plugins # myst-parser markupsafe==3.0.3 # via jinja2 -matplotlib-inline==0.2.1 +matplotlib-inline==0.2.2 # via # ipykernel # ipython -mdit-py-plugins==0.5.0 +mdit-py-plugins==0.6.1 # via myst-parser mdurl==0.1.2 # via markdown-it-py mpire==2.10.2 # via doxysphinx -myst-nb==1.3.0 +myst-nb==1.4.0 # via rocm-docs-core -myst-parser==4.0.1 +myst-parser==5.1.0 # via # -r requirements.in # myst-nb -nbclient==0.10.2 +nbclient==0.11.0 # via # jupyter-cache # myst-nb @@ -164,35 +142,38 @@ nbformat==5.10.4 # jupyter-cache # myst-nb # nbclient -nest-asyncio==1.6.0 +nest-asyncio2==1.7.2 # via ipykernel -packaging==25.0 +packaging==26.2 # via # ipykernel + # pydata-sphinx-theme # sphinx -parso==0.8.5 +parso==0.8.7 # via jedi pexpect==4.9.0 # via ipython -platformdirs==4.5.0 +platformdirs==4.11.0 # via jupyter-core -prompt-toolkit==3.0.52 +prompt-toolkit==3.0.53 # via ipython -psutil==7.1.1 - # via ipykernel +psutil==7.2.2 + # via + # ipykernel + # ipython ptyprocess==0.7.0 # via pexpect pure-eval==0.2.3 # via stack-data -pycparser==2.23 +pycparser==3.0 # via cffi -pydata-sphinx-theme==0.16.1 +pydata-sphinx-theme==0.15.4 # via # rocm-docs-core # sphinx-book-theme -pygithub==2.8.1 +pygithub==2.9.1 # via rocm-docs-core -pygments==2.19.2 +pygments==2.20.0 # via # accessible-pygments # ipython @@ -202,11 +183,11 @@ pygments==2.19.2 # sphinx pyjson5==1.6.9 # via doxysphinx -pyjwt[crypto]==2.10.1 +pyjwt[crypto]==2.13.0 # via pygithub -pynacl==1.6.0 +pynacl==1.6.2 # via pygithub -pyparsing==3.2.5 +pyparsing==3.3.2 # via doxysphinx python-dateutil==2.9.0.post0 # via jupyter-client @@ -226,27 +207,27 @@ referencing==0.37.0 # via # jsonschema # jsonschema-specifications -requests==2.32.5 +requests==2.34.2 # via # pygithub # sphinx -rocm-docs-core==1.27.0 +rocm-docs-core==1.38.0 # via -r requirements.in -roman-numerals-py==3.1.0 +roman-numerals==4.1.0 # via sphinx -rpds-py==0.28.0 +rpds-py==2026.6.3 # via # jsonschema # referencing six==1.17.0 # via python-dateutil -smmap==5.0.2 +smmap==5.0.3 # via gitdb -snowballstemmer==3.0.1 +snowballstemmer==3.1.1 # via sphinx -soupsieve==2.8 +soupsieve==2.9.1 # via beautifulsoup4 -sphinx==8.2.3 +sphinx==9.1.0 # via # breathe # myst-nb @@ -258,17 +239,20 @@ sphinx==8.2.3 # sphinx-copybutton # sphinx-design # sphinx-external-toc + # sphinx-multitoc-numbering # sphinx-notfound-page -sphinx-autoapi==3.6.1 +sphinx-autoapi==3.8.0 # via -r requirements.in -sphinx-book-theme==1.1.3 +sphinx-book-theme==1.1.4 # via rocm-docs-core sphinx-copybutton==0.5.2 # via rocm-docs-core -sphinx-design==0.6.1 +sphinx-design==0.7.0 # via rocm-docs-core -sphinx-external-toc==1.0.1 +sphinx-external-toc==1.1.0 # via rocm-docs-core +sphinx-multitoc-numbering==0.1.3 + # via sphinx-external-toc sphinx-notfound-page==1.1.0 # via rocm-docs-core sphinxcontrib-applehelp==2.0.0 @@ -283,19 +267,19 @@ sphinxcontrib-qthelp==2.0.0 # via sphinx sphinxcontrib-serializinghtml==2.0.0 # via sphinx -sqlalchemy==2.0.44 +sqlalchemy==2.0.51 # via jupyter-cache stack-data==0.6.3 # via ipython -tabulate==0.9.0 +tabulate==0.10.0 # via jupyter-cache -tornado==6.5.2 +tornado==6.5.7 # via # ipykernel # jupyter-client -tqdm==4.67.1 +tqdm==4.70.0 # via mpire -traitlets==5.14.3 +traitlets==5.15.1 # via # ipykernel # ipython @@ -304,19 +288,20 @@ traitlets==5.14.3 # matplotlib-inline # nbclient # nbformat -typing-extensions==4.15.0 +typing-extensions==4.16.0 # via # beautifulsoup4 + # jupyter-client # myst-nb # pydata-sphinx-theme # pygithub # referencing # sqlalchemy -urllib3==2.5.0 +urllib3==2.7.0 # via # pygithub # requests -wcwidth==0.2.14 +wcwidth==0.8.2 # via prompt-toolkit -zipp==3.23.0 +zipp==4.1.0 # via importlib-metadata