Skip to content

fix: ignore docs, tests, and tutorials in Ray uploads#1787

Open
nightcityblade wants to merge 1 commit intoNVIDIA-NeMo:mainfrom
nightcityblade:fix/issue-1337
Open

fix: ignore docs, tests, and tutorials in Ray uploads#1787
nightcityblade wants to merge 1 commit intoNVIDIA-NeMo:mainfrom
nightcityblade:fix/issue-1337

Conversation

@nightcityblade
Copy link
Copy Markdown
Contributor

Description

closes #1337

Add a .rayignore file so Ray uploads skip the docs, tests, and tutorials directories that do not need to be shipped with pipeline code.

Usage

# No code changes required. Ray now respects .rayignore when packaging the working directory.

Checklist

  • The title of the PR starts with fix or feat, if this applies to your PR.
  • Changes are manually tested and documented in the PR if automated coverage is not practical.
  • New or Existing tests cover these changes.
  • The documentation is up to date with these changes.

Signed-off-by: nightcityblade <nightcityblade@gmail.com>
@nightcityblade nightcityblade requested a review from a team as a code owner April 10, 2026 15:20
@nightcityblade nightcityblade requested review from VibhuJawa and removed request for a team April 10, 2026 15:20
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot bot commented Apr 10, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 10, 2026

Greptile Summary

This PR adds a .rayignore file to the repository root to prevent Ray from uploading docs/, tests/, and tutorials/ when packaging the working directory for cluster deployment. This is a clean, low-risk config-only change.

.rayignore is officially supported in Ray 2.54.1+ (per current Ray docs: "if the local directory contains a .gitignore and/or .rayignore file, the specified files are not uploaded to the cluster"), so the file will be respected as intended. The patterns follow valid gitignore syntax.

Confidence Score: 5/5

Safe to merge — config-only change with no runtime risk.

This is a single, config-only file addition. The .rayignore format is confirmed as officially supported in Ray 2.54.1+, the gitignore-style patterns are syntactically correct, and the excluded directories (docs, tests, tutorials) are clearly non-runtime artifacts. The only open item is a P2 suggestion to also exclude benchmarking/.

No files require special attention.

Important Files Changed

Filename Overview
.rayignore New file that excludes docs/, tests/, and tutorials/ from Ray working directory uploads; syntax is valid gitignore-style and the file is officially supported in Ray 2.54.1+.

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Ray as Ray CLI / SDK
    participant Cluster as Ray Cluster

    Dev->>Ray: ray job submit --working-dir .
    Ray->>Ray: Read .rayignore
    Ray->>Ray: Exclude docs/, tests/, tutorials/
    Ray->>Cluster: Upload nemo_curator/ + remaining files
    Cluster->>Cluster: Run pipeline
Loading

Reviews (1): Last reviewed commit: "fix: ignore docs, tests, and tutorials i..." | Re-trigger Greptile

Comment thread .rayignore
Comment on lines +1 to +3
docs/
tests/
tutorials/
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.

P2 Consider also excluding benchmarking/

The top-level benchmarking/ directory is not excluded. Like docs/ and tutorials/, it is unlikely to be needed at runtime on a Ray cluster and could be excluded to further reduce upload size.

Suggested change
docs/
tests/
tutorials/
benchmarking/
docs/
tests/
tutorials/

@chtruong814 chtruong814 added the needs-follow-up Issue needs follow-up label Apr 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use rayignore to ignore docs / tutorials / test

3 participants