Add Upload Guide #1847

SamanehSaadat · 2024-04-29T22:44:28Z

This PR adds a guide to show how to upload to Kaggle and Hugging Face.

mattdangerw

Thanks! Left some initial comments?

guides/keras_nlp/upload.py

SamanehSaadat

Thanks for the review, Matt!

guides/keras_nlp/upload.py

mattdangerw

Thanks!

guides/keras_nlp/upload.py

mattdangerw · 2024-04-30T21:46:17Z

guides/keras_nlp/upload.py

+"""
+
+"""shell
+pip install -q --upgrade keras-nlp


we might want to add huggingface-hub here

Right! Done!

nit, could do this on one line for brevity

guides/keras_nlp/upload.py

mattdangerw · 2024-04-30T21:48:50Z

guides/keras_nlp/upload.py

+
+# Load a user uploaded Classifier from Kaggle Models.
+classifier = keras_nlp.models.Classifier.from_preset(
+    f"kaggle://{kaggle_username}/bert/keras/finetuned_bert"


will this work when running a colab? don't we need a delay before load?

Right! I think for creating the guide I should have started from notebook rather than the .py file to catch these kinds of bugs.

I can add a comment asking the user to make sure the model is uploaded before attempting to load the model.

guides/keras_nlp/upload.py

mattdangerw

LGTM!

mattdangerw · 2024-05-01T18:36:16Z

guides/keras_nlp/upload.py

+"""
+
+"""shell
+pip install -q --upgrade keras-nlp


nit, could do this on one line for brevity

guides/keras_nlp/upload.py

mattdangerw · 2024-05-01T18:39:17Z

guides/keras_nlp/upload.py

+causal_lm = keras_nlp.models.CausalLM.from_preset(preset_dir)
+
+"""
+You can also load the `Backbone` and `Tokenizer` objects from this preset directory.


keras_nlp.models.Backbone and keras_nlp.models.Tokenizer

with backticks. this will trigger auto linking to the docs pages for these classes

mattdangerw · 2024-05-01T18:40:19Z

guides/keras_nlp/upload.py

+"""
+
+To upload a model we can use `keras_nlp.upload_preset(uri, preset_dir)` API where `uri` has the format of
+`kaggle://<KAGGLE_USERNAME>/<MODEL>/<FRAMEWORK>/<VARIATION>` for uploading to Kaggle and `preset_dir` is the directory that the model is saved in.


Note that for Keras models, the <FRAMEWORK> should always be keras.

Right! Replaced it with Keras!

guides/keras_nlp/upload.py

mattdangerw · 2024-05-01T18:45:27Z

guides/keras_nlp/upload.py

+
+classifier = keras_nlp.models.Classifier.from_preset(
+    f"kaggle://{kaggle_username}/bert/keras/bert_tiny_imdb"
+)


This should be a follow up PR, and probably is not too urgent, but we might want to add an "advanced" section here on saving a low-level Backbone and Tokenizer. I'm not sure what the best training setup to show there is.

Sounds good! We'll add this later!

SamanehSaadat · 2024-05-02T01:27:56Z

guides/keras_nlp/upload.py

+)
+
+# Upload to Hugging Face.
+keras_nlp.upload_preset(f"hf://{hf_username}/gpt2_imdb", preset_dir)


@mattdangerw I added back the HF upload because it can create the delay that we need for the model to be uploaded on Kaggle :D

SamanehSaadat · 2024-05-02T01:29:29Z

guides/keras_nlp/upload.py

+
+Running the following uploads the model that is saved in `preset_dir` to Kaggle:
+"""
+kaggle_username = os.getenv("KAGGLE_USERNAME")  # TODO: Assign username.


I changed it to this again to make the autogen run. Kaggle team will have a new release tomorrow with whoami. I'll update this tomorrow.

pcoet

Good stuff!

pcoet · 2024-05-02T18:35:27Z

guides/keras_nlp/upload.py

+# Introduction
+
+Fine-tuning a machine learning model can yield impressive results for specific tasks.
+Uploading your fine-tuned model to a model hub allow you to share it with the broader community.


"hub allow" -> "hub allows"

Done! Thanks!

pcoet · 2024-05-02T18:41:02Z

guides/keras_nlp/upload.py

+causal_lm.save_to_preset(preset_dir)
+
+"""
+Let's see what are the files what are the saved files.


Suggestion: "Let's see the saved files."

Changed it to your suggestion! Thanks!

pcoet · 2024-05-02T18:41:46Z

guides/keras_nlp/upload.py

+"""
+### Load a Locally Saved Model
+
+A model that is saved to a local preset, can be loaded using `from_preset`.


"preset, can" -> "preset can"

pcoet · 2024-05-02T18:44:12Z

guides/keras_nlp/upload.py

+## Upload the Model to a Model Hub
+
+After saving a preset to a directory, this directory can be uploaded to a model hub such as Kaggle or Hugging Face directly from the KerasNLP library.
+To upload the model to Kaggle, the URI should start with `kaggle://` and to upload to Hugging Face, it should start with `hf://`.


Nit: Is the URI format a requirement? If so, say "... the URI must start..." instead of "should".

It is! Replaced "should" with "must"!

pcoet · 2024-05-02T18:44:48Z

guides/keras_nlp/upload.py

+
+"""
+To upload a model to Kaggle, first, we need to authenticate with Kaggle.
+This can by one of the followings:


"by one of the followings:" -> "in one of the following ways:"

pcoet · 2024-05-02T18:45:14Z

guides/keras_nlp/upload.py

+2. Provide a local `~/.kaggle/kaggle.json`.
+3. Call `kagglehub.login()`.
+
+Let's make sure we are logged in before coninuing.


"coninuing" -> "continuing"

pcoet · 2024-05-02T18:46:02Z

guides/keras_nlp/upload.py

+
+"""
+To upload a model to Hugging Face, first, we need to authenticate with Hugging Face.
+This can by one of the followings:


See previous suggestion.

pcoet · 2024-05-02T18:46:26Z

guides/keras_nlp/upload.py

+1. Set environment variables `HF_USERNAME` and `HF_TOKEN`.
+2. Call `huggingface_hub.notebook_login()`.
+
+Let's make sure we are logged in before coninuing.


"coninuing" -> "continuing"

SamanehSaadat

Thanks for the review, David!

SamanehSaadat · 2024-05-02T19:29:43Z

guides/keras_nlp/upload.py

+# Introduction
+
+Fine-tuning a machine learning model can yield impressive results for specific tasks.
+Uploading your fine-tuned model to a model hub allow you to share it with the broader community.


Done! Thanks!

SamanehSaadat · 2024-05-02T19:30:29Z

guides/keras_nlp/upload.py

+causal_lm.save_to_preset(preset_dir)
+
+"""
+Let's see what are the files what are the saved files.


Changed it to your suggestion! Thanks!

SamanehSaadat · 2024-05-02T19:32:08Z

guides/keras_nlp/upload.py

+"""
+### Load a Locally Saved Model
+
+A model that is saved to a local preset, can be loaded using `from_preset`.


SamanehSaadat · 2024-05-02T19:33:08Z

guides/keras_nlp/upload.py

+## Upload the Model to a Model Hub
+
+After saving a preset to a directory, this directory can be uploaded to a model hub such as Kaggle or Hugging Face directly from the KerasNLP library.
+To upload the model to Kaggle, the URI should start with `kaggle://` and to upload to Hugging Face, it should start with `hf://`.


It is! Replaced "should" with "must"!

SamanehSaadat · 2024-05-02T19:33:53Z

guides/keras_nlp/upload.py

+
+"""
+To upload a model to Kaggle, first, we need to authenticate with Kaggle.
+This can by one of the followings:


SamanehSaadat · 2024-05-02T19:34:27Z

guides/keras_nlp/upload.py

+2. Provide a local `~/.kaggle/kaggle.json`.
+3. Call `kagglehub.login()`.
+
+Let's make sure we are logged in before coninuing.


SamanehSaadat · 2024-05-02T19:35:44Z

guides/keras_nlp/upload.py

+1. Set environment variables `HF_USERNAME` and `HF_TOKEN`.
+2. Call `huggingface_hub.notebook_login()`.
+
+Let's make sure we are logged in before coninuing.


* Upload guide. * KerasNLP upload guide. * Address reviews. * Add classifier example. * Kaggle Hub --> Kaggle Models. * Add model loading. * Replace the toy dataset with IMDB dataset. * Adress reviews. * Some final fixes to make autogen run successful. * Fix classifier name in HF upload. * Reduce batch size. * Convert the code for loading to markdown code block. * Get kaggle username from kagglehub.whoami(). * Run black. * Add notebook and markdown. * Add the guide path. * Address reivews. * Update notebook and markdown files. * Remove upload progress bars from the markdown file. * Remove fine tuning progress bars from the markdown file.

SamanehSaadat added 4 commits April 22, 2024 23:38

Upload guide.

1c607a5

Merge branch 'keras-team:master' into upload-guide

d8bd9fc

Merge branch 'keras-team:master' into upload-guide

15e844f

KerasNLP upload guide.

6d9022c

github-actions bot assigned sachinprasadhs Apr 29, 2024

mattdangerw reviewed Apr 30, 2024

View reviewed changes

SamanehSaadat commented Apr 30, 2024

View reviewed changes

SamanehSaadat added 5 commits April 30, 2024 05:55

Address reviews.

c3cdeb3

Add classifier example.

87e9bc8

Kaggle Hub --> Kaggle Models.

a2a4301

Add model loading.

ecabe20

Replace the toy dataset with IMDB dataset.

5277881

SamanehSaadat marked this pull request as ready for review April 30, 2024 20:32

SamanehSaadat requested review from fchollet, MarkDaoust and pcoet as code owners April 30, 2024 20:32

mattdangerw reviewed Apr 30, 2024

View reviewed changes

Adress reviews.

2678f8b

mattdangerw approved these changes May 1, 2024

View reviewed changes

SamanehSaadat added 3 commits May 1, 2024 16:32

Merge branch 'keras-team:master' into upload-guide

02c46dc

Some final fixes to make autogen run successful.

113dfac

Fix classifier name in HF upload.

348a22c

SamanehSaadat commented May 2, 2024

View reviewed changes

SamanehSaadat and others added 6 commits May 2, 2024 01:59

Reduce batch size.

fae8737

Convert the code for loading to markdown code block.

70be534

Get kaggle username from kagglehub.whoami().

f85ba8b

Run black.

c22ed46

Add notebook and markdown.

4aedca2

Add the guide path.

626102a

pcoet approved these changes May 2, 2024

View reviewed changes

Address reivews.

bfc73c4

SamanehSaadat commented May 2, 2024

View reviewed changes

SamanehSaadat and others added 3 commits May 2, 2024 19:45

Update notebook and markdown files.

6cac029

Remove upload progress bars from the markdown file.

c07aa04

Remove fine tuning progress bars from the markdown file.

9d4fa39

pcoet merged commit ac32100 into keras-team:master May 2, 2024
3 checks passed

SamanehSaadat deleted the upload-guide branch May 3, 2024 02:50

Add Upload Guide #1847

Add Upload Guide #1847

Conversation

SamanehSaadat commented Apr 29, 2024

mattdangerw left a comment

Choose a reason for hiding this comment

SamanehSaadat left a comment

Choose a reason for hiding this comment

mattdangerw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattdangerw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pcoet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SamanehSaadat left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment