llama-core 0.35.0

The core library of LlamaEdge
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

//! Define metadata for the piper model.

use super::BaseMetadata;
use serde::{Deserialize, Serialize};

/// Builder for creating a ggml metadata
#[derive(Debug)]
pub struct PiperMetadataBuilder {
    metadata: PiperMetadata,
}
impl PiperMetadataBuilder {
    pub fn new<S: Into<String>>(model_name: S, model_alias: S) -> Self {
        let metadata = PiperMetadata {
            model_name: model_name.into(),
            model_alias: model_alias.into(),
            ..Default::default()
        };

        Self { metadata }
    }

    pub fn enable_debug(mut self, enable: bool) -> Self {
        self.metadata.debug_log = enable;
        self
    }

    pub fn with_speed(mut self, speed: f64) -> Self {
        self.metadata.speed = speed;
        self
    }

    pub fn with_speaker_id(mut self, speaker_id: u32) -> Self {
        self.metadata.speaker_id = speaker_id;
        self
    }

    pub fn with_noise_scale(mut self, noise_scale: f64) -> Self {
        self.metadata.noise_scale = noise_scale;
        self
    }

    pub fn with_length_scale(mut self, length_scale: f64) -> Self {
        self.metadata.length_scale = length_scale;
        self
    }

    pub fn with_noise_w(mut self, noise_w: f64) -> Self {
        self.metadata.noise_w = noise_w;
        self
    }

    pub fn with_sentence_silence(mut self, sentence_silence: f64) -> Self {
        self.metadata.sentence_silence = sentence_silence;
        self
    }

    pub fn with_phoneme_silence(mut self, phoneme_silence: f64) -> Self {
        self.metadata.phoneme_silence = Some(phoneme_silence);
        self
    }

    pub fn enable_json_input(mut self, flag: bool) -> Self {
        self.metadata.json_input = Some(flag);
        self
    }

    pub fn build(self) -> PiperMetadata {
        self.metadata
    }
}

/// Metadata for chat and embeddings models
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct PiperMetadata {
    // this field not defined for the beckend plugin
    #[serde(skip_serializing)]
    pub model_name: String,
    // this field not defined for the beckend plugin
    #[serde(skip_serializing)]
    pub model_alias: String,

    // * Plugin parameters (used by this plugin):
    #[serde(rename = "enable-debug-log")]
    pub debug_log: bool,

    /// The speed of the generated audio. Select a value from `0.25` to `4.0`. Defaults to `1.0`.
    pub speed: f64,
    /// Id of speaker. Defaults to `0`.
    pub speaker_id: u32,
    /// Amount of noise to add during audio generation. Defaults to `0.667`.
    pub noise_scale: f64,
    /// Speed of speaking (1 = normal, < 1 is faster, > 1 is slower). Defaults to `1.0`.
    length_scale: f64,
    /// Variation in phoneme lengths. Defaults to `0.8`.
    pub noise_w: f64,
    /// Seconds of silence after each sentence. Defaults to `0.2`.
    pub sentence_silence: f64,
    /// Seconds of extra silence to insert after a single phoneme.
    #[serde(skip_serializing_if = "Option::is_none")]
    phoneme_silence: Option<f64>,
    /// stdin input is lines of JSON instead of plain text.
    /// The input format should be:
    /// ```json
    /// {
    ///    "text": "some text",     (required)
    ///    "speaker_id": 0,         (optional)
    ///    "speaker": "some name",  (optional)
    /// }
    #[serde(skip_serializing_if = "Option::is_none")]
    pub json_input: Option<bool>,
}
impl Default for PiperMetadata {
    fn default() -> Self {
        Self {
            model_name: String::new(),
            model_alias: String::new(),
            debug_log: false,
            speed: 1.0,
            speaker_id: 0,
            noise_scale: 0.667,
            length_scale: 1.0,
            noise_w: 0.8,
            sentence_silence: 0.2,
            phoneme_silence: None,
            json_input: None,
        }
    }
}
impl BaseMetadata for PiperMetadata {
    fn model_name(&self) -> &str {
        &self.model_name
    }

    fn model_alias(&self) -> &str {
        &self.model_alias
    }
}