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.

Sign up for GitHub

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

Jump to bottom

More doc updates for 24.10 #396

Merged
merged 42 commits into from
Oct 4, 2024
Merged

More doc updates for 24.10 #396

merged 42 commits into from
Oct 4, 2024

Conversation

cjnolet
Copy link
Member

@cjnolet cjnolet commented Oct 4, 2024 •
edited
Loading

This PR adds some critical doc fixes for 24.10-

  1. Since we're working on the Nvidia developer landing page for cuVS, our README content needs to be aligned.
  2. The cuvs-bench documentation was missing the datasets guide and table of contents.
  3. The cuvs-bench docs weren't linked into the main docs.
  4. cuvs-bench was missing several of the mg enabled algorithms, their constraints, and parameter ranges.

cjnolet and others added 30 commits September 9, 2024 11:32
@cjnolet
Adding stub files for vector indexes
79bc8b4
@cjnolet
Checking inx!
0db2eae
@cjnolet
Adding more content
f6731bc
@cjnolet
COntinuing to flesh out getting started materials
0e4c016
@cjnolet
Another updat3
c17e842
@cjnolet
Updates
47b03ef
@cjnolet
Migrating the C++ tutorial
6598ff8
@cjnolet
Adding images and lniks
c619e26
@cjnolet
Moving a few things around
e8494c4
@cjnolet
Merge branch 'branch-24.10' into doc-2410-index_docs
4c81760
@cjnolet
Merge branch 'branch-24.10' into doc-2410-index_docs
838b05f
@cjnolet
More updates to index guides in docs
9d0e012
@cjnolet
Merge branch 'doc-2410-index_docs' of github.com:rapidsai/cuvs into d…
6d21d50 
…oc-2410-index_docs
@cjnolet
Merge branch 'branch-24.10' into doc-2410-index_docs
6143c2c
@cjnolet
MOre docs updates
397e5ff
@cjnolet
Merge branch 'doc-2410-index_docs' of github.com:rapidsai/cuvs into d…
831c2a2 
…oc-2410-index_docs
@cjnolet
MOre updates
55f11ee
@cjnolet
Updates
8c1fa13
@cjnolet
Finishing tuning guide write-up
31cd39b
@cjnolet
More info
d9ef452
@cjnolet
Updating build
325d718
@cjnolet
Updating readme
4d2d305
@cjnolet
Merge branch 'branch-24.10' into doc-2410-index_docs
82ec71b
@cjnolet @lowener
Apply suggestions from code review
a84978a 
Co-authored-by: Micka <mide@nvidia.com>
@cjnolet
Removing the cpp_tutorial
35c8029
@cjnolet
Merge branch 'doc-2410-index_docs' of github.com:rapidsai/cuvs into d…
b6eb5b8 
…oc-2410-index_docs
@cjnolet
Review comments
83994a7
@cjnolet
Adding some additional info to docs
4eeeb89
@cjnolet
More update
4351f58
@cjnolet
Adding graph stuff
25dce03
@cjnolet cjnolet added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Oct 4, 2024
@cjnolet cjnolet self-assigned this Oct 4, 2024
@cjnolet cjnolet marked this pull request as ready for review October 4, 2024 15:36
@cjnolet cjnolet requested a review from a team as a code owner October 4, 2024 15:36
@cjnolet cjnolet changed the title More doc updates for 24.10 [skip-ci] More doc updates for 24.10 Oct 4, 2024
@cjnolet cjnolet requested a review from a team as a code owner October 4, 2024 16:27
@github-actions github-actions bot added the Python label Oct 4, 2024
dantegd
dantegd reviewed Oct 4, 2024
View reviewed changes
Copy link
Member

@dantegd dantegd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look great, just had a couple of comments

README.md Show resolved Hide resolved
README.md Outdated
6. Multiple language support
7. Building blocks for composing new or accelerating existing algorithms

In addition to the items above, cuVS takes on the burden of keeping non-trivial accelerated code up to date as new Nvidia architectures and CUDA versions are released. This provides a deslightful development experimence, guaranteeing that any libraries, databases, or applications built on top of it will always be getting the best performance and scale.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NVIDIA spelling

@viclafargue viclafargue mentioned this pull request Oct 4, 2024
Closed
@raydouglass raydouglass merged commit c14b879 into branch-24.10 Oct 4, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dantegd dantegd dantegd left review comments

@benfred benfred benfred approved these changes

Assignees

@cjnolet cjnolet

Labels
doc Improvements or additions to documentation non-breaking Introduces a non-breaking change Python
Projects
VS/ML/DM Primitives Release Board
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@cjnolet @benfred @dantegd @raydouglass @viclafargue