Update README.md with new model card content

README.md

@@ -1,23 +1,170 @@
 ---
 library_name: keras-hub
 ---
-This is a [`Phi3` model](https://keras.io/api/keras_hub/models/phi3) uploaded using the KerasHub library and can be used with JAX, TensorFlow, and PyTorch backends.
-Model config:
-* **name:** phi3_backbone_1
-* **trainable:** True
-* **vocabulary_size:** 32064
-* **num_layers:** 32
-* **num_query_heads:** 32
-* **hidden_dim:** 3072
-* **intermediate_dim:** 8192
-* **num_key_value_heads:** 32
-* **layer_norm_epsilon:** 1e-05
-* **dropout:** 0.0
-* **max_sequence_length:** 131072
-* **pretraining_sequence_length:** 4096
-* **rope_max_wavelength:** 10000.0
-* **rope_scaling_type:** su
-* **rope_scaling_short_factor:** [1.05, 1.05, 1.05, 1.1, 1.1, 1.1500000000000001, 1.2000000000000002, 1.2500000000000002, 1.3000000000000003, 1.3500000000000003, 1.5000000000000004, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.000000000000001, 2.0500000000000007, 2.0500000000000007, 2.0500000000000007, 2.1000000000000005, 2.1000000000000005, 2.1000000000000005, 2.1500000000000004, 2.1500000000000004, 2.3499999999999996, 2.549999999999999, 2.5999999999999988, 2.5999999999999988, 2.7499999999999982, 2.849999999999998, 2.849999999999998, 2.9499999999999975]
-* **rope_scaling_long_factor:** [1.0299999713897705, 1.0499999523162842, 1.0499999523162842, 1.0799999237060547, 1.2299998998641968, 1.2299998998641968, 1.2999999523162842, 1.4499999284744263, 1.5999999046325684, 1.6499998569488525, 1.8999998569488525, 2.859999895095825, 3.68999981880188, 5.419999599456787, 5.489999771118164, 5.489999771118164, 9.09000015258789, 11.579999923706055, 15.65999984741211, 15.769999504089355, 15.789999961853027, 18.360000610351562, 21.989999771118164, 23.079999923706055, 30.009998321533203, 32.35000228881836, 32.590003967285156, 35.56000518798828, 39.95000457763672, 53.840003967285156, 56.20000457763672, 57.95000457763672, 59.29000473022461, 59.77000427246094, 59.920005798339844, 61.190006256103516, 61.96000671386719, 62.50000762939453, 63.3700065612793, 63.48000717163086, 63.48000717163086, 63.66000747680664, 63.850006103515625, 64.08000946044922, 64.760009765625, 64.80001068115234, 64.81001281738281, 64.81001281738281]
-
-This model card has been generated automatically and should be completed by the model author. See [Model Cards documentation](https://huggingface.co/docs/hub/model-cards) for more information.
+### Model Overview
+Phi-3 is a set of large language models published by Microsoft. Models are instruction tuned, and range in size from 3 billion to 14 billion parameters. See the model card below for benchmarks, data sources, and intended use cases.
+
+Weights are released under the [MIT License](https://opensource.org/license/mit). Keras model code is released under the [Apache 2 License](https://github.com/keras-team/keras-hub/blob/master/LICENSE).
+
+## Links
+
+* [Phi-3 Quickstart Notebook](https://www.kaggle.com/code/matthewdwatson/phi-3-quickstart)
+* [Phi-3 API Documentation](https://keras.io/api/keras_hub/models/phi3/)
+* [Phi-3 Model Card](https://huggingface.co/microsoft/Phi-3-mini-4k-instruct)
+* [KerasHub Beginner Guide](https://keras.io/guides/keras_hub/getting_started/)
+* [KerasHub Model Publishing Guide](https://keras.io/guides/keras_hub/upload/)
+
+## Installation
+
+Keras and KerasHub can be installed with:
+
+```
+pip install -U -q keras-hub
+pip install -U -q keras>=3
+```
+
+Jax, TensorFlow, and Torch come preinstalled in Kaggle Notebooks. For instruction on installing them in another environment see the [Keras Getting Started](https://keras.io/getting_started/) page.
+
+## Presets
+
+The following model checkpoints are provided by the Keras team. Full code examples for each are available below.
+
+| Preset name           | Parameters | Description   |
+|-----------------------|------------|---------------|
+|` phi3_mini_4k_instruct_en`          | 3.82B      | 3B model with 4K max context |
+| `phi3_mini_128k_instruct_en` | 3.82B      | 3B model with 128K max context |
+
+## Prompts
+
+Phi-3 models are instruction tuned on turn by turn conversations and should be prompted with examples that precisely match the training data. Specifically, you must alternate user and assistant turns that begin and end with special tokens. New lines do matter. See the following for an example:
+
+```python
+prompt = """<|user|>
+Hello!<|end|>
+<|assistant|>
+Hello! How are you?<|end|>
+<|user|>
+I'm great. Could you help me with a task?<|end|>
+"""
+```
+
+## Example Usage
+```shell
+pip install -U -q keras-hub
+```
+
+```python
+import keras
+import keras_hub
+import numpy as np
+```
+
+Use `generate()` to do text generation.
+
+```python
+phi3_lm = keras_hub.models.Phi3CausalLM.from_preset("phi3_mini_128k_instruct_en")
+phi3_lm.generate("<|user|>\nHow to explain Internet for a medieval knight?<|end|>\n<|assistant|>", max_length=500)
+
+# Generate with batched prompts.
+phi3_lm.generate([
+    "<|user|>\nWhat is Keras?<|end|>\n<|assistant|>",
+    "<|user|>\nGive me your best brownie recipe.<|end|>\n<|assistant|>",
+], max_length=500)
+```
+
+Compile the `generate()` function with a custom sampler.
+
+```python
+phi3_lm = keras_hub.models.Phi3CausalLM.from_preset("phi3_mini_128k_instruct_en")
+phi3_lm.compile(sampler="greedy")
+phi3_lm.generate("<|user|>\nWhat is Keras?<|end|>\n<|assistant|>", max_length=30)
+
+phi3_lm.compile(sampler=keras_hub.samplers.BeamSampler(num_beams=2))
+phi3_lm.generate("<|user|>\nWhat is Keras?<|end|>\n<|assistant|>", max_length=30)
+```
+
+Use `generate()` without preprocessing.
+
+```python
+prompt = {
+    "token_ids": np.array([[306, 864, 304, 1827, 0, 0, 0, 0, 0, 0]] * 2),
+    # Use `"padding_mask"` to indicate values that should not be overridden.
+    "padding_mask": np.array([[1, 1, 1, 1, 0, 0, 0, 0, 0, 0]] * 2),
+}
+
+phi3_lm = keras_hub.models.Phi3CausalLM.from_preset(
+    "phi3_mini_128k_instruct_en",
+    preprocessor=None,
+    dtype="bfloat16"
+)
+phi3_lm.generate(prompt)
+```
+
+Call `fit()` on a single batch.
+
+```python
+features = ["The quick brown fox jumped.", "I forgot my homework."]
+phi3_lm = keras_hub.models.Phi3CausalLM.from_preset("phi3_mini_128k_instruct_en")
+phi3_lm.fit(x=features, batch_size=2)
+```
+
+## Example Usage with Hugging Face URI
+
+```shell
+pip install -U -q keras-hub
+```
+
+```python
+import keras
+import keras_hub
+import numpy as np
+```
+
+Use `generate()` to do text generation.
+
+```python
+phi3_lm = keras_hub.models.Phi3CausalLM.from_preset("hf://keras/phi3_mini_128k_instruct_en")
+phi3_lm.generate("<|user|>\nHow to explain Internet for a medieval knight?<|end|>\n<|assistant|>", max_length=500)
+
+# Generate with batched prompts.
+phi3_lm.generate([
+    "<|user|>\nWhat is Keras?<|end|>\n<|assistant|>",
+    "<|user|>\nGive me your best brownie recipe.<|end|>\n<|assistant|>",
+], max_length=500)
+```
+
+Compile the `generate()` function with a custom sampler.
+
+```python
+phi3_lm = keras_hub.models.Phi3CausalLM.from_preset("hf://keras/phi3_mini_128k_instruct_en")
+phi3_lm.compile(sampler="greedy")
+phi3_lm.generate("<|user|>\nWhat is Keras?<|end|>\n<|assistant|>", max_length=30)
+
+phi3_lm.compile(sampler=keras_hub.samplers.BeamSampler(num_beams=2))
+phi3_lm.generate("<|user|>\nWhat is Keras?<|end|>\n<|assistant|>", max_length=30)
+```
+
+Use `generate()` without preprocessing.
+
+```python
+prompt = {
+    "token_ids": np.array([[306, 864, 304, 1827, 0, 0, 0, 0, 0, 0]] * 2),
+    # Use `"padding_mask"` to indicate values that should not be overridden.
+    "padding_mask": np.array([[1, 1, 1, 1, 0, 0, 0, 0, 0, 0]] * 2),
+}
+
+phi3_lm = keras_hub.models.Phi3CausalLM.from_preset(
+    "hf://keras/phi3_mini_128k_instruct_en",
+    preprocessor=None,
+    dtype="bfloat16"
+)
+phi3_lm.generate(prompt)
+```
+
+Call `fit()` on a single batch.
+
+```python
+features = ["The quick brown fox jumped.", "I forgot my homework."]
+phi3_lm = keras_hub.models.Phi3CausalLM.from_preset("hf://keras/phi3_mini_128k_instruct_en")
+phi3_lm.fit(x=features, batch_size=2)
+```