-
Notifications
You must be signed in to change notification settings - Fork 663
Enhance README with Customization details #1497
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ram-cherukuri
wants to merge
6
commits into
main
Choose a base branch
from
ram-cherukuri-patch-8
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
4f46f1d
Enhance README with Customization details
ram-cherukuri 56ea2fc
Update README to remove training strategy details
ram-cherukuri b3d4747
Enhance README with codebase architecture and customization
ram-cherukuri b5f0fe9
Refine README
ram-cherukuri cdd0e41
Update README with configuration name corrections
ram-cherukuri cfd3939
Update README.md
RishikeshRanade File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,10 @@ GeoTransolver adapts the Transolver backbone by replacing standard attention wit | |
|
|
||
| GALE directly targets core challenges in AI physics modeling. By structuring self-attention around physics-aware slices, GeoTransolver encourages interactions that reflect operator couplings (e.g., pressure–velocity or field–material). Multi-scale ball queries enforce locality where needed while maintaining access to global signals, balancing efficiency with nonlocal reasoning. Continuous geometry-context projection at depth mitigates representation drift and improves stability, while providing a natural interface for constraint-aware training and regularization. Together, these design choices enhance accuracy, robustness to geometric and regime shifts, and scalability on large, irregular discretizations. | ||
|
|
||
| ## Transolver++ | ||
|
|
||
| Transolver++ is supported with the `plus` flag to the model. In our experiments, we did not see gains, but you are welcome to try it and share your results with us on GitHub! | ||
|
|
||
| ## External Aerodynamics CFD Example: Overview | ||
|
|
||
| This directory contains the essential components for training and evaluating models tailored to external aerodynamics CFD problems. The training examples use the [DrivaerML dataset](https://caemldatasets.org/drivaerml/). | ||
|
|
@@ -210,6 +214,66 @@ mesh is processed. To enable the mesh to fit into GPU memory, the mesh is chunk | |
| into pieces that are then processed, and recombined to form the prediction on the | ||
| entire mesh. The outputs are then saved to .vtp files for downstream analysis. --> | ||
|
|
||
| ## Transolver++ | ||
| ## Customization Guide | ||
|
|
||
| Transolver++ is supported with the `plus` flag to the model. In our experiments, we did not see gains, but you are welcome to try it and share your results with us on GitHub! | ||
| To adapt these models beyond the **DrivaerML dataset**, builders can try out the following steps. These steps have not been tested and are meant to guide custom training experiments: | ||
|
|
||
| #### **A. Customizing the Feature Space** | ||
|
|
||
| * **Surface vs. Volume**: Use the `transolver_surface` or `transolver_volume` configuration names to toggle the dimensionality of the input point cloud. | ||
|
|
||
| * **Input Dimensions**: If your CFD data includes temperature update the "geotransolver.yaml" configuration file if you are using GeoTransolver, to reflect the new feature space `f`. The model expects inputs in shapes of `[1, K, f]`. | ||
|
|
||
| * **Data Pipe**: TBD | ||
|
|
||
| #### **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. | ||
|
|
||
| ## Integration Checklist for New CFD Domains | ||
|
|
||
| If you are moving from External Aerodynamics to a different irregular mesh problem (e.g., Internal Flow or Heat Transfer), ensure you: | ||
|
|
||
| * [ ] **Compute New Normalizations**: Run `compute_normalizations.py` on your specific dataset. | ||
|
|
||
| * [ ] **Update Target Labels**: Modify the metrics.py script if your labels (e.g., Pressure, Shear) differ from the DrivaerML defaults. | ||
|
|
||
| ## Adapting to Internal Pipe flow | ||
|
|
||
| Example: To adapt the **GeoTransolver** architecture for an internal pipe flow problem, you can leverage the existing Hydra configuration structure. | ||
|
|
||
| Internal flow often requires tracking different variables (e.g., velocity components $U_x, U_y, U_z$ and pressure $p$) and may involve specific geometry constraints like pipe diameter or length. | ||
|
|
||
| Below is a sample Hydra configuration block (e.g., `conf/model/geotransolver_pipe_flow.yaml`) | ||
|
|
||
| ### Sample Hydra Configuration: `geotransolver_pipe_flow.yaml` | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @RishikeshRanade Can you take a stab a creating a psuedo config that would adapt this external aero sample to an internal flow sample |
||
|
|
||
| ```yaml | ||
| # @package _global_ | ||
|
|
||
| # Model Architecture Setup | ||
| model: | ||
| _target_: physicsnemo.experimental.models.geotransolver.GeoTransolver | ||
| functional_dim: 4 # Input: Coords (3) + Inlet Velocity/Scalar (1) | ||
| out_dim: 4 # Output: Velocity (Ux, Uy, Uz) + Pressure (p) | ||
| geometry_dim: 3 # 3D internal pipe mesh | ||
| slice_num: 64 # Spatial slices for PhysicsAttention | ||
| n_layers: 6 # Depth of the transformer backbone | ||
| 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" | ||
|
ram-cherukuri marked this conversation as resolved.
|
||
|
|
||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ### Key Adjustments for Internal Pipe Flow | ||
|
|
||
| * **Input/Output Mapping**: While external aerodynamics focuses on `Pressure` and `Wall-Shear-Stress`, internal pipe flow typically prioritizes the full **velocity field** ($U_x, U_y, U_z$) to monitor flow profiles and pressure drops. Adjust `out_dim` accordingly. | ||
| * **Normalization**: Since pipe flow variables (like pressure) can scale differently depending on the pipe length, ensure you rerun `compute_normalizations.py` specifically on your pipe dataset to generate the required `.npz` file. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ktangsali Can you update this section to indicate how one can add Physics Loss to GeoTransolver training if they want to.