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

Some improvement in Study and related widgets #2128

Merged
merged 17 commits into from
Oct 26, 2023

Conversation

samuelgarcia
Copy link
Member

No description provided.

Copy link
Collaborator

@zm711 zm711 left a comment

Choose a reason for hiding this comment

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

Just reviewing the docstring :)

src/spikeinterface/widgets/comparison.py Outdated Show resolved Hide resolved
src/spikeinterface/widgets/comparison.py Outdated Show resolved Hide resolved
src/spikeinterface/widgets/comparison.py Outdated Show resolved Hide resolved
src/spikeinterface/widgets/comparison.py Outdated Show resolved Hide resolved
src/spikeinterface/widgets/comparison.py Outdated Show resolved Hide resolved
@alejoe91 alejoe91 added widgets Related to widgets module comparison Related to comparison module labels Oct 25, 2023
@alejoe91 alejoe91 added this to the 0.99.0 milestone Oct 25, 2023
@samuelgarcia
Copy link
Member Author

@alejoe91 ready to merge on my side.

Copy link
Collaborator

@zm711 zm711 left a comment

Choose a reason for hiding this comment

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

@samuelgarcia,

sorry one more set of reviews for the docstrings on my side. + one question.

@@ -140,16 +134,18 @@ class StudyPerformances(BaseWidget):
study: GroundTruthStudy
A study object.
mode: str
Which mode in "swarm"
Which mode in "ordered", "snr", "swarm"
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't know what 'swarm' is... Is this common knowledge or would it be beneficial to define this? How would a user know when to use 'ordered' vs 'snr' vs 'swarm'....

Copy link
Member

Choose a reason for hiding this comment

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

@zm711 I think it's quite common, but we can ref the seaborn page: https://seaborn.pydata.org/generated/seaborn.swarmplot.html

Copy link
Collaborator

Choose a reason for hiding this comment

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

Cool thanks. Sounds good!

src/spikeinterface/widgets/gtstudy.py Outdated Show resolved Hide resolved
src/spikeinterface/widgets/gtstudy.py Outdated Show resolved Hide resolved
src/spikeinterface/widgets/gtstudy.py Outdated Show resolved Hide resolved
src/spikeinterface/widgets/gtstudy.py Outdated Show resolved Hide resolved
Comment on lines +137 to +141
Which plot mode to use:

* "ordered": plot performance metrics vs unit indices ordered by decreasing accuracy (default)
* "snr": plot performance metrics vs snr
* "swarm": plot performance metrics as a swarm plot (see seaborn.swarmplot for details)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks That's super helpful @alejoe91

Copy link
Member

@alejoe91 alejoe91 left a comment

Choose a reason for hiding this comment

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

@samuelgarcia we'll need more checks at some point to know if different study steps have run. Also removed some debug plots in the merge.py that were active by default!

@alejoe91 alejoe91 merged commit 109b5b3 into SpikeInterface:main Oct 26, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comparison Related to comparison module widgets Related to widgets module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants