PassiveAggressive / Regressor Layer
Passive-Aggressive Regression.
Mathematical formulation: where:
- w are the model weights
- C is the aggressiveness parameter
- ℓ is the loss function
- (x_t,y_t) is the current sample
Key characteristics:
- Online learning
- Adaptive updates
- No learning rate
- Margin-based losses
Advantages:
- Streaming data handling
- Memory efficient
- Quick adaptation
- Robust to outliers
Common applications:
- Online prediction
- Large-scale learning
- Streaming data
- Real-time updates
- Resource-constrained systems
Outputs:
- Predicted Table: Results with predictions
- Validation Results: Cross-validation metrics
- Test Metric: Hold-out performance
- Feature Importances: Model coefficients
SelectFeatures
[column, ...]Feature column selection for PA Regression:
Requirements:
-
Data properties:
- Numeric values
- No missing data
- Finite numbers
- Stream-compatible
-
Online considerations:
- Feature stability
- Update frequency
- Scale consistency
- Stream patterns
-
Preprocessing needs:
- Scaling crucial
- Online normalization
- Drift handling
- Stream adaptation
Note: If empty, uses all numeric columns except target
SelectTarget
columnTarget column specification for PA Regression:
Requirements:
-
Data type:
- Numeric continuous
- No missing values
- Finite numbers
- Stream-suitable
-
Online properties:
- Value stability
- Drift patterns
- Update frequency
- Scale changes
-
Stream considerations:
- Real-time nature
- Adaptation needs
- Response timing
- Quality control
Note: Must be a single numeric column
Params
oneofDefault configuration for Passive-Aggressive Regression:
Core settings:
-
Learning parameters:
- C = 1.0 (aggressiveness)
- ε = 0.1 (margin)
- Epsilon-insensitive loss
-
Training control:
- 1000 max iterations
- 1e-3 tolerance
- Shuffled updates
-
Online behavior:
- No early stopping
- Fresh start
- Adaptive updates
Best suited for:
- Streaming data
- Online learning
- Memory constraints
- Quick adaptation
Customizable parameters for Passive-Aggressive Regression:
Parameter categories:
-
Update control:
- Aggressiveness (C)
- Margin (ε)
- Loss function
-
Training process:
- Iteration limits
- Convergence criteria
- Data handling
-
Online learning:
- Early stopping
- Warm start
- Validation strategy
Trade-offs:
- Stability vs adaptation
- Memory vs performance
- Speed vs precision
CFactor
f64Aggressiveness parameter:
Role in update: where τₜ depends on C
Effects:
- Controls update size
- Balances stability
- Adaptation speed
Selection guide:
- Small: More passive
- Large: More aggressive
- Balance needed
FitIntercept
boolIntercept calculation control:
Model forms: With intercept: Without intercept:
Online impact:
- Updated per sample
- Adapts to shifts
- Tracks bias
- Stream handling
Effects when True:
- Centers predictions
- Handles drift
- Better adaptation
- Standard modeling
MaxIter
u32Maximum passes over training data:
Impact on learning:
- Multiple passes allowed
- Affects fit method only
- Not partial_fit
- Convergence control
Typical ranges:
- Simple: 100-500
- Standard: 1000
- Complex: 2000+
Note: Online learning may need fewer
Tol
f64Convergence tolerance threshold:
Stopping criterion:
Usage:
- 0: No early stopping
- >0: Enables stopping
- Checks n_iter_no_change
Trade-offs:
- Stability vs speed
- Accuracy vs time
- Stream adaptation
Epsilon
f64If the difference between the current prediction and the correct label is below this threshold, the model is not updated.
Update condition:
Effects:
- Controls sensitivity
- Update frequency
- Noise tolerance
- Solution stability
Selection guide:
- Small: More updates
- Large: More passive
- Based on noise level
Shuffle
boolWhether or not the training data should be shuffled after each epoch.
When True:
- Randomizes order
- Better convergence
- Prevents cycles
- Improves generalization
When False:
- Sequential updates
- Order-sensitive
- Stream simulation
- Time series cases
Loss
enumLoss functions for PA updates:
-
Epsilon-insensitive:
- Linear penalty
- Robust behavior
- SVR-like loss
-
Squared epsilon-insensitive:
- Quadratic penalty
- Smoother updates
- More aggressive
Selection impact:
- Update magnitude
- Convergence behavior
- Outlier sensitivity
- Solution stability
EarlyStopping
boolEarly stopping control:
When enabled:
- Monitors validation
- Prevents overfitting
- Saves computation
- Adaptive stopping
Requirements:
- validation_fraction > 0
- Sufficient data
- n_iter_no_change set
- tol > 0
Validation set proportion:
Usage:
- Early stopping only
- Hold-out validation
- Progress monitoring
Typical values:
- Small data: 0.2
- Large data: 0.1
- Streaming: Consider less
Iteration patience:
Early stopping when:
- No improvement for n iterations
- Based on validation score
- Checks tolerance threshold
Selection:
- Small: Quick stopping
- Large: More patience
- Balance needed
WarmStart
boolWhen set to True, reuse the solution of the previous call to fit and add more estimators to the ensemble, otherwise, just fit a whole new ensemble.
When True:
- Reuses weights
- Continues learning
- Stream handling
- Incremental updates
Best for:
- Online learning
- Stream processing
- Continuous adaptation
- Transfer learning
RandomState
u32Random number generation seed:
Controls:
- Shuffling order
- Reproducibility
- Validation split
Usage:
- Fixed: Reproducible
- Different: Robustness
- 0: System random
Hyperparameter optimization for Passive-Aggressive Regression:
Search space organization:
-
Update mechanics:
- Aggressiveness (C)
- Margin (ε)
- Loss functions
-
Online behavior:
- Update frequency
- Adaptation speed
- Stream handling
-
Training control:
- Stopping criteria
- Iteration limits
- Validation strategy
Best practices:
- Consider streaming scenarios
- Balance adaptation speed
- Monitor update frequency
- Verify stability
CFactor
[f64, ...]Aggressiveness parameter search:
Search patterns:
-
Conservative:
- [0.1, 0.5, 1.0]
- Stable updates
-
Aggressive:
- [1.0, 10.0, 100.0]
- Fast adaptation
-
Comprehensive:
- [0.1, 1.0, 10.0, 100.0]
- Full range study
FitIntercept
[bool, ...]Intercept adaptation search:
Options:
-
With bias: [true]
- Stream adaptation
- Drift handling
-
No bias: [false]
- Fixed origin
- Theory-driven
-
Compare: [true, false]
- Adaptation study
- Bias impact
MaxIter
[u32, ...]Maximum iterations search:
Search ranges:
-
Quick learning:
- [100, 300, 500]
- Fast adaptation
-
Standard:
- [500, 1000, 2000]
- Better stability
-
Thorough:
- [1000, 3000, 5000]
- Complex problems
Tol
[f64, ...]Tolerance threshold search:
Search spaces:
-
Tight convergence:
- [1e-4, 1e-3, 1e-2]
- Precise updates
-
Relaxed:
- [1e-3, 1e-2, 1e-1]
- Faster adaptation
-
Online-focused:
- [1e-2, 1e-1]
- Stream processing
Epsilon
[f64, ...]Margin threshold search:
Search patterns:
-
Sensitive:
- [0.01, 0.05, 0.1]
- Frequent updates
-
Conservative:
- [0.1, 0.2, 0.5]
- Stable behavior
-
Mixed:
- Multiple ranges
- Update study
Shuffle
[bool, ...]Order randomization search:
Options:
-
Random: [true]
- Better convergence
- General cases
-
Sequential: [false]
- Stream simulation
- Time series
-
Compare: [true, false]
- Order sensitivity
Loss
[enum, ...]Loss functions for PA updates:
-
Epsilon-insensitive:
- Linear penalty
- Robust behavior
- SVR-like loss
-
Squared epsilon-insensitive:
- Quadratic penalty
- Smoother updates
- More aggressive
Selection impact:
- Update magnitude
- Convergence behavior
- Outlier sensitivity
- Solution stability
EarlyStopping
[bool, ...]Early stopping evaluation:
Search options:
-
Full training: [false]
- Complete passes
- Stream processing
-
With stopping: [true]
- Resource saving
- Convergence check
-
Compare: [true, false]
- Efficiency study
WarmStart
[bool, ...]When set to True, reuse the solution of the previous call to fit and add more estimators to the ensemble, otherwise, just fit a whole new ensemble.
Options:
-
Fresh start: [false]
- Independent runs
- Clean training
-
Continuous: [true]
- Stream handling
- Online learning
-
Compare: [true, false]
- Adaptation study
Validation size control:
Considerations:
- Early stopping needs
- Stream processing
- Data availability
- Online scenarios
Typical values:
- Small data: 0.2
- Large data: 0.1
- Streaming: Minimal
Patience parameter:
Impact:
- Stopping timing
- Adaptation period
- Resource usage
Selection:
- Short: 3-5 iterations
- Long: 10+ iterations
- Stream-appropriate
RandomState
u32Random seed control:
Usage:
- Fixed: Reproducible
- Varied: Robustness
- Multiple: Stability
Best practices:
- Document seeds
- Verify consistency
- Test stability
RefitScore
enumRegression model evaluation metrics:
Purpose:
- Model performance evaluation
- Error measurement
- Quality assessment
- Model comparison
Selection criteria:
- Error distribution
- Scale sensitivity
- Domain requirements
- Business objectives
Model's native scoring method:
- Typically R² score
- Model-specific implementation
- Standard evaluation
- Quick assessment
Coefficient of determination (R²):
Formula:
Properties:
- Range: (-∞, 1]
- 1: Perfect prediction
- 0: Constant model
- Negative: Worse than mean
Best for:
- General performance
- Variance explanation
- Model comparison
- Standard reporting
Explained variance score:
Formula:
Properties:
- Range: (-∞, 1]
- Accounts for bias
- Variance focus
- Similar to R²
Best for:
- Variance analysis
- Bias assessment
- Model stability
Maximum absolute error:
Formula:
Properties:
- Worst case error
- Original scale
- Sensitive to outliers
- Upper error bound
Best for:
- Critical applications
- Error bounds
- Safety margins
- Risk assessment
Negative mean absolute error:
Formula:
Properties:
- Linear error scale
- Robust to outliers
- Original units
- Negated for optimization
Best for:
- Robust evaluation
- Interpretable errors
- Outlier presence
Negative mean squared error:
Formula:
Properties:
- Squared error scale
- Outlier sensitive
- Squared units
- Negated for optimization
Best for:
- Standard optimization
- Large error penalty
- Statistical analysis
Negative root mean squared error:
Formula:
Properties:
- Original scale
- Outlier sensitive
- Interpretable units
- Negated for optimization
Best for:
- Standard reporting
- Interpretable errors
- Model comparison
Negative mean squared logarithmic error:
Formula:
Properties:
- Relative error scale
- For positive values
- Sensitive to ratios
- Negated for optimization
Best for:
- Exponential growth
- Relative differences
- Positive predictions
Negative median absolute error:
Formula:
Properties:
- Highly robust
- Original scale
- Outlier resistant
- Negated for optimization
Best for:
- Robust evaluation
- Heavy-tailed errors
- Outlier presence
Negative Poisson deviance:
Formula:
Properties:
- For count data
- Non-negative values
- Poisson assumption
- Negated for optimization
Best for:
- Count prediction
- Event frequency
- Rate modeling
Negative Gamma deviance:
Formula:
Properties:
- For positive continuous data
- Constant CV assumption
- Relative errors
- Negated for optimization
Best for:
- Positive continuous data
- Multiplicative errors
- Financial modeling
Negative mean absolute percentage error:
Formula:
Properties:
- Percentage scale
- Scale independent
- For non-zero targets
- Negated for optimization
Best for:
- Relative performance
- Scale-free comparison
- Business metrics
D² score with absolute error:
Formula:
Properties:
- Range: (-∞, 1]
- Robust version of R²
- Linear error scale
- Outlier resistant
Best for:
- Robust evaluation
- Non-normal errors
- Alternative to R²
D² score with pinball loss:
Properties:
- Quantile focus
- Asymmetric errors
- Risk assessment
- Distribution modeling
Best for:
- Quantile regression
- Risk analysis
- Asymmetric costs
- Distribution tails
D² score with Tweedie deviance:
Properties:
- Compound Poisson-Gamma
- Flexible dispersion
- Mixed distributions
- Insurance modeling
Best for:
- Insurance claims
- Mixed continuous-discrete
- Compound distributions
- Specialized modeling
Split
oneofStandard train-test split configuration optimized for general classification tasks.
Configuration:
- Test size: 20% (0.2)
- Random seed: 98
- Shuffling: Enabled
- Stratification: Based on target distribution
Advantages:
- Preserves class distribution
- Provides reliable validation
- Suitable for most datasets
Best for:
- Medium to large datasets
- Independent observations
- Initial model evaluation
Splitting uses the ShuffleSplit strategy or StratifiedShuffleSplit strategy depending on the field stratified
. Note: If shuffle is false then stratified must be false.
Configurable train-test split parameters for specialized requirements. Allows fine-tuning of data division strategy for specific use cases or constraints.
Use cases:
- Time series data
- Grouped observations
- Specific train/test ratios
- Custom validation schemes
RandomState
u64Random seed for reproducible splits. Ensures:
- Consistent train/test sets
- Reproducible experiments
- Comparable model evaluations
Same seed guarantees identical splits across runs.
Shuffle
boolData shuffling before splitting. Effects:
- true: Randomizes order, better for i.i.d. data
- false: Maintains order, important for time series
When to disable:
- Time dependent data
- Sequential patterns
- Grouped observations
TrainSize
f64Proportion of data for training. Considerations:
- Larger (e.g., 0.8-0.9): Better model learning
- Smaller (e.g., 0.5-0.7): Better validation
Common splits:
- 0.8: Standard (80/20 split)
- 0.7: More validation emphasis
- 0.9: More training emphasis
Stratified
boolMaintain class distribution in splits. Important when:
- Classes are imbalanced
- Small classes present
- Representative splits needed
Requirements:
- Classification tasks only
- Cannot use with shuffle=false
- Sufficient samples per class
Cv
oneofStandard cross-validation configuration using stratified 3-fold splitting.
Configuration:
- Folds: 3
- Method: StratifiedKFold
- Stratification: Preserves class proportions
Advantages:
- Balanced evaluation
- Reasonable computation time
- Good for medium-sized datasets
Limitations:
- May be insufficient for small datasets
- Higher variance than larger fold counts
- May miss some data patterns
Configurable stratified k-fold cross-validation for specific validation requirements.
Features:
- Adjustable fold count with
NFolds
determining the number of splits. - Stratified sampling
- Preserved class distributions
Use cases:
- Small datasets (more folds)
- Large datasets (fewer folds)
- Detailed model evaluation
- Robust performance estimation
NFolds
u32Number of cross-validation folds. Guidelines:
- 3-5: Large datasets, faster training
- 5-10: Standard choice, good balance
- 10+: Small datasets, thorough evaluation
Trade-offs:
- More folds: Better evaluation, slower training
- Fewer folds: Faster training, higher variance
Must be at least 2.
K-fold cross-validation without stratification. Divides data into k consecutive folds for iterative validation.
Process:
- Splits data into k equal parts
- Each fold serves as validation once
- Remaining k-1 folds form training set
Use cases:
- Regression problems
- Large, balanced datasets
- When stratification unnecessary
- Continuous target variables
Limitations:
- May not preserve class distributions
- Less suitable for imbalanced data
- Can create biased splits with ordered data
NSplits
u32Number of folds for cross-validation. Selection guide: Recommended values:
- 5: Standard choice (default)
- 3: Large datasets/quick evaluation
- 10: Thorough evaluation/smaller datasets
Trade-offs:
- Higher values: More thorough, computationally expensive
- Lower values: Faster, potentially higher variance
Must be at least 2 for valid cross-validation.
RandomState
u64Random seed for fold generation when shuffling. Important for:
- Reproducible results
- Consistent fold assignments
- Benchmark comparisons
- Debugging and validation
Set specific value for reproducibility across runs.
Shuffle
boolWhether to shuffle data before splitting into folds. Effects:
- true: Randomized fold composition (recommended)
- false: Sequential splitting
Enable when:
- Data may have ordering
- Better fold independence needed
Disable for:
- Time series data
- Ordered observations
Stratified K-fold cross-validation maintaining class proportions across folds.
Key features:
- Preserves class distribution in each fold
- Handles imbalanced datasets
- Ensures representative splits
Best for:
- Classification problems
- Imbalanced class distributions
- When class proportions matter
Requirements:
- Classification tasks only
- Sufficient samples per class
- Categorical target variable
NSplits
u32Number of stratified folds. Guidelines: Typical values:
- 5: Standard for most cases
- 3: Quick evaluation/large datasets
- 10: Detailed evaluation/smaller datasets
Considerations:
- Must allow sufficient samples per class per fold
- Balance between stability and computation time
- Consider smallest class size when choosing
RandomState
u64Seed for reproducible stratified splits. Ensures:
- Consistent fold assignments
- Reproducible results
- Comparable experiments
- Systematic validation
Fixed seed guarantees identical stratified splits.
Shuffle
boolData shuffling before stratified splitting. Impact:
- true: Randomizes while maintaining stratification
- false: Maintains data order within strata
Use cases:
- true: Independent observations
- false: Grouped or sequential data
Class proportions maintained regardless of setting.
Random permutation cross-validator with independent sampling.
Characteristics:
- Random sampling for each split
- Independent train/test sets
- More flexible than K-fold
- Can have overlapping test sets
Advantages:
- Control over test size
- Fresh splits each iteration
- Good for large datasets
Limitations:
- Some samples might never be tested
- Others might be tested multiple times
- No guarantee of complete coverage
NSplits
u32Number of random splits to perform. Consider: Common values:
- 5: Standard evaluation
- 10: More thorough assessment
- 3: Quick estimates
Trade-offs:
- More splits: Better estimation, longer runtime
- Fewer splits: Faster, less stable estimates
Balance between computation and stability.
RandomState
u64Random seed for reproducible shuffling. Controls:
- Split randomization
- Sample selection
- Result reproducibility
Important for:
- Debugging
- Comparative studies
- Result verification
TestSize
f64Proportion of samples for test set. Guidelines: Common ratios:
- 0.2: Standard (80/20 split)
- 0.25: More validation emphasis
- 0.1: More training data
Considerations:
- Dataset size
- Model complexity
- Validation requirements
It must be between 0.0 and 1.0.
Stratified random permutation cross-validator combining shuffle-split with stratification.
Features:
- Maintains class proportions
- Random sampling within strata
- Independent splits
- Flexible test size
Ideal for:
- Imbalanced datasets
- Large-scale problems
- When class distributions matter
- Flexible validation schemes
NSplits
u32Number of stratified random splits. Guidelines: Recommended values:
- 5: Standard evaluation
- 10: Detailed analysis
- 3: Quick assessment
Consider:
- Sample size per class
- Computational resources
- Stability requirements
RandomState
u64Seed for reproducible stratified sampling. Ensures:
- Consistent class proportions
- Reproducible splits
- Comparable experiments
Critical for:
- Benchmarking
- Research studies
- Quality assurance
TestSize
f64Fraction of samples for stratified test set. Best practices: Common splits:
- 0.2: Balanced evaluation
- 0.3: More thorough testing
- 0.15: Preserve training size
Consider:
- Minority class size
- Overall dataset size
- Validation objectives
It must be between 0.0 and 1.0.
Time Series cross-validator. Provides train/test indices to split time series data samples that are observed at fixed time intervals, in train/test sets. It is a variation of k-fold which returns first k
folds as train set and the k + 1
th fold as test set. Note that unlike standard cross-validation methods, successive training sets are supersets of those that come before them. Also, it adds all surplus data to the first training partition, which is always used to train the model.
Key features:
- Maintains temporal dependence
- Expanding window approach
- Forward-chaining splits
- No future data leakage
Use cases:
- Sequential data
- Financial forecasting
- Temporal predictions
- Time-dependent patterns
Note: Training sets are supersets of previous iterations.
NSplits
u32Number of temporal splits. Considerations: Typical values:
- 5: Standard forward chaining
- 3: Limited historical data
- 10: Long time series
Impact:
- Affects training window growth
- Determines validation points
- Influences computational load
MaxTrainSize
u64Maximum size of training set. Should be strictly less than the number of samples. Applications:
- 0: Use all available past data
- >0: Rolling window of fixed size
Use cases:
- Limit historical relevance
- Control computational cost
- Handle concept drift
- Memory constraints
TestSize
u64Number of samples in each test set. When 0:
- Auto-calculated as n_samples/(n_splits+1)
- Ensures equal-sized test sets
Considerations:
- Forecast horizon
- Validation requirements
- Available future data
Gap
u64Number of samples to exclude from the end of each train set before the test set.Gap between train and test sets. Uses:
- Avoid data leakage
- Model forecast lag
- Buffer periods
Common scenarios:
- 0: Continuous prediction
- >0: Forward gap for realistic evaluation
- Match business forecasting needs