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

76 add google colab notebook demo #77

Merged
merged 10 commits into from
Jan 13, 2025
Merged

Conversation

daavoo
Copy link
Contributor

@daavoo daavoo commented Dec 27, 2024

@daavoo daavoo requested a review from a team December 27, 2024 10:34
@daavoo daavoo self-assigned this Dec 27, 2024
@daavoo daavoo linked an issue Dec 27, 2024 that may be closed by this pull request
demo/notebook.ipynb Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@daavoo daavoo requested a review from stefanfrench January 9, 2025 10:13
@daavoo daavoo force-pushed the 76-add-google-colab-notebook-demo branch from f708f4b to d1af435 Compare January 9, 2025 11:56
@daavoo daavoo added the demo Related to the demo label Jan 9, 2025
Copy link
Contributor

@stefanfrench stefanfrench left a comment

Choose a reason for hiding this comment

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

@daavoo - Tested this and it worked well on the T4 GPU.

The addition of the content tabs in the Docs looks great!

One minor change I think we should implement - in both the Docs and the Colab Notebook, I think we should be explicit about the user ensuring they change the Colab runtime to a GPU - as it defaults to a CPU, and if they dont change it, it will break. Something like:
"This notebook requires a GPU runtime to function correctly. Using a CPU runtime will result in errors.

How to Switch to GPU:
1. Go to Runtime > Change runtime type in the top menu.
2. Set Hardware accelerator to GPU.
3. Click Save.
"

@daavoo
Copy link
Contributor Author

daavoo commented Jan 10, 2025

One minor change I think we should implement - in both the Docs and the Colab Notebook, I think we should be explicit about the user ensuring they change the Colab runtime to a GPU - as it defaults to a CPU, and if they dont change it, it will break. Something like: "This notebook requires a GPU runtime to function correctly. Using a CPU runtime will result in errors.

@stefanfrench I updated the notebook adding a text paragraph and also a python code that will crash if the GPU is not enabled:

image

I think it is enough to have that in the notebook and something in the docs would be kind of redundant, but I can also update the docs if you think is a blocker

@daavoo daavoo requested a review from stefanfrench January 10, 2025 11:39
Copy link
Contributor

@stefanfrench stefanfrench left a comment

Choose a reason for hiding this comment

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

@daavoo - thanks for adding the GPU check, works great! Approved.

@daavoo daavoo merged commit 9666d83 into main Jan 13, 2025
2 checks passed
@daavoo daavoo deleted the 76-add-google-colab-notebook-demo branch January 13, 2025 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
demo Related to the demo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Google Colab notebook demo
3 participants