Update README.md

README.md

@@ -8,30 +8,34 @@ license: apache-2.0
 ## Model Resources
 
 - **Repository:** https://github.com/openevabyte/evabyte
-- **Blog:** https://hkunlp.github.io/blog/2024/evabyte
+- **Blog:** https://hkunlp.github.io/blog/2025/evabyte
 - **Paper:** Coming soon
 
 ## Model Details
 
-EvaByte is trained using the SambaNova SN30 RDU system with a batch size of 8M bytes and 32K context length. The training process consists of 3 phases: after pre-training on 1.2T bytes (yielding **EvaByte-6.5B-Phase1**), two independent annealing runs (100B and 200B bytes respectively) are conducted with learning rate linearly decayed from 1e-4 to 0. The resulting checkpoints are merged via model soup (**EvaByte-6.5B**), which then undergoes supervised fine-tuning (**EvaByte-6.5B-SFT**).
+EvaByte is trained using the performant SambaNova SN30 RDU system with a batch size of 8M bytes and 32K context length. The training process consists of 3 phases: after pre-training on 1.2T bytes (yielding **EvaByte-Phase1**), two independent annealing runs (100B and 200B bytes respectively) are conducted with learning rate linearly decayed from 1e-4 to 0. The resulting checkpoints are merged via model soup (**EvaByte**), which then undergoes supervised fine-tuning (**EvaByte-SFT**).
 
 | Stage | Model |
 |:----- |:-----|
