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
//! Benchmark builder for creating complex benchmarks

use super::{BenchmarkConfig, BenchmarkIteration, BenchmarkMetrics, CustomBenchmark};
use anyhow::Result;
use parking_lot::Mutex;
use std::sync::Arc;

/// Builder for creating custom benchmarks
pub struct BenchmarkBuilder {
    name: String,
    description: String,
    stages: Vec<BenchmarkStage>,
    config: BenchmarkConfig,
    tags: Vec<String>,
}

/// A stage in a multi-stage benchmark
pub struct BenchmarkStage {
    pub name: String,
    pub setup: Option<Box<dyn Fn() -> Result<()> + Send + Sync>>,
    pub run: Box<dyn Fn() -> Result<BenchmarkIteration> + Send + Sync>,
    pub teardown: Option<Box<dyn Fn() -> Result<()> + Send + Sync>>,
    pub weight: f64,
}

/// Specification for a benchmark
#[derive(Clone)]
pub struct BenchmarkSpec {
    pub name: String,
    pub description: String,
    pub tags: Vec<String>,
    pub config: BenchmarkConfig,
}

impl BenchmarkBuilder {
    /// Create a new benchmark builder
    pub fn new(name: impl Into<String>) -> Self {
        Self {
            name: name.into(),
            description: String::new(),
            stages: Vec::new(),
            config: BenchmarkConfig::default(),
            tags: Vec::new(),
        }
    }

    /// Set description
    pub fn description(mut self, desc: impl Into<String>) -> Self {
        self.description = desc.into();
        self
    }

    /// Add tags
    pub fn tags(mut self, tags: Vec<String>) -> Self {
        self.tags = tags;
        self
    }

    /// Set configuration
    pub fn config(mut self, config: BenchmarkConfig) -> Self {
        self.config = config;
        self
    }

    /// Add a simple stage
    pub fn add_stage<F>(mut self, name: impl Into<String>, run: F) -> Self
    where
        F: Fn() -> Result<BenchmarkIteration> + Send + Sync + 'static,
    {
        self.stages.push(BenchmarkStage {
            name: name.into(),
            setup: None,
            run: Box::new(run),
            teardown: None,
            weight: 1.0,
        });
        self
    }

    /// Add a stage with setup and teardown
    pub fn add_stage_with_lifecycle<S, R, T>(
        mut self,
        name: impl Into<String>,
        setup: S,
        run: R,
        teardown: T,
    ) -> Self
    where
        S: Fn() -> Result<()> + Send + Sync + 'static,
        R: Fn() -> Result<BenchmarkIteration> + Send + Sync + 'static,
        T: Fn() -> Result<()> + Send + Sync + 'static,
    {
        self.stages.push(BenchmarkStage {
            name: name.into(),
            setup: Some(Box::new(setup)),
            run: Box::new(run),
            teardown: Some(Box::new(teardown)),
            weight: 1.0,
        });
        self
    }

    /// Add a weighted stage
    pub fn add_weighted_stage<F>(mut self, name: impl Into<String>, weight: f64, run: F) -> Self
    where
        F: Fn() -> Result<BenchmarkIteration> + Send + Sync + 'static,
    {
        self.stages.push(BenchmarkStage {
            name: name.into(),
            setup: None,
            run: Box::new(run),
            teardown: None,
            weight,
        });
        self
    }

    /// Build the benchmark
    pub fn build(self) -> Result<BuiltBenchmark> {
        if self.stages.is_empty() {
            anyhow::bail!("Benchmark must have at least one stage");
        }

        Ok(BuiltBenchmark {
            name: self.name,
            description: self.description,
            stages: Arc::new(self.stages),
            config: self.config,
            tags: self.tags,
            current_stage: Arc::new(Mutex::new(0)),
        })
    }
}

/// A built custom benchmark
pub struct BuiltBenchmark {
    name: String,
    description: String,
    stages: Arc<Vec<BenchmarkStage>>,
    config: BenchmarkConfig,
    tags: Vec<String>,
    current_stage: Arc<Mutex<usize>>,
}

impl CustomBenchmark for BuiltBenchmark {
    fn name(&self) -> &str {
        &self.name
    }

    fn description(&self) -> &str {
        &self.description
    }

    fn tags(&self) -> Vec<String> {
        self.tags.clone()
    }

    fn setup(&mut self) -> Result<()> {
        // Run setup for all stages
        for stage in self.stages.iter() {
            if let Some(setup) = &stage.setup {
                setup()?;
            }
        }
        Ok(())
    }

    fn run_iteration(&mut self) -> Result<BenchmarkIteration> {
        use scirs2_core::random::*;
        let mut rng = thread_rng();
        let total_weight: f64 = self.stages.iter().map(|s| s.weight).sum();
        let random_value: f64 = rng.random_range(0.0..total_weight);

        let mut cumulative_weight = 0.0;
        for (i, stage) in self.stages.iter().enumerate() {
            cumulative_weight += stage.weight;
            if random_value <= cumulative_weight {
                *self.current_stage.lock() = i;
                return (stage.run)();
            }
        }

        // Fallback to first stage
        (self.stages[0].run)()
    }

    fn teardown(&mut self) -> Result<()> {
        // Run teardown for all stages
        for stage in self.stages.iter() {
            if let Some(teardown) = &stage.teardown {
                teardown()?;
            }
        }
        Ok(())
    }

    fn config(&self) -> BenchmarkConfig {
        self.config.clone()
    }
}

/// Fluent API for building benchmarks
pub struct BenchmarkDSL;

impl BenchmarkDSL {
    /// Start building a latency benchmark
    pub fn latency_benchmark(name: impl Into<String>) -> LatencyBenchmarkBuilder {
        LatencyBenchmarkBuilder::new(name)
    }

    /// Start building a throughput benchmark
    pub fn throughput_benchmark(name: impl Into<String>) -> ThroughputBenchmarkBuilder {
        ThroughputBenchmarkBuilder::new(name)
    }

    /// Start building a memory benchmark
    pub fn memory_benchmark(name: impl Into<String>) -> MemoryBenchmarkBuilder {
        MemoryBenchmarkBuilder::new(name)
    }
}

/// Builder for latency benchmarks
pub struct LatencyBenchmarkBuilder {
    builder: BenchmarkBuilder,
    percentiles: Vec<f64>,
}

impl LatencyBenchmarkBuilder {
    pub fn new(name: impl Into<String>) -> Self {
        Self {
            builder: BenchmarkBuilder::new(name),
            percentiles: vec![0.5, 0.9, 0.95, 0.99, 0.999],
        }
    }

    pub fn percentiles(mut self, percentiles: Vec<f64>) -> Self {
        self.percentiles = percentiles;
        self
    }

    pub fn measure<F>(self, name: impl Into<String>, f: F) -> Self
    where
        F: Fn() -> Result<std::time::Duration> + Send + Sync + 'static,
    {
        let stage_name = name.into();
        let builder = self.builder.add_stage(stage_name, move || {
            let duration = f()?;

            let mut metrics = BenchmarkMetrics::default();
            metrics.custom.insert("latency_ms".to_string(), duration.as_secs_f64() * 1000.0);

            Ok(BenchmarkIteration {
                duration,
                metrics,
                validation_passed: None,
                metadata: None,
            })
        });

        Self {
            builder,
            percentiles: self.percentiles,
        }
    }

    pub fn build(self) -> Result<BuiltBenchmark> {
        self.builder.tags(vec!["latency".to_string()]).build()
    }
}

/// Builder for throughput benchmarks
pub struct ThroughputBenchmarkBuilder {
    builder: BenchmarkBuilder,
    batch_size: usize,
}

impl ThroughputBenchmarkBuilder {
    pub fn new(name: impl Into<String>) -> Self {
        Self {
            builder: BenchmarkBuilder::new(name),
            batch_size: 1,
        }
    }

    pub fn batch_size(mut self, size: usize) -> Self {
        self.batch_size = size;
        self
    }

    pub fn measure<F>(self, name: impl Into<String>, items: usize, f: F) -> Self
    where
        F: Fn() -> Result<std::time::Duration> + Send + Sync + 'static,
    {
        let stage_name = name.into();
        let builder = self.builder.add_stage(stage_name, move || {
            let duration = f()?;
            let throughput = items as f64 / duration.as_secs_f64();

            let metrics = BenchmarkMetrics {
                throughput: Some(throughput),
                ..Default::default()
            };

            Ok(BenchmarkIteration {
                duration,
                metrics,
                validation_passed: None,
                metadata: None,
            })
        });

        Self {
            builder,
            batch_size: self.batch_size,
        }
    }

    pub fn build(self) -> Result<BuiltBenchmark> {
        self.builder.tags(vec!["throughput".to_string()]).build()
    }
}

/// Builder for memory benchmarks
pub struct MemoryBenchmarkBuilder {
    builder: BenchmarkBuilder,
}

impl MemoryBenchmarkBuilder {
    pub fn new(name: impl Into<String>) -> Self {
        Self {
            builder: BenchmarkBuilder::new(name),
        }
    }

    pub fn measure<F>(self, name: impl Into<String>, f: F) -> Self
    where
        F: Fn() -> Result<(std::time::Duration, usize)> + Send + Sync + 'static,
    {
        let stage_name = name.into();
        let builder = self.builder.add_stage(stage_name, move || {
            let (duration, memory_bytes) = f()?;

            let metrics = BenchmarkMetrics {
                memory_bytes: Some(memory_bytes),
                ..Default::default()
            };

            Ok(BenchmarkIteration {
                duration,
                metrics,
                validation_passed: None,
                metadata: None,
            })
        });

        Self { builder }
    }

    pub fn build(self) -> Result<BuiltBenchmark> {
        self.builder.tags(vec!["memory".to_string()]).build()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::time::Duration;

    #[test]
    fn test_benchmark_builder() {
        let benchmark = BenchmarkBuilder::new("test_benchmark")
            .description("Test benchmark")
            .tags(vec!["test".to_string()])
            .add_stage("stage1", || {
                Ok(BenchmarkIteration {
                    duration: Duration::from_millis(10),
                    metrics: BenchmarkMetrics::default(),
                    validation_passed: Some(true),
                    metadata: None,
                })
            })
            .build()
            .expect("operation failed in test");

        assert_eq!(benchmark.name(), "test_benchmark");
        assert_eq!(benchmark.description(), "Test benchmark");
        assert_eq!(benchmark.tags(), vec!["test"]);
    }

    #[test]
    fn test_latency_benchmark_builder() {
        let benchmark = BenchmarkDSL::latency_benchmark("latency_test")
            .measure("operation", || Ok(Duration::from_millis(50)))
            .build()
            .expect("operation failed in test");

        assert!(benchmark.tags().contains(&"latency".to_string()));
    }

    #[test]
    fn test_throughput_benchmark_builder() {
        let benchmark = BenchmarkDSL::throughput_benchmark("throughput_test")
            .batch_size(32)
            .measure("process_batch", 32, || Ok(Duration::from_millis(100)))
            .build()
            .expect("operation failed in test");

        assert!(benchmark.tags().contains(&"throughput".to_string()));
    }
}