Skip to content

docs: translate the repository to English #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Tromset merged 1 commit into from
Oct 3, 2026
Merged

docs: translate the repository to English #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
475 changes: 238 additions & 237 deletions Documentation.md
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions bench/bench.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ export function summarize(model, results) {

export function table(summaries) {
const rows = summaries.map(s => `| ${s.model} | ${s.passed}/${s.total} (${(s.passRate * 100).toFixed(0)} %) | ${s.decodeTokensPerSecond?.toFixed(1) ?? '-'} | ${s.prefillTokensPerSecond?.toFixed(0) ?? '-'} | ${s.meanOutputTokens.toFixed(0)} | ${s.meanSecondsPerProblem.toFixed(1)} |`);
return ['| Modèle | Tests réussis | Génération (tok/s) | Lecture du prompt (tok/s) | Tokens produits / problème | Secondes / problème |', '|---|---|---|---|---|---|', ...rows].join('\n');
return ['| Model | Tests passed | Generation (tok/s) | Prompt processing (tok/s) | Tokens generated / problem | Seconds / problem |', '|---|---|---|---|---|---|', ...rows].join('\n');
}

async function main() {
Expand Down Expand Up @@ -175,7 +175,7 @@ async function main() {
}
save();
console.log(table(report.models.map(m => m.summary)));
console.log(`\nDétails : ${out}`);
console.log(`\nDetails: ${out}`);
}

if (process.argv[1] && import.meta.url === pathToFileURL(fs.realpathSync(process.argv[1])).href) {
Expand Down
14 changes: 7 additions & 7 deletions brain/eval-router.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ for (const c of cases) {
}
const count = f => rows.filter(f).length;
const decided = rows.filter(r => r.rule !== 'unsure');
console.log(`Cas : ${rows.length} (${count(r => r.want === 'simple')} simples, ${count(r => r.want === 'hard')} difficiles)`);
console.log(`Règles seules : ${decided.length} décidés, ${count(r => r.rule !== 'unsure' && r.rule === r.want)} justes, ${count(r => r.rule === 'unsure')} confiés au micro-modèle`);
console.log(`Règles + micro-modèle : ${count(r => r.final === r.want)}/${rows.length} justes`);
console.log(` difficile envoyé au petit expert (perte de qualité) : ${count(r => r.want === 'hard' && r.final === 'simple')}`);
console.log(` simple envoyé au gros expert (temps et RAM en plus) : ${count(r => r.want === 'simple' && r.final === 'hard')}`);
console.log(`Cases: ${rows.length} (${count(r => r.want === 'simple')} simple, ${count(r => r.want === 'hard')} hard)`);
console.log(`Rules alone: ${decided.length} decided, ${count(r => r.rule !== 'unsure' && r.rule === r.want)} correct, ${count(r => r.rule === 'unsure')} handed to the micro-model`);
console.log(`Rules + micro-model: ${count(r => r.final === r.want)}/${rows.length} correct`);
console.log(` hard sent to the small expert (quality loss): ${count(r => r.want === 'hard' && r.final === 'simple')}`);
console.log(` simple sent to the large expert (extra time and RAM): ${count(r => r.want === 'simple' && r.final === 'hard')}`);
const times = rows.filter(r => r.modelMs).map(r => r.modelMs).sort((a, b) => a - b);
if (times.length) console.log(`Micro-modèle : médiane ${times[Math.floor(times.length / 2)]} ms sur ${times.length} appels`);
for (const r of rows.filter(r => r.final !== r.want)) console.log(` ✗ voulu ${r.want}, obtenu ${r.final} (${r.rule}) : ${r.text.slice(0, 90).replace(/\n/g, ' ')}`);
if (times.length) console.log(`Micro-model: median ${times[Math.floor(times.length / 2)]} ms over ${times.length} calls`);
for (const r of rows.filter(r => r.final !== r.want)) console.log(` ✗ wanted ${r.want}, got ${r.final} (${r.rule}): ${r.text.slice(0, 90).replace(/\n/g, ' ')}`);
4 changes: 2 additions & 2 deletions brain/flybrain.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ function main() {
const maxExpert = values['max-expert'] === 'auto' ? defaultMaxExpert() : values['max-expert'];
if (!['full', 'fast'].includes(maxExpert)) throw new Error('--max-expert must be auto, full or fast');
const server = createFlyBrain({ ollama: values.ollama, prefix: values.prefix, maxExpert });
server.listen(Number(values.port), values.host, () => console.error(`FlyBrain écoute sur http://${values.host}:${values.port} (Ollama : ${values.ollama}, expert max : ${maxExpert}). Modèles : flycoder, flycoder:fast`));
server.listen(Number(values.port), values.host, () => console.error(`FlyBrain listening on http://${values.host}:${values.port} (Ollama: ${values.ollama}, max expert: ${maxExpert}). Models: flycoder, flycoder:fast`));
}

if (process.argv[1] && import.meta.url === pathToFileURL(fs.realpathSync(process.argv[1])).href) {
try { main(); } catch (error) { console.error(`FlyBrain : ${error.message}`); process.exitCode = 1; }
try { main(); } catch (error) { console.error(`FlyBrain: ${error.message}`); process.exitCode = 1; }
}
34 changes: 17 additions & 17 deletions install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ REF=${FLYCODER_REF:-main}
RAW=https://raw.githubusercontent.com/Tromset/flycoder/$REF

say() { printf '%s\n' "$@"; }
die() { printf 'FlyCoder : %s\n' "$*" >&2; exit 1; }
die() { printf 'FlyCoder: %s\n' "$*" >&2; exit 1; }

choice=auto
engine=auto
Expand All @@ -26,20 +26,20 @@ for arg in "$@"; do
--gguf) engine=gguf ;;
--no-brain) brain=no ;;
-h|--help) sed -n '2,9p' "$0" 2>/dev/null || true; exit 0 ;;
*) die "option inconnue : $arg" ;;
*) die "unknown option: $arg" ;;
esac
done

