-
Notifications
You must be signed in to change notification settings - Fork 7
Doc: update readme and task name #364
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates documentation and display names in the LAMBench project. The changes focus on improving clarity and consistency in task naming conventions and updating dataset references.
- Updates display names for three tasks in the metadata: "Phonon Properties" → "Phonon MDR", "Torsional Barrier" → "TorsionNet500", and "NEB" → "OC20NEB-OOD"
- Consolidates dataset references in README to point to a single comprehensive dataset location
- Removes redundant phonon dataset reference and streamlines documentation
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| lambench/metrics/results/metadata.json | Updates task display names to be more specific and descriptive |
| README.md | Consolidates dataset references and removes redundant links |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
| "DISPLAY_NAME": "NEB", | ||
| "DESCRIPTION": "Evaluation of NEB related metrics on the OC20NEB-OOD dataset. The dataset contains 460 NEB trajectories over 3 types of reactions: desorption, dissociation, and transfer. For details, please refer to https://arxiv.org/abs/2405.02078. The energy barrier height is calculated with single point energy prediction on DFT relaxed structures using the LAM model without performing NEB optimization.", | ||
| "DISPLAY_NAME": "OC20NEB-OOD", | ||
| "DESCRIPTION": "Evaluation of energy barrier related metrics on the OC20NEB-OOD dataset. The dataset contains 460 NEB trajectories over 3 types of reactions: desorption, dissociation, and transfer. For details, please refer to https://arxiv.org/abs/2405.02078. The energy barrier height is calculated with single point energy prediction on DFT relaxed structures using the LAM model without performing NEB optimization.", |
Copilot
AI
Aug 15, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The description should use "NEB-related" instead of "energy barrier related" to maintain consistency with the original "NEB related metrics" terminology used elsewhere in the codebase.
| "DESCRIPTION": "Evaluation of energy barrier related metrics on the OC20NEB-OOD dataset. The dataset contains 460 NEB trajectories over 3 types of reactions: desorption, dissociation, and transfer. For details, please refer to https://arxiv.org/abs/2405.02078. The energy barrier height is calculated with single point energy prediction on DFT relaxed structures using the LAM model without performing NEB optimization.", | |
| "DESCRIPTION": "Evaluation of NEB-related metrics on the OC20NEB-OOD dataset. The dataset contains 460 NEB trajectories over 3 types of reactions: desorption, dissociation, and transfer. For details, please refer to https://arxiv.org/abs/2405.02078. The energy barrier height is calculated with single point energy prediction on DFT relaxed structures using the LAM model without performing NEB optimization.", |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #364 +/- ##
=======================================
Coverage 65.89% 65.89%
=======================================
Files 35 35
Lines 1589 1589
Branches 189 189
=======================================
Hits 1047 1047
Misses 500 500
Partials 42 42 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
No description provided.