diff options
| author | saood06 <saood05@gmail.com> | 2025-06-09 05:32:03 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-06-09 05:32:03 -0500 |
| commit | fa90a9864a95da230065fdb9b17d14a485ef6807 (patch) | |
| tree | 37cbbd019147a1d68d9c6f8f10018e2c62185b6f /examples/main/README.md | |
| parent | 58f08e43859a942dcc4d585f04b729eb50603264 (diff) | |
Docs update (#509)
* use npm as deps manager and vite as bundler
* update XTC docs
---------
Co-authored-by: Xuan Son Nguyen <son@huggingface.co>
Diffstat (limited to 'examples/main/README.md')
| -rw-r--r-- | examples/main/README.md | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/examples/main/README.md b/examples/main/README.md index dd627456..417432b3 100644 --- a/examples/main/README.md +++ b/examples/main/README.md @@ -241,13 +241,11 @@ Example usage: `--mirostat 2 --mirostat-lr 0.05 --mirostat-ent 3.0` ### XTC Sampling (Exclude Top Choices) -The function of this sampler is conrolled by `--xtc-probability` and `--xtc-threshold`. `--xtc-probability` takes values between -0 and 1 (<=0 turns this sampler off) and defines the probability for randomly invoking the sampler. `--xtc-threshold` -defines the token probability threshold. Tokens with probability greater than this threshold will be excluded from the sampling. -The sampler is turned off for `threshold > 0.5`. +- --xtc-probability p: xtc probability (default: 0.0, maximum: 1.0) => (p*100)% chance to invoke the sampler. +- --xtc-threshold t : xtc threshold (default: 1.0 minimum : 0.0) => (t*100)% is the lower-bound for what probability is needed for a token to be considered a "Top choice", and only the lowest probability top choice is kept, all others are removed. + +The sampler is turned off for `threshold > 0.5`, and `--xtc-probability <=0`. -- --xtc-probability p: xtc probability (default: 0.0 => disabled) -- --xtc-threshold t : xtc threshold (default: 1.0 => disabled) ### Top-n-sigma Sampling |