Skip to content

Commit 6c422ab

Browse files
Vaibhavs10pcuenca
andauthored
Update notebooks doc w/ Kaggle and Colab usage. (#1772)
* Update notebooks doc w/ Kaggle and Colab usage. * Apply suggestions from code review Co-authored-by: Pedro Cuenca <[email protected]> --------- Co-authored-by: Pedro Cuenca <[email protected]>
1 parent ca26828 commit 6c422ab

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/hub/notebooks.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,26 @@
22

33
[Jupyter notebooks](https://jupyter.org/) are a very popular format for sharing code and data analysis for machine learning and data science. They are interactive documents that can contain code, visualizations, and text.
44

5+
## Open models in Google Colab and Kaggle
6+
7+
When you visit a model page on the Hugging Face Hub, you’ll see a new “Google Colab”/ "Kaggle" button in the “Use this model” drop down. Clicking this will generate a ready-to-run notebook with basic code to load and test the model. This is perfect for quick prototyping, inference testing, or fine-tuning experiments — all without leaving your browser.
8+
9+
![Google Colab and Kaggle option for models on the Hub](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/blog/hf-google-colab/gemma3-4b-it-dark.png)
10+
11+
Users can also access a ready-to-run notebook by appending /colab to the model card’s URL. As an example, for the latest Gemma 3 4B IT model, the corresponding Colab notebook can be reached by taking the model card URL:
12+
https://huggingface.co/google/gemma-3-4b-it
13+
14+
And then appending `/colab` to it:
15+
https://huggingface.co/google/gemma-3-4b-it/colab
16+
17+
and similarly for kaggle:
18+
https://huggingface.co/google/gemma-3-4b-it/kaggle
19+
20+
21+
If a model repository includes a file called `notebook.ipynb`, we will use it for Colab and Kaggle instead of the auto-generated notebook content. Model authors can provide tailored examples, detailed walkthroughs, or advanced use cases while still benefiting from one-click Colab integration. [NousResearch/Genstruct-7B](https://huggingface.co/NousResearch/Genstruct-7B) is one such example.
22+
23+
![](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/blog/hf-google-colab/genstruct-notebook-dark.png)
24+
525
## Rendering Jupyter notebooks on the Hub
626

727
Under the hood, Jupyter Notebook files (usually shared with a `.ipynb` extension) are JSON files. While viewing these files directly is possible, it's not a format intended to be read by humans. The Hub has rendering support for notebooks hosted on the Hub. This means that notebooks are displayed in a human-readable format.

0 commit comments

Comments
 (0)