hf2q 0.1.10

Pure Rust CLI for converting HuggingFace models to hardware-optimized formats and serving them over an OpenAI-compatible API on Apple Silicon
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
138
139
140
141
142
143
144
145
146
147
148

//! Side-effect-free completion grammar and semantic candidates.
//!
//! Completion must stay a bounded parser-only path: no network, cache creation,
//! model loading, Metal initialization, or diagnostics are allowed here.

use std::ffi::OsStr;

use clap::CommandFactory as _;
use clap_complete::CompletionCandidate;

use super::Cli;

/// Build the public completion grammar. Clap's `hide = true` is a help policy,
/// not a reliable completion boundary: AOT generators traverse hidden nodes,
/// and the dynamic engine can retain a hidden-only prefix match. Recursively
/// omitting hidden nodes makes the boundary structural.
pub(crate) fn public_completion_command() -> clap::Command {
    project_public(&Cli::command())
}

fn project_public(source: &clap::Command) -> clap::Command {
    let mut out = clap::Command::new(source.get_name().to_owned())
        .display_order(source.get_display_order())
        .disable_help_flag(source.is_disable_help_flag_set())
        .disable_help_subcommand(source.is_disable_help_subcommand_set())
        .disable_version_flag(source.is_disable_version_flag_set());

    if let Some(value) = source.get_version() {
        out = out.version(value.to_owned());
    }
    if let Some(value) = source.get_long_version() {
        out = out.long_version(value.to_owned());
    }
    if let Some(value) = source.get_about() {
        out = out.about(value.clone());
    }
    if let Some(value) = source.get_long_about() {
        out = out.long_about(value.clone());
    }
    if let Some(value) = source.get_subcommand_help_heading() {
        out = out.subcommand_help_heading(value.to_owned());
    }
    if let Some(value) = source.get_subcommand_value_name() {
        out = out.subcommand_value_name(value.to_owned());
    }
    if let Some(value) = source.get_short_flag() {
        out = out.short_flag(value);
    }
    if let Some(value) = source.get_long_flag() {
        out = out.long_flag(value.to_owned());
    }

    out = out.visible_aliases(source.get_visible_aliases().map(str::to_owned));
    out = out.visible_short_flag_aliases(source.get_visible_short_flag_aliases());
    out = out.visible_long_flag_aliases(source.get_visible_long_flag_aliases().map(str::to_owned));
    out = out.args(
        source
            .get_arguments()
            .filter(|argument| !argument.is_hide_set())
            .cloned(),
    );
    out.subcommands(
        source
            .get_subcommands()
            .filter(|subcommand| !subcommand.is_hide_set())
            .map(project_public),
    )
}

pub(crate) fn quant_names(current: &OsStr) -> Vec<CompletionCandidate> {
    prefixed_candidates(
        current,
        crate::convert::quant_selector::QuantSelector::COMPLETION_NAMES
            .iter()
            .copied(),
    )
}

pub(crate) fn architecture_names(current: &OsStr) -> Vec<CompletionCandidate> {
    prefixed_candidates(
        current,
        crate::arch::ArchRegistry::global()
            .known_arches()
            .into_iter(),
    )
}

fn prefixed_candidates<'a>(
    current: &OsStr,
    values: impl IntoIterator<Item = &'a str>,
) -> Vec<CompletionCandidate> {
    let Some(prefix) = current.to_str() else {
        return Vec::new();
    };
    values
        .into_iter()
        .filter(|value| value.starts_with(prefix))
        .take(256)
        .map(CompletionCandidate::new)
        .collect()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn public_projection_excludes_every_hidden_surface() {
        let projected = public_completion_command();
        projected.clone().debug_assert();
        let rendered = format!("{projected:#?}");
        for hidden in [
            "__standalone-install",
            "__fetch-hub-gguf",
            "__catalog-hub-gguf",
            "__verify-local-gguf",
            "source-teacher",
            "source-teacher-reference",
            "source-teacher-acceptance-verify",
            "chat_parent_lifeline_fd",
        ] {
            assert!(
                !rendered.contains(hidden),
                "hidden surface leaked: {hidden}"
            );
        }
    }

    #[test]
    fn quant_candidates_are_exactly_parseable_shipped_names() {
        let values = quant_names(OsStr::new(""));
        assert_eq!(
            values.len(),
            crate::convert::quant_selector::QuantSelector::COMPLETION_NAMES.len()
        );
        for candidate in values {
            let value = candidate.get_value().to_str().expect("ASCII quant");
            crate::convert::quant_selector::QuantSelector::from_name(value)
                .unwrap_or_else(|error| panic!("completion advertised {value:?}: {error}"));
        }
        for reserved in ["dwq", "apex", "apex-custom", "tq1_0", "tq2_0"] {
            assert!(
                !crate::convert::quant_selector::QuantSelector::COMPLETION_NAMES
                    .contains(&reserved)
            );
        }
    }
}