docs.rs failed to build candelabra-0.1.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build:
candelabra-0.1.3
candelabra
candelabra is a small Rust crate for desktop applications that want to run
quantized LLaMA-compatible GGUF models with
candle-core,
candle-transformers, and
hf-hub.
It focuses on the pieces GUI apps usually need:
- Hugging Face downloads that respect the local
hf-hubcache - tokenizer loading helpers
- automatic Metal or CUDA fallback to CPU
- reusable loaded model state
- token streaming with cancellation support
Current Scope
candelabra currently supports quantized LLaMA-family GGUF checkpoints.
That means the crate is a good fit if you want a lightweight Rust API for local
desktop inference on models such as SmolLM GGUF variants that load through
Candle's quantized_llama path.
It is not yet a generic wrapper over every candle-transformers backend.
Installation
Add the crate to your Cargo.toml:
[]
= "0.1"
Quick Start
use ;
use ;
Main API
download_model()downloads a model file through the local Hugging Face cache.download_model_with_progress()anddownload_model_with_channel()emit progress updates suitable for UI progress bars.load_tokenizer_from_repo()downloads and loadstokenizer.json.LlamaModel::load()loads a quantized GGUF model onto the best available device.run_inference()streams generated tokens through a callback.run_inference_with_channel()streams generated tokens over a Tokio channel.
Platform Notes
- On macOS, the crate prefers Metal and falls back to CPU.
- On non-macOS platforms, the crate prefers CUDA and falls back to CPU.
- The public
device_usedstring is intended to be easy to surface directly in desktop UIs.
License
Licensed under either of these, at your option:
- Apache License, Version 2.0
- MIT license