Skip to content

Improving getting started materials#342

Merged
AyodeAwe merged 27 commits into
branch-24.10from
doc-2410-index_docs
Oct 3, 2024
Merged

Improving getting started materials#342
AyodeAwe merged 27 commits into
branch-24.10from
doc-2410-index_docs

Conversation

@cjnolet

@cjnolet cjnolet commented Sep 23, 2024

Copy link
Copy Markdown
Contributor

Adding documentation for each index type. This decouples the major details in the docs from the individual language API docs to present users with a better overal experience. The major topcs in the new index-level docs are meant to be more exhaustive than the API docs in providing

  1. Description of each index type, when it's useful and shortcomings
  2. Links to any relevant research material to learn more foundational info
  3. Hyper-parameters
  4. Links to API docs for each supported language
  5. Links to example projects and notebooks
  6. Formulas for rough estimates of memory footprint
  7. How to use in cuvs-bench, along with some rough benchmarks on different hardware

@cjnolet cjnolet added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Sep 23, 2024
@cjnolet cjnolet self-assigned this Sep 23, 2024
@cjnolet cjnolet requested a review from a team as a code owner September 23, 2024 15:50
@codecov-commenter

codecov-commenter commented Sep 23, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.37%. Comparing base (59bc6bd) to head (83994a7).
Report is 4 commits behind head on branch-24.10.

Additional details and impacted files
@@              Coverage Diff              @@
##           branch-24.10     #342   +/-   ##
=============================================
  Coverage         70.37%   70.37%           
=============================================
  Files                12       12           
  Lines                54       54           
=============================================
  Hits                 38       38           
  Misses               16       16           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cjnolet cjnolet changed the title Adding docs for each index Improving getting started guide Sep 23, 2024
@cjnolet cjnolet changed the title Improving getting started guide Improving getting started materials Sep 24, 2024
Comment thread docs/source/choosing_and_configuring_indexes.rst Outdated
Comment thread docs/source/comparing_indexes.rst Outdated
Comment thread docs/source/indexes/ivfflat.rst Outdated
Comment thread docs/source/indexes/ivfflat.rst Outdated
Comment thread docs/source/cpp_tutorial.rst Outdated
Comment thread docs/source/cpp_tutorial.rst Outdated
Comment thread docs/source/cuvs_bench/index.rst Outdated
@cjnolet

cjnolet commented Oct 3, 2024

Copy link
Copy Markdown
Contributor Author

Moved the cpp tutorial over to a differerent branch for now: https://github.com/rapidsai/cuvs/tree/doc-2412-cpp_tutorial

@dantegd dantegd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overall things look fantastic! Just very few minor comments

Comment thread README.md

```bash
mamba install -c conda-forge -c nvidia -c rapidsai cuvs
conda install -c conda-forge -c nvidia -c rapidsai cuvs

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Would be great to also add the pip command below this.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The only reason I didn't is to try and minimize the number of places we have this info, since it adds to the challenge of keeping everything up to day. I think we should definiely mention pip, though, and link to the build guide. I considered doing this for conda too. What do you think? Or as a user, would you rather see both pip and conda right in the readme?

Comment thread README.md Outdated
```

Please see the [Build and Install Guide](https://docs.rapids.ai/api/cuvs/stable/build/) for more information on installing cuVS and building from source.
Please see the [Build and Install Guide](https://docs.rapids.ai/api/cuvs/nightly/build/) for more information on installing cuVS and building from source.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Consideration for follow up: it'd be great to have a script or job that changes this links to stable at release time, and keeps the as nightly during dev

Comment thread docs/source/choosing_and_configuring_indexes.rst

@benfred benfred left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

amazing work on this - this is a great change.

I left some minor comments, but pre-approving since none of them are blocking

Comment thread README.md
Comment thread README.md
Comment thread docs/source/cuvs_bench/build.rst Outdated
Comment thread docs/source/cuvs_bench/index.rst Outdated
Comment thread docs/source/getting_started.rst Outdated
Comment thread docs/source/tuning_guide.rst Outdated
@cjnolet

cjnolet commented Oct 3, 2024

Copy link
Copy Markdown
Contributor Author

/merge

@AyodeAwe AyodeAwe merged commit cc86ffc into branch-24.10 Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants