Collect all of the clustering methods into a single module. This is to prevent circular imports when trying to use these methods inside the ptychography module.
Approach
I have renamed and moved all of the clustering related functsion into the cluster module. I have dropped the leading words "split" and "cluster" because these are redundant when using the full names of the functions i.e. tike.cluster.cluster_compact vs tike.cluster.compact.
In order to prevent API breaks, I have added wrapper functions with deprecation warnings for the cluster functions which were in the public API. This includes the batch_method parameter in PtychoParameters.
Pre-Merge Checklists
Submitter
[x] Write a helpfully descriptive pull request title.
[x] Organize changes into logically grouped commits with descriptive commit messages.
[x] Document all new functions.
[ ] Click 'details' on the readthedocs check to view the updated docs.
[ ] Write tests for new functions or explain why they are not needed.
[ ] Address any complaints from pep8speaks.
Reviewer
[ ] Actually read all of the code.
[ ] Run the new code yourself; the included tests should make this easy.
[ ] Write a summary of the changes as you understand them.
carterbox
commented
1 year ago
Purpose
Collect all of the clustering methods into a single module. This is to prevent circular imports when trying to use these methods inside the ptychography module.
Approach
I have renamed and moved all of the clustering related functsion into the cluster module. I have dropped the leading words "split" and "cluster" because these are redundant when using the full names of the functions i.e.
tike.cluster.cluster_compactvstike.cluster.compact.In order to prevent API breaks, I have added wrapper functions with deprecation warnings for the cluster functions which were in the public API. This includes the
batch_methodparameter inPtychoParameters.Pre-Merge Checklists
Submitter
Reviewer