dfm-python 0.4.8__tar.gz → 0.5.0__tar.gz

dfm_python-0.5.0/PKG-INFO

@@ -0,0 +1,393 @@
+Metadata-Version: 2.4
+Name: dfm-python
+Version: 0.5.0
+Summary: Dynamic Factor Model (DFM) estimation and nowcasting in Python
+Project-URL: Homepage, https://github.com/yourusername/dfm-python
+Project-URL: Documentation, https://github.com/yourusername/dfm-python#readme
+Project-URL: Repository, https://github.com/yourusername/dfm-python
+Project-URL: Issues, https://github.com/yourusername/dfm-python/issues
+Author: DFM Python Contributors
+License: MIT
+License-File: LICENSE
+Keywords: dfm,dynamic-factor-model,econometrics,forecasting,nowcasting,time-series
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Requires-Dist: hydra-core>=1.3.2
+Requires-Dist: matplotlib>=3.5.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: pyarrow>=22.0.0
+Requires-Dist: pytorch-lightning>=2.0.0
+Requires-Dist: scikit-learn>=1.7.2
+Requires-Dist: scipy>=1.10.0
+Requires-Dist: sktime>=0.40.1
+Requires-Dist: torch>=2.0.0
+Requires-Dist: twine>=6.2.0
+Provides-Extra: all
+Requires-Dist: hydra-core>=1.3.0; extra == 'all'
+Requires-Dist: omegaconf>=2.3.0; extra == 'all'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'all'
+Requires-Dist: pytest>=7.0.0; extra == 'all'
+Requires-Dist: scikit-learn>=1.0.0; extra == 'all'
+Requires-Dist: sktime>=0.27.0; extra == 'all'
+Requires-Dist: sqlalchemy>=2.0.0; extra == 'all'
+Provides-Extra: db
+Requires-Dist: sqlalchemy>=2.0.0; extra == 'db'
+Provides-Extra: deep
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: scikit-learn>=1.0.0; extra == 'dev'
+Provides-Extra: forecasting
+Requires-Dist: sktime[forecasting]>=0.40.1; extra == 'forecasting'
+Provides-Extra: hydra
+Requires-Dist: hydra-core>=1.3.0; extra == 'hydra'
+Requires-Dist: omegaconf>=2.3.0; extra == 'hydra'
+Provides-Extra: transform
+Requires-Dist: sktime>=0.27.0; extra == 'transform'
+Description-Content-Type: text/markdown
+
+# dfm-python: Dynamic Factor Models for Python
+
+[![PyPI version](https://img.shields.io/pypi/v/dfm-python.svg)](https://pypi.org/project/dfm-python/)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+
+A comprehensive Python implementation of **Dynamic Factor Models (DFM)** and **Deep Dynamic Factor Models (DDFM)** for forecasting high-dimensional time series. Built with PyTorch Lightning for production-ready training and inference.
+
+## Features
+
+### Core Capabilities
+- ✅ **Mixed-frequency data**: Monthly, quarterly, semi-annual, annual series in one model
+- ✅ **Clock-based framework**: All factors evolve at a common clock frequency
+- ✅ **Block structure**: Flexible factor organization (global + sector-specific factors)
+- ✅ **Idiosyncratic components**: Per-series state augmentation for better fit
+- ✅ **Preprocessed data**: Users handle preprocessing (imputation, scaling) using sktime or other tools
+- ✅ **Forecasting**: Generate predictions for any horizon
+- ✅ **Nowcasting**: Estimate current period values using incomplete data
+- ✅ **Deep DFM (DDFM)**: Nonlinear encoder with PyTorch for capturing complex factor structures
+
+### Technical Features
+- ✅ **PyTorch Lightning**: Standard training interface with DataModule and Trainer
+- ✅ **Multiple configuration methods**: YAML files, Python dictionaries, or Hydra
+- ✅ **Advanced numerical stability**: Adaptive regularization, spectral radius capping, variance floors
+- ✅ **Production-ready**: Comprehensive error handling, extensive testing, well-documented
+
+## Installation
+
+```bash
+pip install dfm-python
+```
+
+**Requirements**: 
+- Python >= 3.10
+- numpy >= 1.24.0
+- pandas >= 2.0.0
+- scipy >= 1.10.0
+- pytorch-lightning >= 2.0.0
+- torch >= 2.0.0
+- sktime >= 0.40.1
+
+## Quick Start
+
+### Example 1: Linear DFM
+
+```python
+from dfm_python import DFM, DFMDataModule, DFMTrainer
+import pandas as pd
+import numpy as np
+
+# Load and preprocess data
+df = pd.read_csv('data/macro.csv')
+df_processed = df[[col for col in df.columns if col != 'date']]
+
+# Create DataModule
+dm = DFMDataModule(
+    config_path='config/model/dfm.yaml',
+    data=df_processed
+)
+dm.setup()
+
+# Create model and load config
+model = DFM()
+model.load_config('config/model/dfm.yaml')
+
+# Create trainer and fit
+trainer = DFMTrainer(max_iter=10, threshold=1e-4)
+trainer.fit(model, dm)
+
+# Predict
+Xf, Zf = model.predict(horizon=6)
+```
+
+### Example 2: Deep DFM (DDFM)
+
+```python
+from dfm_python import DDFM, DFMDataModule, DDFMTrainer
+import pandas as pd
+
+# Load and preprocess data
+df = pd.read_csv('data/finance.csv')
+df_processed = df[[col for col in df.columns if col != 'date']]
+
+# Create DataModule
+dm = DFMDataModule(
+    config_path='config/model/ddfm.yaml',
+    data=df_processed
+)
+dm.setup()
+
+# Create DDFM model
+ddfm_model = DDFM(
+    encoder_layers=[64, 32],
+    num_factors=2,
+    learning_rate=0.005,
+    epochs=100
+)
+ddfm_model.load_config('config/model/ddfm.yaml')
+
+# Create trainer and fit
+trainer = DDFMTrainer(max_epochs=10)
+trainer.fit(ddfm_model, dm)
+
+# Predict
+Xf, Zf = ddfm_model.predict(horizon=6)
+```
+
+### Example 3: Nowcasting
+
+```python
+from dfm_python import DFM, DFMDataModule, DFMTrainer
+import pandas as pd
+
+# Load data and train model (same as above)
+df = pd.read_csv('data/macro.csv')
+df_processed = df[[col for col in df.columns if col != 'date']]
+
+dm = DFMDataModule(config_path='config/model/dfm.yaml', data=df_processed)
+dm.setup()
+
+model = DFM()
+model.load_config('config/model/dfm.yaml')
+
+trainer = DFMTrainer(max_iter=10, threshold=1e-4)
+trainer.fit(model, dm)
+
+# Nowcast a target series at a specific view date
+result = model.nowcast(
+    target_series='KOEQUIPTE',
+    view_date='2024-01-15'
+)
+
+print(f"Nowcast value: {result.nowcast_value}")
+print(f"Confidence interval: {result.confidence_interval}")
+```
+
+## Configuration
+
+### YAML Configuration (Recommended)
+
+Create a YAML configuration file:
+
+```yaml
+# config/model/dfm.yaml
+clock: m  # Monthly clock frequency
+blocks:
+  Block_Global:
+    factors: 2
+    ar_lag: 1
+    clock: m
+
+series:
+  - series_id: KOEQUIPTE
+    frequency: m
+    transformation: lin
+    blocks: [1]
+  - series_id: KOGDP___D
+    frequency: q
+    transformation: lin
+    blocks: [1]
+
+augment_idio: true
+augment_idio_slow: true
+```
+
+### Python Configuration
+
+```python
+from dfm_python.config import DFMConfig, SeriesConfig, BlockConfig
+
+config = DFMConfig(
+    clock='m',
+    series=[
+        SeriesConfig(series_id='series1', frequency='m', transformation='lin', blocks=[1]),
+        SeriesConfig(series_id='series2', frequency='q', transformation='lin', blocks=[1]),
+    ],
+    blocks={'Block_Global': BlockConfig(factors=2, ar_lag=1, clock='m')},
+    augment_idio=True,
+    augment_idio_slow=True
+)
+```
+
+## Data Format
+
+### CSV Format
+
+Your data CSV should have:
+- **First column**: `date` (YYYY-MM-DD format)
+- **Subsequent columns**: One per time series, column names must match `series_id` in configuration
+- **Missing values**: Empty cells or `NaN`
+
+**Example**:
+```csv
+date,KOEQUIPTE,KOGDP___D
+2000-01-01,100.2,
+2000-02-01,100.5,
+2000-03-01,100.8,100.5
+2000-04-01,101.0,
+```
+
+**Important**: 
+- Data must be preprocessed before passing to the package
+- Use sktime or other tools for imputation, scaling, and transformations
+- Quarterly series should only have values at quarter-end months
+
+## Tutorials
+
+The package includes tutorial scripts demonstrating complete workflows:
+
+```bash
+# Linear DFM tutorial
+python tutorial/tutorial_macro_dfm.py
+python tutorial/tutorial_finance_dfm.py
+
+# Deep DFM tutorial
+python tutorial/tutorial_macro_ddfm.py
+python tutorial/tutorial_finance_ddfm.py
+```
+
+## API Reference
+
+### Core Classes
+
+- **`DFM`**: Linear Dynamic Factor Model (EM algorithm)
+- **`DDFM`**: Deep Dynamic Factor Model (PyTorch encoder)
+- **`DFMDataModule`**: PyTorch Lightning DataModule for data handling
+- **`DFMTrainer`**: Trainer for DFM (EM algorithm)
+- **`DDFMTrainer`**: Trainer for DDFM (gradient descent)
+
+### Key Methods
+
+```python
+# Configuration
+model.load_config(source)  # Load from YAML, dict, or Hydra config
+
+# Training
+trainer.fit(model, datamodule)  # Standard Lightning pattern
+
+# Prediction
+Xf, Zf = model.predict(horizon=6)  # Forecast future values
+
+# Nowcasting
+result = model.nowcast(target_series, view_date)  # Estimate current period
+```
+
+### Result Objects
+
+```python
+# DFMResult / DDFMResult
+result.Z          # (T+1 × m) Smoothed factor estimates
+result.C          # (N × m) Factor loadings matrix
+result.A          # (m × m) Factor transition matrix
+result.Q          # (m × m) Innovation covariance
+result.R          # (N × N) Observation covariance
+result.converged  # bool: Convergence status
+result.num_iter   # int: Number of iterations
+
+# NowcastResult
+result.nowcast_value        # Estimated value
+result.confidence_interval  # Confidence interval
+result.factors_at_view     # Factor state at view date
+```
+
+## Architecture
+
+### Core Modules
+
+- **`models/`**: Model implementations
+  - `base.py`: BaseFactorModel (common interface)
+  - `dfm.py`: Linear DFM (EM algorithm)
+  - `ddfm.py`: Deep DFM (PyTorch encoder)
+  
+- **`ssm/`**: State-space model components
+  - `kalman.py`: Kalman filter and smoother
+  - `em.py`: EM algorithm implementation
+  
+- **`config/`**: Configuration management
+  - `schema.py`: Configuration dataclasses
+  - `results.py`: Result dataclasses
+  
+- **`lightning/`**: PyTorch Lightning integration
+  - `data_module.py`: DFMDataModule
+  - `scaling.py`: Data scaling utilities
+
+## Testing
+
+Run the test suite:
+
+```bash
+pytest src/test/ -v
+```
+
+Run specific tests:
+
+```bash
+pytest src/test/test_nowcast_implementation.py -v
+pytest src/test/test_models.py -v
+pytest src/test/test_trainer.py -v
+```
+
+## Troubleshooting
+
+### Convergence Issues
+
+- Increase `max_iter` in `DFMTrainer`
+- Relax `threshold` (default: 1e-4)
+- Check data quality and preprocessing
+
+### Numerical Instability
+
+- The package includes automatic stability features:
+  - Adaptive regularization for ill-conditioned matrices
+  - Spectral radius capping (< 0.99) for stationarity
+  - Variance floors for all covariance matrices
+
+### Missing Data
+
+- Preprocess data before passing to the package
+- Use sktime for imputation and scaling
+- Verify frequency settings match your data
+
+## Project Status
+
+**Version**: 0.4.9  
+**Status**: Stable and production-ready  
+**Python**: 3.10+  
+
+## License
+
+MIT License
+
+## Contributing
+
+Contributions are welcome! Please ensure:
+- All tests pass: `pytest src/test/ -q`
+- Code follows existing patterns and style
+- New features include tests
+- Documentation is updated