-| Base (before annealing) | [EvaByte-6.5B-Phase1](https://huggingface.co/evabyte/EvaByte-6.5B-Phase1) |
-| Base | [EvaByte-6.5B](https://huggingface.co/evabyte/EvaByte-6.5B) |
-| SFT  | [EvaByte-6.5B-SFT](https://huggingface.co/evabyte/EvaByte-6.5B-SFT) <-- you are here |
+| Base (before annealing) | [EvaByte-Phase1](https://huggingface.co/evabyte/EvaByte-Phase1) |
+| Base | [EvaByte](https://huggingface.co/evabyte/EvaByte) |
+| SFT  | [EvaByte-SFT](https://huggingface.co/evabyte/EvaByte-SFT) <-- you are here |
 
 
 ## Usage
+**Note:** Make sure to set `trust_remote_code=True` when loading the model (or tokenizer), as our implementation includes custom code.
+
+Below is an example of using **EvaByte-6.5B-SFT** for chat or instruction-following tasks. The model is trained with the [Llama-3 chat format](https://github.com/meta-llama/llama3/blob/main/llama/tokenizer.py#L202), and we do not use a specific system prompt during supervised fine-tuning.
 
-Please note that we do not train the model with a specific system prompt during SFT.
 ```python
 from transformers import AutoTokenizer, AutoModelForCausalLM
 import torch
 
-tokenizer = AutoTokenizer.from_pretrained("evabyte/EvaByte-6.5B-SFT", trust_remote_code=True)
-model = AutoModelForCausalLM.from_pretrained("evabyte/EvaByte-6.5B-SFT", torch_dtype=torch.bfloat16, trust_remote_code=True).eval().to("cuda")
+# Load tokenizer and model
+tokenizer = AutoTokenizer.from_pretrained("evabyte/EvaByte-SFT", trust_remote_code=True)
+model = AutoModelForCausalLM.from_pretrained("evabyte/EvaByte-SFT", torch_dtype=torch.bfloat16, trust_remote_code=True).eval().to("cuda")
 
+# Prepare input messages
 messages = [
     {"role": "user", "content": "Write me an English pangram."}
 ]
@@ -41,12 +45,12 @@ input_ids = tokenizer.apply_chat_template(
     return_tensors="pt", 
 ).to("cuda")
 
-# byte-by-byte generation
+# Byte-by-byte generation (default)
 generation_output = model.generate(
     input_ids=input_ids, 
     max_new_tokens=256
 )
-# alternatively, use multibyte generation
+# Multibyte generation (faster alternative)
 generation_output = model.multi_byte_generate(
     input_ids=input_ids, 
     max_new_tokens=256
@@ -58,10 +62,15 @@ response = tokenizer.decode(
     clean_up_tokenization_spaces=False
 )
 print(response)
+# Sample output:
+# An English pangram is a sentence that uses every letter of the alphabet at least once. Here's a simple pangram:\n\n"The quick brown fox jumps over the lazy dog."<|eot_id|>
 ```
-We support two modes of generation:
-- `model.generate()`: When invoked, the model will generate one byte at a time. This is the default mode of generation with the Huggingface interface.
-- `model.multi_byte_generate()`: generate multiple bytes in a single step, adapted from the implementation of [Medusa](https://github.com/FasterDecoding/Medusa). This will be much faster than above and usually yields the same result under the setting of greedy decoding. `model.multi_byte_generate()` supports a subset of arguments in `model.generate()`:
+
+### ⚙️ Generation Modes
+
+EvaByte supports two generation interfaces:
+- `model.generate()`: The default generation method compatible with Huggingface `transformers` library. This approach generates one byte at a time and might be slow.
+- `model.multi_byte_generate()`: A faster alternative that generates multiple bytes per step and usually yields the same result as `model.generate()` under greedy decoding, with the implementation adapted from [Medusa](https://github.com/FasterDecoding/Medusa). `model.multi_byte_generate()` supports a subset of arguments in `model.generate()`:
     - `input_ids`: the input byte ids.
     - `temperature`: the temperature for sampling.
     - `max_length`: the maximum length of the generated sequence.
@@ -70,29 +79,27 @@ We support two modes of generation:
     - `top_p`: the top-p parameter for sampling.
     - `do_sample`: greedy decoding or sampling.
 
-NOTE:
-- `device_map="auto"` is not supported for > 2 GPUs
-- Decoding only supports batch size of 1 with `attention_mask=None` for now.
-- Only supports `torch_dtype=torch.bfloat16` for now.
+**Notes and Limitations:**
+- `device_map="auto"` is not supported for >2 GPUs.
+- Only batch size of 1 (with `attention_mask=None`) is supported for decoding.
+- `torch_dtype=torch.bfloat16` is required.
+- The multibyte generation `model.multi_byte_generate()` might return extra bytes after the end-of-sequence sentinel, due to the nature of the multibyte decoding. Manual truncation or cleaning may be needed.
 
 
 ## Bias, Risks, and Limitations
-`EvaByte-6.5B-SFT` serves primarily as a demonstration to showcase how the base model of EvaByte can be effectively fine-tuned for chat and instruction-following capabilities. While it shows improved conversational abilities, users should note that it has not undergone specific alignment or incorporated any moderation mechanisms. Like other instruction-tuned models without safety filtering, it can still generate potentially harmful, inappropriate, or factually incorrect content.
+`EvaByte-SFT` serves primarily as a demonstration to showcase how the base model of EvaByte can be effectively fine-tuned for chat and instruction-following capabilities. While it shows improved conversational abilities, users should note that it has not undergone specific alignment or incorporated any moderation mechanisms. Like other instruction-tuned models without safety filtering, it can still generate potentially harmful, inappropriate, or factually incorrect content.
 
 ## Evaluation 
 
-For detailed evaluation results, please refer to the [blog](https://hkunlp.github.io/blog/2024/evabyte).
+For detailed evaluation results, please refer to the [blog post](https://hkunlp.github.io/blog/2025/evabyte).
 
 
 ## Citation
-
-**BibTeX:**
-
-```
+```bibtex
 @misc{evabyte,
     title = {EvaByte: Efficient Byte-level Language Models at Scale},
-    url = {},
-    author = {Lin Zheng and Xueliang Zhao and Guangtao Wang and Chen Wu and David Dong and Angela Wang and Mingran Wang and Haige Bo and Tony Zhang and Changran Hu and Urmish Thakker and Lingpeng Kong},
+    url = {https://hkunlp.github.io/blog/2025/evabyte},
+    author = {Lin Zheng and Xueliang Zhao and Guangtao Wang and Chen Wu and David Dong and Angela Wang and Mingran Wang and Yun Du and Haige Bo and Tony Zhang and Changran Hu and Urmish Thakker and Lingpeng Kong},
     year = {2025}
 }
 ```