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

Improve naming and documentation of noise_scaling_converter #1244

Closed
Misty-W opened this issue Apr 23, 2022 · 9 comments · Fixed by #1866
Closed

Improve naming and documentation of noise_scaling_converter #1244

Misty-W opened this issue Apr 23, 2022 · 9 comments · Fixed by #1866
Assignees
Labels
good first issue Good for newcomers interface-and-conversions How Mitiq interfaces with quantum software packages. non-quantum Requires no knowledge of quantum physics to fix / work on. priority/mid Should be fixed by the next 1-2 milestones. unitaryhack-bounty
Milestone

Comments

@Misty-W
Copy link
Contributor

Misty-W commented Apr 23, 2022

The noise_scaling_converter function needs to be renamed to reflect its generality. It can be applied in many more cases than just noise-scaling functions.

Resolution of this issue will require

  1. renaming the function (throughout the code),
  2. rewriting the docstring, and
  3. ensuring tests cover more than just noise scaling functions.
@Misty-W Misty-W added the feature-request A request for a feature, tool, or workflow in Mitiq. label Apr 23, 2022
@Misty-W Misty-W modified the milestones: 0.15.0, 0.16.0 Apr 23, 2022
@Misty-W Misty-W removed this from the 0.16.0 milestone Apr 23, 2022
@Misty-W Misty-W added this to the 0.16.0 milestone Apr 23, 2022
@andreamari andreamari added priority/mid Should be fixed by the next 1-2 milestones. interface-and-conversions How Mitiq interfaces with quantum software packages. labels Apr 25, 2022
@andreamari
Copy link
Member

Good point! Do you have name suggestions? E.g.

in_out_converter() ?
make_multi_frontend() ?

@andreamari andreamari removed this from the 0.16.0 milestone May 6, 2022
@github-actions
Copy link

github-actions bot commented Sep 4, 2022

This issue had no activity for 4 months, and will be closed in 2 weeks unless there is new activity. Cheers!

@github-actions github-actions bot added the stale label Sep 4, 2022
@andreamari andreamari removed the stale label Sep 6, 2022
@natestemen natestemen added non-quantum Requires no knowledge of quantum physics to fix / work on. and removed feature-request A request for a feature, tool, or workflow in Mitiq. labels May 16, 2023
@MZuhairKhan
Copy link
Contributor

Hey Misty! I would love to give this a whirl!

@andreamari
Copy link
Member

@MZuhairKhan, it's yours!
Just to double check, did you register at https://unitaryhack.dev/ ?

@MZuhairKhan
Copy link
Contributor

@andreamari Yes, I have registered this account!

@Misty-W
Copy link
Contributor Author

Misty-W commented May 30, 2023

@MZuhairKhan, anything we can help with?

@MZuhairKhan
Copy link
Contributor

3. ensuring tests cover more than just noise scaling functions.

@Misty-W, Yes, what other tests do I need to add? Will these be unit tests or something else?

@natestemen
Copy link
Member

what other tests do I need to add? Will these be unit tests or something else?

That's a good question, sorry it wasn't a little more clear! I think it depends on how you write the docstring and rename the function. If you put up a PR we'd be happy to provide some feedback directly on code!

@MZuhairKhan
Copy link
Contributor

@natestemen Sorry for the later reply. I have just renamed the built-in test for now. You can have a look at the PR above. I'll make any changes asap, specially if you dislike the name.

@Misty-W Misty-W added this to the 0.29.0 milestone Aug 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers interface-and-conversions How Mitiq interfaces with quantum software packages. non-quantum Requires no knowledge of quantum physics to fix / work on. priority/mid Should be fixed by the next 1-2 milestones. unitaryhack-bounty
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants