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

Remove commented-out function definitions and delete files with no executable code #452

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

Conversation

rileyjmurray
Copy link
Contributor

@rileyjmurray rileyjmurray commented Jun 7, 2024

This PR aims to resolve #428.

At time of opening this PR, the changes might be over-zealous, so I'm happy to roll some changes back. That said, I suggest we be aggressive in removing this kind of unused text. Here's a proposal for how to decide what to actually keep and what to remove:

  • We can/should keep simple reference implementations of functions that are important but very complicated.
    • Example: there's an implementation of Levenberg-Marquardt from Wikipedia that I've kept. I think this is valuable because our actual LM code is very complicated, so having a reference is helpful for maintainability.
  • We could keep text that's related to memory profiling.
    • Rationale: The question of whether or not to bother trying to profile memory usage in a certain location requires a fair amount of expertise, so I think keeping this kind of text could serve as a flag for suspected hot code paths.
  • Commented-out pyx code should be removed unless we have a very good reason for keeping it.

Another source of criteria for figuring out what to keep is to look for a short note at the beginning of some commented-out code block. Often there are notes that say "FUTURE," "Removed," "unused," "REMOVE," "Debugging," etc...

Other, miscellaneous changes

  • Removed some unused imports.

@rileyjmurray rileyjmurray marked this pull request as ready for review September 24, 2024 18:11
rileyjmurray and others added 20 commits September 30, 2024 10:37
These changes address unexpected behavior that can occur when manually adding an operation without then manually rebuilding the parameter vector. When this happens it is possible for the Model's internal attributes to fall out of sync with those of it's child objects. Now we check for the need to rebuild the parameter vector every time.
This is relevant when attempting to use Dask outside of pyGSTi,
where signals cannot be set in the workers.
Setting the PYGSTI_NO_CUSTOMLM_SIGINT env variable
now skips this behavior.
A bug in the parameter label handling code was causing parameter labels to explode exponentially in size when _rebuild_paramvec was caused, leading to major memory issues. This now makes it so that the value of _paramlbls is fixed to that of the underlying operations and adds a new version of the parameter_labels property that goes through the interposer (making the interposer labels something generated on demand). Also add a threshold for coefficients printing in the LinearInterposer to avoid obnoxious labels.
The creation of COPA layouts relies on a number of specialized circuit structures which require non-trivial time to construct. In the context of iterative GST estimation with nested circuit lists (i.e. the default) this results in unnecessarily repeat construction of these objects. This is an initial implementation of a caching scheme allowing for more efficient re-use of these circuit structures across iterations.
Cache the expanded SPAM-free circuits to reduce recomputing things unnecessarily.
Adds a new method to OpModel that allows for doing instrument expansion and povm expansion in bulk, speeding things up be avoiding recomputation of shared quantities. Also adds a pipeline for re-using completed or split circuits (as produced by the related OpModel methods) for more efficient re-use of done work.
Some minor performance oriented tweaks to the init for COPA layouts.
Refactor some of the ordered dictionaries in matrix layout creation into regular ones.
Start adding infrastructure for caching things used in MDC store creation and for plumbing in stuff from layout creation.
Performance optimization for the method for adding omitted frequencies to incorporate caching of the number of outcomes per circuit (which is somewhat expensive since it goes through the instrument/povm expansion code). Additionally refactor some other parts of this code for improved efficiency. Also makes a few minor tweaks to the method for adding counts to speed that up as well. Can probably make this a bit faster still by merging the two calls to reduce redundancy, but that is a future us problem. Additionally make a few microoptimizations to the dataset code for grabbing counts, and to slicetools adding a function for directly giving a numpy array for a slice (instead of needing to cast from a list).

Miscellaneous cleanup of old commented out code that doesn't appear needed any longer.
Fix a bug I introduced in dataset indexing into something that could be None.
Another minor bug caught by testing.
Improve the performance of __getitem__ when indexing into static circuits by making use of the _copy_init code path.
Implement caching of circuit structures tailored to the map forward simulator's requirements.
This finishes the process of refactoring expand_instruments_and_separate_povm from a circuit method to a method of OpModel.
Refactor expand_instruments_and_separate_povm to use the multi-circuit version under the hood to reduce code duplication.
@rileyjmurray rileyjmurray force-pushed the remove-unused-function-defs branch from 01f3ccc to 2cdfe87 Compare September 30, 2024 14:49
@rileyjmurray
Copy link
Contributor Author

Hi @pcwysoc, @kmrudin, @kevincyoung, @adhumu, and @sserita. This pull request is a big spring-cleaning for commented-out code. You're all designated as code-owners for files that are affected by this pull request. Please review the changes for files you "own" and let me know if you object to removing specific blocks of commented-out code.

Things to keep in mind:

  • TODOs can be moved to GitHub issues. You can paste code in the GitHub issue as a starting point, for later reference.
  • You can replace massive comment-out code blocks with a short comment, like the following
    # NOTE: The FancyClass is admittedly very complicated. We used to have an equivalent SimpleClass, but
    # for maintainability reasons we removed it. The old SimpleClass can be found at
    # https://github.com/sandialabs/pyGSTi/blob/d27e4e688a64914a0b7aaec1de91aa56f7ce70c2/pygsti/drivers/longsequence.py#L153
    
    -- I've used a dummy link for reference.
  • If you really want to keep a commented-out code block, please at least add your name and date so it's obvious who made the call to keep it and when. (There's semi-automated tools for this, but they aren't as reliable as old-fashioned comments.)
  • Use triple-ticks or triple-quotes for gigantic comments, rather than hundreds of lines that start with the single-line comment character #. Using the former styles makes it possible to collapse irrelevant text in most code editors.

Copy link

@pcwysoc pcwysoc left a comment

Choose a reason for hiding this comment

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

I have no objection to the removed comments on the files for which I'm a code owner. Someone may wish to put the code for the old RB plot somewhere however if it still has utility. I defer to @jordanh6 or @tjproct on this.

Copy link
Contributor

@adhumu adhumu left a comment

Choose a reason for hiding this comment

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

Ditto what Piper said. Stefan and I were working on changing parts of ForwardSims in a different branch and on my local computer. This part of the code is still in development. I'm happy to approve these changes, thanks Riley!

pygsti/algorithms/germselection.py Outdated Show resolved Hide resolved
pygsti/baseobjs/errorgenbasis.py Show resolved Hide resolved
pygsti/baseobjs/errorgenbasis.py Show resolved Hide resolved
pygsti/baseobjs/polynomial.py Show resolved Hide resolved
pygsti/evotypes/densitymx/opreps.pyx Outdated Show resolved Hide resolved
pygsti/modelmembers/povms/denseeffect.py Show resolved Hide resolved
pygsti/models/model.py Outdated Show resolved Hide resolved
pygsti/tools/fogitools.py Outdated Show resolved Hide resolved
pygsti/tools/fogitools.py Outdated Show resolved Hide resolved
test/unit/objects/test_prefixtable.py Outdated Show resolved Hide resolved
@coreyostrove
Copy link
Contributor

Whoops, forgot to add the top-level comment for my review.

TLDR: Good work @rileyjmurray. It will be a while till most of us can vie for the crown of most lines written, but at this pace you’re definitely in the running for most lines of pyGSTi deleted! I’ll defer judgement to other code owners for stuff they manage (i.e. a lack of comment may just mean I am waiting for one of them to decide whether to chime in rather than explicit approval), but have added a few comments regarding code I would like to keep, as well as a few minor suggestion for additional deletion related clean-up.

Copy link
Contributor

@sserita sserita left a comment

Choose a reason for hiding this comment

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

2/3 of the way check-in

pygsti/algorithms/mirroring.py Show resolved Hide resolved
pygsti/algorithms/randomcircuit.py Show resolved Hide resolved
pygsti/algorithms/rbfit.py Show resolved Hide resolved
pygsti/baseobjs/polynomial.py Show resolved Hide resolved
# + self.op_rep.chp_ops(seed_or_state=seed_or_state)

# TODO: Untested, only support computational and composed for now
#class StateRepTensorProduct(StateRep):
Copy link
Contributor

Choose a reason for hiding this comment

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

For Stefan to check out

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sserita did you look into this? If not, could you open a GitHub issue articulating the question that needs investigation?

pygsti/modelmembers/povms/denseeffect.py Show resolved Hide resolved
pygsti/modelmembers/povms/marginalizedpovm.py Show resolved Hide resolved
pygsti/modelmembers/term.py Outdated Show resolved Hide resolved
@@ -42,127 +42,6 @@ def _get_cachefile_names(std_module, param_type, simulator, py_version):
raise ValueError("No cache files used for param-type=%s" % param_type)


# XXX is this used?
Copy link
Contributor

Choose a reason for hiding this comment

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

This was used for modelpack generation. Fine to remove but note TermForwardSim caching for model packs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

To clarify, @sserita, would you like the source code to include a comment of some kind given that we'll be removing this?

# items = [(k,v) for k,v in self.iteritems()]
# return (_PrefixOrderedDict, (self._prefix, items), None)

"""
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove reduce, but leave docstring

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sserita are you sure? The docstring doesn't seem to apply to this class. It applies somewhat to the class below, but that class has more detailed docs.

@tjproct
Copy link
Contributor

tjproct commented Nov 12, 2024 via email

@rileyjmurray
Copy link
Contributor Author

rileyjmurray commented Nov 12, 2024 via email

Copy link
Contributor

@sserita sserita left a comment

Choose a reason for hiding this comment

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

The majority of my comments are just personal notes for things we should highlight/bookmark in the PR in case we want to come back and revive them later.
Some of my comments are things I would like to be left in, and at least one is an item I need to dig further into to decide.

Thanks for your hard work in help clean up the code, it is super appreciated!

pygsti/optimize/optimize.py Show resolved Hide resolved
pygsti/protocols/vb.py Show resolved Hide resolved
pygsti/report/workspaceplots.py Show resolved Hide resolved
pygsti/tools/rbtheory.py Show resolved Hide resolved
test/unit/objects/test_prefixtable.py Outdated Show resolved Hide resolved
…e old commented-out SLOWPolynomial class and move it into test/objects/test_polynomial.py
@rileyjmurray
Copy link
Contributor Author

I've made some changes based on comments above. Some questions remain. The ball is now simultaneously in Corey's, Stefan's, Tim's, and Jordan's courts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants