quantrs2-ml 0.1.3

Quantum Machine Learning module for QuantRS2
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
//! Configuration types for quantum clustering

use crate::dimensionality_reduction::{QuantumDistanceMetric, QuantumEnhancementLevel};

/// Quantum clustering algorithms
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum ClusteringAlgorithm {
    /// Quantum K-Means
    QuantumKMeans,
    /// Quantum Hierarchical Clustering
    QuantumHierarchical,
    /// Quantum DBSCAN
    QuantumDBSCAN,
    /// Quantum Spectral Clustering
    QuantumSpectral,
    /// Quantum Fuzzy C-Means
    QuantumFuzzyCMeans,
    /// Quantum Gaussian Mixture Models
    QuantumGMM,
    /// Quantum Mean-Shift
    QuantumMeanShift,
    /// Quantum Affinity Propagation
    QuantumAffinityPropagation,
}

/// Quantum clustering configuration
#[derive(Debug, Clone)]
pub struct QuantumClusteringConfig {
    /// Algorithm to use
    pub algorithm: ClusteringAlgorithm,
    /// Number of clusters
    pub n_clusters: usize,
    /// Maximum iterations
    pub max_iterations: usize,
    /// Convergence tolerance
    pub tolerance: f64,
    /// Number of qubits for quantum operations
    pub num_qubits: usize,
    /// Random state for reproducibility
    pub random_state: Option<u64>,
}

impl Default for QuantumClusteringConfig {
    fn default() -> Self {
        Self {
            algorithm: ClusteringAlgorithm::QuantumKMeans,
            n_clusters: 3,
            max_iterations: 100,
            tolerance: 1e-4,
            num_qubits: 4,
            random_state: None,
        }
    }
}

/// Affinity types for spectral clustering
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum AffinityType {
    /// RBF (Gaussian) kernel
    RBF,
    /// Linear kernel
    Linear,
    /// Polynomial kernel
    Polynomial,
    /// Quantum kernel
    QuantumKernel,
    /// Nearest neighbors
    NearestNeighbors,
}

/// Covariance types for Gaussian Mixture Models
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum CovarianceType {
    /// Full covariance matrices
    Full,
    /// Diagonal covariance matrices
    Diagonal,
    /// Tied covariance matrix
    Tied,
    /// Spherical covariance
    Spherical,
    /// Quantum-enhanced covariance
    QuantumEnhanced,
}

/// Ensemble combination methods
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum EnsembleCombinationMethod {
    /// Majority voting
    MajorityVoting,
    /// Weighted voting
    WeightedVoting,
    /// Consensus clustering
    ConsensusClustering,
    /// Quantum consensus
    QuantumConsensus,
}

/// Measurement strategies for quantum operations
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum MeasurementStrategy {
    /// Standard quantum measurements
    Standard,
    /// Adaptive measurements
    AdaptiveMeasurements,
    /// Optimal measurements
    OptimalMeasurements,
}

/// State preparation methods
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum StatePreparationMethod {
    /// Angle encoding
    AngleEncoding,
    /// Amplitude encoding
    AmplitudeEncoding,
    /// Variational state preparation
    VariationalStatePreparation,
}

/// Entanglement structures
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum EntanglementStructure {
    /// Linear entanglement
    Linear,
    /// Circular entanglement
    Circular,
    /// Hardware efficient entanglement
    HardwareEfficient,
    /// All-to-all entanglement
    AllToAll,
}

/// Graph methods for graph clustering
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum GraphMethod {
    /// Standard graph construction
    Standard,
    /// Quantum graph construction
    QuantumGraph,
    /// k-nearest neighbors graph
    KNearestNeighbors,
    /// Epsilon neighborhood graph
    EpsilonNeighborhood,
}

/// Community detection algorithms
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum CommunityAlgorithm {
    /// Modularity-based detection
    Modularity,
    /// Quantum community detection
    QuantumCommunityDetection,
    /// Louvain algorithm
    Louvain,
    /// Label propagation
    LabelPropagation,
}

