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

Rename Qblox module classes #766

Merged
merged 2 commits into from
Jan 25, 2024
Merged

Conversation

PiergiorgioButtarini
Copy link
Contributor

Qblox modules now have conventional names. Also I removed a deprecated test file.

Closes #742
Checklist:

  • Reviewers confirm new code works as expected.
  • Tests are passing.
  • Coverage does not decrease.
  • Documentation is updated.

Copy link

codecov bot commented Jan 18, 2024

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (92f35df) 62.45% compared to head (dfef079) 62.45%.
Report is 47 commits behind head on main.

Files Patch % Lines
src/qibolab/instruments/qblox/controller.py 66.66% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #766   +/-   ##
=======================================
  Coverage   62.45%   62.45%           
=======================================
  Files          47       47           
  Lines        5867     5867           
=======================================
  Hits         3664     3664           
  Misses       2203     2203           
Flag Coverage Δ
unittests 62.45% <77.77%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@@ -18,7 +18,7 @@
from .sweeper import QbloxSweeper, QbloxSweeperType


class ClusterQRM_RF(ClusterModule):
class QrmRf(ClusterModule):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @PiergiorgioButtarini. I partly agree with the renames, particularly the removal of _. Maybe QrmRF would look better but no strong opinion from my side. Maybe we could also ask @aorgazf.

Other than that, could you please update the platforms in the other repo so that we can test?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I also prefer QrmRF but I wanted to follow @alecandido suggestions. I think also Alvaro will prefer this notation.
Sure I will open a PR with the updated runcards

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I said, there is some arbitrariness involved on which acronym you want to turn into words. You could consider a single acronym as a whole, and just use Qrmrf (to me, it's the ugliest).

Within my personal arbitrariness, I'd pick the current one. But the one suggested by you is also fine.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened the relative PR qiboteam/qibolab_platforms_qrc#107.

Copy link
Member

@stavros11 stavros11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I believe the instruments are not available for testing, but given that it is just a rename, it should be easy to identify any bugs so could be fine to even merge.

Regarding the name, I just suggested capital RF because it is closer to literature, does not strongly violate the naming convention (for that I am not sure though) and it is also used in a couple of places, such as

class RFSoC(Controller):

and in #661. But generally, excluding extremely bad choices (eg. class cluster_qcm_bb), I don't have strong opinion because no matter how intuitive we try to make names, most users will still need to look at the docs/code to know what to import.

@alecandido
Copy link
Member

does not strongly violate the naming convention (for that I am not sure though)

Indeed, as I said above, acronyms involve a certain degree of arbitrariness

But generally, excluding extremely bad choices (eg. class cluster_qcm_bb), I don't have strong opinion because no matter how intuitive we try to make names, most users will still need to look at the docs/code to know what to import.

For sure.

I would avoid even the current one, because still wrong (because of the _) even if mildly wrong. For the rest is a matter of taste, I will leave the choice to @PiergiorgioButtarini :)

@stavros11
Copy link
Member

Instruments are now working and QPU tests are passing, so we can probably merge this if the names are final.

@alecandido alecandido added this to the Qibolab 0.1.5 milestone Jan 25, 2024
@alecandido
Copy link
Member

I agree with @stavros11, this could be merged. It's a relatively small (and primarily internal) change, that has been already propagated consistently.

@PiergiorgioButtarini PiergiorgioButtarini merged commit 6d1de6f into main Jan 25, 2024
23 checks passed
@PiergiorgioButtarini PiergiorgioButtarini deleted the rename_qblox_classes branch February 12, 2024 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename Qblox modules classes
3 participants