Skip to main content

Vieneu() Factory

The main entry point for creating a VieNeu-TTS instance.

Signature

Vieneu(mode="standard", **kwargs)

Parameters

ParameterTypeDefaultDescription
modestr"standard"Backend mode: "standard", "fast", "remote", "xpu"

Standard Mode kwargs

ParameterTypeDefaultDescription
backbone_repostr"pnnbao-ump/VieNeu-TTS-0.3B-q4-gguf"HuggingFace repo or local path
backbone_devicestr"cpu""cpu", "cuda", "mps"
codec_repostr"neuphonic/distill-neucodec"Codec model repo
codec_devicestr"cpu"Device for codec
hf_tokenstrNoneHuggingFace token for private models

Remote Mode kwargs

ParameterTypeDefaultDescription
api_basestrrequiredServer URL (e.g., "http://host:23333/v1")
model_namestrrequiredModel ID on the server

Returns

An instance of BaseVieneuTTS (subclass depends on mode).

Examples

# Default: GGUF Q4 on CPU
tts = Vieneu()

# PyTorch on GPU
tts = Vieneu(backbone_repo="pnnbao-ump/VieNeu-TTS-0.3B", backbone_device="cuda")

# LMDeploy fast mode
tts = Vieneu(mode="fast", backbone_repo="pnnbao-ump/VieNeu-TTS")

# Remote client
tts = Vieneu(mode="remote", api_base="http://server:23333/v1", model_name="pnnbao-ump/VieNeu-TTS")