Merge pull request 'mars: add KittenTTS voice provider (CPU-only, offline mini model)' (#7) from feat/mars-hermes-kittentts into master
Reviewed-on: #7
This commit was merged in pull request #7.
This commit is contained in:
@@ -77,6 +77,38 @@ let
|
||||
# Mnemosyne memory provider: third-party plugin, not in the image.
|
||||
mnemosyneEnv = pkgs.callPackage ../../pkgs/mnemosyne-env.nix { };
|
||||
|
||||
# KittenTTS voice provider inputs (CPU-only; model + wheel hash-pinned).
|
||||
# Provisioning unit near the bottom of this file; background on why the
|
||||
# deps deviate from upstream's declaration lives in
|
||||
# ./kittentts/requirements.txt + ./kittentts/kitten-misaki-stub.py.
|
||||
kittenttsWheel = pkgs.fetchurl {
|
||||
url = "https://github.com/KittenML/KittenTTS/releases/download/0.8.1/kittentts-0.8.1-py3-none-any.whl";
|
||||
sha256 = "sha256-SCpDbE8fMZIVNxA3bkWf82iVF+vNp8KwUeL9QYe0GFE=";
|
||||
};
|
||||
# uv parses the version out of the filename; the store hash prefix breaks it.
|
||||
kittenttsWheelFile = "${pkgs.linkFarm "kittentts-wheel" {
|
||||
"kittentts-0.8.1-py3-none-any.whl" = kittenttsWheel;
|
||||
}}/kittentts-0.8.1-py3-none-any.whl";
|
||||
kittenttsRuntimeLibs = "${pkgs.stdenv.cc.cc.lib}/lib ${pkgs.zlib}/lib";
|
||||
kittenttsReqs = pkgs.writeText "kittentts-requirements.txt" (
|
||||
builtins.readFile ./kittentts/requirements.txt
|
||||
);
|
||||
kittenttsStub = pkgs.writeText "kitten-tts-stub.py" (
|
||||
builtins.readFile ./kittentts/kitten-misaki-stub.py
|
||||
);
|
||||
kittenttsModelOnnx = pkgs.fetchurl {
|
||||
url = "https://huggingface.co/KittenML/kitten-tts-mini-0.8/resolve/c02725660cea441db4c383af69f1f26f5cd00947/kitten_tts_mini_v0_8.onnx";
|
||||
sha256 = "sha256-D1u65PxIAMmNvFRKh+z6eVEN4vuCItsw0S5b/pF335E=";
|
||||
};
|
||||
kittenttsModelVoices = pkgs.fetchurl {
|
||||
url = "https://huggingface.co/KittenML/kitten-tts-mini-0.8/resolve/c02725660cea441db4c383af69f1f26f5cd00947/voices.npz";
|
||||
sha256 = "sha256-QK0mOJUrd7ey8wEn4mCOFp/GndJWtTvYqqNAmjMZPEI=";
|
||||
};
|
||||
kittenttsModelConfig = pkgs.fetchurl {
|
||||
url = "https://huggingface.co/KittenML/kitten-tts-mini-0.8/resolve/c02725660cea441db4c383af69f1f26f5cd00947/config.json";
|
||||
sha256 = "sha256-axYLybGeJOyyHoS8FPin2iH99H7HLUJFC8XPUUthgEo=";
|
||||
};
|
||||
|
||||
# Wire event names (X-GitHub-Event) each route accepts — NOT the
|
||||
# subscription names the gitea hooks in services/dev/gitea.nix use. The two
|
||||
# namespaces collide; see the long comment on the route unit below.
|
||||
@@ -274,6 +306,11 @@ in
|
||||
# Authentik rejects. Safe to trust any peer: 9119 is already scoped to
|
||||
# loopback + tailscale0 only.
|
||||
FORWARDED_ALLOW_IPS = "*";
|
||||
|
||||
# KittenTTS: point huggingface_hub at the pre-seeded offline cache and
|
||||
# forbid network — no model drift, no boot-time fetch (review #4).
|
||||
HF_HOME = "/opt/data/kittentts-hf";
|
||||
HF_HUB_OFFLINE = "1";
|
||||
};
|
||||
environmentFiles = [ config.sops.templates."hermes-agent.env".path ];
|
||||
cmd = [ "gateway" "run" ];
|
||||
@@ -450,4 +487,199 @@ in
|
||||
chown -h ${hermesUid}:${hermesGid} "$pluginDir"
|
||||
'';
|
||||
};
|
||||
|
||||
# ---- KittenTTS voice provider ------------------------------------------
|
||||
# CPU-only onnxruntime TTS (no GPU on mars), mini model per darman. The
|
||||
# upstream `misaki[en]` declaration is deliberately not honored — it pulls
|
||||
# torch→CUDA (5.6 GB verified); the runtime phonemizes with espeak-ng only,
|
||||
# so the dead `from misaki import en, espeak` import is satisfied by a
|
||||
# .pth-registered stub (kitten-misaki-stub.py) that fails loudly if misaki
|
||||
# is ever actually used.
|
||||
#
|
||||
# Provisioner invariants (shaped by the Mnemosyne + KittenTTS review rounds):
|
||||
# - Build in a ROOT-OWNED staging dir (/var/lib/hermes-kittentts, 0755 so
|
||||
# the uid-986 delivery step can read it; nothing in it is secret):
|
||||
# stamp, staging venv, uv cache and staging model copies all live there.
|
||||
# Root never reads or executes anything the container can write — the
|
||||
# container cannot symlink-takeover the stamp (review #1) or plant a
|
||||
# wheel in the uv cache (review #2); only FINISHED artifacts are copied
|
||||
# into hermesHome, and the stamp compares the delivered copy against
|
||||
# staging byte-for-byte.
|
||||
# - Root runs python ONLY from the staging venv (never from the delivered
|
||||
# uid-986-owned tree in hermesHome) — after a root-side offline import
|
||||
# check; a failing build aborts before anything is delivered.
|
||||
# - HF model cache delivered to hermesHome from staging (refs/main ->
|
||||
# snapshots/<real commit sha>), and the container env pins
|
||||
# HF_HOME=/opt/data/kittentts-hf + HF_HUB_OFFLINE=1: zero boot-time
|
||||
# network, no drift.
|
||||
# - Idempotency stamp keyed on the FULL input set (requirements + wheel +
|
||||
# stub + model files), not just requirements (review #5); a deleted
|
||||
# delivered file falls out of the fast path and re-provisions cheaply.
|
||||
# - Order after prepare-dirs (review #6) — mirrors the mnemosyne unit.
|
||||
#
|
||||
# Trust boundary: the DELIVERED venv lives inside hermesHome
|
||||
# (HERMES_WRITE_SAFE_ROOT), so luna can alter her own TTS engine — and a
|
||||
# deleted/modified copy just triggers a fresh delivery from the root-owned
|
||||
# staging area on next boot (self-heals instead of wedging). Deliberate: it's
|
||||
# her voice, not her jail — the webhook filter scripts remain the only
|
||||
# write-protected-but-load-bearing items.
|
||||
systemd.services.hermes-agent-kittentts-provision = {
|
||||
description = "Provision KittenTTS voice provider (side venv + offline HF cache)";
|
||||
before = [ "podman-hermes-agent.service" ];
|
||||
wantedBy = [ "podman-hermes-agent.service" ];
|
||||
wants = [ "network-online.target" ];
|
||||
# after prepare-dirs (review #6): on a fresh state dir this unit must not
|
||||
# create hermesHome root-owned before prepare-dirs sets the ownership
|
||||
# layout — same ordering contract the mnemosyne unit has. PLUS
|
||||
# network-online ordering (review2 #3): this unit CAN download at boot
|
||||
# (unlike mnemosyne's store-path build), so uv must not run before the
|
||||
# network is actually up.
|
||||
after = [
|
||||
"network-online.target"
|
||||
"hermes-agent-prepare-dirs.service"
|
||||
];
|
||||
requires = [ "hermes-agent-prepare-dirs.service" ];
|
||||
# diffutils: `cmp` in the fast path; missing, it silently re-delivers every boot.
|
||||
path = [ pkgs.uv pkgs.coreutils pkgs.diffutils pkgs.util-linux pkgs.auto-patchelf pkgs.patchelf ];
|
||||
serviceConfig = {
|
||||
Type = "oneshot";
|
||||
TimeoutStartSec = 600;
|
||||
};
|
||||
script = ''
|
||||
set -euo pipefail
|
||||
|
||||
venv=${hermesHome}/kittentts-venv
|
||||
hubDir=${hermesHome}/kittentts-hf/hub/models--KittenML--kitten-tts-mini-0.8
|
||||
# Real upstream commit SHA as snapshot dir: hf_hub_download resolves
|
||||
# refs/main -> snapshots/<sha>; "kitten" (review #3) is never found
|
||||
# offline and silently triggers a re-download.
|
||||
modelSha=c02725660cea441db4c383af69f1f26f5cd00947
|
||||
snap=$hubDir/snapshots/$modelSha
|
||||
# REVIEW #1/#2: nothing root touches lives in hermesHome. Stamp, staging
|
||||
# venv and uv cache live root-owned under /var/lib/hermes-kittentts (a
|
||||
# path the container can not pathwrite or symlinks into its own tree);
|
||||
# the FINISHED staging venv and model files are the only things copied
|
||||
# into hermesHome, and only after being validated. Root doesn't follow
|
||||
# any uid-986-writable path while running as root.
|
||||
stageDir=/var/lib/hermes-kittentts
|
||||
# Root-side staging of the DELIVERED TREE (venv + full HF hub layout
|
||||
# including refs/main) — everything root writes lives here.
|
||||
# review2 #4: root never writes into hermesHome; delivery happens as
|
||||
# the container uid via setpriv, copying from these root-owned sources.
|
||||
stageVenv=$stageDir/venv
|
||||
stageHub=$stageDir/kittentts-hf
|
||||
stageSnap=$stageDir/hf-model
|
||||
# Input key: requirements + wheel + stub + model files + resolved script.
|
||||
# Review #5 — a miss on the old requirements-only stamp let a changed
|
||||
# wheel/stub/model URL keep running the stale install forever.
|
||||
inputHash=$({ cat ${kittenttsReqs} ${kittenttsWheel} ${kittenttsStub} \
|
||||
${kittenttsModelOnnx} ${kittenttsModelVoices} ${kittenttsModelConfig}
|
||||
echo ${kittenttsRuntimeLibs}; } | sha256sum | cut -d' ' -f1)
|
||||
stampFile=$stageDir/provision.stamp
|
||||
|
||||
# Idempotent early exit: stamp matches the full input hash, staging venv
|
||||
# validated, delivered copy intact check runs below.
|
||||
if [ -f "$stampFile" ] && [ "$(cat "$stampFile")" = "$inputHash" ] \
|
||||
&& [ -x "$stageVenv/bin/python" ] \
|
||||
&& [ -f "$stageSnap/config.json" ]; then
|
||||
# Delivered artifacts in hermesHome must ALSO match the staging copy:
|
||||
# luna can rewrite her copy, that's fine — but then the missing file
|
||||
# forces a re-provision (cheap copy, not a rebuild) so deletions
|
||||
# cannot wedge the gateway without a voice.
|
||||
if [ -x "$venv/bin/python" ] \
|
||||
&& cmp -s "$stageSnap/config.json" "$snap/config.json" 2>/dev/null \
|
||||
&& cmp -s "$stageSnap/kitten_tts_mini_v0_8.onnx" "$snap/kitten_tts_mini_v0_8.onnx" 2>/dev/null \
|
||||
&& cmp -s "$stageSnap/voices.npz" "$snap/voices.npz" 2>/dev/null; then
|
||||
exit 0
|
||||
fi
|
||||
fi
|
||||
|
||||
# ---- staging venv + staged hub tree: root-owned path, uv cache
|
||||
# included. Root runs python from HERE (container can write nothing in
|
||||
# this tree); the FINISHED result is copied into hermesHome AS THE
|
||||
# CONTAINER USER via setpriv (review2 #4) — root never writes into
|
||||
# hermesHome, so no uid-986-controlled path is ever followed while
|
||||
# running as root; symlink-takeover of stamps/refs/install targets is
|
||||
# structurally impossible. ----
|
||||
mkdir -p "$stageDir" "$stageSnap" "$stageVenv" "$stageHub"
|
||||
# 0755: the setpriv'd uid-986 delivery below must be able to read it.
|
||||
chmod 0755 "$stageDir"
|
||||
install -m 0444 ${kittenttsModelConfig} "$stageSnap/config.json"
|
||||
install -m 0444 ${kittenttsModelOnnx} "$stageSnap/kitten_tts_mini_v0_8.onnx"
|
||||
install -m 0444 ${kittenttsModelVoices} "$stageSnap/voices.npz"
|
||||
|
||||
# Skip the venv REBUILD when staging is still valid (review2 minor:
|
||||
# damaged delivery should be a copy, not a rebuild) — but only for the
|
||||
# CURRENT inputs, else a bump delivers the old venv under a new stamp.
|
||||
if [ "$(cat "$stampFile" 2>/dev/null)" != "$inputHash" ] \
|
||||
|| ! [ -x "$stageVenv/bin/python" ] \
|
||||
|| ! [ -f "$stageVenv/lib/python3.13/site-packages/kitten_tts_stub.py" ]; then
|
||||
rm -rf "$stageVenv"
|
||||
UV_CACHE_DIR=$stageDir/uv-cache \
|
||||
uv venv "$stageVenv" --python ${pkgs.python313}/bin/python3 --quiet
|
||||
UV_CACHE_DIR=$stageDir/uv-cache \
|
||||
uv pip install --python "$stageVenv/bin/python" --quiet \
|
||||
--requirement ${kittenttsReqs}
|
||||
# kittentts --no-deps: its overlay of spacy/misaki[en] is what drags in
|
||||
# the CUDA tree; the requirements freeze already covers its real needs.
|
||||
UV_CACHE_DIR=$stageDir/uv-cache \
|
||||
uv pip install --python "$stageVenv/bin/python" --quiet --no-deps \
|
||||
${kittenttsWheelFile}
|
||||
|
||||
# Dead-import shim: .pth auto-loads kitten_tts_stub at interpreter
|
||||
# start so `from misaki import en, espeak` resolves without the real
|
||||
# misaki.en.
|
||||
siteDir=$("$stageVenv/bin/python" -c 'import sysconfig; print(sysconfig.get_paths()["purelib"])')
|
||||
cp ${kittenttsStub} "$siteDir/kitten_tts_stub.py"
|
||||
printf 'import kitten_tts_stub\n' > "$siteDir/zz-kitten-stub.pth"
|
||||
|
||||
# PyPI manylinux .so's (numpy, onnxruntime) need libstdc++, which the
|
||||
# Nix loader never finds, on the host or in the container.
|
||||
auto-patchelf --paths "$stageVenv" --libs ${kittenttsRuntimeLibs}
|
||||
fi
|
||||
|
||||
# Stage the full delivered hub tree (exact hf_hub_download layout:
|
||||
# refs/main -> snapshots/<sha>; review1 #3) under root-owned staging.
|
||||
stageModelDir=$stageHub/hub/models--KittenML--kitten-tts-mini-0.8
|
||||
mkdir -p "$stageModelDir/refs" "$stageModelDir/snapshots/$modelSha"
|
||||
printf '%s' "$modelSha" > "$stageModelDir/refs/main"
|
||||
install -m 0444 ${kittenttsModelOnnx} "$stageModelDir/snapshots/$modelSha/kitten_tts_mini_v0_8.onnx"
|
||||
install -m 0444 ${kittenttsModelVoices} "$stageModelDir/snapshots/$modelSha/voices.npz"
|
||||
install -m 0444 ${kittenttsModelConfig} "$stageModelDir/snapshots/$modelSha/config.json"
|
||||
# No blobs/ indirection: kittentts reads paths RETURNED by
|
||||
# hf_hub_download, which serves the resolved snapshot file directly
|
||||
# (prefer-dir layout works offline for fully-materialized files).
|
||||
|
||||
# Root-side sanity: the staged interpreter must construct the model
|
||||
# END-TO-END offline (review2 minor — import alone doesn't exercise
|
||||
# hf_hub_download; a broken cache layout must fail HERE, not in the
|
||||
# gateway). Points HF_HOME at the staged hub tree itself.
|
||||
HF_HOME=$stageHub \
|
||||
HF_HUB_OFFLINE=1 \
|
||||
PHONEMIZER_ESPEAK_LIBRARY="$("$stageVenv/bin/python" -c 'import espeakng_loader,pathlib;print(pathlib.Path(espeakng_loader.get_library_path()))')" \
|
||||
PHONEMIZER_ESPEAK_DATA_PATH="$("$stageVenv/bin/python" -c 'import espeakng_loader,pathlib;print(pathlib.Path(espeakng_loader.get_data_path()))')" \
|
||||
"$stageVenv/bin/python" -c 'from kittentts import KittenTTS; KittenTTS("KittenML/kitten-tts-mini-0.8"); print("kittentts offline build ok")' >/dev/null
|
||||
|
||||
# ---- deliver AS THE CONTAINER USER (review2 #4): root never writes
|
||||
# into hermesHome, so no symlink race and no `chown` step. setpriv
|
||||
# drops to uid 986, rm -rf's the old delivered copies and copies the
|
||||
# fresh staging tree in. cp-as-986 also fixes review2 #2: rm+cp in one
|
||||
# step, no mv -Tf rename-replace on a non-empty directory.
|
||||
setpriv --reuid=${hermesUid} --regid=${hermesGid} --clear-groups \
|
||||
${pkgs.runtimeShell} -c '
|
||||
set -eu
|
||||
rm -rf "$1" "$2"
|
||||
cp -a "$3" "$1"
|
||||
cp -a "$4" "$2"
|
||||
' _ \
|
||||
"${hermesHome}/kittentts-venv" \
|
||||
"${hermesHome}/kittentts-hf" \
|
||||
"$stageVenv" \
|
||||
"$stageHub"
|
||||
|
||||
# Stamp LAST, root-owned outside hermesHome — luna can delete it (which
|
||||
# forces a cheap re-delivery on next boot), not tamper via symlink.
|
||||
printf '%s' "$inputHash" > "$stampFile"
|
||||
'';
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
# Runtime shim for KittenTTS on a CPU-only, disk-constrained host.
|
||||
#
|
||||
# kittentts/onnx_model.py opens with `from misaki import en, espeak` — a dead import:
|
||||
# every code path that produces audio from text goes through phonemizer-fork's
|
||||
# EspeakBackend (espeak-ng via espeakng-loader); misaki.en/espeak are never called.
|
||||
# If misaki[en] were installed for real, those two imports would be a hook for the
|
||||
# whole spacy → thinc → torch → CUDA chain (~5.6 GB verified). This stub registers
|
||||
# `misaki.en` and `misaki.espeak` as import-time-only placeholders instead.
|
||||
#
|
||||
# Written into site-packages by the derivation (see pkgs/kittentts-env.nix) under
|
||||
# `sitecustomize.py`-style auto-load — actually via a `kitten_tts_stub.py` + a `.pth`
|
||||
# pointing at it, so any Python process in this env gets the stub registered before
|
||||
# any kittentts import. If KittenTTS upstream ever starts USING misaki, this shim
|
||||
# will fail loudly at import of the missing attributes (better than silent distortion),
|
||||
# and the fix becomes "install the real misaki[en]" — a deliberate, reviewed change.
|
||||
import sys
|
||||
import types
|
||||
|
||||
_misaki = sys.modules.get("misaki")
|
||||
if _misaki is None:
|
||||
# Avoid registering a fake parent before the real misaki loads — the base misaki
|
||||
# (addict/regex only) is installed normally, so usually already here.
|
||||
import misaki # noqa: F401 (raises if base misaki is missing — loud, not silent)
|
||||
_misaki = sys.modules["misaki"]
|
||||
|
||||
if getattr(_misaki, "en", None) is None:
|
||||
_stub = types.ModuleType("misaki.en")
|
||||
sys.modules.setdefault("misaki.en", _stub)
|
||||
_misaki.en = _stub
|
||||
|
||||
if getattr(_misaki, "espeak", None) is None:
|
||||
_stub2 = types.ModuleType("misaki.espeak")
|
||||
sys.modules.setdefault("misaki.espeak", _stub2)
|
||||
_misaki.espeak = _stub2
|
||||
@@ -0,0 +1,69 @@
|
||||
# Pinned requirements for the KittenTTS side-venv on mars (validated freeze, CPU-only).
|
||||
#
|
||||
# DEPENDENCY DISCIPLINE (important — this is NOT the upstream dependency set):
|
||||
# `kittentts` declares `misaki[en]` + spacy, which transitively pull torch → the whole
|
||||
# CUDA runtime (~5.6 GB with nvidia-* wheels, verified in a clean install on this box).
|
||||
# NONE of that is reachable at runtime: onnx_model.py imports `from misaki import en, espeak`
|
||||
# at module load but generate() phonemizes exclusively through `phonemizer-fork` +
|
||||
# `espeakng-loader` (espeak-ng via EspeakBackend); misaki.en/espeak glyphs are parsed but
|
||||
# never called in the ONNX path. mars has no GPU and a modest disk budget, so:
|
||||
#
|
||||
# - install kittentts with --no-deps and enumerate its deps manually,
|
||||
# - install base `misaki` (NOT misaki[en]) — only addict/regex,
|
||||
# - the misaki.en import is satisfied by a stub registered in sitecustomize
|
||||
# (kitten-misaki-stub.py, written into site-packages by the derivation).
|
||||
#
|
||||
# Freeze captured 2026-09-19 from a verified CPU-only venv (python 3.13, i5-4460,
|
||||
# generation ~= 1x realtime with the mini model, HF_HUB_OFFLINE=1).
|
||||
#
|
||||
# kittentts itself comes from a GitHub release wheel (0.8.1), not PyPI (PyPI's 0.1.3 is
|
||||
# the old v0.1-lineage); see pkgs/kittentts-env.nix.
|
||||
addict==2.4.0
|
||||
anyio==4.15.1
|
||||
attrs==26.1.0
|
||||
babel==2.18.0
|
||||
certifi==2026.7.22
|
||||
cffi==2.1.1
|
||||
click==8.5.0
|
||||
cloudpickle==3.1.2
|
||||
csvw==4.1.0
|
||||
dlinfo==2.0.0
|
||||
docopt==0.6.2
|
||||
espeakng-loader==0.2.4
|
||||
filelock==4.0.1
|
||||
flatbuffers==25.12.19
|
||||
fsspec==2026.9.0
|
||||
h11==0.16.0
|
||||
hf-xet==1.6.0
|
||||
httpcore==1.0.9
|
||||
httpx==0.28.1
|
||||
huggingface-hub==1.32.0
|
||||
idna==3.20
|
||||
isodate==0.7.2
|
||||
joblib==1.6.0
|
||||
jsonschema-specifications==2025.9.1
|
||||
jsonschema==4.26.0
|
||||
language-tags==1.3.1
|
||||
misaki==0.9.4
|
||||
num2words==0.5.14
|
||||
numpy==2.5.3
|
||||
onnxruntime==1.30.0
|
||||
packaging==26.3
|
||||
phonemizer-fork==3.3.2
|
||||
protobuf==7.36.2
|
||||
pycparser==3.0
|
||||
pyparsing==3.3.2
|
||||
python-dateutil==2.9.0.post0
|
||||
pyyaml==6.0.3
|
||||
rdflib==7.6.0
|
||||
referencing==0.37.0
|
||||
regex==2026.9.10
|
||||
rfc3986==1.5.0
|
||||
rpds-py==2026.6.3
|
||||
segments==2.4.0
|
||||
six==1.17.0
|
||||
soundfile==0.14.0
|
||||
termcolor==3.3.0
|
||||
tqdm==4.70.1
|
||||
typing-extensions==4.16.0
|
||||
uritemplate==4.2.0
|
||||
Reference in New Issue
Block a user