encoderfile 0.6.2

Distribute and run transformer encoders with a single file.
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
138
139
140
141
142
143

use std::{
    borrow::Cow,
    fs::File,
    io::{BufWriter, Seek, Write},
    path::PathBuf,
};

use crate::{
    builder::{
        base_binary::{BaseBinaryResolver, TargetSpec},
        config::BuildConfig,
        model::ModelTypeExt as _,
        terminal,
    },
    format::{
        assets::{AssetKind, AssetPlan, AssetSource, PlannedAsset},
        codec::EncoderfileCodec,
    },
    generated::manifest::Backend,
};
use anyhow::{Context, Result};
use serde::{Deserialize, Serialize};

#[derive(Debug, Serialize, Deserialize)]
#[serde(transparent)]
pub struct EncoderfileBuilder {
    pub config: BuildConfig,
}

impl EncoderfileBuilder {
    pub fn new(config: BuildConfig) -> EncoderfileBuilder {
        Self { config }
    }

    pub fn from_file(file_path: &PathBuf) -> Result<EncoderfileBuilder> {
        BuildConfig::load(file_path).map(|config| EncoderfileBuilder { config })
    }

    pub fn build(&self, runtime_version: &Option<String>, no_download: bool) -> Result<()> {
        let target = self
            .config
            .encoderfile
            .target()?
            .unwrap_or(TargetSpec::detect_host()?);

        // load base binary
        let base_path = {
            let cache_dir = self.config.encoderfile.cache_dir();
            let base_binary_path = self.config.encoderfile.base_binary_path.as_deref();

            let resolver = BaseBinaryResolver {
                cache_dir: cache_dir.as_path(),
                base_binary_path,
                target,
                runtime_version: runtime_version.clone(),
            };

            resolver.resolve(no_download)?
        };

        let mut planned_assets: Vec<PlannedAsset<'_>> = Vec::new();

        // validate model config
        let model_config = self.config.encoderfile.model_config()?;

        planned_assets.push(PlannedAsset::from_asset_source(
            AssetSource::InMemory(Cow::Owned(serde_json::to_vec(&model_config)?)),
            AssetKind::ModelConfig,
        )?);
        terminal::success("Model config validated");

        // validate model
        let model_weights_path = self.config.encoderfile.path.model_weights_path()?;

        let model_asset = self
            .config
            .encoderfile
            .model_type
            .validate_model(&model_weights_path)?;

        planned_assets.push(model_asset);
        terminal::success("Model weights validated");

        // validate transform
        if let Some(asset) =
            crate::builder::transforms::validate_transform(&self.config.encoderfile, &model_config)?
        {
            planned_assets.push(asset);
            terminal::success("Transform validated");
        }

        // validate tokenizer
        let tokenizer_asset =
            crate::builder::tokenizer::validate_tokenizer(&self.config.encoderfile)?;
        planned_assets.push(tokenizer_asset);
        terminal::success("Tokenizer validated");

        // initialize final binary
        terminal::info("Writing encoderfile...");
        let output_path = self.config.encoderfile.output_path();
        let out = File::create(output_path.clone()).context(format!(
            "Failed to create final encoderfile at {:?}",
            output_path.as_path()
        ))?;

        let mut out = BufWriter::new(out);
        let mut base = File::open(base_path.as_path()).context(format!(
            "Failed to open base binary at {:?}",
            base_path.as_path()
        ))?;

        // copy base binary to out
        std::io::copy(&mut base, &mut out).context(format!(
            "Failed to copy base binary to {:?}",
            output_path.as_path()
        ))?;

        // get metadata start position
        let payload_start = out.stream_position()?;

        // create codec
        let codec = EncoderfileCodec::new(payload_start);

        // create asset plan
        let asset_plan = AssetPlan::new(planned_assets)?;

        // write to file
        codec.write(
            self.config.encoderfile.name.clone(),
            self.config.encoderfile.version.clone(),
            self.config.encoderfile.model_type.clone(),
            Backend::Cpu,
            &asset_plan,
            &mut out,
        )?;

        out.flush()?;

        terminal::success_kv("Encoderfile written to", output_path.display());

        Ok(())
    }
}