trustformers-core 0.1.1

Core traits and utilities for TrustformeRS
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
//! # TrustformeRS Core
//!
//! Core traits, types, and utilities for the TrustformeRS transformer library.
//!
//! This crate provides the foundational building blocks for implementing transformer models
//! in pure Rust with zero-cost abstractions. It includes:
//!
//! - **Tensor operations**: High-performance tensor abstractions with GPU acceleration
//! - **Neural network layers**: Attention mechanisms, feed-forward networks, normalization
//! - **Model traits**: Unified interfaces for models, tokenizers, and configurations
//! - **Device management**: CPU, CUDA, Metal, and other hardware backend support
//! - **Quantization**: INT4/INT8/FP16 quantization for efficient inference
//! - **Memory management**: Caching, checkpointing, and memory-efficient operations
//! - **Hardware acceleration**: SIMD, BLAS, GPU kernels, and compiler optimizations
//!
//! ## Quick Start
//!
//! ```rust,no_run
//! use trustformers_core::{
//!     tensor::Tensor,
//!     layers::Linear,
//!     traits::Layer,
//! };
//!
//! // Create a tensor on CPU
//! let input = Tensor::randn(&[32, 512])?;
//!
//! // Create a linear layer
//! let linear = Linear::new(512, 768, true);
//! let output = linear.forward(input)?;
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! ## Architecture
//!
//! TrustformeRS Core follows a dual-layer architecture:
//! - High-level ML abstractions (tensors, layers, models)
//! - Low-level scientific computing via SciRS2 (SIMD, parallel ops, BLAS)
//!
//! All external dependencies (PyTorch, ONNX Runtime, tokenizers) are abstracted
//! through unified interfaces to maintain flexibility and testability.
//!
//! ## Features
//!
//! - `cuda`: NVIDIA GPU support via CUDA
//! - `metal`: Apple GPU support via Metal
//! - `opencl`: OpenCL GPU support
//! - `mkl`: Intel MKL BLAS backend
//! - `quantization`: Model quantization support
//! - `distributed`: Distributed training utilities
//!
//! ## Safety and Performance
//!
//! - **Memory-safe**: Pure Rust with no unsafe code in critical paths
//! - **Zero-cost abstractions**: Performance comparable to C++ implementations
//! - **GPU-accelerated**: Automatic dispatch to GPU when available
//! - **SIMD-optimized**: Vectorized operations for CPU performance

#![allow(clippy::excessive_nesting)] // Algorithm-heavy code often requires deep nesting
#![allow(clippy::result_large_err)] // Large error enums are intentional for rich error context
#![allow(clippy::excessive_precision)] // High-precision floats needed for ML computations
#![allow(clippy::module_name_repetitions)] // Module names often repeat for clarity
#![allow(clippy::similar_names)] // Similar variable names are common in mathematical code
#![allow(clippy::too_many_arguments)] // ML functions often require many parameters
#![allow(clippy::too_many_lines)] // Complex algorithms require longer functions

pub mod ab_testing;
pub mod adaptive_computation;
pub mod autodiff;
pub mod blas;
pub mod cache;
pub mod checkpoint;
pub mod compiler;
pub mod compression;
pub mod device;
pub mod error;
pub mod errors;
pub mod evaluation;
pub mod export;
pub mod generation;
pub mod gpu;
// Temporarily disabled when CUDA feature is enabled - needs cudarc 0.17.7 API migration
#[cfg(not(feature = "cuda"))]
pub mod gpu_accelerated;
pub mod gpu_ops;
pub mod hardware;
// Temporarily disabled when CUDA feature is enabled - needs cudarc 0.17.7 API migration
#[cfg(test)]
mod error_tests;
pub mod grad_checkpoint;
#[cfg(not(feature = "cuda"))]
pub mod hardware_acceleration;
pub mod kernel_fusion;
pub mod kernel_tuning;
pub mod kernels;
pub mod layers;
pub mod leaderboard;
pub mod memory;
pub mod monitoring;
pub mod neuromorphic;
pub mod numa_optimization;
pub mod ops;
pub mod optical;
pub mod parallel;
pub mod patterns;
pub mod peft;
pub mod performance;
pub mod plugins;
pub mod quantization;
pub mod quantum;
pub mod sparse_ops;
pub mod sparse_tensor;
pub mod tensor;
pub mod tensor_debugger;
pub mod testing;
#[cfg(test)]
pub mod tests;
pub mod tokenizer_backend;
pub mod traits;
#[cfg(test)]
mod traits_tests;
pub mod utils;
pub mod versioning;
pub mod visualization;

