Skip to content

Update Datapipes API#1468

Merged
ktangsali merged 14 commits intoNVIDIA:2.0.0-rcfrom
coreyjadams:datapipes-api-rc
Mar 9, 2026
Merged

Update Datapipes API#1468
ktangsali merged 14 commits intoNVIDIA:2.0.0-rcfrom
coreyjadams:datapipes-api-rc

Conversation

@coreyjadams
Copy link
Collaborator

@coreyjadams coreyjadams commented Mar 2, 2026

PhysicsNeMo Pull Request

This PR updates the Datapipes API docs. The idea here was to break down the datapipes API into several pages that are smaller and more consumable. I separated the "legacy" datapipes (v1 format) and the composable datapipes (v2 format). The main intro page gives the high level summary and there are details on the subsequent pages.

Hard to review until it's rendered, but hard to render without the docs build ...

Description

Checklist

Dependencies

Review Process

All PRs are reviewed by the PhysicsNeMo team before merging.

Depending on which files are changed, GitHub may automatically assign a maintainer for review.

We are also testing AI-based code review tools (e.g., Greptile), which may add automated comments with a confidence score.
This score reflects the AI’s assessment of merge readiness and is not a qualitative judgment of your work, nor is
it an indication that the PR will be accepted / rejected.

AI-generated feedback should be reviewed critically for usefulness.
You are not required to respond to every AI comment, but they are intended to help both authors and reviewers.
Please react to Greptile comments with 👍 or 👎 to provide feedback on their accuracy.

@coreyjadams coreyjadams marked this pull request as ready for review March 2, 2026 15:55
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 2, 2026

Greptile Summary

Added comprehensive documentation for the PhysicsNeMo datapipes module, including new RST files for benchmarks, CAE, climate, GNN, readers, transforms, and the main datapipes page. The documentation includes usage examples, architecture diagrams, and API references.

Key changes:

  • Reorganized datapipes documentation into dedicated subdirectory
  • Added detailed docs for v2.0 redesigned datapipes architecture with GPU-first philosophy
  • Documented legacy v1 datapipes for backward compatibility
  • Included quick start guides and custom extension examples

Issues found:

  • Multiple spelling errors in main documentation files that need correction
  • Missing newline at end of one file

Important Files Changed

Filename Overview
docs/api/datapipes/physicsnemo.datapipes.cae.rst added CAE datapipes docs; has typo on line 18 and missing newline at EOF
docs/api/datapipes/physicsnemo.datapipes.rst added main datapipes documentation; contains multiple typos (lines 14, 35, 49, 156, 159)
docs/api/datapipes/physicsnemo.datapipes.transforms.rst added transforms documentation; has typo on line 25

Last reviewed commit: 0897f6d

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

8 files reviewed, 8 comments

Edit Code Review Agent Settings | Greptile

@coreyjadams coreyjadams changed the title Trying again with datapipes check in Update Datapipes API Mar 2, 2026
Copy link
Collaborator

@ktangsali ktangsali left a comment

Choose a reason for hiding this comment

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

Looks good, have a few minor comments.

coreyjadams and others added 13 commits March 6, 2026 19:50
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@ktangsali ktangsali merged commit ad1af7c into NVIDIA:2.0.0-rc Mar 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants