feat(pt): add Mean absolute percentage error (MAPE) loss for prop. pred. #4854

SchrodingersCattt · 2025-07-29T12:35:34Z

feat: add Mean absolute percentage error (MAPE) loss for property prediction

Summary by CodeRabbit

New Features
- Added support for the Mean Absolute Percentage Error (MAPE) as a selectable loss function and metric.
Documentation
- Updated user-facing documentation to include "mape" as an option for loss function selection.

…diction

for more information, see https://pre-commit.ci

coderabbitai · 2025-07-29T12:38:14Z

📝 Walkthrough

Walkthrough

Support for the "mape" (Mean Absolute Percentage Error) loss function and metric is added to the PropertyLoss class. This includes updating the constructor documentation and implementing the MAPE calculation in the forward method for both loss and metric reporting.

Changes

Cohort / File(s)	Change Summary
PropertyLoss MAPE Support `deepmd/pt/loss/property.py`	Added "mape" as a supported loss function and metric in `PropertyLoss`; updated docstring and implemented MAPE computation in `forward`.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3b4ab75 and 04e3517.

📒 Files selected for processing (1)

deepmd/pt/loss/property.py (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

deepmd/pt/loss/property.py

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this 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.

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b494a0d and 8dae2fa.

📒 Files selected for processing (1)

deepmd/pt/loss/property.py (3 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

deepmd/pt/loss/property.py (1)

deepmd/driver.py (1)

label (42-75)

🪛 Ruff (0.12.2)

deepmd/pt/loss/property.py

192-192: f-string without any placeholders

Remove extraneous f prefix

(F541)

🔇 Additional comments (1)

deepmd/pt/loss/property.py (1)

45-45: LGTM!

The documentation correctly includes "mape" as a supported loss function option.

deepmd/pt/loss/property.py

codecov · 2025-07-29T18:10:24Z

Codecov Report

❌ Patch coverage is 25.00000% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.76%. Comparing base (43504d3) to head (04e3517).
⚠️ Report is 79 commits behind head on devel.

Files with missing lines	Patch %	Lines
deepmd/pt/loss/property.py	25.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##            devel    #4854      +/-   ##
==========================================
- Coverage   84.76%   84.76%   -0.01%     
==========================================
  Files         699      699              
  Lines       68077    68080       +3     
  Branches     3541     3542       +1     
==========================================
+ Hits        57708    57710       +2     
- Misses       9235     9237       +2     
+ Partials     1134     1133       -1

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…ed. (deepmodeling#4854) feat: add Mean absolute percentage error (MAPE) loss for property prediction  ## Summary by CodeRabbit * **New Features** * Added support for the Mean Absolute Percentage Error (MAPE) as a selectable loss function and metric. * **Documentation** * Updated user-facing documentation to include "mape" as an option for loss function selection.  --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

feat: add Mean absolute percentage error (MAPE) loss for property pre…

8dae2fa

…diction

github-actions bot added the Python label Jul 29, 2025

SchrodingersCattt changed the base branch from master to devel July 29, 2025 12:36

[pre-commit.ci] auto fixes from pre-commit.com hooks

5d1a1d1

for more information, see https://pre-commit.ci

github-actions bot added the Docs label Jul 29, 2025

Merge branch 'devel' into feat/gmy/property-mape

3b4ab75

coderabbitai bot reviewed Jul 29, 2025

View reviewed changes

deepmd/pt/loss/property.py Show resolved Hide resolved

deepmd/pt/loss/property.py Outdated Show resolved Hide resolved

fix: add detach for MAPE

7e0173c

SchrodingersCattt changed the title ~~feat: add Mean absolute percentage error (MAPE) loss for prop. pred.~~ feat(pt): add Mean absolute percentage error (MAPE) loss for prop. pred. Jul 29, 2025

Chengqian-Zhang approved these changes Jul 29, 2025

View reviewed changes

njzjz enabled auto-merge July 29, 2025 17:15

njzjz disabled auto-merge July 29, 2025 17:15

Merge branch 'devel' into feat/gmy/property-mape

04e3517

njzjz approved these changes Jul 31, 2025

View reviewed changes

njzjz enabled auto-merge July 31, 2025 10:28

njzjz closed this Aug 1, 2025

auto-merge was automatically disabled August 1, 2025 13:30
Pull request was closed

njzjz reopened this Aug 1, 2025

njzjz enabled auto-merge August 1, 2025 13:30

njzjz added this pull request to the merge queue Aug 1, 2025

Merged via the queue into deepmodeling:devel with commit 1dc1248 Aug 1, 2025
104 of 106 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(pt): add Mean absolute percentage error (MAPE) loss for prop. pred. #4854

feat(pt): add Mean absolute percentage error (MAPE) loss for prop. pred. #4854

Uh oh!

SchrodingersCattt commented Jul 29, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 29, 2025 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Jul 29, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat(pt): add Mean absolute percentage error (MAPE) loss for prop. pred. #4854

feat(pt): add Mean absolute percentage error (MAPE) loss for prop. pred. #4854

Uh oh!

Conversation

SchrodingersCattt commented Jul 29, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

SchrodingersCattt commented Jul 29, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 29, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jul 29, 2025 •

edited

Loading