Lib.rs

Cargo Features

[dependencies]
burn = { version = "0.15.0", default-features = false, features = ["std", "doc", "train", "tui", "metrics", "dataset", "sqlite", "sqlite-bundled", "vision", "autodiff", "fusion", "accelerate", "autotune", "blas-netlib", "candle-cuda", "metal", "openblas", "openblas-system", "template", "candle", "cuda-jit", "hip-jit", "ndarray", "tch", "wgpu", "wgpu-spirv", "network", "experimental-named-tensor", "record-backward-compat", "record-item-custom-serde"] }

default doc? = std

These default features are set whenever burn is added without default-features = false somewhere in the dependency tree.

Enables burn-core and optional burn-train

burn-core:

** Please make sure all dependencies support no_std when std is disabled **

std default

Enables std of burn-core

doc = default, train

Enables doc of burn-core and burn-train

train doc? = autodiff, burn-train, dataset

Training with full features

Affects burn::train…

tui

Includes the Text UI (progress bars, metric plots)

Enables tui of optional burn-train

metrics

Includes system info metrics (CPU/GPU usage, etc)

Enables metrics of optional burn-train

dataset train?

Datasets

Enables dataset of burn-core

sqlite

Enables sqlite of burn-core

sqlite-bundled

Enables sqlite-bundled of burn-core

vision

Enables vision of burn-core

autodiff train?

Backends

Enables autodiff of burn-core

fusion

Enables fusion of burn-core

accelerate

Backend features

Enables accelerate of burn-core

autotune

Enables autotune of burn-core

blas-netlib

Enables blas-netlib of burn-core

candle-cuda

Enables candle-cuda of burn-core

metal

Enables metal of burn-core

openblas

Enables openblas of burn-core

openblas-system

Enables openblas-system of burn-core

template

Enables template of burn-core

candle

Enables candle of burn-core

cuda-jit

Enables cuda-jit of burn-core

hip-jit

Enables hip-jit of burn-core

ndarray

Enables ndarray of burn-core

tch

Enables tch of burn-core

wgpu

Enables wgpu of burn-core

wgpu-spirv

Enables wgpu-spirv of burn-core

network

Network utils

Enables network of burn-core

experimental-named-tensor

Experimental

Enables experimental-named-tensor of burn-core

record-backward-compat

Records

Enables record-backward-compat of burn-core

record-item-custom-serde

Enables record-item-custom-serde of burn-core

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

burn-train doc? train?