trustformers 0.1.1

TrustformeRS - Rust port of Hugging Face Transformers
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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
//! Memory utilities for conversation management.
//!
//! This module provides comprehensive memory management utilities including
//! importance calculation, memory type classification, relevance scoring,
//! decay algorithms, and memory organization and retrieval.

use chrono::Utc;
use std::collections::HashSet;

use super::super::types::{
    ConversationMemory, ConversationState, ConversationTurn, EngagementLevel, MemoryType,
};

/// Memory utilities for conversation management
pub struct MemoryUtils;

impl MemoryUtils {
    /// Calculate memory importance based on content
    pub fn calculate_importance(turn: &ConversationTurn) -> f32 {
        let mut importance = 0.5; // Base importance

        // Increase importance for questions
        if turn.content.contains('?') {
            importance += 0.2;
        }

        // Increase for personal information
        if ["i am", "my name", "i like", "i prefer", "i work", "i live"]
            .iter()
            .any(|&pattern| turn.content.to_lowercase().contains(pattern))
        {
            importance += 0.3;
        }

        // Increase for goals and preferences
        if ["want", "need", "goal", "prefer", "like", "dislike", "plan"]
            .iter()
            .any(|&pattern| turn.content.to_lowercase().contains(pattern))
        {
            importance += 0.2;
        }

        // Increase for emotional content
        if ["feel", "emotion", "happy", "sad", "excited", "worried"]
            .iter()
            .any(|&pattern| turn.content.to_lowercase().contains(pattern))
        {
            importance += 0.15;
        }

        // Adjust based on metadata if available
        if let Some(metadata) = &turn.metadata {
            importance += metadata.confidence * 0.1;
            match metadata.engagement_level {
                EngagementLevel::High | EngagementLevel::VeryHigh => importance += 0.2,
                EngagementLevel::Medium => importance += 0.1,
                _ => {},
            }
        }

        // Adjust based on content length (very short or very long content might be less important)
        let length = turn.content.len();
        if length < 10 {
            importance -= 0.1;
        } else if length > 500 {
            importance += 0.1;
        }

        importance.clamp(0.0, 1.0)
    }

    /// Classify memory type based on content
    pub fn classify_memory_type(turn: &ConversationTurn) -> MemoryType {
        let content = turn.content.to_lowercase();

        if ["prefer", "like", "dislike", "favorite", "hate", "love"]
            .iter()
            .any(|&pattern| content.contains(pattern))
        {
            MemoryType::Preference
        } else if ["goal", "want", "plan", "will", "hope", "aim", "intend"]
            .iter()
            .any(|&pattern| content.contains(pattern))
        {
            MemoryType::Goal
        } else if [
            "friend",
            "family",
            "colleague",
            "know",
            "relationship",
            "partner",
        ]
        .iter()
        .any(|&pattern| content.contains(pattern))
        {
            MemoryType::Relationship
        } else if [
            "happened",
            "did",
            "went",
            "experience",
            "remember",
            "recall",
        ]
        .iter()
        .any(|&pattern| content.contains(pattern))
        {
            MemoryType::Experience
        } else {
            MemoryType::Fact
        }
    }

    /// Extract tags from conversation turn
    pub fn extract_tags(turn: &ConversationTurn) -> Vec<String> {
        let mut tags = Vec::new();

        // Add metadata-based tags
        if let Some(metadata) = &turn.metadata {
            tags.extend(metadata.topics.clone());
            if let Some(sentiment) = &metadata.sentiment {
                tags.push(format!("sentiment:{}", sentiment));
            }
            if let Some(intent) = &metadata.intent {
                tags.push(format!("intent:{}", intent));
            }
        }

        // Extract keyword-based tags
        let keyword_tags = [
            "work",
            "family",
            "hobby",
            "food",
            "travel",
            "technology",
            "health",
            "education",
            "entertainment",
            "sports",
            "music",
            "books",
            "movies",
        ];

        let content_lower = turn.content.to_lowercase();
        for keyword in keyword_tags {
            if content_lower.contains(keyword) {
                tags.push(keyword.to_string());
            }
        }

        // Add role-based tag
        tags.push(format!("role:{:?}", turn.role).to_lowercase());

        tags
    }

    /// Calculate memory relevance to a query
    pub fn calculate_memory_relevance(memory: &ConversationMemory, query: &str) -> f32 {
        let query_lower = query.to_lowercase();
        let query_words: Vec<&str> = query_lower.split_whitespace().collect();
        let memory_lower = memory.content.to_lowercase();
        let memory_words: Vec<&str> = memory_lower.split_whitespace().collect();

        // Calculate word overlap
        let overlap = query_words.iter().filter(|word| memory_words.contains(word)).count();

        let word_relevance = overlap as f32 / query_words.len().max(1) as f32;

        // Check tag relevance
        let tag_relevance = memory.tags.iter().any(|tag| query_lower.contains(&tag.to_lowercase()))
            as i32 as f32
            * 0.3;

        // Calculate time decay factor
        let time_decay = {
            let hours_since_access = (Utc::now() - memory.last_accessed).num_hours() as f32;
            let days_since_access = hours_since_access / 24.0;
            // Exponential decay over 30 days
            (-days_since_access / 30.0).exp()
        };

        // Combine factors
        let base_relevance = (word_relevance * 0.6 + tag_relevance * 0.4).min(1.0);
        let importance_factor = memory.importance;
        let access_factor = (memory.access_count as f32).ln().max(1.0) / 10.0;

        (base_relevance * importance_factor + access_factor * 0.1 + time_decay * 0.2).min(1.0)
    }

    /// Decay memory importance over time
    pub fn apply_decay(memory: &mut ConversationMemory, decay_rate: f32) {
        let hours_since_access = (Utc::now() - memory.last_accessed).num_hours() as f32;
        let time_factor = hours_since_access / (24.0 * 7.0); // Weekly decay
        memory.importance *= decay_rate.powf(time_factor);
        memory.importance = memory.importance.max(0.0);
    }