pub use ab_testing::{
    ABTestManager, ABTestSummary, ConfidenceLevel, DeploymentStrategy, Experiment,
    ExperimentConfig, ExperimentStatus, HealthCheck, HealthCheckType, MetricCollector,
    MetricSummary, MetricType, MetricValue, Recommendation, RollbackCondition, RolloutController,
    RolloutStatus, RoutingStrategy, StatisticalAnalyzer, TestRecommendation, TestResult,
    TrafficSplitter, UserSegment, Variant,
};
pub use adaptive_computation::{
    AdaptiveComputationConfig, AdaptiveComputationManager, AdaptiveComputationStrategy,
    ComplexityEstimationMethod, ComplexityEstimator, ComputationBudget, ComputationPath,
    ConfidenceBasedStrategy, DynamicDepthStrategy, EntropyBasedComplexityEstimator, LayerMetrics,
    LayerSkipPattern, PerformanceTracker, ResourceAllocation, UncertaintyBasedStrategy,
};
pub use blas::{
    blas_optimizer, init_blas, optimized_dot, optimized_gemm, optimized_gemv, BlasBackend,
    BlasConfig, BlasOperation, BlasOptimizer,
};
pub use cache::{
    CacheConfig, CacheEntry, CacheKey, CacheKeyBuilder, CacheMetrics, EvictionPolicy,
    InferenceCache, LRUEviction, SizeBasedEviction, TTLEviction,
};
pub use checkpoint::{
    convert_checkpoint, detect_format, load_checkpoint, save_checkpoint, CheckpointConverter,
    CheckpointFormat, ConversionConfig, ConversionResult, JaxCheckpoint, LayerMapping,
    PyTorchCheckpoint, TensorFlowCheckpoint, TrustformersCheckpoint, WeightMapping,
    WeightMappingRule,
};
pub use compiler::{
    CompilationResult, CompilerConfig, CompilerOptimizer, ComputationGraph, DeviceType, GraphEdge,
    GraphNode, HardwareTarget, OptimizationLevel, OptimizationRecommendation,
    OptimizationRecommendations, OptimizationResult, PassResult, RecommendationCategory,
    RecommendationPriority,
};
pub use compression::{
    // Convenience functions
    create_compression_pipeline,
    AccuracyRetention,
    AttentionDistiller,
    ChannelPruner,
    CompressionConfig as CompressionPipelineConfig,
    CompressionEvaluator,
    // Metrics exports
    CompressionMetrics,
    // Pipeline exports
    CompressionPipeline,
    CompressionRatio,
    CompressionReport,
    CompressionResult,
    CompressionStage,
    CompressionTargets,
    // Distillation exports
    DistillationConfig,
    DistillationLoss,
    DistillationResult,
    DistillationStrategy,
    FeatureDistiller,
    FilterPruner,
    GradualPruner,
    HeadPruner,
    HiddenStateDistiller,
    InferenceSpeedup,
    KnowledgeDistiller,
    LayerDistiller,
    LayerPruner,
    MagnitudePruner,
    ModelSizeReduction,
    PipelineBuilder,
    PruningConfig,
    PruningResult,
    PruningSchedule,
    PruningStats,
    // Pruning exports
    PruningStrategy,
    ResponseDistiller,
    SparsityMetric,
    StructuredPruner,
    StudentModel,
    TeacherModel,
    UnstructuredPruner,
};
pub use device::Device;
pub use errors::{Result, TrustformersError};
pub use evaluation::{
    Accuracy, DatasetLoader, DatasetManager, DatasetSample, EvaluationConfig, EvaluationDataset,
    EvaluationHarness, EvaluationResult, EvaluationSuite, Evaluator, ExactMatch, F1Average,
    F1Score, FileDatasetLoader, GLUEEvaluator, GLUETask, MemoryDatasetLoader, Metric,
    MetricCollection, OtherBenchmark, Perplexity, SuperGLUEEvaluator, SuperGLUETask, BLEU,
};
pub use export::{
    CoreMLExporter, ExportConfig, ExportFormat, ExportPrecision, ExportQuantization, GGMLExporter,
    GGUFExporter, ModelExporter, ONNXExporter, TensorRTExporter, UniversalExporter,
};
pub use generation::{
    FinishReason,
    GenerationConfig,
    GenerationStrategy,
    GenerationStream,
    // KVCache, // Now exported from cache module
    // SpeculativeDecoder, TextGenerator,  // Temporarily disabled due to missing modules
};
#[cfg(not(feature = "cuda"))]
pub use gpu_accelerated::{GpuAcceleratedOps, GpuOpsConfig, GpuPrecision};
pub use hardware::{
    AsicBackend, AsicDevice, AsicOperationSet, DataType, HardwareBackend, HardwareCapabilities,
    HardwareConfig, HardwareDevice, HardwareManager, HardwareMetrics, HardwareOperation,
    HardwareRegistry, HardwareResult, HardwareType, OperationMode, PrecisionMode,
};
pub use kernel_fusion::{
    ComputationGraph as FusionComputationGraph, DataType as FusionDataType, Device as FusionDevice,
    FusedKernel, FusionConstraint, FusionOpportunity, FusionPattern, FusionStatistics,
    GraphNode as FusionGraphNode, KernelFusionEngine, KernelImplementation, MemoryLayout,
    NodeMetadata, OperationType, TensorInfo,
};
pub use kernel_tuning::{
    get_kernel_tuner, Backend as TuningBackend, KernelParams, KernelTuner,
    Operation as TuningOperation, PlatformInfo, TuningConfig, TuningStatistics,
};
pub use kernels::fused_ops::ActivationType;
pub use kernels::{
    FusedAttentionDropout, FusedBiasActivation, FusedGELU, FusedLinear, FusedMatmulScale,
    OptimizedRoPE, RoPEConfig, RoPEScalingType, SIMDLayerNorm, SIMDSoftmax, VectorizedRoPE,
};
// Import hardware traits separately
pub use hardware::traits::{
    AsyncHardwareOperation, AsyncOperationHandle, AsyncOperationStatus, DeviceMemory, DeviceStatus,
    HardwareScheduler, MemoryType, MemoryUsage as HardwareMemoryUsage, OperationParameter,
    OperationRequirements, PerformanceRequirements, SchedulerStatistics,
};
// Import ASIC types from asic submodule
pub use autodiff::{
    AnalysisResult,
    AutodiffEngine,
    ComputationGraph as AutodiffComputationGraph,
    DebuggerConfig,
    GradientFlowStats,
    GradientMode,
    GradientTape,
    // Debugger exports
    GraphDebugger,
    GraphIssue,
    GraphNode as AutodiffGraphNode,
    GraphOutputFormat,
    IssueSeverity,
    IssueType,
    MemoryStats,
    NodeDebugInfo,
    NodeId,
    OperationType as AutodiffOperationType,
    TapeEntry,
    TraversalInfo,
    Variable,
    VariableRef,
};
pub use hardware::asic::{
    AsicDeviceConfig, AsicDriver, AsicDriverFactory, AsicMemoryConfig, AsicPerformanceMonitor,
    AsicSpec, AsicType, AsicVendor, CacheConfig as AsicCacheConfig,
};
#[cfg(not(feature = "cuda"))]
pub use hardware_acceleration::{
    api as hardware_acceleration_api, AccelerationBackend, AccelerationConfig, AccelerationStats,
    HardwareAccelerator,
};
pub use leaderboard::{
    LeaderboardCategory, LeaderboardClient, LeaderboardEntry, LeaderboardFilter,
    LeaderboardManager, LeaderboardQuery, LeaderboardRanking, LeaderboardStats, LeaderboardStorage,
    LeaderboardSubmission, RankingCriteria, SubmissionValidator,
};
pub use memory::{
    get_memory_manager, get_tensor, init_memory_manager, return_tensor, AdaptiveStrategy,
    MemoryConfig, MemoryEvictionPolicy, MemoryMappedTensor, MemoryPoolStats, TensorMemoryPool,
    TensorView,
};
pub use monitoring::{
    AttentionPattern, AttentionPatternType, AttentionReport, AttentionVisualizer,
    AttentionVisualizerConfig, Counter, Gauge, Histogram, MemoryReport, MemorySnapshot,
    MemoryTracker, MemoryTrackerConfig, MemoryUsage, MetricsCollector, MetricsCollectorConfig,
    MetricsSummary, ModelMonitor, ModelProfiler, MonitoringConfig, MonitoringReport,
    MonitoringSession, OptimizationSuggestion, OptimizationType, ProfilerConfig, ProfilingReport,
};
pub use numa_optimization::{
    get_numa_allocator, init_numa_allocator, numa_alloc, numa_free, AllocationStats,
    HotspotSeverity, NumaAllocation, NumaAllocator, NumaNode, NumaPerformanceMonitor, NumaPolicy,
    NumaStrategy, NumaTopology, NumaTrafficAnalysis, ThreadAffinity, ThreadPriority,
    TrafficHotspot,
};
pub use parallel::{
    init_parallelism,
    parallel_chunk_map,
    parallel_context,
    parallel_execute,
    parallel_map,
    ActivationType as ParallelActivationType,
    AsyncTensorParallel,
    // Parallel layers exports
    ColumnParallelLinear,
    CommunicationBackend,
    Communicator,
    DeviceMesh,
    DistributedTensor,
    InitMethod,
    MemoryPolicy,
    MicrobatchManager,
    // Model parallel exports
    ModelParallelConfig,
    ModelParallelContext,
    ModelParallelStrategy,
    NumaConfig,
    ParallelContext,
    ParallelMLP,
    ParallelMultiHeadAttention,
    ParallelOps,
    ParallelismStrategy,
    PipelineExecutor,
    // Pipeline parallel exports
    PipelineLayer,
    PipelineModel,
    PipelineOp,
    PipelineOptimizer,
    PipelineSchedule,
    PipelineScheduleType,
    PipelineStage,
    RowParallelLinear,
    TensorParallelInit,
    // Tensor parallel exports
    TensorParallelOps,
    TensorParallelShapes,
    TensorPartition,
};
pub use patterns::{
    Buildable, Builder, BuilderError, BuilderResult, ConfigBuilder, ConfigBuilderImpl,
    ConfigManager, ConfigMetadata, ConfigSerializable, CpuLimits, EnvironmentConfig, GpuLimits,
    LoggingConfig, MemoryLimits, PatternError, PatternResult, PerformanceConfig, ResourceConfig,
    SecurityConfig, StandardBuilder, StandardConfig, UnifiedConfig, ValidatedBuilder,
};
pub use peft::{
    AdapterLayer, LoRALayer, PeftConfig, PeftMethod, PeftModel, PrefixTuningLayer,
    PromptTuningEmbedding, QLoRALayer,
};
pub use performance::{
    BenchmarkBuilder, BenchmarkCategory, BenchmarkConfig, BenchmarkDSL, BenchmarkMetadata,
    BenchmarkRegistry, BenchmarkReport, BenchmarkResult, BenchmarkRunner, BenchmarkRunnerBuilder,
    BenchmarkSpec, BenchmarkSuite, ComparisonResult, ContinuousBenchmark,
    ContinuousBenchmarkConfig, CustomBenchmark, Framework, HuggingFaceBenchmark, LatencyMetrics,
    MemoryMetrics, MemoryProfiler, MemorySnapshot as PerformanceMemorySnapshot,
    MemoryTracker as PerformanceMemoryTracker, MetricsTracker, ModelComparison,
    PerformanceProfiler, PerformanceRegression, ProfileResult, PytorchBenchmark, ReportFormat,
    Reporter, RunConfig, RunMode, ThroughputMetrics,
};
pub use plugins::{
    Dependency, GpuRequirements, Plugin, PluginContext, PluginEvent, PluginEventHandler,
    PluginInfo, PluginLoader, PluginManager, PluginRegistry, SystemRequirements,
};
pub use quantization::{
    dequantize_bitsandbytes,
    estimate_quantization_error,
    from_bitsandbytes_format,
    quantize_4bit,
    quantize_dynamic_tree,
    quantize_int8,
    select_fp8_format,
    to_bitsandbytes_format,
    AWQQuantizer,
    ActivationLayerQuantConfig,
    // Activation quantization
    ActivationQuantConfig,
    ActivationQuantScheme,
    ActivationQuantizer,
    ActivationStats,
    // Mixed-bit quantization
    AutoBitAllocationStrategy,
    // BitsAndBytes compatibility
    BitsAndBytesConfig,
    // GGUF K-quant formats
    BlockQ2K,
    BlockQ3K,
    BlockQ4K,
    BnBComputeType,
    BnBConfig,
    BnBQuantType,
    BnBQuantizer,
    BnBStorageType,
    // FP8 quantization
    DelayedScalingConfig,
    FP8Config,
    FP8Format,
    FP8Quantizer,
    FP8Tensor,
    FakeQuantize,
    GPTQQuantizer,
    KQuantConfig,
    KQuantTensor,
    KQuantType,
    KQuantizer,
    LayerQuantConfig,
    MixedBitConfig,
    MixedBitQuantizedTensor,
    MixedBitQuantizer,
    Observer,
    QATConfig,
    QuantState,
    QuantizationConfig,
    QuantizationScheme,
    QuantizedActivation,
    QuantizedBlock,
    QuantizedTensor,
    Quantizer,
    ScaleFactors,
    ScalingStrategy,
    SensitivityConfig,
    SensitivityMetric,
};
pub use sparse_ops::{
    conversion, pruning, sparse_attention, sparse_matmul, BlockSparsity, NMSparsity,
    StructuredSparsityPattern,
};
pub use sparse_tensor::{SparseFormat, SparseIndices, SparseTensor};
pub use tensor::{
    DType, EvalContext, ExprNode, OpType, OptimizationHints, Tensor, TensorExpr, TensorType,
};
pub use tensor_debugger::{
    DebugTensorStats, OperationTrace, Severity, TensorDebugIssue, TensorDebugger,
    TensorDebuggerConfig, TensorIssueType, WatchCondition, Watchpoint,
};
pub use tokenizer_backend::{Encoding, Tokenizer, TokenizerError};
pub use traits::{Config, Layer, Model};
pub use versioning::{
    ActiveDeployment,
    // Storage types
    Artifact,
    ArtifactType,
    DateRange,
    DeploymentConfig,
    DeploymentEvent,
    DeploymentEventType,
    // Deployment types
    DeploymentManager,
    DeploymentStatistics,
    DeploymentStatus,
    DeploymentStrategy as VersioningDeploymentStrategy,
    Environment,
    FileSystemStorage,
    HealthStatus,
    InMemoryStorage,
    LifecycleEvent,
    LifecyclePolicies,
    LifecycleStatistics,
    // Metadata types
    ModelMetadata,
    ModelRegistry,
    ModelRoutingResult,
    ModelSource,
    ModelStorage,
    ModelTag,
    // Core versioning types
    ModelVersionManager,
    PromotionResult,
    RegistryStatistics,
    SortBy,
    SortOrder,
    TagMatchMode,
    VersionExperimentConfig,
    VersionExperimentResult,
    VersionFilter,
    VersionLifecycle,
    VersionMetricType,
    // Registry types
    VersionQuery,
    VersionStats,
    // Lifecycle types
    VersionStatus,
    VersionTransition,
    // Integration types
    VersionedABTestManager,
    VersionedExperiment,
    VersionedExperimentStatus,
    VersionedModel,
};
pub use visualization::{
    ColorScheme, OutputFormat, TensorHeatmap, TensorHistogram, TensorSliceView, TensorStats,
    TensorVisualizer, VisualizationConfig,
};