mirror of
https://github.com/huggingface/candle.git
synced 2025-06-19 03:54:56 +00:00
ded93a1169
* Add the nn::optim and some conversion traits. * Add the backward_step function for SGD. * Get the SGD optimizer to work and add a test. * Make the test slighly simpler.
82 lines
2.2 KiB
Rust
82 lines
2.2 KiB
Rust
//! ML framework for Rust
|
|
//!
|
|
//! ```rust
|
|
//! use candle::{Tensor, DType, Device};
|
|
//! # use candle::Error;
|
|
//! # fn main() -> Result<(), Error>{
|
|
//!
|
|
//! let a = Tensor::arange(0f32, 6f32, &Device::Cpu)?.reshape((2, 3))?;
|
|
//! let b = Tensor::arange(0f32, 12f32, &Device::Cpu)?.reshape((3, 4))?;
|
|
//!
|
|
//! let c = a.matmul(&b)?;
|
|
//! # Ok(())}
|
|
//! ```
|
|
//!
|
|
//! ## Features
|
|
//!
|
|
//! - Simple syntax (looks and like PyTorch)
|
|
//! - CPU and Cuda backends (and M1 support)
|
|
//! - Enable serverless (CPU) small and fast deployments
|
|
//! - Model training
|
|
//! - Distributed computing (NCCL).
|
|
//! - Models out of the box (Llama, Whisper, Falcon, ...)
|
|
//!
|
|
//! ## FAQ
|
|
//!
|
|
//! - Why Candle?
|
|
//!
|
|
//! Candle stems from the need to reduce binary size in order to *enable serverless*
|
|
//! possible by making the whole engine smaller than PyTorch very large library volume
|
|
//!
|
|
//! And simply *removing Python* from production workloads.
|
|
//! Python can really add overhead in more complex workflows and the [GIL](https://www.backblaze.com/blog/the-python-gil-past-present-and-future/) is a notorious source of headaches.
|
|
//!
|
|
//! Rust is cool, and a lot of the HF ecosystem already has Rust crates [safetensors](https://github.com/huggingface/safetensors) and [tokenizers](https://github.com/huggingface/tokenizers)
|
|
|
|
mod backend;
|
|
mod backprop;
|
|
mod conv;
|
|
mod convert;
|
|
mod cpu_backend;
|
|
#[cfg(feature = "cuda")]
|
|
mod cuda_backend;
|
|
mod device;
|
|
pub mod display;
|
|
mod dtype;
|
|
mod dummy_cuda_backend;
|
|
mod error;
|
|
mod indexer;
|
|
mod layout;
|
|
#[cfg(feature = "mkl")]
|
|
mod mkl;
|
|
pub mod npy;
|
|
mod op;
|
|
pub mod safetensors;
|
|
mod shape;
|
|
mod storage;
|
|
mod strided_index;
|
|
mod tensor;
|
|
pub mod utils;
|
|
mod variable;
|
|
|
|
pub use cpu_backend::CpuStorage;
|
|
pub use device::{Device, DeviceLocation};
|
|
pub use dtype::{DType, WithDType};
|
|
pub use error::{Error, Result};
|
|
pub use indexer::IndexOp;
|
|
pub use layout::Layout;
|
|
pub use shape::{Shape, D};
|
|
pub use storage::Storage;
|
|
use strided_index::StridedIndex;
|
|
pub use tensor::{Tensor, TensorId};
|
|
pub use variable::Var;
|
|
|
|
#[cfg(feature = "cuda")]
|
|
pub use cuda_backend::{CudaDevice, CudaStorage};
|
|
|
|
#[cfg(not(feature = "cuda"))]
|
|
pub use dummy_cuda_backend::{CudaDevice, CudaStorage};
|
|
|
|
#[cfg(feature = "mkl")]
|
|
extern crate intel_mkl_src;
|