update README.md

README.md

@@ -31,11 +31,17 @@ from llama_cpp import Llama
 
 # Our stepper takes in a Outlines model to enable guided generation
 # This forces the model to follow our output format
-model = Llama(
-      model_path="./path/to/model/npc-llm-3_8B-128k.gguf",
-      # n_gpu_layers=-1, # Uncomment to use GPU acceleration
+llm = Llama.from_pretrained(
+    repo_id="Gigax/NPC-LLM-3_8B-128k-GGUF",
+    filename="npc-llm-3_8B-128k.gguf"
+    # n_gpu_layers=-1, # Uncomment to use GPU acceleration
+    # seed=1337, # Uncomment to set a specific seed
+    # n_ctx=2048, # Uncomment to increase the context window
 )
 
+model = models.LlamaCpp(llm) 
+
+
 # Instantiate a stepper: handles prompting + output parsing
 stepper = NPCStepper(model=model)
 ```
@@ -54,7 +60,9 @@ from gigax.scene import (
     ParameterType,
 )
 # Use sample data
+context = "Medieval world"
 current_location = Location(name="Old Town", description="A quiet and peaceful town.")
+locations = [current_location] # you can add more locations to the scene
 NPCs = [
     Character(
     name="John the Brave",
@@ -127,15 +135,15 @@ Aldren:
 
 - **Developed by:** Gigax
 - **Language(s) (NLP):** English
-- **Finetuned from model [optional]:** [Phi-3-mini-4k-instruct](https://huggingface.co/microsoft/Phi-3-mini-4k-instruct)
+- **Finetuned from model [optional]:** [Phi-3-mini-128k-instruct](https://huggingface.co/microsoft/Phi-3-mini-128k-instruct)
 - **Contact:** Join our [Discord](https://discord.gg/xES2Z8X4J6) for info, help, and more!
 
 ## How to Cite
 
 ```bibtex
-@misc{NPC-LLM-3_8B,
-      url={[https://huggingface.co/Gigax/NPC-LLM-7B](https://huggingface.co/Gigax/NPC-LLM-3_8B)},
-      title={NPC-LLM-3_8B},
+@misc{NPC-LLM-3_8B-128k-GGUF,
+      url={[https://huggingface.co/Gigax/NPC-LLM-3_8B-128k-GGUF](https://huggingface.co/Gigax/NPC-LLM-3_8B-128k-GGUF)},
+      title={NPC-LLM-3_8B-128k-GGUF},
       author={Gigax team}
 }
 ```