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

add convertion for small type_map in deepmd system #676

Closed
wants to merge 1 commit into from

Conversation

iProzd
Copy link
Collaborator

@iProzd iProzd commented Jun 23, 2024

Summary by CodeRabbit

  • Bug Fixes
    • Improved sorting of atom names to handle cases where atom types are deleted, ensuring accurate atom name and type updates.

Copy link

coderabbitai bot commented Jun 23, 2024

Walkthrough

Walkthrough

The dpdata/utils.py file has been updated to enhance the functionality for sorting atom names. This includes adding logic to manage deletions based on atom numbers and ensuring that both atom names and types are updated correspondingly. This improvement aims to maintain consistency and correctness in the atom data representation after any changes.

Changes

File Change Summary
dpdata/utils.py Updated sort_atom_names function to include handling for type mapping and updating atom names and types based on atom numbers.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant sort_atom_names
    participant TypeMapHandler
    participant DataUpdater
    
    User->>sort_atom_names: Call function with data and type_map
    sort_atom_names->>TypeMapHandler: Determine which types to delete based on atom numbers
    TypeMapHandler-->>sort_atom_names: Return updated types
    sort_atom_names->>DataUpdater: Update atom names and types
    DataUpdater-->>sort_atom_names: Return updated atom names and types
    sort_atom_names-->>User: Return sorted atom names and updated types
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a9a8b48 and b908d6f.

Files selected for processing (1)
  • dpdata/utils.py (1 hunks)
Additional context used
Ruff
dpdata/utils.py

6-6: Version block is outdated for minimum Python version (UP036)

Remove outdated version block


125-125: Loop control variable idx not used within loop body (B007)

Rename unused idx to _idx


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

codspeed-hq bot commented Jun 23, 2024

CodSpeed Performance Report

Merging #676 will not alter performance

Comparing iProzd:slim_tm (b908d6f) with devel (a9a8b48)

Summary

✅ 2 untouched benchmarks

@iProzd iProzd closed this Jun 23, 2024
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: 2

Outside diff range and nitpick comments (2)
dpdata/utils.py (2)

Line range hint 6-6: Remove outdated version block.

The version block checking for Python 3.8 is outdated and should be removed, as the minimum supported Python version is now higher.

- if sys.version_info >= (3, 8):
-     from typing import Literal
- else:
-     from typing_extensions import Literal
+ from typing import Literal

This change removes unnecessary code and simplifies the import statements.


Line range hint 125-125: Rename unused loop control variable.

In the uniq_atom_names function, the loop control variable idx is not used and should be renamed to _ to indicate its purpose.

- for idx, ii in enumerate(data["atom_names"]):
+ for _, ii in enumerate(data["atom_names"]):

This change makes it clear that the loop index is not used within the loop body.

Comment on lines +80 to +89
if not set(data["atom_names"]).issubset(set(type_map)):
# delete the types where atom_numbs == 0
real_index = np.array(data["atom_numbs"]) > 0
real_map = list(np.array(data["atom_names"])[real_index])
assert set(real_map).issubset(set(type_map))
data["atom_numbs"] = list(np.array(data["atom_numbs"])[real_index])
idx = np.zeros(len(data["atom_names"]), dtype=int)
idx[real_index] = np.arange(len(real_map))
data["atom_names"] = real_map
data["atom_types"] = idx[data["atom_types"]]
Copy link

Choose a reason for hiding this comment

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

Refactor the type filtering logic for clarity and performance.

The logic to filter out atom types where atom_numbs equals zero is complex and may be hard to follow. Consider refactoring for better clarity and potentially improved performance.

- real_index = np.array(data["atom_numbs"]) > 0
- real_map = list(np.array(data["atom_names"])[real_index])
- assert set(real_map).issubset(set(type_map))
- data["atom_numbs"] = list(np.array(data["atom_numbs"])[real_index])
- idx = np.zeros(len(data["atom_names"]), dtype=int)
- idx[real_index] = np.arange(len(real_map))
- data["atom_names"] = real_map
- data["atom_types"] = idx[data["atom_types"]]
+ filtered_atoms = [(name, num) for name, num in zip(data["atom_names"], data["atom_numbs"]) if num > 0]
+ assert all(name in type_map for name, _ in filtered_atoms)
+ data["atom_names"], data["atom_numbs"] = zip(*filtered_atoms) if filtered_atoms else ([], [])
+ data["atom_types"] = np.arange(len(data["atom_names"]))[data["atom_types"]]

This refactoring uses list comprehension for filtering and asserts, making the code more Pythonic and potentially faster by reducing the need for multiple numpy array conversions.

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. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if not set(data["atom_names"]).issubset(set(type_map)):
# delete the types where atom_numbs == 0
real_index = np.array(data["atom_numbs"]) > 0
real_map = list(np.array(data["atom_names"])[real_index])
assert set(real_map).issubset(set(type_map))
data["atom_numbs"] = list(np.array(data["atom_numbs"])[real_index])
idx = np.zeros(len(data["atom_names"]), dtype=int)
idx[real_index] = np.arange(len(real_map))
data["atom_names"] = real_map
data["atom_types"] = idx[data["atom_types"]]
if not set(data["atom_names"]).issubset(set(type_map)):
# delete the types where atom_numbs == 0
filtered_atoms = [(name, num) for name, num in zip(data["atom_names"], data["atom_numbs"]) if num > 0]
assert all(name in type_map for name, _ in filtered_atoms)
data["atom_names"], data["atom_numbs"] = zip(*filtered_atoms) if filtered_atoms else ([], [])
data["atom_types"] = np.arange(len(data["atom_names"]))[data["atom_types"]]

Optimize the handling of new atoms.

The current method for handling new atoms is efficient but could be further optimized by directly updating data within the add_atom_names function, thus avoiding potential issues with data consistency.

- new_atoms = [e for e in type_map if e not in data["atom_names"]]
- if new_atoms:
-    data = add_atom_names(data, new_atoms)
+ data = add_atom_names(data, [e for e in type_map if e not in data["atom_names"]])

This change ensures that data is always updated regardless of whether new atoms are added, simplifying the control flow and potentially reducing the risk of bugs.

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. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if not set(data["atom_names"]).issubset(set(type_map)):
# delete the types where atom_numbs == 0
real_index = np.array(data["atom_numbs"]) > 0
real_map = list(np.array(data["atom_names"])[real_index])
assert set(real_map).issubset(set(type_map))
data["atom_numbs"] = list(np.array(data["atom_numbs"])[real_index])
idx = np.zeros(len(data["atom_names"]), dtype=int)
idx[real_index] = np.arange(len(real_map))
data["atom_names"] = real_map
data["atom_types"] = idx[data["atom_types"]]
if not set(data["atom_names"]).issubset(set(type_map)):
# delete the types where atom_numbs == 0
real_index = np.array(data["atom_numbs"]) > 0
real_map = list(np.array(data["atom_names"])[real_index])
assert set(real_map).issubset(set(type_map))
data["atom_numbs"] = list(np.array(data["atom_numbs"])[real_index])
idx = np.zeros(len(data["atom_names"]), dtype=int)
idx[real_index] = np.arange(len(real_map))
data["atom_names"] = real_map
data["atom_types"] = idx[data["atom_types"]]
data = add_atom_names(data, [e for e in type_map if e not in data["atom_names"]])

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.

1 participant