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

[DOC] jupyerlite kernel & notebooks paths #2

Closed
treatmesubj opened this issue Jan 3, 2024 · 4 comments
Closed

[DOC] jupyerlite kernel & notebooks paths #2

treatmesubj opened this issue Jan 3, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@treatmesubj
Copy link

treatmesubj commented Jan 3, 2024

Describe the issue linked to the documentation

Wow, super cool library & docs.
I had not seen sphinx-gallery docs before, they look nice. It looks like the gallery includes a jupyterlite environment where you can run notebooks like this; I haven't seen that before either.

Suggest a potential alternative/fix

Given the docs are hosted on GitHub pages for now, I guess you probably can't install and run a kernel in that environment. It seemed that it couldn't quite find the notebooks, for example, https://skfolio.org/lite/lab/?path=auto_examples/1_mean_risk/plot_1_maximum_sharpe_ratio.ipynb, but maybe that can be fixed in conf.py via these docs - maybe the notebook can still be displayed nicely in jupyterlite, just not run, which would probably still be cool.
Either way, maybe you'd want to temporarily remove allusions to the jupyterlite pages from your docs, e.g. plot_1_maximum_sharpe_ratio.html#L399 & plot_1_maximum_sharpe_ratio.html#L836 with a script or something, or maybe can just be done in sphinx-gallery build.

@treatmesubj treatmesubj added the documentation Improvements or additions to documentation label Jan 3, 2024
@HugoDelatte
Copy link
Member

Thank you very much!
Very good spot, the folder "files" containing the notbooks is missing from https://github.com/skfolio/skfolio/tree/gh-pages/lite
I'll investigate why the GitHub workflow didn't generate it.

@HugoDelatte
Copy link
Member

The jupyterlite configuration was missing in conf.py under sphinx_gallery_conf. However, after more testing, the first import was too slow as described here: https://sphinx-gallery.github.io/stable/configuration.html#generate-jupyterlite-links-for-gallery-notebooks-experimental
So I replaced jupyterlite by binder.
Fixed in https://github.com/skfolio/skfolio/releases/v0.0.9

@treatmesubj
Copy link
Author

Works. Wow, Binder is cool tech. Crazy they build images & run K8s cluster of pods/containers w/ 4GB RAM each & just execute arbitrary code in notebooks from the internet for free! From this white paper, it sounds like the German government pays for it through the GRF. Cool

@HugoDelatte
Copy link
Member

Indeed, what they offer is quite amazing. They give more details about resources here
Didn't know GRF was a sponsor, very interesting!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants