-
Notifications
You must be signed in to change notification settings - Fork 36
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
QuadratiK Submission #180
Comments
Editor in Chief checksHi there! Thank you for submitting your package for pyOpenSci Please check our Python packaging guide for more information on the elements
Editor commentsNice submission, I'll get started on finding the perfect editor for |
Hey @rmj3197, Happy reviewing! |
Hello there! Happy to be ushering this package through 👋 I'm going to go ahead and start looking for reviewers; I'll plan to touch base when I have reviewers lined up OR in 2 weeks (say, June 24), whichever comes first. |
Hello @isabelizimm, Thank you so much for the update and for taking the time to review our package. I look forward to hearing from you soon. |
Checking in! I have one reviewer ready (yay!) and have reached out to some possibilities for a second. I'll keep you updated when I know more 👍 |
Hello @isabelizimm , thank you very much for the update! |
Welcome welcome to our fearless reviewers: @acolum and @ab93 👋 Thank you SO MUCH for volunteering to review for pyOpenSci! You are two people with awesome math-y, stats-y, ML-y, Python-y backgrounds, which is perfect for this package, and I am looking forward to learning from you through this review process 🌻 Please fill out our pre-review surveyBefore beginning your review, please fill out our pre-review survey. This helps us improve all aspects of our review and better understand our community. No personal data will be shared from this survey - it will only be used in an aggregated format by our Executive Director to improve our processes and programs. The following resources will help you complete your review:
Please get in touch with any questions or concerns!
|
Package ReviewPlease check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide
DocumentationThe package includes all the following forms of documentation:
Readme file requirements
The README should include, from top to bottom:
NOTE: If the README has many more badges, you might want to consider using a table for badges: see this example. Such a table should be more wide than high. (Note that the a badge for pyOpenSci peer-review will be provided upon acceptance.)
UsabilityReviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole.
Functionality
For packages also submitting to JOSS
Note: Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted. The package contains a
Final approval (post-review)
Estimated hours spent reviewing: 2.5 Review CommentsOverall, this submission was well done and followed most Python package development and documentation best practices. I found no major issues with the package's documentation, usability, and functionality, but I've outlined a few minor issues below. Potential issues that could be fixed:
Minor issues that need fixing:
|
Package ReviewPlease check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide
DocumentationThe package includes all the following forms of documentation:
Readme file requirements
The README should include, from top to bottom:
NOTE: If the README has many more badges, you might want to consider using a table for badges: see this example. Such a table should be more wide than high. (Note that the a badge for pyOpenSci peer-review will be provided upon acceptance.)
UsabilityReviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole.
Functionality
For packages also submitting to JOSS
Note: Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted. The package contains a
Final approval (post-review)
Estimated hours spent reviewing: 3 hours Review CommentsGreat submission overall. Documentation is good, and I like the user guide as well. Packaging and CI
Code Practices, which again can be identified using a linter like Ruff
|
Thank you so much to our reviewers @acolum and @ab93 for your thoughts on
This is okay! As long as there is a README file there, we are good to go 😄 |
Thank you @acolum and @ab93 for your valuable suggestions and comments. Thank you @isabelizimm for your help and communication. I will address the changes and update you once they are completed. Thank you all for your time. |
Dear @acolum, @ab93, and @isabelizimm, Thank you very much for your insightful review. We apologize for the delay in our response. We have tried to address the points raised in the review below: Comments from @acolum
We have added a list of relevant packages in R and Python in the README file.
We have added the repo status badge and organized the various other badges according to the categories specified in the example package.
We have now linked all vignettes in the README file.
We have added a CITATION.cff file in the repository. Additionally, we have also included the BibTex entry in the README.
This was clarified by @isabelizimm that a .rst file is fine. Comments from @ab93
We have now updated the development guide with commands and instructions on using Poetry. Please see the README file for the updated guide.
This has been updated in the pyproject.toml file with
The black format CI check is included now. The github action can be found at - https://github.com/rmj3197/QuadratiK/actions/workflows/black_check.yml.
We have now implemented the Ruff linting. The github action can be found at - https://github.com/rmj3197/QuadratiK/actions/workflows/ruff_linting.yml.
We have now included Python typing. The hints are now being shown in our updated documentation (https://quadratik.readthedocs.io/en/latest/api_reference/index.html).
All instance variables are now first defined in the
The base Exception class is not raised anymore. We now raise relevant errors. |
Thank you for the changes, @rmj3197. It looks good now. I have approved it! |
Hi all--apologies for the late response! @acolum, are you able to check if the changes made addressed the comments in your review? If so, please check the box in your review that states |
Thanks for the reminder, @isabelizimm! I've checked the box and approved the package. |
Thank you @ab93 and @acolum for your feedback in improving the package and approving the changes. @isabelizimm, thanks for facilitating the process. Please let us know what are the next steps! Thank you very much for your time. |
🎉 YIPPEEE thanks all! Author Wrap Up TasksThere are a few things left to do to wrap up this submission:
Editor Final ChecksPlease complete the final steps to wrap up this review. Editor, please do the following:
If you have any feedback for us about the review process please feel free to share it here. We are always looking to improve our process and documentation in the peer-review-guide. |
Hello @isabelizimm, Thank you very much for approving the package! I wanted to let you know that I have released a new version and completed the Zenodo tagging (and watching) as well as the survey. We are currently working on the blog post and will submit a separate pull request for it, referencing this issue once it's ready. I would also be interested in joining the Slack channel. Thanks again for your help and support, and wishing you a happy holiday season! |
Submitting Author: Raktim Mukhopadhyay (@rmj3197)
All current maintainers: @rmj3197 @giovsaraceno
Package Name: QuadratiK
One-Line Description of Package: QuadratiK includes test for multivariate normality, test for uniformity on the sphere, non-parametric two- and k-sample tests, random generation of points from the Poisson kernel-based density and clustering algorithm for spherical data.
Repository Link: https://github.com/rmj3197/QuadratiK
Version submitted: 1.1.0
EIC: @Batalex
Editor: @isabelizimm
Reviewer 1: @acolum
Reviewer 2: @ab93
Archive: TBD
JOSS DOI: TBD
Version accepted: TBD
Date accepted (month/day/year): TBD
Code of Conduct & Commitment to Maintain Package
Description
Documentation link : https://quadratik.readthedocs.io/en/latest/
We introduce the$d$ -dimensional Sphere based on Poisson kernel densities, and algorithms for generating random samples from Poisson kernel densities. Particularly noteworthy is the incorporation of a unique clustering algorithm specifically tailored for spherical data that leverages a mixture of Poisson kernel-based densities on the sphere. Alongside this, our software includes additional graphical functions, aiding the users in validating, as well as visualizing and representing clustering results. This enhances interpretability and usability of the analysis. In summary, our
QuadratiK
package that incorporates innovative data analysis methodologies. The presented software, implemented in bothR
andPython
, offers a comprehensive set of novel goodness-of-fit tests and clustering techniques using kernel-based quadratic distances. Our software implements one, two and k-sample tests for goodness of fit, providing an efficient and mathematically sound way to assess the fit of probability distributions. Expanded capabilities of our software include supporting tests for uniformity on theR
andPython
packages serve as a powerful suite of tools, offering researchers and practitioners the means to delve deeper into their data, draw robust inference, and conduct potentially impactful analyses and inference across a wide array of disciplines.Scope
Please indicate which category or categories.
Check out our package scope page to learn more about our
scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):
Domain Specific
Community Partnerships
If your package is associated with an existing community please check below:
For all submissions, explain how the and why the package falls under the categories you indicated above. In your explanation, please address the following points (briefly, 1-2 sentences for each):
Who is the target audience and what are scientific applications of this package?
Are there other Python packages that accomplish the same thing? If so, how does yours differ?
SciPy
andhyppo
also have collections of goodness-of-fit test functionalities. Our interest focuses on tests that are based on the family of kernel-based quadratic distances. The kernels we use are diffusion kernels, that is, probability distributions that depend on a tuning parameter and satisfy the convolution property. We also implement the Poisson kernel-based tests for uniformity on the d-dimensional sphere.We are aware of only a limited number of
Python
libraries that offer spherical clustering capabilities, such asspherecluster
(last updated in November 2018) andsoyclustering
(last updated in May 2020).spherecluster
implements Spherical K-Means and clustering using von Mises Fisher distributions as proposed in "Banerjee, Arindam, et al. "Clustering on the Unit Hypersphere using von Mises-Fisher Distributions." Journal of Machine Learning Research 6.9 (2005).".soyclustering
implements spherical k-means for document clustering which has been proposed in Kim, Hyunjoong, Han Kyul Kim, and Sungzoon Cho. "Improving spherical k-means for document clustering: Fast initialization, sparse centroid projection, and efficient cluster labeling." Expert Systems with Applications 150 (2020): 113288.In summary, there are fundamental differences between QuadratiK and existing packages that are as follows -
We also implement a GUI to enable interaction with the software in a non-programmatic manner using the
streamlit
library. We have not found any python package that implements a GUI for the above described tasks.If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or
@tag
the editor you contacted:Please see our pre-submission enquiry for this submission at -
Pre-submission Inquiry for QuadratiK #168
Technical checks
For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:
Publication Options
JOSS Checks
paper.md
matching JOSS's requirements with a high-level description in the package root or ininst/
.Note: JOSS accepts our review as theirs. You will NOT need to go through another full review. JOSS will only review your paper.md file. Be sure to link to this pyOpenSci issue when a JOSS issue is opened for your package. Also be sure to tell the JOSS editor that this is a pyOpenSci reviewed package once you reach this step.
Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?
This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.
Confirm each of the following by checking the box.
Please fill out our survey
submission and improve our peer review process. We will also ask our reviewers
and editors to fill this out.
P.S. Have feedback/comments about our review process? Leave a comment here
Editor and Review Templates
The editor template can be found here.
The review template can be found here.
Footnotes
Please fill out a pre-submission inquiry before submitting a data visualization package. ↩
The text was updated successfully, but these errors were encountered: