Example script for PushToHubCallback (huggingface#15375)

Rocketknight1 · web-flow · commit c43749289de6 · 2022-01-27T16:16:24.000Z
* Example script for PushToHubCallback

* Expanding description slightly
diff --git a/src/transformers/keras_callbacks.py b/src/transformers/keras_callbacks.py
@@ -241,7 +241,21 @@ def on_epoch_end(self, epoch, logs=None):
 
 class PushToHubCallback(Callback):
     """
-    Callback that will save and push the model to the Hub regularly.
+    Callback that will save and push the model to the Hub regularly. By default, it pushes once per epoch, but this can
+    be changed with the `save_strategy` argument. Pushed models can be accessed like any other model on the hub, such
+    as with the `from_pretrained` method.
+
+    ```py
+    from transformers.keras_callbacks import PushToHubCallback
+
+    push_to_hub_callback = PushToHubCallback(
+        output_dir="./model_save",
+        tokenizer=tokenizer,
+        hub_model_id="gpt5-7xlarge",
+    )
+
+    model.fit(train_dataset, callbacks=[push_to_hub_callback])
+    ```
 
     Args:
         output_dir (`str`):
