[WIP] Nicer more structured docs #272
Conversation
docs/index.rst
Outdated
|
|
||
| # Create the model | ||
| model = ShallowFBCSPNet( | ||
| in_chans=train_set[0][0].shape[0], |
There was a problem hiding this comment.
calling this n_channels seems so much more natural to me...
docs/index.rst
Outdated
| model = ShallowFBCSPNet( | ||
| in_chans=train_set[0][0].shape[0], | ||
| n_classes=4, | ||
| input_window_samples=train_set[0][0].shape[1], |
There was a problem hiding this comment.
| input_window_samples=train_set[0][0].shape[1], | |
| n_samples=train_set[0][0].shape[1], |
or n_times ...
|
Hello @robintibor, I am wondering if I could perhaps take advantage of your pull-request to change the site's theme from braindecode to pydata_sphinx_theme, such as numpy and mne. Would that be acceptable to you? Probably, this involves a lot of small changes to make the site look nicer, and I would need some help. Example: https://bruaristimunha.github.io/braindecode.github.io/master/index.html |
|
Yeah, feel free to go ahead! |
|
many thanks @robintibor! I created a PR in your folk. |
changing braindecode documentation theme
Co-authored-by: Alexandre Gramfort <alexandre.gramfort@m4x.org>
Co-authored-by: Alexandre Gramfort <alexandre.gramfort@m4x.org>
Codecov Report
@@ Coverage Diff @@
## master #272 +/- ##
==========================================
- Coverage 82.66% 82.63% -0.03%
==========================================
Files 53 53
Lines 3738 3738
==========================================
- Hits 3090 3089 -1
- Misses 648 649 +1 |
|
For me there are still several details to review to fully integrate this new theme. At mne it looks like this involved a team, we can just copy if the license allows. What do you think @agramfort? |
|
A logo for braindecode would be very cool. Does anyone have any artistic skills? |
|
here is the rendered doc: it's going in the right direction but it needs a few more iterations thx @bruAristimunha for taking a stab at this 🙏 |
|
Besides the details and adjustments in the div, I was wondering if the colours are a good start. In the light mode, it is not bad. I don't appreciated it much in the dark mode, and I suggest turning off this option. I was thinking about this palette in the light mode:
I don't know if someone will engage in this task with me, but I will try to centralize any decision here. |
|
I would encourage to have a look at how mne did its configuration.
regarding colors no strong feelings. Just make it with high enough contrast
for readability.
thx !
… Message ID: ***@***.***>
|
|
A first draft version of a logo: As picture: Vectorized version: It's something to start with. Anyone want to give some feedback? @robintibor, @gemeinl, @agramfort |
|
how about something like this
|
|
I liked Alexandre! |
|
How about putting the NN on the right inside the brain to match the left hemisphere? something like this but with the brain from your options and EEG between the hemispheres: in case, graphic from here: https://www.pngegg.com/en/png-bbroj |
|
I like this option also @sliwy. The only thing I would add is a brain sign somewhere, but it could be near the name. Let's wait for some maintainers and contributors to manifest, and we close with a vote. @hubertjb, @cedricrommel, @sylvchev, any contribution to the logo? I don't know the entire team involved in braindecode very well, so if you want to invite more people to encourage participation, please do. |
|
Primitive version but something like that:
and more compact one:
I would still work on the contrast of the network graph inside the brain, maybe it is too similar to the brain color, or we can remove the brain coloring from the right hemisphere. |
|
@bruAristimunha can you see why CIs are red? it prevents us from looking at the rendered doc. 🙏 |
|
A thousand apologies for the mess, @agramfort. It looks like a test on augmentations is returning a RunTimeError, which is pretty weird because I didn't touch this area. While trying to find out the cause of the error, I will locally compile the rendered and put it on my fork. |
|
can you see if the pb is also present in current master branch?
… Message ID: ***@***.***>
|
|
I will rebase the nicer-doc branch with the current master branch, but the error does not seem related. In the meantime, I think I've made a first iteration of the new format for the site. I put it in my fork since I can't pass the CI. Link bellow: https://bruaristimunha.github.io/braindecode.github.io/master/index.html Can you look @agramfort and @robintibor? I still have to correct the colours and aspect ratio of the images. So it would be nice to comment without being related to these two points. |
|
looks good !
I can you create a PR from current master branch to see if the CI failure
is specific to this branch?
Message ID: ***@***.***>
… |
|
Sure!
…On Tue, 19 Jul 2022, 14:04 Alexandre Gramfort, ***@***.***> wrote:
looks good !
I can you create a PR from current master branch to see if the CI failure
is specific to this branch?
Message ID: ***@***.***>
>
—
Reply to this email directly, view it on GitHub
<#272 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AKFZNAUOJ5HMXZZSSBOKI7DVU2RWTANCNFSM47GJNAMA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
@agramfort and @gemeinl, can you take a look? (I think robin is on ICML) |
|
besides a glitch in the footer LGTM
… Message ID: ***@***.***>
|
|
@agramfort, can you merge? To do this merge, we will have to change some things in the braindecode.github.io repository. I think there will be other issues with this documentation change, but I think we can fix it in other iterations. |
|
@bruAristimunha can you just fix the footer issue with the date? |
|
Sure @agramfort. Done! |
|
Thx @bruAristimunha ! |
|
It's alive =) @robintibor and @agramfort https://braindecode.org/master/index.html# It's going to be pretty cool when we reach version 0.7 =) |
|
Wow cool! |
Aim:
Have more structure in the documentation so that people can more easily find all relevant documentation without going through the example list.
Maybe also try whatever can be done to make the documentation more beautiful.
For now added some "Quickstart" example, will do more in coming days to improve.