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

Propose notebooks on colab #297

Merged
merged 3 commits into from
Dec 19, 2023
Merged

Propose notebooks on colab #297

merged 3 commits into from
Dec 19, 2023

Conversation

nhuet
Copy link
Contributor

@nhuet nhuet commented Dec 11, 2023

  • We add a cell on each notebook installing the necessary dependencies when on colab, and especially the last nightly wheel available for scikit-decide.
  • At each release "vx.y.z", we create a dedicated tag "notebooks-vx.y.z" in which we modify this cell to install the corresponding release instead of the nightly wheel. The doc for the release will point to the notebook from this tag.
    (NB: When in a colab notebook, we have no means to know the link followed to get there and thus we need such a commit to install the proper version of scikit-decide.)
  • We add a link to colab for each notebook available in the doc.

You can see what the doc will look like with the new links and follow them here: https://nhuet.github.io/scikit-decide/notebooks/
I also made a fake release to show how the notebooks will be updated in doc: https://nhuet.github.io/scikit-decide/version/0.0.10/notebooks/ . Follow the link to maze tutorial, you can see that (fake) release 0.0.10 will be installed.

@nhuet nhuet marked this pull request as draft December 11, 2023 10:42
We look for the last asset of nightly release and download it to get the
last built wheel.
We also install other necessary dependencies and get utility modules
from repository.

We solve some colab install issues:
- uninstall protobuf by default
- reload cffi that else mix default one and downgraded one installed
  when installing scikit-decide dependencies
…cide

When tagging a new release vx.y.z, we create an associated tag
notebooks-vx.y.z with notebooks installing (on colab) the appropriate
release version instead of the nightly wheel.

Then the doc for the release will point towards those notebooks so that
the examples use the release.

If on fork, we install the release from Test.Pypi where the release
should have been deployed.
@nhuet nhuet marked this pull request as ready for review December 12, 2023 08:28
@g-poveda g-poveda merged commit d96267c into airbus:master Dec 19, 2023
38 checks passed
@nhuet nhuet deleted the colab branch January 2, 2024 08:25
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.

2 participants