Feature flags of burn-core crate // Lib.rs

Cargo Features

[dependencies]
burn-core = { version = "0.17.0", default-features = false, features = ["std", "dataset", "network", "sqlite", "sqlite-bundled", "vision", "audio", "doc", "record-item-custom-serde", "experimental-named-tensor", "test-cuda", "test-rocm", "test-tch", "test-wgpu", "test-wgpu-spirv", "burn-remote", "burn-router"] }

default = std

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

Enables burn-common, optional burn-dataset, and burn-tensor

burn-common:
** Please make sure all dependencies support no_std when std is disabled **

std default doc? = flate2, log, rmp-serde

Enables std of bincode, burn-common, burn-tensor, half, num-traits, rand, serde, and serde_json

rand:
Default enables std

Affects config::Config.save, config::Config.load, burn-core::data, burn-core::lr_scheduler, base::Module.save_file, base::Module.load_file, memory::NamedMpkBytesRecorder, recorder::DefaultRecorder, recorder::CompactRecorder, recorder::SensitiveCompactRecorder, recorder::NoStdTrainingRecorder, recorder::DebugRecordSettings…

dataset doc? = burn-dataset

Affects data::dataloader, data::dataset…

network

Enables network of burn-common

Affects data::network…

sqlite

Enables sqlite of optional burn-dataset

sqlite-bundled

Enables sqlite-bundled of optional burn-dataset

vision doc?

Enables network of burn-common, vision of optional burn-dataset

audio doc?

Enables audio of optional burn-dataset

doc = audio, dataset, std, vision

Enables doc of burn-common, burn-dataset, and burn-tensor

record-item-custom-serde = regex, thiserror

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

Affects record::serde…

experimental-named-tensor

Serialization formats

Enables experimental-named-tensor of burn-tensor

test-cuda

To use cuda during testing, default uses ndarray.

Enables burn-cuda

FOR TESTING

test-rocm

To use hip during testing, default uses ndarray.

Enables burn-rocm

test-tch

To use tch during testing, default uses ndarray.

Enables burn-tch

test-wgpu

To use wgpu during testing, default uses ndarray.

Enables burn-wgpu

test-wgpu-spirv

To use wgpu-spirv during testing, default uses ndarray.

Enables vulkan of burn-wgpu

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-dataset dataset? doc?

log std

flate2 std