How x512/getfactormodels works
getfactormodels is a Python library and CLI for retrieving financial factor-model data, portfolio sorts, and anomaly datasets. Users request a model or dataset, the API/CLI constructs the appropriate source implementation, which retrieves and parses provider data into Arrow tables for filtering, combining, and export. The graph preserves documented model families and the portfolio/anomaly branches. Some subsystem links are documented only at package level; unsampled implementations are represented by their exact tree paths, and uncertain call links are omitted.
Main entry points: base.py Model lifecycle · main.py Python API · q_factors.py Global-Q models · ff_portfolios.py FF portfolio sorts
Components 23
User entry points
- Python API
src/getfactormodels/main.py - Command-line interface
src/getfactormodels/utils/cli.py
Data products
- Fama–French factors
src/getfactormodels/models/fama_french.py - AQR factors
src/getfactormodels/models/aqr_models.py - Global-Q models
src/getfactormodels/models/q_factors.py - JKP anomalies
src/getfactormodels/models/jkp.py - Other factor families
src/getfactormodels/models - FF portfolio sorts
src/getfactormodels/models/ff_portfolios.py - FF breakpoints
src/getfactormodels/models/ff_breakpoints.py - Industry portfolios
src/getfactormodels/models/ff_industries.py
Model catalog
- Model registry
src/getfactormodels/registry/model_registry.py - Q dataset catalog
src/getfactormodels/registry/_q.py - JKP dataset catalog
src/getfactormodels/registry/_jkp.py
Retrieval and processing
- Model lifecycle
src/getfactormodels/models/base.py - HTTP retrieval
src/getfactormodels/utils/http_client.py - Download cache
src/getfactormodels/utils/cache.py - Arrow processing
src/getfactormodels/utils/arrow_utils.py - Date processing
src/getfactormodels/utils/date_utils.py
Other components
- Python user
- CLI user
- Dataset providers
- Arrow tables
- File or dataframe
Connections 27
- Python user → Python API: requests data
README.md - CLI user → Command-line interface: submits options
README.md - Command-line interface → Python API: constructs requests
src/getfactormodels/utils/cli.py - Python API → Model registry: resolves models
src/getfactormodels/main.py - Python API → FF portfolio sorts: constructs sorts
src/getfactormodels/main.py - Python API → Industry portfolios: constructs industries
src/getfactormodels/main.py - Python API → Global-Q models: constructs Q models
src/getfactormodels/main.py - Model registry → Q dataset catalog: uses catalog
- Model registry → JKP dataset catalog: uses catalog
- Fama–French factors → Model lifecycle: extends lifecycle
src/getfactormodels/models/fama_french.py - AQR factors → Model lifecycle: extends lifecycle
src/getfactormodels/models/aqr_models.py - Global-Q models → Model lifecycle: extends lifecycle
src/getfactormodels/models/q_factors.py - JKP anomalies → Model lifecycle: extends lifecycle
src/getfactormodels/models/jkp.py - Other factor families → Model lifecycle: shares lifecycle
src/getfactormodels/models/q_factors.py - FF portfolio sorts → Model lifecycle: extends portfolio base
src/getfactormodels/models/ff_portfolios.py - FF portfolio sorts → FF breakpoints: uses breakpoints
src/getfactormodels/models/ff_portfolios.py - Model lifecycle → HTTP retrieval: retrieves data
src/getfactormodels/models/base.py - HTTP retrieval → Download cache: reads and writes
src/getfactormodels/utils/http_client.py - Fama–French factors → Dataset providers: downloads from
README.md - AQR factors → Dataset providers: downloads from
README.md - Global-Q models → Dataset providers: downloads from
README.md - Model lifecycle → Arrow processing: processes tables
src/getfactormodels/models/base.py - Model lifecycle → Date processing: normalizes dates
src/getfactormodels/models/base.py - Global-Q models → Q dataset catalog: resolves dataset slugs
src/getfactormodels/models/q_factors.py - JKP anomalies → JKP dataset catalog: uses factor catalog
src/getfactormodels/models/jkp.py - Python API → Arrow tables: returns datasets
README.md - Arrow tables → File or dataframe: exports or converts
README.md