Raising a warning for running analysis on an empty ExperimentData object
#1313
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yaelbh
approved these changes
Nov 9, 2023
releasenotes/notes/add_warning_analysis_without_data-bfc802da52591f13.yaml
Outdated
Show resolved
Hide resolved
…2591f13.yaml Co-authored-by: Yael Ben-Haim <yaelbh@il.ibm.com>
nkanazawa1989
pushed a commit
to nkanazawa1989/qiskit-experiments
that referenced
this pull request
Jan 17, 2024
…bject (qiskit-community#1313) ### Summary Added a warning for the user if the `ExperimentData` data is empty before running an analysis and if the data couldn't be retrieved. ### Details and comments Some details that should be in this section include: - The user will get an un-inductive error regarding the analysis while the reason it was raised is because the analysis doesn't have data to analyze from the experiment. We can see an example in qiskit-community#1182 . - A solution that was suggested was to raise an error that says the user is trying to run analysis on empty `ExperimentData` object but the team didn't want to constraint the user to run analysis only if the experiment has data so we decided that raising a warning is enough. Changes: - [x] Added warning before analysis if `ExperimentData.data()` is empty. ### PR checklist (delete when all criteria are met) - [x] I have read the contributing guide `CONTRIBUTING.md`. - [x] I have added a release note file using `reno` if this change needs to be documented in the release notes. --------- Co-authored-by: Yael Ben-Haim <yaelbh@il.ibm.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added a warning for the user if the
ExperimentDatadata is empty before running an analysis and if the data couldn't be retrieved.Details and comments
Some details that should be in this section include:
ExperimentDataobject but the team didn't want to constraint the user to run analysis only if the experiment has data so we decided that raising a warning is enough.Changes:
ExperimentData.data()is empty.PR checklist (delete when all criteria are met)
CONTRIBUTING.md.renoif this change needs to be documented in the release notes.