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

Fix(load_library): When ENABLE_CUSTOMIZED_OP = False, change op_info = None to op_info = {} #3912

Merged
merged 2 commits into from
Jun 26, 2024

Conversation

Chengqian-Zhang
Copy link
Collaborator

@Chengqian-Zhang Chengqian-Zhang commented Jun 26, 2024

Solve issue #3911

When I run examples/water/dpa2 using dp --pt train input_torch.json. An error occurs:
To get the best performance, it is recommended to adjust the number of threads by setting the environment variables OMP_NUM_THREADS, DP_INTRA_OP_PARALLELISM_THREADS, and DP_INTER_OP_PARALLELISM_THREADS. See https://deepmd.rtfd.io/parallelism/ for more information.
[2024-06-26 07:53:43,325] DEEPMD INFO DeepMD version: 2.2.0b1.dev892+g73dab63f.d20240612
[2024-06-26 07:53:43,325] DEEPMD INFO Configuration path: input_torch.json
Traceback (most recent call last):
File "/home/data/zhangcq/conda_env/deepmd-pt-1026/bin/dp", line 8, in
sys.exit(main())
File "/home/data/zcq/deepmd-source/deepmd-kit/deepmd/main.py", line 842, in main
deepmd_main(args)
File "/home/data/zhangcq/conda_env/deepmd-pt-1026/lib/python3.10/site-packages/torch/distributed/elastic/multiprocessing/errors/init.py", line 346, in wrapper
return f(*args, **kwargs)
File "/home/data/zcq/deepmd-source/deepmd-kit/deepmd/pt/entrypoints/main.py", line 384, in main
train(FLAGS)
File "/home/data/zcq/deepmd-source/deepmd-kit/deepmd/pt/entrypoints/main.py", line 223, in train
SummaryPrinter()()
File "/home/data/zcq/deepmd-source/deepmd-kit/deepmd/utils/summary.py", line 62, in call
build_info.update(self.get_backend_info())
File "/home/data/zcq/deepmd-source/deepmd-kit/deepmd/pt/entrypoints/main.py", line 213, in get_backend_info
return {
TypeError: 'NoneType' object is not a mapping

This bug is made by PR #3895
20240626-160240
When op_info is None, {**op_info} will raise error. Changing op_info = None to op_info = {} will solve the issue.

Summary by CodeRabbit

  • Bug Fixes
    • Improved system stability by initializing op_info as an empty dictionary instead of None, preventing potential runtime errors.

Copy link
Contributor

coderabbitai bot commented Jun 26, 2024

Walkthrough

Walkthrough

The recent changes involve a minor alteration in the initialization of op_info within the get_backend_info method of a class in the deepmd/pt/entrypoints module. Previously, op_info was set to None, but it is now initialized as an empty dictionary {}. This adjustment ensures that op_info is always a dictionary, simplifying downstream usage and possibly preventing NoneType errors.

Changes

File Path Change Summary
deepmd/pt/entrypoints/main.py Initialized op_info as an empty dictionary {} instead of None.

Sequence Diagram(s)

Since the changes involve only the modification of the initialization of a variable within a method, no new features or complex control flows have been introduced. Therefore, a sequence diagram is not necessary for this update.


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2f18f04 and 1e5caa2.

Files selected for processing (1)
  • deepmd/pt/entrypoints/main.py (1 hunks)
Additional context used
Ruff
deepmd/pt/entrypoints/main.py

117-117: Local variable f is assigned to but never used (F841)

Remove assignment to unused variable f


374-377: Use ternary operator FLAGS = parse_args(args=args) if not isinstance(args, argparse.Namespace) else args instead of if-else-block (SIM108)

Replace if-else-block with FLAGS = parse_args(args=args) if not isinstance(args, argparse.Namespace) else args

Additional comments not posted (1)
deepmd/pt/entrypoints/main.py (1)

212-212: Good fix to prevent TypeError in dictionary merging.

Changing op_info from None to {} when ENABLE_CUSTOMIZED_OP is False is a necessary fix to prevent runtime errors during dictionary merging. This change ensures that op_info can always be safely merged with other dictionaries.


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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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
Contributor

@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: 0

Outside diff range and nitpick comments (2)
deepmd/pt/entrypoints/main.py (2)

Line range hint 117-117: Remove unused variable.

The variable f is opened but never used, which could lead to unnecessary resource allocation.

- with h5py.File(stat_file_path_single, "w") as f:
+ h5py.File(stat_file_path_single, "w").close()

Line range hint 374-377: Simplify assignment using ternary operator.

Using a ternary operator here will make the code more concise and readable.

- if not isinstance(args, argparse.Namespace):
-     FLAGS = parse_args(args=args)
- else:
-     FLAGS = args
+ FLAGS = parse_args(args=args) if not isinstance(args, argparse.Namespace) else args

Copy link

codecov bot commented Jun 26, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 82.72%. Comparing base (2f18f04) to head (1e5caa2).
Report is 116 commits behind head on devel.

Files with missing lines Patch % Lines
deepmd/pt/entrypoints/main.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #3912   +/-   ##
=======================================
  Coverage   82.72%   82.72%           
=======================================
  Files         519      519           
  Lines       50515    50515           
  Branches     3015     3015           
=======================================
  Hits        41790    41790           
  Misses       7788     7788           
  Partials      937      937           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@njzjz njzjz added this pull request to the merge queue Jun 26, 2024
Merged via the queue into deepmodeling:devel with commit 17cdcb0 Jun 26, 2024
60 checks passed
mtaillefumier pushed a commit to mtaillefumier/deepmd-kit that referenced this pull request Sep 18, 2024
…fo = None` to `op_info = {}` (deepmodeling#3912)

Solve issue deepmodeling#3911 

When I run `examples/water/dpa2` using `dp --pt train input_torch.json`.
An error occurs:
To get the best performance, it is recommended to adjust the number of
threads by setting the environment variables OMP_NUM_THREADS,
DP_INTRA_OP_PARALLELISM_THREADS, and DP_INTER_OP_PARALLELISM_THREADS.
See https://deepmd.rtfd.io/parallelism/ for more information.
[2024-06-26 07:53:43,325] DEEPMD INFO DeepMD version:
2.2.0b1.dev892+g73dab63f.d20240612
[2024-06-26 07:53:43,325] DEEPMD INFO Configuration path:
input_torch.json
Traceback (most recent call last):
File "/home/data/zhangcq/conda_env/deepmd-pt-1026/bin/dp", line 8, in
<module>
    sys.exit(main())
File "/home/data/zcq/deepmd-source/deepmd-kit/deepmd/main.py", line 842,
in main
    deepmd_main(args)
File
"/home/data/zhangcq/conda_env/deepmd-pt-1026/lib/python3.10/site-packages/torch/distributed/elastic/multiprocessing/errors/__init__.py",
line 346, in wrapper
    return f(*args, **kwargs)
File
"/home/data/zcq/deepmd-source/deepmd-kit/deepmd/pt/entrypoints/main.py",
line 384, in main
    train(FLAGS)
File
"/home/data/zcq/deepmd-source/deepmd-kit/deepmd/pt/entrypoints/main.py",
line 223, in train
    SummaryPrinter()()
File "/home/data/zcq/deepmd-source/deepmd-kit/deepmd/utils/summary.py",
line 62, in __call__
    build_info.update(self.get_backend_info())
File
"/home/data/zcq/deepmd-source/deepmd-kit/deepmd/pt/entrypoints/main.py",
line 213, in get_backend_info
    return {
TypeError: 'NoneType' object is not a mapping

This bug is made by PR deepmodeling#3895 

![20240626-160240](https://github.com/deepmodeling/deepmd-kit/assets/100290172/92008b01-1e3d-437d-a09e-cc74b2da6412)
When `op_info` is `None`, `{**op_info}` will raise error. Changing
`op_info = None` to `op_info = {}` will solve the issue.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Bug Fixes**
- Improved system stability by initializing `op_info` as an empty
dictionary instead of `None`, preventing potential runtime errors.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] TypeError: 'NoneType' object is not a mapping when running dp --pt train in devel branch
2 participants