    /// Get relevant memories for current context (enhanced algorithm)
    pub fn get_relevant_memories_for_context<'a>(
        state: &'a ConversationState,
        query: &str,
        limit: usize,
    ) -> Vec<&'a ConversationMemory> {
        let mut scored_memories: Vec<_> = state
            .memories
            .iter()
            .map(|memory| {
                let relevance = Self::calculate_memory_relevance_enhanced(memory, query);
                (memory, relevance)
            })
            .collect();

        scored_memories.sort_by(|a, b| b.1.partial_cmp(&a.1).unwrap_or(std::cmp::Ordering::Equal));
        scored_memories.into_iter().take(limit).map(|(memory, _)| memory).collect()
    }

    /// Enhanced memory relevance calculation with multiple factors
    pub fn calculate_memory_relevance_enhanced(memory: &ConversationMemory, query: &str) -> f32 {
        let query_lower = query.to_lowercase();
        let query_words: Vec<&str> = query_lower.split_whitespace().collect();
        let memory_lower = memory.content.to_lowercase();
        let memory_words: Vec<&str> = memory_lower.split_whitespace().collect();

        // Word overlap calculation
        let overlap = query_words.iter().filter(|word| memory_words.contains(word)).count();

        let word_relevance = overlap as f32 / query_words.len().max(1) as f32;

        // Enhanced tag relevance
        let tag_relevance = memory
            .tags
            .iter()
            .map(|tag| {
                if query_lower.contains(&tag.to_lowercase()) {
                    0.5
                } else if tag.contains(':') {
                    // Handle structured tags like "sentiment:positive"
                    let tag_parts: Vec<&str> = tag.split(':').collect();
                    if tag_parts.len() == 2 && query_lower.contains(tag_parts[1]) {
                        0.3
                    } else {
                        0.0
                    }
                } else {
                    0.0
                }
            })
            .sum::<f32>();

        // Semantic similarity (simple implementation)
        let semantic_similarity = Self::calculate_semantic_similarity(&memory_lower, &query_lower);

        // Time decay factor with improved calculation
        let time_decay = {
            let hours_since_access = (Utc::now() - memory.last_accessed).num_hours() as f32;
            let days_since_access = hours_since_access / 24.0;
            // Sigmoid decay function for more gradual decline
            1.0 / (1.0 + (days_since_access / 14.0).exp())
        };

        // Access frequency boost
        let access_boost = (memory.access_count as f32).ln().max(1.0) / 20.0;

        // Memory type relevance
        let type_relevance = match memory.memory_type {
            MemoryType::Preference | MemoryType::Goal => 0.2,
            MemoryType::Experience => 0.15,
            MemoryType::Relationship => 0.1,
            MemoryType::Fact => 0.05,
        };

        // Combine all factors with weights
        let base_relevance =
            word_relevance * 0.4 + tag_relevance * 0.2 + semantic_similarity * 0.2 + type_relevance;

        let final_relevance =
            base_relevance * memory.importance + access_boost * 0.1 + time_decay * 0.3;

        final_relevance.min(1.0)
    }

    /// Simple semantic similarity calculation
    fn calculate_semantic_similarity(text1: &str, text2: &str) -> f32 {
        let words1: HashSet<&str> = text1.split_whitespace().collect();
        let words2: HashSet<&str> = text2.split_whitespace().collect();

        let intersection = words1.intersection(&words2).count();
        let union = words1.union(&words2).count();

        if union == 0 {
            0.0
        } else {
            intersection as f32 / union as f32
        }
    }

    /// Batch memory decay for performance
    pub fn batch_decay_memories(memories: &mut [ConversationMemory], decay_rate: f32) {
        let now = Utc::now();
        for memory in memories.iter_mut() {
            let hours_since_access = (now - memory.last_accessed).num_hours() as f32;
            let time_factor = hours_since_access / (24.0 * 7.0);
            memory.importance *= decay_rate.powf(time_factor);
            memory.importance = memory.importance.max(0.0);
        }
    }

    /// Prune low-importance memories
    pub fn prune_memories(memories: &mut Vec<ConversationMemory>, min_importance: f32) {
        memories.retain(|memory| memory.importance >= min_importance);
    }

    /// Sort memories by combined importance and relevance
    pub fn sort_memories_by_priority(memories: &mut [ConversationMemory]) {
        memories.sort_by(|a, b| {
            let priority_a = a.importance + (a.access_count as f32 * 0.01);
            let priority_b = b.importance + (b.access_count as f32 * 0.01);
            priority_b.partial_cmp(&priority_a).unwrap_or(std::cmp::Ordering::Equal)
        });
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use chrono::Utc;

    fn make_turn(content: &str) -> ConversationTurn {
        ConversationTurn {
            role: ConversationRole::User,
            content: content.to_string(),
            timestamp: Utc::now(),
            metadata: None,
            token_count: content.len() / 4 + 1,
        }
    }

    fn make_memory(content: &str, importance: f32) -> ConversationMemory {
        ConversationMemory {
            id: uuid::Uuid::new_v4().to_string(),
            content: content.to_string(),
            importance,
            last_accessed: Utc::now(),
            access_count: 1,
            memory_type: MemoryType::Fact,
            tags: Vec::new(),
        }
    }

    #[test]
    fn test_calculate_importance_base() {
        let turn = make_turn("hello world");
        let importance = MemoryUtils::calculate_importance(&turn);
        // base 0.5, no modifiers for this short but not too short content
        assert!(importance >= 0.0);
        assert!(importance <= 1.0);
    }

    #[test]
    fn test_calculate_importance_with_question() {
        let turn = make_turn("What is your name?");
        let importance = MemoryUtils::calculate_importance(&turn);
        // base 0.5 + question 0.2
        assert!(importance >= 0.6);
    }

    #[test]
    fn test_calculate_importance_personal_info() {
        let turn = make_turn("My name is Alice and I like programming");
        let importance = MemoryUtils::calculate_importance(&turn);
        // personal info and preference keywords boost importance
        assert!(importance >= 0.8);
    }

    #[test]
    fn test_calculate_importance_clamped_to_one() {
        let turn = make_turn("I am Alice. I like hiking. I want to be a programmer. I feel happy! What do you think?");
        let importance = MemoryUtils::calculate_importance(&turn);
        assert!(importance <= 1.0);
        assert!(importance >= 0.0);
    }

    #[test]
    fn test_calculate_importance_very_short_content() {
        let turn = make_turn("Hi");
        let importance = MemoryUtils::calculate_importance(&turn);
        // short content gets penalty
        assert!(importance <= 0.5);
    }

    #[test]
    fn test_classify_memory_type_preference() {
        let turn = make_turn("I prefer coffee over tea");
        let mem_type = MemoryUtils::classify_memory_type(&turn);
        assert_eq!(mem_type, MemoryType::Preference);
    }

    #[test]
    fn test_classify_memory_type_goal() {
        let turn = make_turn("I want to learn Rust programming");
        let mem_type = MemoryUtils::classify_memory_type(&turn);
        assert_eq!(mem_type, MemoryType::Goal);
    }

    #[test]
    fn test_classify_memory_type_relationship() {
        let turn = make_turn("My friend Alice is a doctor");
        let mem_type = MemoryUtils::classify_memory_type(&turn);
        assert_eq!(mem_type, MemoryType::Relationship);
    }

    #[test]
    fn test_classify_memory_type_experience() {
        let turn = make_turn("I remember when I went to Tokyo last year");
        let mem_type = MemoryUtils::classify_memory_type(&turn);
        assert_eq!(mem_type, MemoryType::Experience);
    }

    #[test]
    fn test_classify_memory_type_fact() {
        let turn = make_turn("The capital of France is Paris");
        let mem_type = MemoryUtils::classify_memory_type(&turn);
        assert_eq!(mem_type, MemoryType::Fact);
    }

    #[test]
    fn test_extract_tags_keyword() {
        let turn = make_turn("I work in technology and love music");
        let tags = MemoryUtils::extract_tags(&turn);
        assert!(tags.contains(&"work".to_string()));
        assert!(tags.contains(&"technology".to_string()));
        assert!(tags.contains(&"music".to_string()));
    }

    #[test]
    fn test_extract_tags_role() {
        let turn = make_turn("hello");
        let tags = MemoryUtils::extract_tags(&turn);
        let has_role_tag = tags.iter().any(|t| t.starts_with("role:"));
        assert!(has_role_tag);
    }

    #[test]
    fn test_calculate_memory_relevance_exact_match() {
        let mut memory = make_memory("I like programming in Rust", 0.8);
        memory.tags = vec!["technology".to_string()];
        let relevance = MemoryUtils::calculate_memory_relevance(&memory, "programming in Rust");
        assert!(relevance > 0.0);
    }

    #[test]
    fn test_calculate_memory_relevance_no_match() {
        let memory = make_memory("I enjoy hiking in the mountains", 0.5);
        let relevance = MemoryUtils::calculate_memory_relevance(&memory, "quantum physics");
        // Very low overlap
        assert!(relevance < 0.5);
    }

    #[test]
    fn test_prune_memories() {
        let mut memories = vec![
            make_memory("important", 0.9),
            make_memory("medium", 0.5),
            make_memory("low importance", 0.1),
        ];
        MemoryUtils::prune_memories(&mut memories, 0.4);
        assert_eq!(memories.len(), 2);
        assert!(memories.iter().all(|m| m.importance >= 0.4));
    }

    #[test]
    fn test_sort_memories_by_priority() {
        let mut memories = vec![
            make_memory("low", 0.2),
            make_memory("high", 0.9),
            make_memory("medium", 0.5),
        ];
        MemoryUtils::sort_memories_by_priority(&mut memories);
        assert!(memories[0].importance >= memories[1].importance);
        assert!(memories[1].importance >= memories[2].importance);
    }

    #[test]
    fn test_batch_decay_memories() {
        let mut memories = vec![make_memory("test memory", 1.0)];
        MemoryUtils::batch_decay_memories(&mut memories, 0.9);
        // Decay should keep importance non-negative
        assert!(memories[0].importance >= 0.0);
        assert!(memories[0].importance <= 1.0);
    }

    #[test]
    fn test_get_relevant_memories_for_context_empty() {
        let state = ConversationState::new("test".to_string());
        let memories = MemoryUtils::get_relevant_memories_for_context(&state, "some query", 5);
        assert!(memories.is_empty());
    }

    #[test]
    fn test_calculate_memory_relevance_enhanced_matching() {
        let mut memory = make_memory("Rust programming language is fast", 0.8);
        memory.tags = vec!["technology".to_string()];
        let relevance =
            MemoryUtils::calculate_memory_relevance_enhanced(&memory, "Rust programming");
        assert!(relevance > 0.0);
        assert!(relevance <= 1.0);
    }

    #[test]
    fn test_calculate_memory_relevance_enhanced_goal_type() {
        let mut memory = make_memory("Learn machine learning", 0.7);
        memory.memory_type = MemoryType::Goal;
        let relevance =
            MemoryUtils::calculate_memory_relevance_enhanced(&memory, "machine learning");
        assert!(relevance > 0.0);
    }

    #[test]
    fn test_prune_memories_keeps_all_above_threshold() {
        let mut memories = vec![
            make_memory("a", 0.8),
            make_memory("b", 0.7),
            make_memory("c", 0.6),
        ];
        MemoryUtils::prune_memories(&mut memories, 0.5);
        assert_eq!(memories.len(), 3);
    }

    #[test]
    fn test_prune_memories_removes_all_below_threshold() {
        let mut memories = vec![make_memory("a", 0.1), make_memory("b", 0.2)];
        MemoryUtils::prune_memories(&mut memories, 0.5);
        assert!(memories.is_empty());
    }

    use super::super::super::types::ConversationRole;
    use super::super::super::types::ConversationState;
}