[Unitary Hack] Improve docstrings in submission/ir/task_specification.py #982
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #982 +/- ##
==========================================
+ Coverage 89.90% 89.91% +0.01%
==========================================
Files 110 110
Lines 8132 8132
==========================================
+ Hits 7311 7312 +1
+ Misses 821 820 -1 ☔ View full report in Codecov by Sentry. |
|
While I do appreciate the hard work you did in your previous PRs, please do not open new PRs if you still have other PRs under review. This is unfair to others who want to work on the same module. And this results in duplicated review comments. I have commented on other PRs; you should have one example demonstrating how to use the API in these user-facing APIs. |
@Roger-luo I understand what you meant. I am just trying my best to win some more bounties despite being new to the quantum field. I won't mention anyone now first. |
We are happy to provide anything you need to learn about neutral atom computing and quantum information. This is exactly why this hackathon is for, and we understand the hardness. Thus, improving docstring is designed to be a good and easy starting task for learning and joining the field. But submitting more PRs with similar issues won't win you more bounties except for producing more work for everyone. You really made a lot of good changes, and there are some promising PRs, so I really hope you can finish them and understand what these functions are for and be able to make examples for them. |
There was a problem hiding this comment.
I think as an addition to the doc strings and examples if you could rename all task_capabilities to device_capabilities I think this PR would be good to go.
The meaning of descretize is to make sore the resulting IR object is compatible with a device so making this change to the argument will communicate this better.
| Discretizes the global field values based on the task capabilities. | ||
|
|
||
| Args: | ||
| task_capabilities (QuEraCapabilities): Capabilities of the task for discretization. |
There was a problem hiding this comment.
| task_capabilities (QuEraCapabilities): Capabilities of the task for discretization. | |
| task_capabilities (QuEraCapabilities): Capabilities of the target device |
Sorry about this, the name of the argument isn't really intuitive here so this isn't really your fault but for context the capabilities for a particular quantum device not a task. This function is used to transform the IR nodes to be more compatible with a particular device.
| @@ -51,6 +68,15 @@ def __hash__(self): | |||
| return hash((RabiFrequencyAmplitude, self.global_)) | |||
|
|
|||
| def discretize(self, task_capabilities: QuEraCapabilities): | |||
There was a problem hiding this comment.
please go ahead and change all argument names task_capabilities to device_capabilities which is more accurate name for what this argument means.
| # Create a Detuning | ||
| detuning = Detuning(global_=global_field) | ||
|
|
||
| # Generate and display the figure | ||
| detuning_figure = detuning.figure() | ||
| show(detuning_figure) | ||
| ``` |
| # Define example capabilities | ||
| class RydbergCapabilities: | ||
| class GlobalCapabilities: | ||
| time_resolution = Decimal('0.5') | ||
| phase_resolution = Decimal('0.1') | ||
|
|
||
| global_ = GlobalCapabilities() | ||
|
|
||
| class Capabilities: | ||
| rydberg = RydbergCapabilities() | ||
|
|
||
| device_capabilities = QuEraCapabilities(capabilities=Capabilities()) |
There was a problem hiding this comment.
This is not the intended useage of this function. I suggest using the default capabilities instead of creating your own for the examples. if you want to modify the capabilities, modify the capabilities object directly before passing it into the method.
I would also make sure your examples run, this one is incomplete and doesn't run even if you have the correct imports.
Fixes #957
Added Module , function docstrings and removed Markdown errors.