rlx-orpheus 0.2.9

Orpheus TTS — Llama-3B speech LM + SNAC decoder for RLX
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

// RLX — versatile ML compiler + runtime.
// Copyright (C) 2026 Eugene Hauptmann, Nataliya Kosmyna.

//! SNAC 24 kHz RVQ decoder for Orpheus speech tokens.
//!
//! - **Eager** ([`SnacDecoder`]): host safetensors + ndarray (default).
//! - **CoreML** ([`SnacBackend`] with [`SnacLoadOptions::coreml`]): quantizer on CPU,
//!   conv decoder compiled to [`Device::Ane`] via `rlx-ir` (feature `coreml`).
//!
//! Weights: [`decoder_weights_path`] (`ORPHEUS_SNAC_PATH`).

mod backend;
mod config;
mod eager;
mod ops;

#[cfg(feature = "coreml")]
mod compiled;

pub use backend::{SnacBackend, SnacLoadOptions};
pub use config::SnacConfig;
pub use eager::{SAMPLE_RATE, SAMPLES_PER_FRAME, SnacDecoder};

use std::path::PathBuf;

use anyhow::{Result, bail};

/// Resolve SNAC decoder weights from `ORPHEUS_SNAC_PATH`.
pub fn decoder_weights_path() -> Result<PathBuf> {
    let path = std::env::var("ORPHEUS_SNAC_PATH")
        .ok()
        .filter(|p| !p.is_empty())
        .map(PathBuf::from)
        .ok_or_else(|| {
            anyhow::anyhow!(
                "ORPHEUS_SNAC_PATH is not set (SNAC weights are not bundled in rlx-orpheus)"
            )
        })?;
    if !path.exists() {
        bail!("ORPHEUS_SNAC_PATH does not exist: {}", path.display());
    }
    Ok(path)
}

/// Like [`decoder_weights_path`], but returns `None` when unset or missing (for tests).
pub fn decoder_weights_path_if_available() -> Option<PathBuf> {
    let path = std::env::var("ORPHEUS_SNAC_PATH")
        .ok()
        .filter(|p| !p.is_empty())
        .map(PathBuf::from)?;
    if path.exists() { Some(path) } else { None }
}