Fix single file binary builder to only run when env var is set (#3126)

Author: ivarflakstad

candle-examples/Cargo.toml

@@ -41,7 +41,7 @@ tokenizers = { workspace = true, features = ["onig"] }
 cpal = { version = "0.15.2", optional = true }
 pdf2image = { version = "0.1.2", optional = true }
 tekken-rs = { version = "0.1.1", optional = true }
-bert-single-file-binary-builder = { path = "bert_single_file_binary_builder", optional = true }
+single-file-binary-builder = { path = "single-file-binary-builder", optional = true }
 
 [dev-dependencies]
 anyhow = { workspace = true }
@@ -92,7 +92,7 @@ mimi = ["cpal", "symphonia", "rubato"]
 snac = ["cpal", "symphonia", "rubato"]
 depth_anything_v2 = ["palette", "enterpolation"]
 tekken = ["tekken-rs"]
-bert-single-file-binary-builder = ["dep:bert-single-file-binary-builder"]
+single-file-binary-builder = ["dep:single-file-binary-builder"]
 
 [[example]]
 name = "llama_multiprocess"
@@ -160,4 +160,4 @@ required-features = ["symphonia"]
 
 [[example]]
 name = "bert_single_file_binary"
-required-features = ["bert-single-file-binary-builder"]
+required-features = ["single-file-binary-builder"]

candle-examples/examples/bert_single_file_binary/README.md

@@ -2,19 +2,18 @@
 
 This is an adapted version of the Candle Bert example to inline (embed) the model files into the binary to create a single file binary.
 
-**Note: the bert-single-file-binary-builder feature is required `--features="bert-single-file-binary-builder"`.**
+**Note: the single-file-binary-builder feature is required `--features="single-file-binary-builder"`.**
 
 ### Limitations
 
-1. Because the model files must be available at compile time, a special build step is needed. See the [bert-single-file-binary-builder crate](../../bert_single_file_binary_builder/)
-2. The model id and revision is hardcoded
-3. Since the [`include_bytes!`](https://doc.rust-lang.org/std/macro.include_bytes.html) marco is project relative and requires the argument must be a string literal, it is easier to download the files into the examples dir than navigate the hub cache dir snapshots.
+1. Because the model files must be available at compile time, a special build step is needed. See the [single-file-binary-builder crate](../../single_file_binary_builder/)
+2. Since the [`include_bytes!`](https://doc.rust-lang.org/std/macro.include_bytes.html) marco is project relative and requires the argument must be a string literal, it is easier to download the files into the examples dir than navigate the hub cache dir snapshots.
 
 ## Running the example
 
 ```bash
 cd path/to/candle/candle-examples
-cargo build --example bert_single_file_binary --release --features="bert-single-file-binary-builder"
+CANDLE_SINGLE_FILE_BINARY_BUILDER_URL="https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/c9745ed1d9f207416be6d2e6f8de32d1f16199bf" cargo build --example bert_single_file_binary --release --features="single-file-binary-builder"
 ../target/release/examples/bert_single_file_binary --prompt "Here is a test sentence"
 ```
 

candle-examples/examples/bert_single_file_binary/main.rs

@@ -39,6 +39,10 @@ struct Args {
     approximate_gelu: bool,
 }
 
+// Remember to set env variable before running.
+// Use specific commit vs main to reduce chance of URL breaking later from directory layout changes, etc.
+// CANDLE_SINGLE_FILE_BINARY_BUILDER_URL="https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/c9745ed1d9f207416be6d2e6f8de32d1f16199bf"
+// cargo run --example bert_single_file_binary
 fn main() -> Result<()> {
     use tracing_chrome::ChromeLayerBuilder;
     use tracing_subscriber::prelude::*;
@@ -171,13 +175,11 @@ fn main() -> Result<()> {
 }
 
 pub fn build_model_and_tokenizer_from_bytes(device: &Device) -> Result<(BertModel, Tokenizer)> {
-    let config_data = include_bytes!("../../bert_single_file_binary_builder/files/config.json");
+    let config_data = include_bytes!("../../single-file-binary-builder/files/config.json");
 
-    let tokenizer_data =
-        include_bytes!("../../bert_single_file_binary_builder/files/tokenizer.json");
+    let tokenizer_data = include_bytes!("../../single-file-binary-builder/files/tokenizer.json");
 
-    let weights_data =
-        include_bytes!("../../bert_single_file_binary_builder/files/model.safetensors");
+    let weights_data = include_bytes!("../../single-file-binary-builder/files/model.safetensors");
 
     let config_string = std::str::from_utf8(config_data)?;
     let config: BertConfig = serde_json::from_str(config_string)?;

candle-examples/bert_single_file_binary_builder/.gitignore renamed to candle-examples/single-file-binary-builder/.gitignore

@@ -1,5 +1,5 @@
 [package]
-name = "bert-single-file-binary-builder"
+name = "single-file-binary-builder"
 version.workspace = true
 edition.workspace = true
 description.workspace = true

candle-examples/bert_single_file_binary_builder/Cargo.toml renamed to candle-examples/single-file-binary-builder/Cargo.toml

@@ -1,10 +1,9 @@
-# candle_bert_single_file_binary_builder
+# candle_single_file_binary_builder
 
 This crate provides and isolates the necessary build steps to fetch the model files for the [`bert_single_file_binary` example](../examples/bert_single_file_binary/). See [https://github.com/huggingface/candle/pull/3104#issuecomment-3369276760](https://github.com/huggingface/candle/pull/3104#issuecomment-3369276760) for background.
 
 ### Limitations
 
 1. Because the model files must be available at compile time, a special build step is needed
-2. The model id and revision is hardcoded
-3. The model files are downloaded from directly Hugging Face at compile time for simplicity sake, not using the hf-hub library
+2. The model files are downloaded from directly Hugging Face at compile time for simplicity sake, not using the hf-hub library
    1. Since the file paths must be known at compile time it is easier to download the files into the example dir than navigate the hub cache dir snapshots.

candle-examples/bert_single_file_binary_builder/README.md renamed to candle-examples/single-file-binary-builder/README.md

@@ -7,10 +7,13 @@ use std::{
 use anyhow::{Context, Result};
 
 fn main() -> Result<()> {
-    println!("cargo:rerun-if-changed=build.rs");
+    let base_url = core::option_env!("CANDLE_SINGLE_FILE_BINARY_BUILDER_URL");
+    if base_url.is_none() {
+        return Ok(());
+    }
+    let base_url = base_url.unwrap();
 
-    // Use specific commit vs main to reduce chance of URL breaking later from directory layout changes, etc.
-    let base_url = "https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2/resolve/c9745ed1d9f207416be6d2e6f8de32d1f16199bf";
+    println!("cargo::rerun-if-changed=build.rs");
 
     let example_name = "bert-single-file-binary-builder";
     let dest_path = Path::new("files");
@@ -22,26 +25,26 @@ fn main() -> Result<()> {
 
     if all_files_exist {
         println!(
-            "cargo:warning=All {} files already exist, skipping download",
+            "cargo::warning=All {} files already exist, skipping download",
             example_name
         );
         return Ok(());
     }
 
-    println!("cargo:warning=Downloading {} files...", example_name);
+    println!("cargo::warning=Downloading {} files...", example_name);
 
     fs::create_dir_all(dest_path).context("Failed to create destination directory")?;
 
     for filename in &files {
         let dest_file = dest_path.join(filename);
 
         if dest_file.exists() {
-            println!("cargo:warning=File already exists, skipping: {}", filename);
+            println!("cargo::warning=File already exists, skipping: {}", filename);
             continue;
         }
 
         let url = format!("{}/{}", base_url, filename);
-        println!("cargo:warning=Downloading {} from {}...", filename, url);
+        println!("cargo::warning=Downloading {} from {}...", filename, url);
 
         let response = ureq::get(&url)
             .call()
@@ -63,13 +66,13 @@ fn main() -> Result<()> {
             copy(&mut reader, &mut file).context(format!("Failed to write {}", filename))?;
 
         println!(
-            "cargo:warning=Downloaded {} ({} bytes)",
+            "cargo::warning=Downloaded {} ({} bytes)",
             filename, bytes_written
         );
     }
 
     println!(
-        "cargo:warning=All {} files downloaded successfully",
+        "cargo::warning=All {} files downloaded successfully",
         example_name
     );