Skip to content

Commit

Permalink
update docz
Browse files Browse the repository at this point in the history
  • Loading branch information
grencez committed Dec 29, 2024
1 parent 67bf941 commit 5aa46ef
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 12 deletions.
12 changes: 10 additions & 2 deletions doc/setting/prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,25 @@ By default, there are only 2 characters: the protagonist (your input) and the co
; Confidant's name. Can be changed later via the `/confidant Bot` command.
(confidant "Bot")
(substitution
(language
(substitution
; Replace "{{user}}" in the input prompts with the protagonist name.
(protagonist_alias "{{user}}")
; Replace "{{char}}" in the input prompts with the confidant name.
(confidant_alias "{{char}}")
)
)
```

You can also add more chat prefixes to help frame how the token generation.
```lisp
(((chat_prefixes)) "{{user}}:" "{{char}} feels:" "{{char}} wants:" "{{char}} plans:" "{{char}}:")
(((chat_prefixes))
"{{user}}:"
"{{char}} feels:"
"{{char}} wants:"
"{{char}} plans:"
"{{char}}:"
)
```

## Format
Expand Down
24 changes: 14 additions & 10 deletions doc/setting/sample.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ The defaults are okay for chatting.
Mirostat version 2 is the current default with the following parameters.

```lisp
(temperature 0.7)
(language
((infer_via sampling)
(adjust_thru (())
(temperature 0.7)
)
((pick_via mirostat)
; Use Mirostat version 2.
(version 2)
Expand All @@ -23,17 +25,19 @@ Mirostat version 2 is the current default with the following parameters.

## Probability
```lisp
(temperature 0.7)
; Top-K Sampling (default is 1000).
(top_k 40)
; Top-P Sampling (default is 0.95).
(top_p 0.9)
; Min-P Sampling (default is 0.05).
(min_p 0.05)
; Locally Typical Sampling cutoff (default is 1.0, off).
(typical_p 0.9)
(language
((infer_via sampling)
(adjust_thru (())
; Top-K Sampling (default is 1000).
(top_k 40)
; Top-P Sampling (default is 0.95).
(top_p 0.9)
; Locally Typical Sampling cutoff (default is 1.0, off).
(typical_p 0.9)
; Min-P Sampling (default is 0.05).
(min_p 0.05)
(temperature 0.7)
)
; Turn Mirostat off.
((pick_via probability))
)
Expand Down

0 comments on commit 5aa46ef

Please sign in to comment.