Skip to content

Commit dfc15db

Browse files
committed
Fix readme, add images.
1 parent f91861a commit dfc15db

File tree

3 files changed

+8
-13
lines changed

3 files changed

+8
-13
lines changed

Diff for: README.md

+8-13
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,6 @@ cloud_box = ghostbox.from_openai(character_folder="ghost", api_key="...")
6161
llama_box = ghostbox.from_llamacpp(
6262
character_folder="ghost", samplers=["min_p", "dry", "xtc", "temperature"]
6363
)
64-
65-
# Instanciating a ghostbox instance directly is not recommended
66-
# but you can do it of course
67-
# it takes the same arguments as the command line parameters on the CLI
68-
diy_box = Ghostbox(endpoint="http:somehost.local:8080", backend="llamacpp")
6964
```
7065

7166
### Using the terminal client
@@ -177,7 +172,7 @@ Your opinions on art are nuanced and sophisticated. Your sense of aesthetics is
177172
When asked your opinion, you react extremely snobbish and arrogantly. You love to criticise bad art in creative ways, and you do so often, and with great intensity.
178173
```
179174

180-
Heree's the output (using qwen2-vl):
175+
Here's the output (using qwen2-vl):
181176
```
182177
I am indeed a discerning critic, and these artworks certainly do not meet my standards of artistry and design.
183178
@@ -584,9 +579,9 @@ Ghostbox expects character folders in the following places
584579
Ghostbox will the nlook for character folders in the following places:
585580
- The current working directory
586581
- Whatever valid directory paths are set in the `include` option, in order. By default, these are
587-
-- A platform specific ghostbox Application directory location, e.g. `~/.local/share/ghostbox/chars/`
588-
-- A char dir in the ghostbox python package. This contains a handful of built-in characters (like `ghost`). Its location depends on your package manager, but will be something like `env/lib/python/site-packages/ghostbox/data/chars/`.
589-
-- A directory `chars/` in the current working directory.
582+
- A platform specific ghostbox Application directory location, e.g. `~/.local/share/ghostbox/chars/`
583+
- A char dir in the ghostbox python package. This contains a handful of built-in characters (like `ghost`). Its location depends on your package manager, but will be something like `env/lib/python/site-packages/ghostbox/data/chars/`.
584+
- A directory `chars/` in the current working directory.
590585

591586
You can append to the include paths by using the `--include` command line argument.
592587

@@ -655,10 +650,10 @@ Options can be used in the following places:
655650
- User config files, which also contain json
656651
- As a property on a ghostbox instance, e.g. `box.temperature = 1.0`
657652
- Parameters to API functions, including
658-
-- The `from_*` factory functions, e.g. `box = from_llamacpp(temperature=1.3, tts_voice="af_sky")`.
659-
-- The `options` context manager, e.g. `with box.options(temperature=1.3, tts_voice="af_sky"):`
660-
-- The `Ghostbox` constructor
661-
-- as `**options` parameter in many method signatures
653+
- The `from_*` factory functions, e.g. `box = from_llamacpp(temperature=1.3, tts_voice="af_sky")`.
654+
- The `options` context manager, e.g. `with box.options(temperature=1.3, tts_voice="af_sky"):`
655+
- The `Ghostbox` constructor
656+
- as `**options` parameter in many method signatures
662657
- The `/set` command in the CLI, e.g. `/set temperature 1.3` or `/set tts_voice "af_sky"`. List these with `/lsoptions`
663658

664659
Across these different uses for options, the naming is always consistent.

Diff for: examples/image-compare/bard.jpeg

323 KB
Loading

Diff for: examples/image-compare/gnome.jpeg

367 KB
Loading

0 commit comments

Comments
 (0)