search

deepmodeling / dpdata

Manipulating multiple atomic simulation data formats, including DeePMD-kit, VASP, LAMMPS, ABACUS, etc.
https://docs.deepmodeling.com/projects/dpdata/
GNU Lesser General Public License v3.0
188 stars 128 forks source link

benchmark performance of import #653

Closed njzjz closed 1 month ago

njzjz commented 1 month ago

Do a benchmark before working on #526

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent updates focus on bolstering testing capabilities through the introduction of benchmark testing for a Python package. The project now features a GitHub Actions workflow (benchmark.yml) that sets up Python, installs dependencies, and executes benchmarks using CodSpeedHQ. Furthermore, the pyproject.toml file now includes pytest and pytest-codspeed in the benchmark section to support these new tests. A new test file, test_import.py, has been added to assess importing dpdata and its command line interface.

Changes

File(s) Change Summary
.github/workflows/benchmark.yml Introduces a GitHub Actions workflow for running benchmarks using CodSpeedHQ.
pyproject.toml Added pytest and pytest-codspeed to the benchmark section.
tests/benchmark/test_import.py Added benchmark tests for importing dpdata and testing the dpdata command line interface.

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.63%. Comparing base (8b9fd0f) to head (cd9cc4f). Report is 1 commits behind head on devel.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## devel #653 +/- ## ======================================= Coverage 83.63% 83.63% ======================================= Files 81 81 Lines 7009 7009 ======================================= Hits 5862 5862 Misses 1147 1147 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codspeed-hq[bot] commented 1 month ago

CodSpeed Performance Report

Congrats! CodSpeed is installed 🎉

🆕 2 new benchmarks were detected.

You will start to see performance impacts in the reports once the benchmarks are run from your default branch.

Detected benchmarks

 - `test_cli` (671.5 µs) - `test_import` (729 µs)
adriencaccia commented 1 month ago

Hey @njzjz, I am a co-founder @CodSpeedHQ, glad to see you trying out our tool!

You use the CodSpeed action inside a matrix, thus running the action 3 times with different Python versions. However, this will not work properly as CodSpeed is built to run only once per PR. There might be instances where the job is picked up correctly, and not the same Python version will be picked up each time.

I recommend that you create a separate workflow file or job with a single Python version and single use of the CodSpeed action. I recommend using Python 3.12, so that you can benefit from the automated flamegraphs in the CodSpeed UI 😉

njzjz commented 1 month ago

I recommend that you create a separate workflow file or job with a single Python version and single use of the CodSpeed action. I recommend using Python 3.12, so that you can benefit from the automated flamegraphs in the CodSpeed UI 😉

Thanks for your friendly reminder!