[Patch] Follow up to #1531 - Layers: Add layers in layout, and replace it in scheduler#1701
Open
aserhani wants to merge 23 commits into
Open
[Patch] Follow up to #1531 - Layers: Add layers in layout, and replace it in scheduler#1701aserhani wants to merge 23 commits into
aserhani wants to merge 23 commits into
Conversation
Contributor
|
Thanks @aserhani for opening this PR! You can do multiple things directly here: Once the workflow completes a message will appear displaying informations related to the run. Also the PR gets automatically reviewed by gemini, you can: |
Contributor
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a significant architectural change by implementing a multi-layered data layout system. The new Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces a PatchDataLayout to manage multiple data layers, which is a good step towards more complex simulations. The changes correctly replace the old PatchDataLayerLayout in most places. My review focuses on improving consistency and leveraging modern C++ features.
A recurring point is the access to the default layer. In some places, it's accessed by index 0, while in others by name "main". Using the name is more robust and readable. I've suggested changes to consistently use "main".
I've also pointed out opportunities to simplify code by removing redundant checks and using helper functions, and to modernize some C++ constructs for better maintainability.
Comment on lines
+48
to
+54
| PatchDataLayout(const std::vector<std::string> &layer_names) | ||
| : layer_layouts{layer_names.size()} { | ||
| for (size_t i = 0; i < layer_layouts.size(); i++) { | ||
| layer_layouts[i].name = layer_names[i]; | ||
| layer_layouts[i].layout = std::make_shared<PatchDataLayerLayout>(); | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
This constructor can be implemented more idiomatically using modern C++ features like reserve and push_back with an initializer list. This avoids default-constructing LayerEntry objects and then re-assigning their members, which is slightly more efficient and readable.
PatchDataLayout(const std::vector<std::string> &layer_names) {
layer_layouts.reserve(layer_names.size());
for (const auto &name : layer_names) {
layer_layouts.push_back({std::make_shared<PatchDataLayerLayout>(), name});
}
}
Comment on lines
+61
to
+69
| size_t get_layer_index(const std::string &name) const { | ||
| for (size_t i = 0; i < layer_layouts.size(); i++) { | ||
| if (layer_layouts[i].name == name) { | ||
| return i; | ||
| } | ||
| } | ||
| throw shambase::make_except_with_loc<std::invalid_argument>( | ||
| "the requested layer does not exists"); | ||
| } |
Contributor
There was a problem hiding this comment.
This loop can be replaced with std::find_if from the <algorithm> header for a more idiomatic C++ implementation. You will need to include <algorithm> and <iterator>.
size_t get_layer_index(const std::string &name) const {
auto it = std::find_if(layer_layouts.begin(), layer_layouts.end(),
[&name](const LayerEntry &entry) {
return entry.name == name;
});
if (it != layer_layouts.end()) {
return std::distance(layer_layouts.begin(), it);
}
throw shambase::make_except_with_loc<std::invalid_argument>(
"the requested layer does not exists");
}| auto &pdl = *pdl_ptr; | ||
| std::shared_ptr<shamrock::patch::PatchDataLayout> pdl_ptr | ||
| = std::make_shared<shamrock::patch::PatchDataLayout>(std::vector<std::string>{"main"}); | ||
| auto &pdl = pdl_ptr->get_layer_ref(0); |
Contributor
There was a problem hiding this comment.
For consistency and readability, it's better to access the layer by its name "main" instead of its index 0.
auto &pdl = pdl_ptr->get_layer_ref("main");
Comment on lines
+18
to
+20
| auto &layer1 = pdl.get_layer_ref(0); | ||
| auto &layer2 = pdl.get_layer_ref(1); | ||
| auto &layer3 = pdl.get_layer_ref(2); |
Contributor
There was a problem hiding this comment.
Accessing layers by name instead of index would make this test more robust against changes in layer order.
auto &layer1 = pdl.get_layer_ref("layer1");
auto &layer2 = pdl.get_layer_ref("layer2");
auto &layer3 = pdl.get_layer_ref("layer3");
Comment on lines
+76
to
+78
| PatchDataLayout pdl_ref = PatchDataLayout(); | ||
| pdl_ref.layer_layouts.push_back( | ||
| PatchDataLayout::LayerEntry{std::make_shared<PatchDataLayerLayout>(pdl_layer), "main"}); |
Contributor
There was a problem hiding this comment.
It's better to use the public API to construct the reference object for the test. This makes the test clearer and also tests the class's public interface.
PatchDataLayout pdl_ref({"main"});
pdl_ref.get_layer_ref("main") = pdl_layer;References
- In tests, prefer programmatic construction of expected data collections over manual, verbose initialization to improve maintainability and robustness.
| auto &layout = *layout_ptr; | ||
| std::shared_ptr<PatchDataLayout> layout_ptr | ||
| = std::make_shared<PatchDataLayout>(std::vector<std::string>{"main"}); | ||
| auto &layout = layout_ptr->get_layer_ref(0); |
Contributor
There was a problem hiding this comment.
For consistency and readability, it's better to access the layer by its name "main" instead of its index 0.
auto &layout = layout_ptr->get_layer_ref("main");
Contributor
Workflow reportworkflow report corresponding to commit d042116 Light CI is enabled. This will only run the basic tests and not the full tests. Pre-commit check reportPre-commit check: ✅ Test pipeline can run. Doxygen diff with
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.