multiscreen-rs 0.2.1

A Rust implementation of the Multiscreen neural language model — training and inference powered by Burn.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

use crate::error::{Error, Result};
use burn::{
    backend::Autodiff,
    tensor::backend::{Backend, BackendTypes},
};
use std::env;

// ---------------------------------------------------------------------------
// Backend selection (feature-gated)
// ---------------------------------------------------------------------------

/// Default CPU backend (Flex) — used when the `cuda` feature is not enabled.
#[cfg(not(feature = "cuda"))]
pub type DefaultBackend = burn::backend::Flex;

/// Default CUDA backend — used when the `cuda` feature is enabled.
#[cfg(feature = "cuda")]
pub type DefaultBackend = burn::backend::Cuda;

/// Default training backend. Burn's `Autodiff` decorator adds backpropagation.
pub type DefaultAutodiffBackend = Autodiff<DefaultBackend>;

/// Device type for the active backend.
pub type Device = <DefaultAutodiffBackend as BackendTypes>::Device;

/// Chooses the default device based on the active backend.
///
/// With `cuda` feature: returns the default CUDA device (GPU 0).
/// Without `cuda` feature: returns the default Flex (CPU) device.
///
/// Also reads `MULTISCREEN_DEVICE` env var for manual override.
pub fn default_device() -> Result<Device> {
    let requested = env::var("MULTISCREEN_DEVICE").unwrap_or_else(|_| "auto".to_string());
    match requested.trim().to_ascii_lowercase().as_str() {
        "" | "auto" => Ok(Device::default()),
        "cpu" | "flex" => {
            #[cfg(feature = "cuda")]
            {
                Err(Error::Config(
                    "MULTISCREEN_DEVICE=cpu is not supported when compiled with the cuda feature. \
                     Recompile without --features cuda for CPU training."
                        .to_string(),
                ))
            }
            #[cfg(not(feature = "cuda"))]
            {
                Ok(Device::default())
            }
        }
        other => Err(Error::Config(format!(
            "unsupported MULTISCREEN_DEVICE={other:?}; use auto"
        ))),
    }
}

/// Human-readable label for the active backend device.
pub fn device_label(device: &Device) -> String {
    <DefaultAutodiffBackend as Backend>::name(device)
}

// ---------------------------------------------------------------------------
// CUDA-specific types (always available for documentation)
// ---------------------------------------------------------------------------

/// Autodiff-wrapped CUDA backend for training on GPU.
#[cfg(feature = "cuda")]
pub type CudaAutodiffBackend = Autodiff<burn::backend::Cuda>;

/// Device type for the CUDA backend.
#[cfg(feature = "cuda")]
pub type CudaDevice = <CudaAutodiffBackend as BackendTypes>::Device;

/// Convenience alias for a Multiscreen model backed by CUDA.
#[cfg(feature = "cuda")]
pub type CudaMultiscreenModel = crate::model::MultiscreenModel<CudaAutodiffBackend>;