/// Time series distance metrics
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum TimeSeriesDistanceMetric {
    /// Dynamic time warping
    DTW,
    /// Euclidean distance
    Euclidean,
    /// Quantum temporal distance
    QuantumTemporal,
}

/// Dimensionality reduction methods for high-dimensional clustering
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum DimensionalityReduction {
    /// Principal Component Analysis
    PCA,
    /// Quantum PCA
    QuantumPCA,
    /// t-SNE
    TSNE,
    /// UMAP
    UMAP,
}

/// Configuration for Quantum K-Means clustering
#[derive(Debug, Clone)]
pub struct QuantumKMeansConfig {
    /// Number of clusters
    pub n_clusters: usize,
    /// Maximum iterations
    pub max_iterations: usize,
    /// Convergence tolerance
    pub tolerance: f64,
    /// Distance metric to use
    pub distance_metric: QuantumDistanceMetric,
    /// Number of quantum repetitions
    pub quantum_reps: usize,
    /// Quantum enhancement level
    pub enhancement_level: QuantumEnhancementLevel,
    /// Random seed
    pub seed: Option<u64>,
}

/// Configuration for Quantum DBSCAN clustering
#[derive(Debug, Clone)]
pub struct QuantumDBSCANConfig {
    /// Epsilon neighborhood radius
    pub eps: f64,
    /// Minimum samples in neighborhood
    pub min_samples: usize,
    /// Distance metric to use
    pub distance_metric: QuantumDistanceMetric,
    /// Quantum enhancement level
    pub enhancement_level: QuantumEnhancementLevel,
    /// Random seed
    pub seed: Option<u64>,
}

/// Configuration for Quantum Spectral clustering
#[derive(Debug, Clone)]
pub struct QuantumSpectralConfig {
    /// Number of clusters
    pub n_clusters: usize,
    /// Affinity type
    pub affinity: AffinityType,
    /// Gamma parameter for RBF kernel
    pub gamma: f64,
    /// Quantum enhancement level
    pub enhancement_level: QuantumEnhancementLevel,
    /// Random seed
    pub seed: Option<u64>,
}

/// Configuration for Quantum Fuzzy C-Means clustering
#[derive(Debug, Clone)]
pub struct QuantumFuzzyCMeansConfig {
    /// Number of clusters
    pub n_clusters: usize,
    /// Fuzziness parameter
    pub fuzziness: f64,
    /// Maximum iterations
    pub max_iterations: usize,
    /// Convergence tolerance
    pub tolerance: f64,
    /// Distance metric to use
    pub distance_metric: QuantumDistanceMetric,
    /// Quantum enhancement level
    pub enhancement_level: QuantumEnhancementLevel,
    /// Random seed
    pub seed: Option<u64>,
}

/// Configuration for Quantum Gaussian Mixture Models
#[derive(Debug, Clone)]
pub struct QuantumGMMConfig {
    /// Number of components
    pub n_components: usize,
    /// Covariance type
    pub covariance_type: CovarianceType,
    /// Maximum iterations
    pub max_iterations: usize,
    /// Convergence tolerance
    pub tolerance: f64,
    /// Quantum enhancement level
    pub enhancement_level: QuantumEnhancementLevel,
    /// Random seed
    pub seed: Option<u64>,
}

/// Configuration for clustering ensembles
#[derive(Debug, Clone)]
pub struct ClusteringEnsembleConfig {
    /// Base clustering algorithms
    pub base_algorithms: Vec<ClusteringAlgorithm>,
    /// Number of ensemble members
    pub n_members: usize,
    /// Combination method
    pub combination_method: EnsembleCombinationMethod,
    /// Random seed
    pub seed: Option<u64>,
}

