search

unitaryfund / mitiq

Mitiq is an open source toolkit for implementing error mitigation techniques on most current intermediate-scale quantum computers.
https://mitiq.readthedocs.io
GNU General Public License v3.0
352 stars 156 forks source link

Improve naming and documentation of `noise_scaling_converter` #1244

Closed Misty-W closed 1 year ago

Misty-W commented 2 years ago

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.
andreamari commented 2 years ago

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

in_out_converter() ? make_multi_frontend() ?

github-actions[bot] commented 1 year ago

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

MZuhairKhan commented 1 year ago

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

andreamari commented 1 year ago

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

MZuhairKhan commented 1 year ago

@andreamari Yes, I have registered this account!

Misty-W commented 1 year ago

@MZuhairKhan, anything we can help with?

MZuhairKhan commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

@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.