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

Renaming and moving things around to match architecture #539

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from

Conversation

apchytr
Copy link
Collaborator

@apchytr apchytr commented Jan 16, 2025

Context: Offline discussion has made it apparent that certain objects within lab_dev (such as Circuit) should be renamed and grouped together to reflect the architectural decisions we're making. Circuits now should refer to a future 'Circuit' layer and what is currently in lab_dev is the 'Computational Graph' layer.

Description of the Change: Renamed circuits.py to computational_graph.py, circuit_components.py to graph_component.py. Moved graph_component.py, branch_and_bound.py and computational_graph.py to a computational_graphs folder. Renamed Circuit to ComputationalGraph, GraphComponent to LightGraphComponent, CircuitComponent to GraphComponent. Updated docs to reflect these changes.

Benefits: Makes things clearer

Possible Drawbacks: Since lab_dev has been around for so long people have most likely gotten used to terms such as CircuitComponent, Circuit, etc so there will be an adjustment period.

@apchytr apchytr added the no changelog Pull request does not require a CHANGELOG entry label Jan 16, 2025
@apchytr apchytr requested a review from ziofil January 16, 2025 18:36
@apchytr
Copy link
Collaborator Author

apchytr commented Jan 16, 2025

Would love to hear people's opinion on what we should actually name things. Perhaps computational_graph is better?

Copy link

codecov bot commented Jan 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.05%. Comparing base (5a11703) to head (ce2aca9).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #539   +/-   ##
========================================
  Coverage    90.05%   90.05%           
========================================
  Files          102      103    +1     
  Lines         6222     6223    +1     
========================================
+ Hits          5603     5604    +1     
  Misses         619      619           
Files with missing lines Coverage Δ
mrmustard/lab_dev/__init__.py 100.00% <100.00%> (ø)
mrmustard/lab_dev/computational_graphs/__init__.py 100.00% <100.00%> (ø)
...d/lab_dev/computational_graphs/branch_and_bound.py 93.00% <100.00%> (ø)
...ab_dev/computational_graphs/computational_graph.py 94.93% <100.00%> (ø)
...rd/lab_dev/computational_graphs/graph_component.py 98.44% <100.00%> (ø)
...rmustard/lab_dev/graph_component_utils/__init__.py 100.00% <ø> (ø)
mrmustard/lab_dev/graph_component_utils/b_to_ps.py 100.00% <ø> (ø)
mrmustard/lab_dev/graph_component_utils/b_to_q.py 100.00% <ø> (ø)
...mustard/lab_dev/graph_component_utils/trace_out.py 100.00% <100.00%> (ø)
mrmustard/lab_dev/samplers.py 98.91% <100.00%> (ø)
... and 8 more

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5a11703...ce2aca9. Read the comment docs.

@apchytr apchytr changed the title Moving circuits.py and branch_and_bound.py to a circuits folder Renaming and moving things around to match architecture Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no changelog Pull request does not require a CHANGELOG entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants