Ammah commited on
Commit
d1e3bd3
1 Parent(s): 07619da

update README.md

Browse files
Files changed (1) hide show
  1. README.md +15 -6
README.md CHANGED
@@ -31,11 +31,17 @@ from llama_cpp import Llama
31
 
32
  # Our stepper takes in a Outlines model to enable guided generation
33
  # This forces the model to follow our output format
34
- model = Llama(
35
- model_path="./path/to/model/npc-llm-3_8B.gguf",
36
- # n_gpu_layers=-1, # Uncomment to use GPU acceleration
 
 
 
37
  )
38
 
 
 
 
39
  # Instantiate a stepper: handles prompting + output parsing
40
  stepper = NPCStepper(model=model)
41
  ```
@@ -53,8 +59,11 @@ from gigax.scene import (
53
  Skill,
54
  ParameterType,
55
  )
 
56
  # Use sample data
 
57
  current_location = Location(name="Old Town", description="A quiet and peaceful town.")
 
58
  NPCs = [
59
  Character(
60
  name="John the Brave",
@@ -133,9 +142,9 @@ Aldren:
133
  ## How to Cite
134
 
135
  ```bibtex
136
- @misc{NPC-LLM-3_8B,
137
- url={[https://huggingface.co/Gigax/NPC-LLM-7B](https://huggingface.co/Gigax/NPC-LLM-3_8B)},
138
- title={NPC-LLM-3_8B},
139
  author={Gigax team}
140
  }
141
  ```
 
31
 
32
  # Our stepper takes in a Outlines model to enable guided generation
33
  # This forces the model to follow our output format
34
+ llm = Llama.from_pretrained(
35
+ repo_id="Gigax/NPC-LLM-3_8B-GGUF",
36
+ filename="npc-llm-3_8B.gguf"
37
+ # n_gpu_layers=-1, # Uncomment to use GPU acceleration
38
+ # seed=1337, # Uncomment to set a specific seed
39
+ # n_ctx=2048, # Uncomment to increase the context window
40
  )
41
 
42
+ model = models.LlamaCpp(llm)
43
+
44
+
45
  # Instantiate a stepper: handles prompting + output parsing
46
  stepper = NPCStepper(model=model)
47
  ```
 
59
  Skill,
60
  ParameterType,
61
  )
62
+
63
  # Use sample data
64
+ context = "Medieval world"
65
  current_location = Location(name="Old Town", description="A quiet and peaceful town.")
66
+ locations = [current_location] # you can add more locations to the scene
67
  NPCs = [
68
  Character(
69
  name="John the Brave",
 
142
  ## How to Cite
143
 
144
  ```bibtex
145
+ @misc{NPC-LLM-3_8B-GGUF,
146
+ url={[https://huggingface.co/Gigax/NPC-LLM-3_8B-GGUF-](https://huggingface.co/Gigax/NPC-LLM-3_8B-GGUF)},
147
+ title={NPC-LLM-3_8B-GGUF},
148
  author={Gigax team}
149
  }
150
  ```