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

Update link in resilience_options.py #1807

Merged
merged 10 commits into from
Jul 22, 2024
Merged

Update link in resilience_options.py #1807

merged 10 commits into from
Jul 22, 2024

Conversation

beckykd
Copy link
Collaborator

@beckykd beckykd commented Jul 18, 2024

The link in measure_mitgation pointed to measure_noise_learning

Summary

Details and comments

Fixes #

The link in measure_mitgation pointed to measure_noise_learning
@beckykd beckykd requested review from kt474 and jyu00 July 18, 2024 14:41
@beckykd beckykd temporarily deployed to ibm-quantum-production July 18, 2024 14:50 — with GitHub Actions Inactive
@beckykd beckykd temporarily deployed to ibm-cloud-production July 18, 2024 14:50 — with GitHub Actions Inactive
@jyu00
Copy link
Collaborator

jyu00 commented Jul 18, 2024

@beckykd the text is meant to say that you can use measure_mitigation to enable measurement mitigation, and if you want to fine tune that, you can use the suboptions under measure_noise_learning.

Having said that, linking to :attr:~measure_noise_learning is not very helpful. In the API doc, if I click on that link, it just brings me to the measure_noise_learning attribute. It'd be more useful if it says something like

If you enable measurement mitigation, you can fine tune its noise learning using :attr:`~measure_noise_learning`. 
See :class:`MeasureNoiseLearningOptions` for all measurement mitigation noise learning options.

@beckykd
Copy link
Collaborator Author

beckykd commented Jul 18, 2024

Having said that, linking to :attr:~measure_noise_learning is not very helpful. In the API doc, if I click on that link, it just brings me to the measure_noise_learning attribute. It'd be more useful if it says something like

I totally agree that linking to that attribute isn't helpful - especially since it's just a boolean value. I did it like that to match the rest of the page. Should we also update zne_mitigation then? Maybe just delete the sentence about further options; or change it to something useful?

@jyu00
Copy link
Collaborator

jyu00 commented Jul 18, 2024

Should we also update zne_mitigation then?

Yeah I think that'd be the most useful and consistent way.

@kt474 kt474 temporarily deployed to ibm-quantum-production July 18, 2024 20:24 — with GitHub Actions Inactive
@kt474 kt474 temporarily deployed to ibm-cloud-production July 18, 2024 20:24 — with GitHub Actions Inactive
@kt474 kt474 changed the base branch from stable/0.25 to main July 19, 2024 15:43
@kt474 kt474 temporarily deployed to ibm-quantum-production July 19, 2024 15:53 — with GitHub Actions Inactive
@kt474 kt474 temporarily deployed to ibm-cloud-production July 19, 2024 15:53 — with GitHub Actions Inactive
@kt474 kt474 temporarily deployed to ibm-quantum-production July 21, 2024 21:26 — with GitHub Actions Inactive
@kt474 kt474 temporarily deployed to ibm-cloud-production July 21, 2024 21:26 — with GitHub Actions Inactive
@kt474 kt474 temporarily deployed to ibm-quantum-production July 22, 2024 13:25 — with GitHub Actions Inactive
@kt474 kt474 temporarily deployed to ibm-cloud-production July 22, 2024 13:25 — with GitHub Actions Inactive
@kt474 kt474 merged commit 18b571d into main Jul 22, 2024
36 checks passed
@kt474 kt474 deleted the beckykd-patch-1 branch July 22, 2024 21:31
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.

3 participants