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

More natural phrasing in README.rst #396

Merged
merged 9 commits into from
Aug 3, 2022
Merged

Conversation

cedricrommel
Copy link
Collaborator

Sorry, I did not see this when the PR was opened, so just creating a new PR 😬

These are just small changes to the new README.rst in places where I found the phrasing a bit unnatural. Also, I removed the part mentioning the decoding of MEG, SEG and ECoG, since the lib does not support this other data modalities yet AFAIK.

@codecov
Copy link

codecov bot commented Jul 26, 2022

Codecov Report

Merging #396 (ec40f52) into master (337d4c8) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #396   +/-   ##
=======================================
  Coverage   82.63%   82.63%           
=======================================
  Files          53       53           
  Lines        3738     3738           
=======================================
  Hits         3089     3089           
  Misses        649      649           

Copy link
Collaborator

@bruAristimunha bruAristimunha left a comment

Choose a reason for hiding this comment

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

Your changes look great to me! But, you may need to change also the index.rst to affect the new webpage.

Also, I think we have support for ECoG because of MNE, example: https://braindecode.org/auto_examples/plot_bcic_iv_4_ecog_trial.html

README.rst Outdated
`Braindecode`_ is an open-source Python toolbox for decode neurophysiological data such as MEG, EEG, sEEG,
ECoG, and more with Deep Learning models. It includes modules for data input/output, preprocessing,
visualization, data augmentation, classification, regression, sampler and much more!
`Braindecode`_ is an open-source Python toolbox for decoding raw EEG data with
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would keep ECoG as we have two examples analyzing ECoG data, for example this one: plot_bcic_iv_4_ecog_cropped.py

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sure! Didn't know about those 😅 Cool stuff!

@bruAristimunha bruAristimunha removed the request for review from robintibor July 26, 2022 20:08
@bruAristimunha
Copy link
Collaborator

I made a small commit to change this ECoG and MEG issue (because of the MNE), and to copy the information to index.rst for the new documentation. @sliwy or @cedricrommel, for me you can apply the merge in PR.

@cedricrommel
Copy link
Collaborator Author

Sorry guys, I am a bit taken by the NeurIPS rebuttal phase. I would recommending not merging this PR yet as I found some other copy-paste mistakes in the FAQ if I remember well. Would be nice to gather all these small fixes in this PR. Will be back actively next week!

@robintibor
Copy link
Contributor

I'm not so sure about the changes removing EEG/MEG etc, like brain signals can also be fMRI, which we don't really do at all so far?

README.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
bruAristimunha and others added 2 commits July 29, 2022 10:11
Co-authored-by: Alexandre Gramfort <alexandre.gramfort@m4x.org>
Co-authored-by: Alexandre Gramfort <alexandre.gramfort@m4x.org>
README.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
bruAristimunha and others added 5 commits August 2, 2022 22:51
@cedricrommel
Copy link
Collaborator Author

Alright guys, I just fixed the few things I saw but did not have time to deal with last week :)
Thanks for helping to make the homepage text neat!! 🚀

Good to go as far as it concerns me!

@cedricrommel cedricrommel removed the wip label Aug 3, 2022
@robintibor
Copy link
Contributor

yes looks good to me what do others think?

@bruAristimunha
Copy link
Collaborator

Looks good to me!

@cedricrommel
Copy link
Collaborator Author

Merging it then!

@cedricrommel cedricrommel merged commit 66ddda1 into master Aug 3, 2022
@bruAristimunha bruAristimunha deleted the fixing-english-readme branch August 27, 2022 01:33
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.

5 participants