Enhance README with Customization details#1497
Conversation
Added sections on codebase architecture, customization guide. Included example configuration for adapting GeoTransolver to internal pipe flow problems.
Greptile SummaryThis PR enhances the README for the
Important Files Changed
Last reviewed commit: 4f46f1d |
| [cite_start]functional_dim: 4 # Input: Coords (3) + Inlet Velocity/Scalar (1) [cite: 22, 24] | ||
| [cite_start]out_dim: 4 # Output: Velocity (Ux, Uy, Uz) + Pressure (p) [cite: 83] | ||
| [cite_start]geometry_dim: 3 # 3D internal pipe mesh [cite: 65, 71] | ||
| [cite_start]slice_num: 64 # Spatial slices for PhysicsAttention [cite: 71] | ||
| [cite_start]n_layers: 6 # Depth of the transformer backbone [cite: 71] | ||
| use_te: True # Enable TransformerEngine for speed | ||
|
|
||
| # Data Handling & Normalization | ||
| data: | ||
| resolution: 32768 # Points per GPU for large pipe meshes | ||
| normalization_dir: "pipe_stats/" # Path to normalization .npz | ||
| return_mesh_features: False # Set to True only for inference | ||
| input_dir: "data/pipe_flow/train" | ||
| input_dir_val: "data/pipe_flow/val" | ||
|
|
||
| # Training Strategy | ||
| training: | ||
| precision: "bfloat16" # Recommended for stability on modern GPUs | ||
| num_epochs: 1000 # Internal flow may require longer convergence | ||
| save_interval: 50 # Checkpoint frequency | ||
| optimizer: "muon" # Highly recommended for Transolver backbones | ||
| [cite_start]learning_rate: 2e-4 # Base LR for the Muon/AdamW optimizer [cite: 37] |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
| # Training Strategy | ||
| training: | ||
| precision: "bfloat16" # Recommended for stability on modern GPUs | ||
| num_epochs: 1000 # Internal flow may require longer convergence | ||
| save_interval: 50 # Checkpoint frequency | ||
| optimizer: "muon" # Highly recommended for Transolver backbones | ||
| [cite_start]learning_rate: 2e-4 # Base LR for the Muon/AdamW optimizer [cite: 37] | ||
|
|
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
|
||
| * [ ] **Update Target Labels**: Modify the normalization script if your labels (e.g., Pressure, Shear) differ from the DrivaerML defaults. | ||
|
|
||
| * [ ] **Verify Precision Compatibility**: If using **fp8**, ensure your hardware supports it (Hopper/Ada Lovelace). |
There was a problem hiding this comment.
fp8 hardware list omits Blackwell
The checklist item mentions only "Hopper/Ada Lovelace", but the existing README (Training Precision section, line 62) already states that fp8 is available on "Hopper, Blackwell, Ada Lovelace, and others." Omitting Blackwell here creates an inconsistency that could mislead users with newer hardware.
| * [ ] **Verify Precision Compatibility**: If using **fp8**, ensure your hardware supports it (Hopper/Ada Lovelace). | |
| * [ ] **Verify Precision Compatibility**: If using **fp8**, ensure your hardware supports it (Hopper, Blackwell, Ada Lovelace, or other fp8-capable GPUs). |
Removed training strategy section from README.
Added detailed architecture overview and customization guide for the Lagrangian MeshGraphNet codebase.
coreyjadams
left a comment
There was a problem hiding this comment.
Hi @ram-cherukuri,
I think the AI used to make these updates went off the rails here. Overall, I don't think we should be using AI to update our readmes like this without closer supervision, they need to be vetted for technical content quite closely still, almost at the level of our example codes.
A lot of the content generated here is speculative at best, and kinda wrong at worst, and we shouldn't merge this.
How do you want to proceed?
examples/cfd/external_aerodynamics/transformer_models/README.md
Outdated
Show resolved
Hide resolved
examples/cfd/external_aerodynamics/transformer_models/README.md
Outdated
Show resolved
Hide resolved
examples/cfd/external_aerodynamics/transformer_models/README.md
Outdated
Show resolved
Hide resolved
examples/cfd/external_aerodynamics/transformer_models/README.md
Outdated
Show resolved
Hide resolved
examples/cfd/external_aerodynamics/transformer_models/README.md
Outdated
Show resolved
Hide resolved
examples/cfd/external_aerodynamics/transformer_models/README.md
Outdated
Show resolved
Hide resolved
Updated README to address inaccuracies
|
|
||
| Below is a sample Hydra configuration block (e.g., `conf/model/geotransolver_pipe_flow.yaml`) | ||
|
|
||
| ### Sample Hydra Configuration: `geotransolver_pipe_flow.yaml` |
There was a problem hiding this comment.
@RishikeshRanade Can you take a stab a creating a psuedo config that would adapt this external aero sample to an internal flow sample
|
|
||
| #### **B. Physics-Informing** | ||
|
|
||
| * Builders can Physics Inform their training by injecting custom PDE-based constraints (e.g., mass conservation) as context by using the physicsnemo.physicsinformer module. |
There was a problem hiding this comment.
@ktangsali Can you update this section to indicate how one can add Physics Loss to GeoTransolver training if they want to.
Clarified configuration names for surface and volumetric data in README.
Added sections on codebase architecture, customization guide. Included example configuration for adapting GeoTransolver to internal pipe flow problems.
PhysicsNeMo Pull Request
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.