Skip to content

[QDP] Enhance benchmark's installation journey#1154

Open
0lai0 wants to merge 3 commits intoapache:mainfrom
0lai0:Enhace_benchmark_installation
Open

[QDP] Enhance benchmark's installation journey#1154
0lai0 wants to merge 3 commits intoapache:mainfrom
0lai0:Enhace_benchmark_installation

Conversation

@0lai0
Copy link
Contributor

@0lai0 0lai0 commented Mar 8, 2026

Related Issues

Closes #1141

Changes

  • Bug fix
  • New feature
  • Refactoring
  • Documentation
  • Test
  • CI/CD pipeline
  • Other

Why

Currently, make benchmark doesn't exist, and setting up benchmarks requires multiple manual steps. Since the Python environment has been unified to use the root .venv, we should provide a simple make benchmark command from the root directory to streamline the benchmark setup and execution process.

How

  • Added benchmark and setup-benchmark targets to the root Makefile
    • setup-benchmark: Installs benchmark dependencies and builds QDP extension
    • benchmark: Sets up environment and displays instructions for running benchmarks
  • Updated qdp/qdp-python/benchmark/README.md to document make benchmark as the recommended way
  • Updated qdp/DEVELOPMENT.md to include make benchmark in the benchmarks section

Checklist

  • Added or updated unit tests for all changes
  • Added or updated documentation for all changes

Copy link
Member

@guan404ming guan404ming left a comment

Choose a reason for hiding this comment

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

Thanks

Then run individual benchmarks:

```bash
uv sync --group dev --extra qdp
Copy link
Member

Choose a reason for hiding this comment

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

Why do we need to remove these lines?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch! Thanks @guan404ming.
I found that setup-benchmark should include uv sync --group dev --extra qdp to ensure the qumat-qdp package path is properly registered in the environment, consistent with the development environment setup in DEVELOPMENT.md.
I will fix the Makefile to include this, and also restore the manual setup steps in the README as an alternative option. Will push a fix shortly!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I moved this line because it will be handled in make benchmark.

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.

Enhace benchmark's installation journey

2 participants