Skip to content

Updated download.md page for one download jar instead of two#14375

Open
sameerz wants to merge 2 commits into
NVIDIA:mainfrom
sameerz:download-doc-fix
Open

Updated download.md page for one download jar instead of two#14375
sameerz wants to merge 2 commits into
NVIDIA:mainfrom
sameerz:download-doc-fix

Conversation

@sameerz

@sameerz sameerz commented Mar 7, 2026

Copy link
Copy Markdown
Collaborator

Description

Made the following documentation changes:

  1. Our download documentation refers to an outdated cudf jar requiring installation. Updating download.md to remove that second reference.
  2. Replaced the long name for the product with the short name after the first reference.
  3. Documentation mentions the CUDA toolkit needs to be installed. It does not, since it is bundled with the jar. Instead, mention the NVIDIA driver.

Checklists

  • This PR has added documentation for new or modified features or behaviors.
  • This PR has added new tests or modified existing tests to cover new code paths.
    (Please explain in the PR description how the new code paths are tested, such as names of the new/existing tests that cover them.)
  • Performance testing has been performed and its results are added in the PR description. Or, an issue has been filed with a link in the PR description.

Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
@sameerz sameerz added the documentation Improvements or additions to documentation label Mar 7, 2026
@sameerz sameerz requested review from nvliyuan and viadea March 7, 2026 00:25
@greptile-apps

greptile-apps Bot commented Mar 7, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR updates docs/download.md to reflect the current single-jar distribution model and corrects two outdated installation prerequisites.

  • Removes the reference to the separate RAPIDS cuDF jar; users now only need the rapids-4-spark plugin jar.
  • Replaces the CUDA toolkit installation requirement with the NVIDIA driver, since CUDA is bundled in the jar.
  • Introduces "RAPIDS Spark" as a short-form abbreviation after the first full product name reference, reducing verbosity.
  • Fixes the capitalisation of "for" in the full product name ("For" → "for") and adds a trailing newline at the end of the file.
  • One minor wording inconsistency remains: "the RAPIDS Spark" on line 17 uses an article inconsistently compared to the rest of the paragraph; dropping "the" is suggested.

Confidence Score: 5/5

  • Documentation-only change with accurate, low-risk corrections; safe to merge.
  • All three stated goals (single-jar, driver vs. CUDA toolkit, short-form name) are correctly implemented. The only finding is a trivial article-usage nit that does not affect accuracy or correctness.
  • No files require special attention.

Important Files Changed

Filename Overview
docs/download.md Documentation-only update: removes the outdated two-jar installation requirement, replaces the CUDA toolkit prerequisite with the NVIDIA driver, and introduces "RAPIDS Spark" as a short-form name; one minor article-usage inconsistency ("the RAPIDS Spark") flagged.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Worker Node Setup] --> B{NVIDIA GPU present?}
    B -- No --> C[Cannot use RAPIDS Spark]
    B -- Yes --> D[Install NVIDIA Driver R525+]
    D --> E[Deploy rapids-4-spark plugin jar]
    E --> F{Deployment method}
    F -- Preinstalled --> G[Add jar to Spark classpath on all nodes]
    F -- Per-job --> H[Submit jar with each Spark job]
    G --> I[RAPIDS Spark ready]
    H --> I
Loading

Last reviewed commit: a0588e9

Comment thread docs/download.md
that uses the RAPIDS Accelerator For Apache Spark. See the [getting-started
guide](https://docs.nvidia.com/spark-rapids/user-guide/latest/getting-started/overview.html) for more details.
RAPIDS Spark consists of the rapids-4-spark plugin jar. The jar is either preinstalled in the Spark
classpath on all nodes or submitted with each job that uses the RAPIDS Spark. See the

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.

Awkward article before product short name

The phrase "that uses the RAPIDS Spark" reads unnaturally — "the" before a proper noun used as a product abbreviation is grammatically awkward here, and the same paragraph introduces the name without an article on line 16 ("RAPIDS Spark consists of…"). Dropping "the" improves consistency and flow.

Suggested change
classpath on all nodes or submitted with each job that uses the RAPIDS Spark. See the
classpath on all nodes or submitted with each job that uses RAPIDS Spark. See the

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@nvauto

nvauto commented Mar 30, 2026

Copy link
Copy Markdown
Collaborator

NOTE: release/26.04 has been created from main. Please retarget your PR to release/26.04 if it should be included in the release.

@nvliyuan nvliyuan left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

GaryShen2008 pushed a commit that referenced this pull request Apr 7, 2026
Fixes #14019.

### Description

Backport doc changes to release/26.02 branch for v26.02.2 hot release:
- Add CUDA 13 jars to download page (x86_64/arm64, Scala 2.12/2.13)
- Update product description (one jar instead of two, per #14375)
- Add known issue note for windowing op bug in
GpuBatchedBoundedWindowExec
- Add v26.02.0 and v26.02.1 to archived releases
- Update version references to 26.02.2

### Checklists

- [x] This PR has added documentation for new or modified features or
behaviors.
- [ ] This PR has added new tests or modified existing tests to cover
new code paths.
- [ ] Performance testing has been performed and its results are added
in the PR description. Or, an issue has been filed with a link in the PR
description.

---------

Signed-off-by: liyuan <yuali@nvidia.com>
Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
Co-authored-by: Sameer Raheja <sraheja@.nvidia.com>

@revans2 revans2 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Do we want to upmerge this?

@nvauto

nvauto commented May 25, 2026

Copy link
Copy Markdown
Collaborator

NOTE: release/26.06 has been created from main. Please retarget your PR to release/26.06 if it should be included in the release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants