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: use rdkit API to remove implicit hydrogens #2278

Merged
merged 3 commits into from
Oct 3, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Oct 3, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced SMILES conversion process with improved implicit hydrogen handling for atoms.
  • Bug Fixes

    • Removed outdated method that previously handled SMILES conversion, streamlining the conversion process.
  • Tests

    • Removed a test related to the now-removed SMILES handling method, reflecting updates in testing strategy.
  • Chores

    • Minor formatting adjustments and removal of unused imports for cleaner code.

Copy link
Contributor

coderabbitai bot commented Oct 3, 2024

Warning

Rate limit exceeded

@njzjz has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 9 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between 3619f96 and 19284b9.

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request primarily involve the _path.py file, where the _re method in the _CollectPaths class has been removed, and the convertSMILES method has been updated to eliminate its previous dependency on _re. Additionally, the handling of implicit hydrogens in the convertSMILES method has been enhanced. In the test suite tests/test_reacnetgen.py, the test_re method has been removed, reflecting the changes in the functionality of the _HTMLResult class. Minor formatting adjustments have also been made across both files.

Changes

File Change Summary
reacnetgenerator/_path.py Removed _re method from _CollectPaths. Updated convertSMILES method to remove call to _re and added implicit hydrogen handling. Minor formatting adjustments and removal of unused imports.
tests/test_reacnetgen.py Removed test_re method from TestReacNetGen. Minor formatting adjustments in benchmark function definitions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ConvertSMILES
    participant RDKit

    User->>ConvertSMILES: Request SMILES conversion
    ConvertSMILES->>RDKit: Generate SMILES string
    RDKit-->>ConvertSMILES: Return SMILES string
    ConvertSMILES-->>User: Return final SMILES string
Loading

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

Signed-off-by: Jinzhe Zeng <[email protected]>
Copy link

codspeed-hq bot commented Oct 3, 2024

CodSpeed Performance Report

Merging #2278 will not alter performance

Comparing njzjz:remove-implicit-hydrogen (19284b9) with master (f5a25e9)

Summary

✅ 8 untouched benchmarks

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 (1)
reacnetgenerator/_path.py (1)

Line range hint 1-239: Approve removal of _re method and suggest documentation update

The removal of the _re method is consistent with the changes in the convertSMILES method and aligns with the PR objective to use the RDKit API directly for handling hydrogens. This simplification improves code maintainability and reduces potential sources of errors.

Consider updating the class documentation to reflect the removal of the _re method and the changes in the SMILES conversion process, if applicable.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8289d2c and 3619f96.

📒 Files selected for processing (2)
  • reacnetgenerator/_path.py (1 hunks)
  • tests/test_reacnetgen.py (0 hunks)
💤 Files with no reviewable changes (1)
  • tests/test_reacnetgen.py
🔇 Additional comments (2)
reacnetgenerator/_path.py (2)

234-237: Approve changes to handle implicit hydrogens explicitly

The modifications to the convertSMILES method align with the PR objective to remove implicit hydrogens using the RDKit API. By setting NoImplicit to True for each atom and updating the property cache, the code ensures that all hydrogens are explicitly represented in the molecule. This change improves the accuracy of the SMILES representation and prevents potential issues with implicit hydrogen handling in downstream processes.


Line range hint 1-239: Summary of changes and their impact

The modifications in this PR successfully implement the objective of using the RDKit API to remove implicit hydrogens. The changes primarily affect the SMILES conversion process in the _CollectPaths class:

  1. The _re method has been removed, simplifying the code.
  2. The convertSMILES method now directly uses RDKit's functionality to handle hydrogens explicitly.

These changes should improve the accuracy of SMILES representations and ensure consistency in hydrogen handling throughout the molecule processing pipeline. The code is now more streamlined and better aligned with RDKit's capabilities.

Signed-off-by: Jinzhe Zeng <[email protected]>
Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.05%. Comparing base (8289d2c) to head (19284b9).
Report is 9 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2278      +/-   ##
==========================================
+ Coverage   94.98%   96.05%   +1.06%     
==========================================
  Files          17       17              
  Lines        1415     1418       +3     
==========================================
+ Hits         1344     1362      +18     
+ Misses         71       56      -15     

☔ 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 Oct 3, 2024
Merged via the queue into deepmodeling:master with commit ac39c96 Oct 3, 2024
22 checks passed
@njzjz njzjz deleted the remove-implicit-hydrogen branch October 3, 2024 19:30
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