/// Configuration for graph clustering
#[derive(Debug, Clone)]
pub struct GraphClusteringConfig {
    /// Graph construction method
    pub graph_method: GraphMethod,
    /// Community detection algorithm
    pub community_algorithm: CommunityAlgorithm,
    /// Number of neighbors for graph construction
    pub n_neighbors: usize,
    /// Quantum enhancement level
    pub enhancement_level: QuantumEnhancementLevel,
    /// Random seed
    pub seed: Option<u64>,
}

/// Configuration for time series clustering
#[derive(Debug, Clone)]
pub struct TimeSeriesClusteringConfig {
    /// Number of clusters
    pub n_clusters: usize,
    /// Time series distance metric
    pub ts_distance_metric: TimeSeriesDistanceMetric,
    /// Window size for analysis
    pub window_size: usize,
    /// Random seed
    pub seed: Option<u64>,
}

/// Configuration for high-dimensional clustering
#[derive(Debug, Clone)]
pub struct HighDimClusteringConfig {
    /// Number of clusters
    pub n_clusters: usize,
    /// Dimensionality reduction method
    pub dim_reduction: DimensionalityReduction,
    /// Target dimensionality after reduction
    pub target_dim: usize,
    /// Random seed
    pub seed: Option<u64>,
}

/// Configuration for streaming clustering
#[derive(Debug, Clone)]
pub struct StreamingClusteringConfig {
    /// Number of clusters
    pub n_clusters: usize,
    /// Batch size for processing
    pub batch_size: usize,
    /// Memory size for streaming
    pub memory_size: usize,
    /// Forgetting factor
    pub forgetting_factor: f64,
    /// Random seed
    pub seed: Option<u64>,
}

/// Configuration for quantum-native clustering
#[derive(Debug, Clone)]
pub struct QuantumNativeConfig {
    /// Number of qubits
    pub num_qubits: usize,
    /// Circuit depth
    pub circuit_depth: usize,
    /// State preparation method
    pub state_preparation: StatePreparationMethod,
    /// Measurement strategy
    pub measurement_strategy: MeasurementStrategy,
    /// Entanglement structure
    pub entanglement_structure: EntanglementStructure,
    /// Random seed
    pub seed: Option<u64>,
}

// Default implementations
impl Default for QuantumKMeansConfig {
    fn default() -> Self {
        Self {
            n_clusters: 3,
            max_iterations: 100,
            tolerance: 1e-4,
            distance_metric: QuantumDistanceMetric::QuantumEuclidean,
            quantum_reps: 2,
            enhancement_level: QuantumEnhancementLevel::Moderate,
            seed: None,
        }
    }
}

impl Default for QuantumDBSCANConfig {
    fn default() -> Self {
        Self {
            eps: 0.5,
            min_samples: 5,
            distance_metric: QuantumDistanceMetric::QuantumEuclidean,
            enhancement_level: QuantumEnhancementLevel::Moderate,
            seed: None,
        }
    }
}

impl Default for QuantumSpectralConfig {
    fn default() -> Self {
        Self {
            n_clusters: 3,
            affinity: AffinityType::RBF,
            gamma: 1.0,
            enhancement_level: QuantumEnhancementLevel::Moderate,
            seed: None,
        }
    }
}

impl Default for QuantumFuzzyCMeansConfig {
    fn default() -> Self {
        Self {
            n_clusters: 3,
            fuzziness: 2.0,
            max_iterations: 100,
            tolerance: 1e-4,
            distance_metric: QuantumDistanceMetric::QuantumEuclidean,
            enhancement_level: QuantumEnhancementLevel::Moderate,
            seed: None,
        }
    }
}

impl Default for QuantumGMMConfig {
    fn default() -> Self {
        Self {
            n_components: 3,
            covariance_type: CovarianceType::Full,
            max_iterations: 100,
            tolerance: 1e-4,
            enhancement_level: QuantumEnhancementLevel::Moderate,
            seed: None,
        }
    }
}