Update README.md

README.md

@@ -92,3 +92,90 @@ cd text-generation-inference/integration_tests
 make gen-client
 pip install . --no-cache-dir
 ```
+
+### Minimal Sample
+
+*To try this out with the fms-native compiled model, please execute the following:*
+
+#### Install
+
+```bash
+git clone https://github.com/foundation-model-stack/fms-extras
+(cd fms-extras && pip install -e .)
+pip install transformers==4.35.0 sentencepiece numpy
+```
+
+#### Run Sample
+
+```bash
+python sample_client.py
+```
+
+_Note: first prompt may be slower as there is a slight warmup time_
+
+### Minimal Sample
+
+#### Install
+
+```bash
+git clone --branch main --single-branch llama_3_variants https://github.com/JRosenkranz/fms-extras
+(cd fms-extras && pip install -e .)
+pip install transformers==4.35.0 sentencepiece numpy
+```
+
+#### Run Sample
+
+##### batch_size=1 (compile + cudagraphs)
+
+```bash
+MODEL_PATH=/path/to/llama3/hf/Meta-Llama-3-8B-Instruct
+python fms-extras/scripts/paged_speculative_inference.py \
+    --architecture=llama3 \
+    --variant=8b \
+    --model_path=$MODEL_PATH \
+    --model_source=hf \
+    --tokenizer=$MODEL_PATH \
+    --speculator_path=ibm-fms/codellama-13b-accelerator \
+    --speculator_source=hf \
+    --speculator_variant=3_2b \
+    --top_k_tokens_per_head=4,3,2,2 \
+    --compile \
+    --compile_mode=reduce-overhead
+```
+
+##### batch_size=1 (compile)
+
+```bash
+MODEL_PATH=/path/to/llama3/hf/Meta-Llama-3-8B-Instruct
+python fms-extras/scripts/paged_speculative_inference.py \
+    --architecture=llama3 \
+    --variant=8b \
+    --model_path=$MODEL_PATH \
+    --model_source=hf \
+    --tokenizer=$MODEL_PATH \
+    --speculator_path=ibm-fms/codellama-13b-accelerator \
+    --speculator_source=hf \
+    --speculator_variant=3_2b \
+    --top_k_tokens_per_head=4,3,2,2 \
+    --compile
+```
+
+##### batch_size=4 (compile)
+
+```bash
+MODEL_PATH=/path/to/llama3/hf/Meta-Llama-3-8B-Instruct
+python fms-extras/scripts/paged_speculative_inference.py \
+    --architecture=llama3 \
+    --variant=8b \
+    --model_path=$MODEL_PATH \
+    --model_source=hf \
+    --tokenizer=$MODEL_PATH \
+    --speculator_path=ibm-fms/codellama-13b-accelerator \
+    --speculator_source=hf \
+    --speculator_variant=3_2b \
+    --top_k_tokens_per_head=4,3,2,2 \
+    --batch_input \
+    --compile
+```
+
+Sample code can be found [here](https://github.com/foundation-model-stack/fms-extras/pull/24)