Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CAGRA C example and DlPack docs #51

Merged
merged 55 commits into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
e851903
Getting a start on the docs
cjnolet Mar 7, 2024
73fa0c8
Progress
cjnolet Mar 7, 2024
8e48382
Getting CAGRA C++ docs to build
cjnolet Mar 7, 2024
ca465e6
Updating
cjnolet Mar 8, 2024
58743b5
Checking in
cjnolet Mar 8, 2024
d2dd4cc
New docs
cjnolet Mar 8, 2024
19319d7
Updating build.sh to build the examples
cjnolet Mar 8, 2024
f8c1015
Merge branch 'branch-24.04' into docs_2404-api_docs
cjnolet Mar 8, 2024
358df75
Fixing docs per review
cjnolet Mar 8, 2024
e6bff2b
Merge branch 'docs_2404-api_docs' of github.com:rapidsai/cuvs into do…
cjnolet Mar 8, 2024
5ac765f
Merge branch 'branch-24.04' into docs_2404-api_docs
cjnolet Mar 8, 2024
64d594b
Removing developer guide. That's unneeded int the docs
cjnolet Mar 8, 2024
620e080
Stubbing out quick start guide
cjnolet Mar 8, 2024
f1f671f
Adding quick start
cjnolet Mar 11, 2024
31d014c
Checking in
cjnolet Mar 12, 2024
f69e86e
Renaming quick_start to getting started
cjnolet Mar 12, 2024
0afe86b
Removing osexamples
cjnolet Mar 12, 2024
929e9b4
Fixing package issuey
cjnolet Mar 12, 2024
77e1cbe
Breaking apart getting started guide
cjnolet Mar 12, 2024
3a79601
MOre updates
cjnolet Mar 12, 2024
c9a50fe
Merge remote-tracking branch 'origin/branch-24.04' into docs_2404-api…
cjnolet Mar 12, 2024
86ad684
Dlpack docs
divyegala Mar 12, 2024
9e33a72
fix typo
divyegala Mar 12, 2024
935e0fc
Merge remote-tracking branch 'origin/branch-24.04' into docs_2404-api…
cjnolet Mar 12, 2024
ba7c1a7
Adding integrations page
cjnolet Mar 12, 2024
e2b083e
Merge branch 'docs_2404-api_docs' into dlpack-docs
cjnolet Mar 12, 2024
d2f7c2a
more info
divyegala Mar 13, 2024
e33d666
merging upstream
divyegala Mar 13, 2024
aef7e1d
merge origin
divyegala Mar 13, 2024
921421f
fix bad merge
divyegala Mar 13, 2024
1336fab
more bad merge fix
divyegala Mar 13, 2024
e7a4e18
bad merge
divyegala Mar 13, 2024
6ef65c9
bad merge
divyegala Mar 13, 2024
3fa2840
bad merge
divyegala Mar 13, 2024
7b396ca
bad merge
divyegala Mar 13, 2024
3dcfd21
bad merge
divyegala Mar 13, 2024
b106d3c
bad merge
divyegala Mar 13, 2024
f98839c
hopefully final bad merge
divyegala Mar 13, 2024
2006650
add c example
divyegala Mar 13, 2024
a7d52f9
restructure examples
divyegala Mar 14, 2024
4ca00b6
Update docs/source/interoperability.rst
divyegala Mar 14, 2024
504ce4a
Merge branch 'branch-24.04' into dlpack-docs
cjnolet Mar 14, 2024
36d8520
add get_dlpack.cmake
divyegala Mar 15, 2024
b50ffbe
dlpack headers include
divyegala Mar 15, 2024
de155b9
Replace local copyright check with pre-commit-hooks verify-copyright …
KyleFromNVIDIA Mar 18, 2024
be206d8
Remove unused get_*.cmake files. (#57)
bdice Mar 19, 2024
2b18f49
Add ability to allocate with RMM to the c-api and rust api (#56)
benfred Mar 19, 2024
eb7c496
use cuvsRMMAlloc/cuvsRMMFree
divyegala Mar 20, 2024
3d52f91
Merge branch 'branch-24.04' into dlpack-docs
divyegala Mar 20, 2024
d0c5287
Merge branch 'branch-24.04' into dlpack-docs
divyegala Mar 21, 2024
f1d1527
Merge branch 'branch-24.04' into dlpack-docs
divyegala Mar 21, 2024
531c667
Merge branch 'branch-24.04' into dlpack-docs
cjnolet Apr 2, 2024
12362b1
Apply suggestions from code review
divyegala Apr 2, 2024
8626c15
cuvs docs
divyegala Apr 2, 2024
80b50f5
address review
divyegala Apr 2, 2024
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
Prev Previous commit
Next Next commit
merging upstream
  • Loading branch information
divyegala committed Mar 13, 2024
commit e33d666a0a14de1e51e8c1ad01ceba2cfdf87d66
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ _xml
# sphinx
_html
_text
docs/source/_static/rust

# clang tooling
compile_commands.json
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@

## 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
- [Code Examples](https://github.com/rapidsai/cuvs/tree/HEAD/examples): Self-contained Code Examples.
- [API Reference Documentation](https://docs.rapids.ai/api/cuvs/nightly/api_docs): API Documentation.
- [Getting Started Guide](https://docs.rapids.ai/api/cuvs/nightly/getting_started): Getting started with RAFT.
- [Build and Install Guide](https://docs.rapids.ai/api/cuvs/nightly/build): Instructions for installing and building cuVS.
- [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.
Expand Down
6 changes: 5 additions & 1 deletion conda/environments/all_cuda-118_arch-aarch64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ channels:
dependencies:
- breathe
- c-compiler
- clang
- clang-tools=16.0.6
- clang==16.0.6
- cmake>=3.26.4
Expand All @@ -27,6 +28,7 @@ dependencies:
- graphviz
- gtest>=1.13.0
- ipython
- libclang
- libcublas-dev=11.11.3.6
- libcublas=11.11.3.6
- libcurand-dev=10.3.0.86
Expand All @@ -35,9 +37,10 @@ dependencies:
- libcusolver=11.4.1.48
- libcusparse-dev=11.7.5.86
- libcusparse=11.7.5.86
- make
- nccl>=2.9.9
- ninja
- numpy>=1.23
- numpy>=1.23,<2.0a0
- numpydoc
- nvcc_linux-aarch64=11.8
- pre-commit
Expand All @@ -47,6 +50,7 @@ dependencies:
- pytest==7.*
- recommonmark
- rmm==24.4.*
- rust
- scikit-build-core>=0.7.0
- scikit-learn
- sphinx-copybutton
Expand Down
6 changes: 5 additions & 1 deletion conda/environments/all_cuda-118_arch-x86_64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ channels:
dependencies:
- breathe
- c-compiler
- clang
- clang-tools=16.0.6
- clang==16.0.6
- cmake>=3.26.4
Expand All @@ -27,6 +28,7 @@ dependencies:
- graphviz
- gtest>=1.13.0
- ipython
- libclang
- libcublas-dev=11.11.3.6
- libcublas=11.11.3.6
- libcurand-dev=10.3.0.86
Expand All @@ -35,9 +37,10 @@ dependencies:
- libcusolver=11.4.1.48
- libcusparse-dev=11.7.5.86
- libcusparse=11.7.5.86
- make
- nccl>=2.9.9
- ninja
- numpy>=1.23
- numpy>=1.23,<2.0a0
- numpydoc
- nvcc_linux-64=11.8
- pre-commit
Expand All @@ -47,6 +50,7 @@ dependencies:
- pytest==7.*
- recommonmark
- rmm==24.4.*
- rust
- scikit-build-core>=0.7.0
- scikit-learn
- sphinx-copybutton
Expand Down
6 changes: 5 additions & 1 deletion conda/environments/all_cuda-122_arch-aarch64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ channels:
dependencies:
- breathe
- c-compiler
- clang
- clang-tools=16.0.6
- clang==16.0.6
- cmake>=3.26.4
Expand All @@ -28,13 +29,15 @@ dependencies:
- graphviz
- gtest>=1.13.0
- ipython
- libclang
- libcublas-dev
- libcurand-dev
- libcusolver-dev
- libcusparse-dev
- make
- nccl>=2.9.9
- ninja
- numpy>=1.23
- numpy>=1.23,<2.0a0
- numpydoc
- pre-commit
- pydata-sphinx-theme
Expand All @@ -43,6 +46,7 @@ dependencies:
- pytest==7.*
- recommonmark
- rmm==24.4.*
- rust
- scikit-build-core>=0.7.0
- scikit-learn
- sphinx-copybutton
Expand Down
6 changes: 5 additions & 1 deletion conda/environments/all_cuda-122_arch-x86_64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ channels:
dependencies:
- breathe
- c-compiler
- clang
- clang-tools=16.0.6
- clang==16.0.6
- cmake>=3.26.4
Expand All @@ -28,13 +29,15 @@ dependencies:
- graphviz
- gtest>=1.13.0
- ipython
- libclang
- libcublas-dev
- libcurand-dev
- libcusolver-dev
- libcusparse-dev
- make
- nccl>=2.9.9
- ninja
- numpy>=1.23
- numpy>=1.23,<2.0a0
- numpydoc
- pre-commit
- pydata-sphinx-theme
Expand All @@ -43,6 +46,7 @@ dependencies:
- pytest==7.*
- recommonmark
- rmm==24.4.*
- rust
- scikit-build-core>=0.7.0
- scikit-learn
- sphinx-copybutton
Expand Down
3 changes: 2 additions & 1 deletion dependencies.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ files:
- test_python_common
- test_py_cuvs
- cupy
- rust
test_cpp:
output: none
includes:
Expand Down Expand Up @@ -355,7 +356,7 @@ dependencies:
common:
- output_types: [conda, pyproject]
packages:
- &numpy numpy>=1.23
- &numpy numpy>=1.23,<2.0a0
- output_types: [conda]
packages:
- *rmm_conda
Expand Down
20 changes: 18 additions & 2 deletions docs/source/basics.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
cuVS API Basics
===============

<<<<<<< HEAD
.. toctree::
:maxdepth: 1
:caption: Contents:

`Memory management`_
`Resource management`_
=======
- `Memory management`_
- `Resource management`_
>>>>>>> upstream/branch-24.04

Memory management
-----------------
Expand All @@ -18,7 +23,11 @@ RMM currently has APIs for C++ and Python.
C++
^^^

<<<<<<< HEAD
Here's an example of configuring RMM to use a pool allocator in C++ (derived from the RMM example [here](https://github.com/rapidsai/rmm?tab=readme-ov-file#example)):
=======
Here's an example of configuring RMM to use a pool allocator in C++ (derived from the RMM example `here <https://github.com/rapidsai/rmm?tab=readme-ov-file#example>`_):
>>>>>>> upstream/branch-24.04

.. code-block:: c++

Expand All @@ -33,7 +42,11 @@ Here's an example of configuring RMM to use a pool allocator in C++ (derived fro
Python
^^^^^^

<<<<<<< HEAD
And the corresponding code in Python (derived from the RMM example [here](https://github.com/rapidsai/rmm?tab=readme-ov-file#memoryresource-objects)):
=======
And the corresponding code in Python (derived from the RMM example `here <https://github.com/rapidsai/rmm?tab=readme-ov-file#memoryresource-objects>`_):
>>>>>>> upstream/branch-24.04

.. code-block:: python

Expand All @@ -48,9 +61,9 @@ And the corresponding code in Python (derived from the RMM example [here](https:
Resource management
-------------------

cuVS uses an API from the [RAFT](https://github.com/rapidsai/raft) library of ML and data mining primitives to centralize and reuse expensive resources, such as memory management. The below code examples demonstrate how to create these resources for use throughout this guide.
cuVS uses an API from the `RAFT <https://github.com/rapidsai/raft>`_ library of ML and data mining primitives to centralize and reuse expensive resources, such as memory management. The below code examples demonstrate how to create these resources for use throughout this guide.

See RAFT's [resource API documentation](https://docs.rapids.ai/api/raft/nightly/cpp_api/core_resources/) for more information.
See RAFT's `resource API documentation <https://docs.rapids.ai/api/raft/nightly/cpp_api/core_resources/>`_ for more information.

C
^
Expand Down Expand Up @@ -89,3 +102,6 @@ Python
Rust
^^^^

.. code-block:: rust

let res = cuvs::Resources::new()?;
Loading
You are viewing a condensed version of this merge commit. You can view the full changes here.