From e07df3951e73c80ebaa8081964fe87a2484579e2 Mon Sep 17 00:00:00 2001 From: kingbri <8082010+kingbri1@users.noreply.github.com> Date: Mon, 18 Aug 2025 23:06:16 -0400 Subject: [PATCH] Docs: Update sampler overrides Change the sampling subsection to sampler overrides and add a warning about the default preset. Signed-off-by: kingbri <8082010+kingbri1@users.noreply.github.com> --- docs/01.-Getting-Started.md | 3 +++ docs/{08.-Sampling.md => 08.-Sampler-Overrides.md} | 0 2 files changed, 3 insertions(+) rename docs/{08.-Sampling.md => 08.-Sampler-Overrides.md} (100%) diff --git a/docs/01.-Getting-Started.md b/docs/01.-Getting-Started.md index c71413a..4bf0b3e 100644 --- a/docs/01.-Getting-Started.md +++ b/docs/01.-Getting-Started.md @@ -76,6 +76,9 @@ A config.yml file is required for overriding project defaults. **If you are okay If you do want a config file, copy over `config_sample.yml` to `config.yml`. All the fields are commented, so make sure to read the descriptions and comment out or remove fields that you don't need. +> [!WARNING] +> Due to frontends not sending sampler settings per request, tabbyAPI sets a safe defaults sampler override in config_sample.yml. If you are testing metrics or experimenting, please remove `safe_defaults` from the `override_preset` key! + In addition, if you want to manually set the API keys, copy over `api_keys_sample.yml` to `api_keys.yml` and fill in the fields. However, doing this is less secure and autogenerated keys should be used instead. You can also access the configuration parameters under [2. Configuration](https://github.com/theroyallab/tabbyAPI/wiki/2.-Configuration) in this wiki! diff --git a/docs/08.-Sampling.md b/docs/08.-Sampler-Overrides.md similarity index 100% rename from docs/08.-Sampling.md rename to docs/08.-Sampler-Overrides.md