command -v ollama >/dev/null 2>&1 || die "Ollama n'est pas installé. Téléchargez-le sur https://ollama.com/download puis relancez cette commande."
ollama list >/dev/null 2>&1 || die "Ollama ne répond pas. Ouvrez l'application Ollama (ou lancez 'ollama serve') puis relancez."
command -v ollama >/dev/null 2>&1 || die "Ollama is not installed. Download it from https://ollama.com/download, then run this command again."
ollama list >/dev/null 2>&1 || die "Ollama is not responding. Open the Ollama app (or run 'ollama serve'), then try again."

# Version check: returns success when $1 >= $2 (x.y.z).
version_ge() {
[ "$(printf '%s\n%s\n' "$2" "$1" | sort -t. -k1,1n -k2,2n -k3,3n | head -n 1)" = "$2" ]
}
current=$(ollama --version 2>/dev/null | sed -n 's/.*version is \([0-9][0-9.]*\).*/\1/p' | head -n 1)
[ -n "$current" ] || die "impossible de lire la version d'Ollama."
version_ge "$current" "$MIN_OLLAMA" || die "Ollama $current est trop ancien. FlyCoder $VERSION demande Ollama $MIN_OLLAMA ou plus récent : https://ollama.com/download"
[ -n "$current" ] || die "could not read the Ollama version."
version_ge "$current" "$MIN_OLLAMA" || die "Ollama $current is too old. FlyCoder $VERSION needs Ollama $MIN_OLLAMA or later: https://ollama.com/download"

os=$(uname -s)
arch=$(uname -m)
Expand All @@ -65,7 +65,7 @@ trap 'rm -rf "$workdir"' EXIT
trap 'exit 130' INT TERM
fetch() {
if [ -f "$here/$1" ] && grep -q "FlyCoder" "$here/$1"; then cp "$here/$1" "$workdir/$1"
else curl -fsSL "$RAW/$1" -o "$workdir/$1" || die "téléchargement impossible : $RAW/$1"; fi
else curl -fsSL "$RAW/$1" -o "$workdir/$1" || die "download failed: $RAW/$1"; fi
}

build() { # build <Modelfile> <tag> <mlx base> <gguf base>
Expand All @@ -75,14 +75,14 @@ build() { # build <Modelfile> <tag> <mlx base> <gguf base>
base=$4
sed "s|^FROM $3\$|FROM $4|" "$workdir/$1" > "$workdir/$1.gguf" && mv "$workdir/$1.gguf" "$workdir/$1"
fi
grep -q "^FROM $base\$" "$workdir/$1" || die "$1 ne part pas de $base."
say "" "==> Téléchargement de la base $base"
grep -q "^FROM $base\$" "$workdir/$1" || die "$1 does not start from $base."
say "" "==> Downloading base model $base"
ollama pull "$base"
say "==> Création de flycoder:$2"
say "==> Creating flycoder:$2"
ollama create "flycoder:$2" -f "$workdir/$1"
}

say "FlyCoder $VERSION · Ollama $current · $os $arch · ${memory_gb} Go · moteur $engine"
say "FlyCoder $VERSION · Ollama $current · $os $arch · ${memory_gb} GB · $engine engine"
case $choice in
default) build Modelfile "$VERSION" gemma4:12b-mlx gemma4:12b; ollama cp "flycoder:$VERSION" flycoder:latest ;;
fast) build Modelfile.fast "$VERSION-fast" qwen3.5:4b-mlx qwen3.5:4b; ollama cp "flycoder:$VERSION-fast" flycoder:latest ;;
Expand All @@ -102,15 +102,15 @@ if [ "$brain" = yes ]; then
mkdir -p "$brain_dir"
for file in brain/router.mjs brain/flybrain.mjs; do
if [ -f "$here/$file" ]; then cp "$here/$file" "$brain_dir/"
else curl -fsSL "$RAW/$file" -o "$brain_dir/${file#brain/}" || die "téléchargement impossible : $RAW/$file"; fi
else curl -fsSL "$RAW/$file" -o "$brain_dir/${file#brain/}" || die "download failed: $RAW/$file"; fi
done
fi

say "" "FlyCoder est installé. Lancez : ollama run flycoder"
say "" "FlyCoder is installed. Run: ollama run flycoder"
if [ "$brain" = yes ]; then
say "Avec le routeur FlyBrain (moins de RAM, Node 22) : node $brain_dir/flybrain.mjs" \
"puis, dans un autre terminal : OLLAMA_HOST=127.0.0.1:11435 ollama run flycoder"
if [ "$choice" = fast ]; then say "(sans le modèle 12B, lancez FlyBrain avec --max-expert fast)"; fi
say "With the FlyBrain router (less RAM, Node 22): node $brain_dir/flybrain.mjs" \
"then, in another terminal: OLLAMA_HOST=127.0.0.1:11435 ollama run flycoder"
if [ "$choice" = fast ]; then say "(without the 12B model, start FlyBrain with --max-expert fast)"; fi
fi
[ "$choice" = default ] && say "Version la plus rapide (8 Go) : sh install.sh --fast"
[ "$choice" = default ] && say "Fastest version (8 GB): sh install.sh --fast"
exit 0
Loading
Loading