Skip to main content

ATR-adaptive Laguerre RSI for non-anticipative feature engineering in seq-2-seq forecasting

Project description

ATR-Adaptive Laguerre RSI

Non-anticipative volatility-adaptive momentum indicator for sequence-to-sequence forecasting.

Overview

This library implements the ATR-Adaptive Laguerre RSI indicator, designed for robust feature engineering in financial time series forecasting. The indicator combines:

  • True Range (TR) - Volatility measurement including gaps
  • ATR with Min/Max Tracking - Rolling volatility envelope
  • Adaptive Coefficient - Volatility-normalized adaptation
  • Laguerre 4-Stage Cascade - Low-lag smoothing filter
  • Laguerre RSI - Momentum from filter stage differences

Key Features

  • Non-anticipative: Guaranteed no lookahead bias
  • O(1) Incremental: Efficient streaming updates with .update() method
  • Multi-interval: Supports 1s-1d timeframes with 85-feature extraction (133 without filtering)
  • Redundancy filtering: Optional 133→85 feature reduction (|ρ| > 0.9 removed)
  • Flexible datetime: Works with DatetimeIndex, 'date' column, or custom column names
  • Validated: Information coefficient > 0.03 on k-step-ahead returns

Installation

uv add atr-adaptive-laguerre

Feature Modes: Choose Your Use Case

This package supports two operational modes with very different capabilities:

Mode Features Lookback Use Case
Multi-Interval (Recommended) 85 360 bars Production ML pipelines - includes cross-timeframe analysis
Single-Interval 31 30 bars Minimal data requirements or single-timeframe analysis

⚠️ Important: Multi-Interval Mode is Recommended

If you're building ML features, you want multi-interval mode (85 features), which includes:

  • Base interval features (31)
  • First multiplier interval features (31)
  • Second multiplier interval features (31)
  • Cross-interval analysis features (40) ← Unique to multi-interval mode!
  • Redundancy filtered: 133 → 85 features (48 redundant features removed)

Cross-interval features detect multi-timeframe patterns like:

  • Regime alignment across timeframes
  • Divergence detection
  • Momentum cascades
  • Gradient analysis
  • Statistical stability metrics

Quick Start

Multi-Interval Mode (Recommended - 85 Features)

from atr_adaptive_laguerre import ATRAdaptiveLaguerreRSI, ATRAdaptiveLaguerreRSIConfig

# RECOMMENDED: Use multi-interval mode for full feature set
config = ATRAdaptiveLaguerreRSIConfig.multi_interval(
    multiplier_1=4,   # 4x base interval (e.g., 2h → 8h)
    multiplier_2=12   # 12x base interval (e.g., 2h → 24h)
)
indicator = ATRAdaptiveLaguerreRSI(config)

# Extract 85 features across 3 timeframes (31 per interval + 40 cross-interval, filtered)
features_df = indicator.fit_transform_features(df)

print(f"Features extracted: {indicator.n_features}")  # 85
print(f"Min data required: {indicator.min_lookback_base_interval} bars")  # 360

Single-Interval Mode (Minimal Lookback - 31 Features)

Use this mode only if you have limited historical data or need single-timeframe analysis:

from atr_adaptive_laguerre import ATRAdaptiveLaguerreRSI, ATRAdaptiveLaguerreRSIConfig

# Single-interval mode (WARNING: only 31 features, missing cross-timeframe analysis)
config = ATRAdaptiveLaguerreRSIConfig.single_interval(
    atr_period=14,
    smoothing_period=5,
    date_column='date'  # Or use DatetimeIndex
)
indicator = ATRAdaptiveLaguerreRSI(config)

# Get single RSI value
rsi_series = indicator.fit_transform(df)  # Returns pd.Series (single RSI column)

# Or get 31 single-interval features
features_df = indicator.fit_transform_features(df)  # Returns DataFrame with 31 columns

print(f"Features extracted: {indicator.n_features}")  # 31
print(f"Min data required: {indicator.min_lookback} bars")  # 30

Advanced: Incremental Updates (O(1) Streaming)

Both modes support efficient incremental updates:

# After initial fit_transform
new_row = {'open': 100, 'high': 101, 'low': 99, 'close': 100.5, 'volume': 1000}
new_rsi = indicator.update(new_row)  # Returns float (O(1) complexity)

Disabling Redundancy Filtering (85 → 133 Features)

# Disable redundancy filtering to get all 133 features
config = ATRAdaptiveLaguerreRSIConfig.multi_interval(
    multiplier_1=4,
    multiplier_2=12,
    filter_redundancy=False  # Get all 133 features
)
feature = ATRAdaptiveLaguerreRSI(config)

# Returns DataFrame with 133 columns (all features, including 48 redundant ones)
features_df = feature.fit_transform_features(df)

# Verify feature count
print(f"Features: {feature.n_features}")  # 133 (85 by default)

# Redundancy filtering (enabled by default):
# - Data: 3 years of 2h OHLCV (BTCUSDT, ETHUSDT, SOLUSDT)
# - Threshold: |ρ| > 0.9 (perfect correlations and near-redundant features)
# - Removes: Base RSI values, redundant distance metrics, duplicate regime features
# - Retains: Rate-of-change, cross-interval, temporal features, and tail risk features
# - IC validation: Tail risk features validated on out-of-sample data (2025-10-08)

Documentation

License

MIT License - Eon Labs Ltd.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

atr_adaptive_laguerre-1.0.12.tar.gz (273.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

atr_adaptive_laguerre-1.0.12-py3-none-any.whl (50.3 kB view details)

Uploaded Python 3

File details

Details for the file atr_adaptive_laguerre-1.0.12.tar.gz.

File metadata

File hashes

Hashes for atr_adaptive_laguerre-1.0.12.tar.gz
Algorithm Hash digest
SHA256 c90a52f95e2a122d6b1a52b3ed24c1c62598de403ea99caf47b3eb6c6795d1e2
MD5 88c0f0998662855ce16d3d490cb91498
BLAKE2b-256 44eb8a5680b878d80273a46defbda1c3d4e5393f0dbbca34aec2bc365264205b

See more details on using hashes here.

File details

Details for the file atr_adaptive_laguerre-1.0.12-py3-none-any.whl.

File metadata

File hashes

Hashes for atr_adaptive_laguerre-1.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 a5cce35873e4f5189fa2c7a7b1d98c9ea4d6b9d7bc9ed07a5334927863ff2ec4
MD5 fb9c25408406d038ca99dadd9e844bd0
BLAKE2b-256 90418f0571924af7977d5491ca0460a009e64e0a1c7937e216e2b43c03b13444

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page