Files
velixio 090cc37144 fix(memory): release the model before emptying the cache, not after
The shared voice model's unload emptied the allocator caches and *then*
dropped the reference. That frees nothing: the weights are still reachable
when gc.collect() runs, empty_cache() only returns blocks the allocator
already considered free, and the reference drops a moment later into a cache
nothing will flush again. The unload logs success, the engine leaves the
registry, and nvidia-smi does not move.

Six modules open-coded the same two lines. Exactly one had them inverted --
OmniVoiceBackend.unload, which is the path the engine-registry idle sweep
reaches, which is the sweep a headless worker node runs. So every unload a
user could trigger from the UI worked, and the one that runs unattended on a
machine lending its GPU held 3.6 GB indefinitely. Found on hardware: the
sweep fired on schedule, logged "Released 1 idle engine(s)", and VRAM stayed
flat at 3656 MiB for the next two minutes.

Replace all six with model_manager.unload_shared_model(), which clears the
reference, drops the clone-prompt side cache, then frees -- in that order,
in one place. Two callers gain the side-cache drop they were missing
(/system/flush-memory and the shutdown path), which is the same defect one
step down: an unload that kept the encoded reference tensors belonging to the
model it had just released.

A source guard asserts nothing outside model_manager assigns the shared
reference, so the next caller cannot reintroduce the ordering. It caught the
sixth site while being written.

Also give the AudioSeal watermark models the bargain every other model in the
app already makes: they loaded on the first embed and stayed resident for the
life of the process. CPU-resident, so this is system RAM rather than VRAM,
and the machines that notice are the ones running batches.

The error text on a failing unload changes with the ordering. "Could not be
unloaded, retry after the current generation finishes" was accurate when the
cache flush ran first and aborted before the release; now the release has
already happened and only the flush can fail, so it says that instead of
sending the user to repeat work that is done.
2026-08-12 02:33:04 +05:30

99 lines
4.1 KiB
Python
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"""Single-active-TTS-engine memory discipline.
Only one TTS engine's model stays resident at a time. When the generate path
resolves an engine, every *other* resident engine is unloaded first — so the
previous engine's model is handed back instead of stacking in memory until GC.
Why this matters (measured on a 16 GB M2): a generate on ``omnivoice`` leaves
its ~2.8 GB core model resident; a subsequent generate on ``mlx-audio`` loaded
that engine's model **on top** (footprint 3.9 GB → 4.3 GB, both resident),
because the two live in different caches with no coordination — the core in
``model_manager.model``, the rest in ``engines._ENGINE_INSTANCES`` (which was
never unloaded). That accumulation is the baseline that pushes a 16 GB machine
into the memory pressure behind the "Can't reach the local backend" OOM deaths.
Default on. Opt out with ``OMNIVOICE_SINGLE_ENGINE_RESIDENT=0`` on machines with
RAM to spare (keeping several engines warm avoids the reload latency on an A/B
switch — ~8 s for the VoiceStudio core, ~1–2 s for the lighter engines).
"""
from __future__ import annotations
import logging
from core.logging_utils import log_safe
import os
logger = logging.getLogger("omnivoice.engine_memory")
_OFF = {"0", "false", "no", "off"}
def single_engine_resident() -> bool:
"""Whether the one-engine-at-a-time policy is active (default True)."""
return (os.environ.get("OMNIVOICE_SINGLE_ENGINE_RESIDENT", "1").strip().lower()
not in _OFF)
def _evict_instance_cache(keep_cls) -> list[str]:
"""Unload + drop every cached engine instance except ``keep_cls``.
Operates on the per-request instance cache the generate path shares with the
engine health route (``engines._ENGINE_INSTANCES``). Each engine's
``unload()`` frees its heavy model (the ABC default clears ``_MODEL_ATTRS``
and empties the device cache; subprocess engines reap their sidecar). Never
raises — a stuck unload must not block the generation that triggered it."""
evicted: list[str] = []
try:
from api.routers.engines import _ENGINE_INSTANCES
except Exception: # pragma: no cover — router import should always succeed
return evicted
for cls, inst in list(_ENGINE_INSTANCES.items()):
if cls is keep_cls:
continue
try:
inst.unload()
except Exception: # noqa: BLE001
logger.warning("evict: %s.unload() failed", getattr(cls, "id", cls.__name__),
exc_info=True)
_ENGINE_INSTANCES.pop(cls, None)
evicted.append(getattr(cls, "id", cls.__name__))
return evicted
async def evict_other_tts_engines(keep_id: str) -> list[str]:
"""Unload every resident TTS engine except ``keep_id`` and return their ids.
Spans both stores a TTS model can live in: the VoiceStudio core singleton
(``model_manager.model``, freed under its async lock when we're switching
*away* from it) and the generic engine instance cache. A no-op when the
policy is off or nothing else is resident, so steady-state single-engine use
pays nothing — only an actual switch evicts. Never raises."""
if not single_engine_resident():
return []
evicted: list[str] = []
# The VoiceStudio core singleton — only when the incoming engine isn't it.
if keep_id != "omnivoice":
try:
import services.model_manager as mm
async with mm._model_lock:
if mm.unload_shared_model():
evicted.append("omnivoice")
except Exception: # noqa: BLE001
logger.warning("evict: VoiceStudio core unload failed", exc_info=True)
# Every other in-process / sidecar engine instance.
keep_cls = None
try:
from services.tts_backend import get_backend_class
keep_cls = get_backend_class(keep_id)
except Exception: # noqa: BLE001 — unknown id → evict all cached instances
keep_cls = None
evicted.extend(_evict_instance_cache(keep_cls))
if evicted:
logger.info("single-engine eviction: freed %s (keeping %s)", log_safe(evicted), log_safe(keep_id))
return evicted