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

Add manually-triggered debugging workflow #6918

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

mhucka
Copy link
Contributor

@mhucka mhucka commented Jan 4, 2025

image

This workflow is designed to let you run pytest with various debugging options. It's meant to be executed manually using the "Run workflow" button on https://github.com/quantumlib/Cirq/actions/workflows/debug.yaml

Clicking the "Run workflow" button there will make GitHub present a form interface with various options for the characteristics of the run. (See screenshot at right.) Options include:

  • give it a specific test to run (in the form of a path to a test file)
  • set the number of repetitions of the test
  • set the python version to use
  • set the random seed
  • turn on verbose logging

This workflow was developed as an aid to debugging issue #6906, involving curve fitting that failed on occasion. This workflow is general and I think it will be useful for other debugging needs.

mhucka added 2 commits January 3, 2025 18:15
This workflow is designed to let you run pytest with various debugging
options. It's meant to be executed manually using "Run workflow"on
https://github.com/quantumlib/Cirq/actions/workflows/debug.yaml

Clicking the "Run workflow" button there will make GitHub present a
form interface with various options for the characteristics of the
run. Options include:

- give it a specific test to run (in the form of a path to a test file)
- set the number of repetitions of the test
- set the python version to use
- set the random seed
- turn on verbose logging

This workflow was developed as an aid to debugging issue quantumlib#6906,
involving curve fitting that failed on occasion. This workflow is
general and I think it will be useful for other debugging needs.
@CirqBot CirqBot added the size: M 50< lines changed <250 label Jan 4, 2025
Copy link

codecov bot commented Jan 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.86%. Comparing base (ecf9ed7) to head (5b22565).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6918   +/-   ##
=======================================
  Coverage   97.86%   97.86%           
=======================================
  Files        1084     1084           
  Lines       94315    94315           
=======================================
+ Hits        92301    92304    +3     
+ Misses       2014     2011    -3     

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

@mhucka mhucka marked this pull request as ready for review January 4, 2025 02:34
@mhucka mhucka requested review from vtomole and a team as code owners January 4, 2025 02:34
1) Turns out `--trace-config` is not that useful.
2) Using `--strict-config` seems like a good idea.
@mhucka mhucka self-assigned this Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: M 50< lines changed <250
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants