Lib.rs

Cargo Features

[dependencies]
burn = { version = "0.17.0", default-features = false, features = ["std", "network", "doc", "train", "tui", "metrics", "dataset", "sqlite", "sqlite-bundled", "record-item-custom-serde", "experimental-named-tensor", "audio", "vision", "autodiff", "fusion", "accelerate", "autotune", "blas-netlib", "openblas", "openblas-system", "remote", "router", "server", "simd", "template", "candle", "candle-cuda", "candle-metal", "cuda", "rocm", "ndarray", "tch", "vulkan", "webgpu", "metal", "wgpu", "compilation-cache"] }

default doc? = std

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

Enables optional burn-autodiff and optional burn-candle

burn-autodiff:

Backends

and burn-core, optional burn-cuda, optional burn-ndarray, optional burn-rocm, optional burn-router, optional burn-tch, optional burn-train, and optional burn-wgpu

burn-core:

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

std default

Enables std of optional burn-autodiff, optional burn-candle, burn-core, optional burn-cuda, optional burn-ndarray, optional burn-rocm, optional burn-router, and optional burn-wgpu

network

Enables network of burn-core

doc = default, train

Enables doc of burn-candle, burn-core, burn-cuda, burn-ndarray, burn-rocm, burn-router, burn-tch, burn-train, and burn-wgpu, std of optional burn-autodiff

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 sys-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

record-item-custom-serde

Custom deserializer for Record that is helpful for importing data, such as PyTorch pt files.

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

experimental-named-tensor

Serialization formats

Enables experimental-named-tensor of burn-core

audio

Enables audio of burn-core

vision

Enables vision of burn-core

autodiff train? = burn-autodiff

Backend

fusion

Enables fusion of optional burn-cuda and optional burn-wgpu

accelerate

Backend features

Enables accelerate of optional burn-candle, blas-accelerate of optional burn-ndarray

autotune

Enables autotune of optional burn-cuda, optional burn-rocm, and optional burn-wgpu

blas-netlib

Enables blas-netlib of optional burn-ndarray

openblas

Enables blas-openblas of optional burn-ndarray

openblas-system

Enables blas-openblas-system of optional burn-ndarray

remote

Enables client of burn-remote

router = burn-router

server

Enables server of burn-remote

simd

Enables simd of optional burn-ndarray

template

Enables template of optional burn-wgpu

candle candle-cuda? = burn-candle

candle-cuda = candle

Enables cuda of burn-candle

candle-metal

Enables metal of optional burn-candle

cuda = burn-cuda

rocm = burn-rocm

ndarray = burn-ndarray

tch = burn-tch

vulkan = wgpu

Enables vulkan of burn-wgpu

burn-wgpu:

Backends

webgpu = wgpu

Enables webgpu of burn-wgpu

metal = wgpu

Enables metal of burn-wgpu

wgpu metal? vulkan? webgpu? = burn-wgpu

compilation-cache

Enables compilation-cache of optional burn-cuda and optional burn-rocm

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?

burn-autodiff autodiff?

burn-candle candle? candle-cuda? doc?

burn-cuda cuda? doc?

burn-rocm doc? rocm?

burn-ndarray doc? ndarray?

burn-remote remote? server?

burn-router doc? router?

burn-tch doc? tch?

burn-wgpu doc? metal? vulkan? webgpu? wgpu?