Skip to content

Update API docs and structure.#1337

Open
coreyjadams wants to merge 6 commits into2.0.0-rcfrom
api-docs-updates
Open

Update API docs and structure.#1337
coreyjadams wants to merge 6 commits into2.0.0-rcfrom
api-docs-updates

Conversation

@coreyjadams
Copy link
Collaborator

PhysicsNeMo Pull Request

This PR brings the API section of the docs in line with the refactor work. To-dos remain:

We also need to check models are all listed in the API section, I think we are missing some.

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.

@ktangsali ktangsali changed the base branch from main to 2.0.0-rc February 26, 2026 19:37
@ktangsali ktangsali marked this pull request as ready for review March 3, 2026 22:53
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 3, 2026

Greptile Summary

This PR restructures the API documentation to align with a broader codebase refactor: removing old physicsnemo.launch.*, physicsnemo.deploy, and physicsnemo.distributed.shardtensor docs in favor of new pages for physicsnemo.core, physicsnemo.diffusion, physicsnemo.domain_parallel, physicsnemo.nn, and physicsnemo.mesh. However, several of the newly added automodule directives reference modules that do not exist, causing Sphinx build warnings and empty documentation sections.

Key issues found:

  • docs/api/models/weather.rst: GraphCast utils directives reference physicsnemo.graphcast.utils.*, but this package doesn't exist; the correct prefix is physicsnemo.models.graphcast.utils.*. Additionally, data_utils and loss modules don't exist in the repository.

  • docs/api/physicsnemo.diffusion.rst: References non-existent modules physicsnemo.diffusion.samplers.deterministic_sampler and stochastic_sampler (actual files are samplers.py, solvers.py, and legacy variants).

  • docs/api/models/operators.rst: References physicsnemo.utils.domino.utils which doesn't exist; correct path is physicsnemo.models.domino.utils.

  • docs/api/physicsnemo.nn.rst: All four referenced modules don't exist under physicsnemo.nn, and the file lacks a required top-level RST document title.

  • docs/api/physicsnemo.mesh.rst: Completely empty file included in toctree will cause Sphinx build error; needs at minimum a placeholder title.

  • docs/api/physicsnemo.core.rst: Ends with a dangling cross-reference label and missing trailing newline.

Last reviewed commit: 3405928

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 3, 2026

Additional Comments (1)

docs/api/physicsnemo.mesh.rst
The file is completely empty but is included in api_index.rst's toctree. Sphinx requires every file in a toctree to have at least a document title, otherwise it will produce a build error.

Add a minimal placeholder since mesh documentation is a pending TODO:

PhysicsNeMo Mesh
================

.. note::

   Documentation for ``physicsnemo.mesh`` is coming soon.

Copy link
Collaborator

@peterdsharpe peterdsharpe left a comment

Choose a reason for hiding this comment

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

Reviewing only the changes to the Mesh API docs - this migration looks good to me! Thanks!

Copy link
Collaborator

@loliverhennigh loliverhennigh left a comment

Choose a reason for hiding this comment

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

Checked the image moves and it looks good to me. I read through the other doc changes. They make sense to me and happy to approve although I know others might know a bit better about the distributed stuff and diffusion.

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.

4 participants