Skip to content
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

Increase more code coverage in _chgnet.py #261

Merged
merged 37 commits into from
May 12, 2024

Conversation

kenko911
Copy link
Contributor

Summary

Increase more code coverage in _chgnet.py

Checklist

  • Google format doc strings added. Check with ruff.
  • Type annotations included. Check with mypy.
  • Tests added for new features/fixes.
  • If applicable, new classes/functions/modules have duecredit @due.dcite decorators to reference relevant papers by DOI (example)

Tip: Install pre-commit hooks to auto-check types and linting before every commit:

pip install -U pre-commit
pre-commit install

kenko911 and others added 30 commits November 18, 2023 02:52
…oat_th and including linear layer in TensorNet to match the original implementations
@kenko911 kenko911 requested a review from shyuep as a code owner May 12, 2024 03:46
Copy link

coderabbitai bot commented May 12, 2024

Walkthrough

The recent modifications involve enhancing the CHGNet class by introducing new parameters (readout_field, final_mlp_type) to its constructor in the test suite. Additionally, a new test function test_exceptions has been added to validate error handling capabilities, specifically for managing ValueError scenarios.

Changes

File Path Description of Changes
.../test_chgnet.py Added parameters readout_field, final_mlp_type to CHGNet constructor; introduced test_exceptions function for error handling.

Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between ca6fddc and ac92f1d.
Files selected for processing (1)
  • tests/models/test_chgnet.py (1 hunks)
Additional comments not posted (1)
tests/models/test_chgnet.py (1)

45-47: Ensure proper error message in test_exceptions.

The test case test_exceptions is designed to catch a ValueError with a specific message. It's crucial to verify that the error message "Invalid activation type" is indeed implemented in the CHGNet class to ensure this test will behave as expected.

Verification successful

The error message "Invalid activation type" is indeed implemented in the CHGNet class within the file src/matgl/models/_chgnet.py. This confirms that the test case test_exceptions in test_chgnet.py is correctly designed to catch this specific ValueError.

  • The error message is part of a formatted string that dynamically lists valid activation functions, which enhances the error message's usefulness by informing the user about acceptable values.

Conclusion:
The review comment concern has been verified as correct. The CHGNet class does implement the error message "Invalid activation type," ensuring that the associated test case will behave as expected.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that the error message "Invalid activation type" is implemented in the CHGNet class.

# Test: Search for the error message in the CHGNet class implementation. Expect: At least one occurrence.
rg --type py 'Invalid activation type' src/models/chgnet.py

Length of output: 122



Script:

#!/bin/bash
# Description: Locate the file `chgnet.py` in the repository to confirm its existence and correct path.
fd chgnet.py

Length of output: 70



Script:

#!/bin/bash
# Description: Verify that the error message "Invalid activation type" is implemented in the CHGNet class within the correct file path.

# Test: Search for the error message in the CHGNet class implementation at the correct file path. Expect: At least one occurrence.
rg --type py 'Invalid activation type' src/matgl/models/_chgnet.py

Length of output: 177


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Comment on lines +24 to +44
for readout_field in ["atom_feat", "bond_feat", "angle_feat"]:
for final_mlp_type in ["gated", "mlp"]:
model = CHGNet(
element_types=["Mo", "S"],
activation_type=activation,
bond_update_hidden_dims=bond_dim,
learn_basis=learn_basis,
angle_update_hidden_dims=angle_dim,
conv_dropout=dropout,
readout_field=readout_field,
final_mlp_type=final_mlp_type,
)
global_out = model(g=graph)
assert torch.numel(global_out) == 1
assert torch.numel(graph.ndata["magmom"]) == graph.num_nodes()
model.save(".")
CHGNet.load(".")
os.remove("model.pt")
os.remove("model.json")
os.remove("state.pt")

Copy link

Choose a reason for hiding this comment

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

Refactor repeated code in test_model method.

The instantiation of CHGNet and subsequent operations are repeated for each combination of readout_field and final_mlp_type. Consider refactoring this to reduce code duplication and improve maintainability. You could define a helper function that takes readout_field and final_mlp_type as parameters and performs the instantiation and checks.

+ def instantiate_and_test_model(readout_field, final_mlp_type):
+     model = CHGNet(
+         element_types=["Mo", "S"],
+         activation_type=activation,
+         bond_update_hidden_dims=bond_dim,
+         learn_basis=learn_basis,
+         angle_update_hidden_dims=angle_dim,
+         conv_dropout=dropout,
+         readout_field=readout_field,
+         final_mlp_type=final_mlp_type,
+     )
+     global_out = model(g=graph)
+     assert torch.numel(global_out) == 1
+     assert torch.numel(graph.ndata["magmom"]) == graph.num_nodes()
+     model.save(".")
+     CHGNet.load(".")
+     os.remove("model.pt")
+     os.remove("model.json")
+     os.remove("state.pt")
- for readout_field in ["atom_feat", "bond_feat", "angle_feat"]:
-     for final_mlp_type in ["gated", "mlp"]:
-         model = CHGNet(
-             element_types=["Mo", "S"],
-             activation_type=activation,
-             bond_update_hidden_dims=bond_dim,
-             learn_basis=learn_basis,
-             angle_update_hidden_dims=angle_dim,
-             conv_dropout=dropout,
-             readout_field=readout_field,
-             final_mlp_type=final_mlp_type,
-         )
-         global_out = model(g=graph)
-         assert torch.numel(global_out) == 1
-         assert torch.numel(graph.ndata["magmom"]) == graph.num_nodes()
-         model.save(".")
-         CHGNet.load(".")
-         os.remove("model.pt")
-         os.remove("model.json")
-         os.remove("state.pt")

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
for readout_field in ["atom_feat", "bond_feat", "angle_feat"]:
for final_mlp_type in ["gated", "mlp"]:
model = CHGNet(
element_types=["Mo", "S"],
activation_type=activation,
bond_update_hidden_dims=bond_dim,
learn_basis=learn_basis,
angle_update_hidden_dims=angle_dim,
conv_dropout=dropout,
readout_field=readout_field,
final_mlp_type=final_mlp_type,
)
global_out = model(g=graph)
assert torch.numel(global_out) == 1
assert torch.numel(graph.ndata["magmom"]) == graph.num_nodes()
model.save(".")
CHGNet.load(".")
os.remove("model.pt")
os.remove("model.json")
os.remove("state.pt")
def instantiate_and_test_model(readout_field, final_mlp_type):
model = CHGNet(
element_types=["Mo", "S"],
activation_type=activation,
bond_update_hidden_dims=bond_dim,
learn_basis=learn_basis,
angle_update_hidden_dims=angle_dim,
conv_dropout=dropout,
readout_field=readout_field,
final_mlp_type=final_mlp_type,
)
global_out = model(g=graph)
assert torch.numel(global_out) == 1
assert torch.numel(graph.ndata["magmom"]) == graph.num_nodes()
model.save(".")
CHGNet.load(".")
os.remove("model.pt")
os.remove("model.json")
os.remove("state.pt")

@kenko911 kenko911 merged commit 0426a80 into materialsvirtuallab:main May 12, 2024
3 checks passed
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.

None yet

1 participant