Commit f6059afe by PLN (Algolia)

docs: le choix du modèle et les champs raisonnement bas, dans l'aide et le README

parent 87f866e5
......@@ -107,6 +107,15 @@ then checks the suggestions before believing any of them.
- **Local only.** The endpoint is LM Studio's OpenAI-compatible server at
`http://127.0.0.1:1234/v1` by default. `BUVARD_FIX_URL` points at another
local endpoint, and that is all: the text never leaves the machine.
- **No silent reasoner.** Without `BUVARD_FIX_MODEL`, buvard lists the
server's models and picks the first whose id does not look like a reasoning
model (the skip-list is a documented constant in `lib/fix.mjs`: thinking,
reason, r1, qwq, o1, o3, o4, deepseek-r1, phi-4-reasoning, nemotron). A
one-model listing is used as is; an all-reasoning listing fails clean and
asks for `BUVARD_FIX_MODEL`. And whichever model is used — named by hand or
picked — every request sends `reasoning_effort: "low"` and
`chat_template_kwargs: {enable_thinking: false}`; servers that don't know
these fields simply ignore them, so reasoning is always off or low.
- **Dry run by default.** You get the diff, a per-suggestion table (applied /
KEEP / dropped, with the reason) and before/after scores. Nothing is written
until `--write`, and `--json` gives the whole structured result.
......@@ -121,7 +130,7 @@ Setup, two lines:
```
LM Studio → Developer → Start Server # serves http://127.0.0.1:1234
buvard fix article.md # BUVARD_FIX_MODEL picks the model
buvard fix article.md # picks a non-reasoning model itself
```
## Science and references
......
......@@ -8,8 +8,13 @@
* model (LM Studio at 127.0.0.1:1234
* by default; BUVARD_FIX_URL for
* another local endpoint — text
* never leaves the machine). Dry
* run by default.
* never leaves the machine).
* BUVARD_FIX_MODEL names the
* model; otherwise the first
* non-reasoning id on the server
* is picked, and every request
* caps reasoning (low, thinking
* off). Dry run by default.
* buvard --help | --version
*
* Scoring starts at 100; each hit costs its weight (lexique 5, structure 8,
......@@ -252,7 +257,7 @@ async function fixMain(argv) {
for (const a of argv) {
if (a === '--json' || a === '--write') flags.add(a);
else if (a === '-h' || a === '--help') {
console.log(`${FIX_USAGE}\n\nAppel d'un modèle local (127.0.0.1:1234 par défaut, BUVARD_FIX_URL pour un autre) ; texte jamais sorti de la machine. Dry run par défaut — --write pour appliquer.`);
console.log(`${FIX_USAGE}\n\nAppel d'un modèle local (127.0.0.1:1234 par défaut, BUVARD_FIX_URL pour un autre) ; texte jamais sorti de la machine. Modèle : BUVARD_FIX_MODEL le fixe, sinon le premier id hors raisonnement est pris — et chaque requête borne le raisonnement (low, thinking off). Dry run par défaut — --write pour appliquer.`);
return 0;
} else if (a.startsWith('-')) {
console.error(`buvard fix: option inconnue "${a}"\n\n${FIX_USAGE}`);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment