Crate sklears_covariance

Crate sklears_covariance 

Source
Expand description

Covariance estimation algorithms

This module provides covariance estimators including empirical, shrinkage-based, and robust estimators.

Re-exports§

pub use plugin_architecture::GLOBAL_REGISTRY;

Modules§

model_selection_presets
Convenience functions for creating common selectors
polars_utils
Utility functions for DataFrame integration
tuning_presets
Convenience functions for creating common tuning configurations

Macros§

register_covariance_estimator
Convenience macros for plugin registration
register_hook
register_regularization

Structs§

ALSCovariance
Alternating Least Squares estimator for covariance matrices
ALSCovarianceTrained
Trained ALS state
AccuracyTestResult
AdamOptimizer
Adam optimizer
AdaptiveFilteringCovariance
Adaptive filtering covariance
AdaptiveFilteringCovarianceTrained
Trained state for adaptive filtering covariance
AdaptiveFilteringCovarianceUntrained
Untrained state for adaptive filtering covariance
AdaptiveLassoCovariance
Adaptive Lasso Covariance Estimator
AdaptiveLassoCovarianceTrained
Trained state for AdaptiveLassoCovariance
AdversarialRobustCovariance
Adversarially robust covariance estimator
AdversarialRobustCovarianceTrained
AdversarialRobustCovarianceUntrained
States for adversarial robust covariance
AlternatingProjections
Alternating Projections Estimator (Untrained State)
AlternatingProjectionsTrained
Marker for trained state
ArraySignalProcessing
Array signal processing covariance
ArraySignalProcessingTrained
Trained state for array signal processing
ArraySignalProcessingUntrained
Untrained state for array signal processing
AutoCovarianceSelector
Automatic model selection framework for covariance estimators
BayesianCovariance
Bayesian covariance estimator in untrained state
BayesianCovarianceFitted
Bayesian covariance estimator in trained state
BayesianPrior
Prior specification for Bayesian covariance estimation
BeamformingCovariance
Beamforming covariance applications
BeamformingCovarianceTrained
Trained state for beamforming covariance
BeamformingCovarianceUntrained
Untrained state for beamforming covariance
BenchmarkConfig
BenchmarkResult
Results from performance benchmarking
BenchmarkSuite
BestEstimator
Best estimator information
BigQUIC
BigQUIC estimator for large-scale sparse precision matrix estimation
BigQUICTrained
Trained BigQUIC state
CLIME
CLIME (Constrained L1 Minimization) estimator
CVResult
Single cross-validation result
CandidateResult
Individual candidate result
ChenSteinCovariance
Chen-Stein Shrinkage Covariance Estimator
ChenSteinCovarianceTrained
Trained state for ChenSteinCovariance
ClutterStatistics
Clutter statistics
ColumnStatistics
Statistical summary for a column
CommunicationCost
Communication cost analysis
ComparisonResult
CompositeRegularization
Composite regularization strategy
ComputationStats
ComputationalConstraints
Computational constraints
ConditioningStep
Matrix conditioning post-processing step
ConvergenceAnalysis
Convergence analysis
ConvergenceInfo
Convergence information for iterative estimators
ConvergenceParams
Convergence parameters
CoordinateDescentCovariance
Coordinate descent covariance estimator
CoordinateDescentCovarianceTrained
Trained Coordinate Descent state
CoordinateDescentOptimizer
Coordinate descent optimizer
CopulaConfig
Copula-based estimation configuration
CorrelationDiagnostics
Correlation-based diagnostics
CorrelationStructure
Correlation structure analysis
CovarianceAccumulator
CovarianceBenchmark
Performance benchmarking utilities for covariance estimators
CovarianceCV
Cross-validation utility for covariance estimator selection
CovarianceDataFrame
Polars DataFrame wrapper for covariance estimation
CovarianceDiagnostics
Comprehensive diagnostic report for a covariance matrix
CovarianceHyperparameterTuner
Hyperparameter tuner for covariance estimators
CovarianceIterator
CovarianceMetadata
CovariancePipeline
Fluent covariance estimation pipeline builder
CovariancePluginRegistry
Plugin registry for custom covariance estimators
CovariancePresets
Configuration presets for common covariance estimation scenarios
CovarianceProperties
Properties of a covariance matrix
CovarianceResult
Result of covariance estimation with DataFrame context
CrossValidationConfig
Cross-validation configuration
DataCharacteristics
Data characteristics analysis
DataCharacterizationRules
Data characterization rules
DataFrameDescription
Summary description of a DataFrame
DataFrameMetadata
Metadata about the DataFrame columns
DccConfig
DCC model specification
Diagonal
DiagonalStats
Statistics for diagonal elements (variances)
DifferentialPrivacyCovariance
Basic Differential Privacy Covariance Estimator (Untrained)
DistributedCovariance
DistributionCharacteristics
Distribution characteristics
DistributionFreeConfig
Distribution-free estimation configuration
DomainPresets
Domain-specific preset collections
EMCovarianceMissingData
EM-based covariance estimator for missing data
EMCovarianceMissingDataTrained
Trained EM Covariance state
EarlyStoppingConfig
Early stopping configuration
ElasticNetCovariance
Elastic Net Regularized Covariance Estimator
ElasticNetCovarianceTrained
Trained state for ElasticNetCovariance
EllipticEnvelope
Elliptic Envelope
EllipticEnvelopeTrained
Trained state for EllipticEnvelope
EmpiricalCovariance
Empirical Covariance Estimator
EmpiricalCovarianceTrained
Trained state for EmpiricalCovariance
EstimatorConfig
Estimator configuration options
EstimatorInfo
Information about the estimator used
EstimatorMetadata
Metadata for custom estimators
ExplorationMetrics
Metrics about search space exploration
ExponentialWeightedConfig
Exponentially weighted configuration
FactorModelCovariance
Factor Model Covariance estimator
FactorModelCovarianceTrained
Trained Factor Model state
FederatedCovariance
Federated covariance estimator
FederatedCovarianceTrained
FederatedCovarianceUntrained
States for federated covariance
FederatedParty
Federated party data structure
Financial
Financial domain presets
Fitted
FluentCrossValidationConfig
Cross-validation configuration
FrameworkOptimizationHistory
Optimization history tracking
FrankWolfeCovariance
Frank-Wolfe Covariance Estimator (Untrained State)
FrankWolfeCovarianceTrained
Marker for trained state
GLOBAL_REGISTRY
GarchConfig
GARCH model configuration
GeneExpressionNetwork
Gene expression covariance network estimation
GeneExpressionNetworkTrained
Trained state for gene expression network
GeneExpressionNetworkUntrained
Untrained state for gene expression network
General
GenericEmpiricalCovariance
Genomics
Genomics domain presets
GraphicalLasso
Graphical Lasso Estimator
GraphicalLassoTrained
Trained state for GraphicalLasso
GroundTruthTestCase
GroupLassoCovariance
Group Lasso Covariance Estimator
GroupLassoCovarianceTrained
Trained state for GroupLassoCovariance
GroupLassoRegularization
Group Lasso regularization
HeuristicRule
Heuristic rules for model selection
HookContext
Context passed to hooks
HuberCovariance
Huber Robust Covariance Estimator
HuberCovarianceTrained
Trained state for HuberCovariance
ICACovariance
ICA-based covariance estimator
ICACovarianceTrained
Trained ICA Covariance state
IPFCovariance
Iterative Proportional Fitting covariance estimator
IPFCovarianceTrained
Trained IPF Covariance state
InformationMetrics
Information geometry metrics
InformationTheoryCovariance
Information Theory Covariance Estimator
KdeConfig
Kernel density estimation configuration
L1Regularization
L1 regularization (Lasso)
L2Regularization
L2 regularization (Ridge)
LedoitWolf
Ledoit-Wolf Covariance Estimator
LedoitWolfTrained
Trained state for LedoitWolf
LowRankSparseCovariance
Low-Rank Plus Sparse decomposition estimator for covariance matrices
LowRankSparseCovarianceTrained
Trained Low-Rank Sparse state
MarginalConstraint
Marginal constraint specification
McmcConfig
MCMC sampling configuration
MemoryEfficientCovariance
MemoryEstimate
MetaFeatures
Meta-features extracted from datasets
MetaLearningCovariance
Meta-Learning Covariance Estimator
MetaPerformanceMetrics
Performance metrics for meta-learning
MinCovDet
Minimum Covariance Determinant (MCD) Estimator
MinCovDetTrained
Trained state for MinCovDet
MissingDataInfo
Missing data information
ModelFitStatistics
Model fit statistics
ModelSelectionCV
Cross-validation configuration for model selection
ModelSelectionResult
Model selection result
MultiOmicsCovariance
Multi-omics covariance estimation
MultiOmicsCovarianceTrained
Trained state for multi-omics covariance
MultiOmicsCovarianceUntrained
Untrained state for multi-omics covariance
NMFCovariance
NMF Covariance Estimator (Untrained State)
NMFCovarianceTrained
Marker for trained state
NeighborhoodSelection
Neighborhood Selection Estimator
NeighborhoodSelectionTrained
Trained state for NeighborhoodSelection
NelderMeadOptimizer
Nelder-Mead simplex optimizer (derivative-free)
NetworkStatistics
Network statistics
NoiseCharacteristics
Noise characteristics
NonlinearShrinkage
Nonlinear shrinkage covariance estimator
NonparametricCovariance
Non-parametric covariance estimator in untrained state
NonparametricCovarianceFitted
Non-parametric covariance estimator in trained state
NuclearNormMinimization
Nuclear norm minimization estimator for matrix completion
NuclearNormRegularization
Nuclear norm regularization
NumericalAccuracyTester
NumericallyStableCovariance
OAS
Oracle Approximating Shrinkage (OAS) Estimator
OASTrained
Trained state for OAS
OffDiagonalStats
Statistics for off-diagonal elements (covariances)
OptimizationConfig
Optimization configuration
OptimizationConfigBuilder
Builder for optimization configuration
OptimizationHistory
Optimization history tracking
OptimizationResult
Optimization result
OptimizerRegistry
Registry for managing optimization algorithms
OutlierRemovalStep
Outlier removal preprocessing step
PCACovariance
PCA-based covariance estimator
PCACovarianceTrained
Trained PCA Covariance state
ParallelCovariance
ParallelCovarianceTrained
ParallelCovarianceUntrained
ParameterSpec
Parameter specification for tuning
PathwayAnalysis
Pathway analysis integration
PathwayAnalysisTrained
Trained state for pathway analysis
PathwayAnalysisUntrained
Untrained state for pathway analysis
PerformanceComparison
Performance comparison statistics
PerformanceHistory
Performance history for meta-learning
PerformanceMetrics
Performance metrics for the estimation
PhylogeneticCovariance
Phylogenetic covariance estimation
PhylogeneticCovarianceTrained
Trained state for phylogenetic covariance
PhylogeneticCovarianceUntrained
Untrained state for phylogenetic covariance
PipelineMetadata
Pipeline metadata
PluginParameterSpec
Parameter specification
PortfolioOptimizer
PositiveDefinite
PresetRecommendations
Preset validation and recommendations
PrivacyAccountant
Privacy accounting for composition
PrivacyOperation
Individual privacy operation
PropertyFailure
PropertyTestResult
PropertyTester
ProteinInteractionNetwork
Protein interaction network estimation
ProteinInteractionNetworkTrained
Trained state for protein interaction network
ProteinInteractionNetworkUntrained
Untrained state for protein interaction network
ProximalGradientOptimizer
Proximal gradient optimizer
QuantumAdvantageAnalysis
Analysis of quantum computational advantage
QuantumInspiredCovariance
Quantum-inspired covariance estimation using quantum algorithms principles
QuantumInspiredCovarianceTrained
QuantumInspiredCovarianceUntrained
States for quantum-inspired covariance estimation
RadarSonarCovariance
Radar and sonar covariance applications
RadarSonarCovarianceTrained
Trained state for radar/sonar covariance
RadarSonarCovarianceUntrained
Untrained state for radar/sonar covariance
RankBasedConfig
Rank-based estimation configuration
RaoBlackwellLedoitWolf
Rao-Blackwell Ledoit-Wolf Covariance Estimator
RaoBlackwellLedoitWolfTrained
Trained state for RaoBlackwellLedoitWolf
RegimeSwitchingConfig
Regime-switching configuration
RegularizationFactory
Regularization factory for creating common combinations
RidgeCovariance
Ridge Regularized Covariance Estimator
RidgeCovarianceTrained
Trained state for RidgeCovariance
RiskDecomposition
RiskFactorModel
RiskFactorModelTrained
RiskFactorModelUntrained
RobustCorrelationConfig
Robust correlation configuration
RobustPCA
Robust Principal Component Analysis (RPCA) Estimator
RobustPCATrained
Trained state for RobustPCA
RobustnessDiagnostics
Robustness diagnostics
RollingWindowConfig
Rolling window configuration
RotationEquivariant
Rotation-Equivariant Shrinkage Covariance Estimator
RotationEquivariantTrained
Trained state for RotationEquivariant
SGDOptimizer
Stochastic Gradient Descent optimizer
SIMDCovariance
SPACE
SPACE (Sparse Partial Correlation Estimation) Estimator
SPACETrained
Trained state for SPACE
SharedCovariance
ShrunkCovariance
Shrunk Covariance Estimator
ShrunkCovarianceTrained
Trained state for ShrunkCovariance
SignalProcessing
Signal processing domain presets
SingleAccuracyResult
SingleComparison
SparseFactorModel
Sparse Factor Model (Untrained State)
SparseFactorModelTrained
Marker for trained state
SpatialCovarianceEstimator
Spatial covariance estimation for array processing
SpatialCovarianceEstimatorTrained
Trained state for spatial covariance estimator
SpatialCovarianceEstimatorUntrained
Untrained state for spatial covariance estimator
StandardizationStep
Standardization preprocessing step
StepResult
Step execution result
StreamingCovariance
StressScenario
StressTestResult
StressTesting
Symmetric
TIGER
TIGER (Tuning-Insensitive Graph Estimation) Estimator
TIGERTrained
Trained state for TIGER
TestingBenchmarkResult
ThreadSafeCovarianceView
TimeVaryingCovariance
Time-varying covariance estimator in untrained state
TimeVaryingCovarianceFitted
Time-varying covariance estimator in trained state
TopologyMetrics
Network topology metrics
TuningConfig
Hyperparameter tuning configuration
TuningResult
Result of hyperparameter tuning
TypedMatrix
Unfit
Pipeline states
UtilityMetrics
Utility metrics for privacy-utility trade-off
VariationalConfig
Variational Bayes configuration
VariationalParameters
Variational parameters for Bayesian inference
VolatilityModel
ZeroCostCovariance

Enums§

APAlgorithm
Alternating projections algorithm variants
AcquisitionFunction
Acquisition function for Bayesian optimization
AdaptiveAlgorithm
Adaptive algorithms
AggregationMethod
Methods for federated aggregation
AlgorithmComplexity
Algorithm complexity classifications
ArrayGeometry
Array geometry types
BayesianMethod
Bayesian covariance estimation methods
BeamformingAlgorithm
Beamforming algorithms
BranchLengthMethod
Branch length estimation methods
BudgetAllocation
Privacy budget allocation strategies
ClusteringMethod
Clustering methods for gene network analysis
ClutterSuppression
Clutter suppression methods
CombinationMethod
Methods for combining regularization strategies
ComplexDetectionMethod
Methods for protein complex detection
CompositionMethod
Composition methods for privacy accounting
ComputationalComplexity
Computational complexity classification
ConditioningMethod
ConstraintType
Types of constraints for IPF
ContrastFunction
Contrast functions for FastICA
ConvergenceCriterion
Convergence criteria
CopulaType
Copula types for dependency modeling
CorrectionMethod
Correction methods for multiple testing
CorrelationHandling
Correlation handling methods
CovarianceError
CovarianceMethod
Available covariance estimation methods for meta-learning
DOAMethod
Direction of arrival estimation methods
DetectionMethod
Detection methods
DifficultyLevel
DistributionStrategy
DivergenceMeasure
Divergence measures for information theory
DopplerProcessing
Doppler processing methods
EnrichmentMethod
Enrichment analysis methods
EntropyEstimator
Entropy estimation methods
EstimatorState
Estimator state for hooks
EstimatorType
Available estimator types
EvolutionaryModel
Evolutionary models
FactorModelMethod
FederatedPrivacyMechanism
Privacy mechanisms for federated learning
FilterType
Filter types
FluentScoringMetric
Scoring metrics for cross-validation
FrankWolfeAlgorithm
Frank-Wolfe algorithm variants
FrankWolfeConstraint
Constraint sets for Frank-Wolfe optimization
FrankWolfeLineSearchMethod
Line search methods for Frank-Wolfe
FrankWolfeObjectiveFunction
Objective functions for covariance optimization
GarchType
GARCH model types for multivariate estimation
HookType
Hook types for different estimation phases
ICAAlgorithm
ICA algorithms
InformationCriterion
Information criteria for model selection
InformationMethod
Information theory estimation methods
InformationRegularization
Regularization strategies based on information theory
IntegrationMethod
Integration methods for multi-omics data
KernelFunction
Kernel functions for kernel PCA
KernelType
Kernel types for density estimation
LineSearchMethod
Line search methods
MetaLearningStrategy
Meta-learning strategy
MetaOptimizationMethod
Hyperparameter optimization method
MissingDataMethod
Methods for handling missing data
ModelSelectionScoring
Scoring metrics for model selection
NMFAlgorithm
NMF algorithm variants
NMFInitialization
NMF initialization methods
NoiseCalibration
Noise calibration methods
NoiseType
Noise types
NonparametricMethod
Non-parametric covariance estimation methods
NormalizationMethod
Normalization methods
OptimizationMethod
OptimizationTarget
Optimization targets for coordinate descent
OptimizerType
Optimization algorithm types
OutlierMethod
PCAMethod
Methods for PCA computation
ParameterType
Types of parameters that can be tuned
ParameterValue
Parameter value wrapper
PerformanceMetric
Performance metrics
PivotingStrategy
PrivacyMechanism
Privacy mechanism types
ProjectionConstraint
Projection constraint types
QualityAssessment
Overall quality assessment
QuantumAlgorithmType
Types of quantum algorithms for covariance estimation
RangeProcessing
Range processing methods
RankCorrelationType
Rank-based correlation types
RankMethod
Methods for handling rank deficiency
RateVariationModel
Rate variation models
RegularizationMethod
Regularization methods for coordinate descent
RobustCorrelationType
Robust correlation types
RobustnessMethod
Methods for adversarial robustness
RuleCondition
Rule conditions for heuristic selection
ScoringMethod
Scoring methods for covariance cross-validation
ScoringMetric
Scoring metrics for evaluating covariance estimators
SearchStrategy
Search strategy for hyperparameter optimization
SelectionRule
Selection rules for choosing final model
SelectionStrategy
Model selection strategies
SparseInitialization
Sparse initialization methods
SparseRegularization
Sparse regularization methods
SpatialEstimationMethod
Spatial estimation methods
SpatialSmoothing
Spatial smoothing techniques
StepType
Step types
StratificationStrategy
Stratification strategies for CV
StreamingMethod
SystemType
System types
TimeVaryingMethod
Time-varying covariance estimation methods
UpdateRule
Update rules for multiplicative NMF
VolatilityModelType
WhiteningMethod
Whitening methods

Traits§

CovarianceEstimator
CovarianceEstimatorFitted
Trait for fitted covariance estimators
CovarianceEstimatorTunable
Trait for covariance estimators that can be tuned
CustomCovarianceEstimator
Trait for custom covariance estimators
DataFrameEstimator
Trait for estimators that can work directly with DataFrames
EstimatorFactory
Factory trait for creating custom estimators
Hook
Hook trait for callback functions
MatrixStructure
Phantom types for matrix structure
Middleware
Middleware trait for estimation pipelines
ObjectiveFunction
Trait for objective functions
OptimizationAlgorithm
Core trait for optimization algorithms
PostprocessingStep
Post-processing step trait
PreprocessingStep
Preprocessing step trait
RegularizationFunction
Regularization function trait
RegularizationStrategy
Trait for regularization strategies
RobustCovarianceEstimator
SparseCovarianceEstimator

Functions§

adaptive_shrinkage
Stability-oriented covariance shrinkage
compare_covariance_matrices
Compare two covariance matrices
create_federated_parties
Create federated parties from distributed data
frobenius_norm
Compute the Frobenius norm of a matrix
is_diagonally_dominant
Check if a matrix is diagonally dominant (useful for convergence analysis)
matrix_determinant
Compute matrix determinant
matrix_inverse
Compute matrix inverse using appropriate method based on size
nuclear_norm_approximation
Compute the nuclear norm (sum of singular values) approximation via trace
rank_estimate
Matrix rank estimation via iterative hard thresholding
spectral_radius_estimate
Estimate the spectral radius (largest eigenvalue magnitude) via power iteration
split_data_for_federation
Split data for federated simulation
validate_covariance_matrix
Validate properties of a covariance matrix

Type Aliases§

CLIMETrained
DifferentialPrivacyCovarianceTrained
DifferentialPrivacyCovarianceUntrained
InformationTheoryCovarianceTrained
InformationTheoryCovarianceUntrained
MetaLearningCovarianceTrained
MetaLearningCovarianceUntrained
NonlinearShrinkageTrained
NuclearNormMinimizationTrained