Skip to main content

Performance analysis of predictive (alpha) stock factors

Project description

PyPI Anaconda Tests PyPI Coverage Status GitHub issues PyPI - License Discourse users Twitter Follow

Alphalens is a Python library for performance analysis of predictive (alpha) stock factors. Alphalens works great with the Zipline open source backtesting library, and Pyfolio which provides performance and risk analysis of financial portfolios.

The main function of Alphalens is to surface the most relevant statistics and plots about an alpha factor, including:

  • Returns Analysis
  • Information Coefficient Analysis
  • Turnover Analysis
  • Grouped Analysis

Getting started

With a signal and pricing data creating a factor "tear sheet" is a two step process:

import alphalens

# Ingest and format data
factor_data = alphalens.utils.get_clean_factor_and_forward_returns(my_factor,
                                                                   pricing,
                                                                   quantiles=5,
                                                                   groupby=ticker_sector,
                                                                   groupby_labels=sector_names)

# Run analysis
alphalens.tears.create_full_tear_sheet(factor_data)

Learn more

Check out the example notebooks for more on how to read and use the factor tear sheet.

Installation

Install with pip:

pip install alphalens-reloaded

Install with conda:

conda install -c ml4t alphalens-reloaded

Install from the master branch of Alphalens repository (development code):

pip install git+https://github.com/stefan-jansen/alphalens-reloaded

Alphalens depends on:

Note that Numpy>=2.0 requires pandas>=2.2.2. If you are using an older version of pandas, you may need to upgrade accordingly, otherwise you may encounter compatibility issues.

Usage

A good way to get started is to run the examples in a Jupyter notebook.

To get set up with an example, you can:

Run a Jupyter notebook server via:

jupyter notebook

From the notebook list page(usually found at http://localhost:8888/), navigate over to the examples directory, and open any file with a .ipynb extension.

Execute the code in a notebook cell by clicking on it and hitting Shift+Enter.

Questions?

If you find a bug, feel free to open an issue on our github tracker.

Contribute

If you want to contribute, a great place to start would be the help-wanted issues.

Credits

For a full list of contributors see the contributors page.

Example Tear Sheets

Example factor courtesy of ExtractAlpha

Peformance Metrics Tables

image

Returns Tear Sheet

image

Information Coefficient Tear Sheet

image

Sector Tear Sheet

image

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

alphalens_reloaded-0.4.6.tar.gz (94.6 kB view details)

Uploaded Source

Built Distribution

alphalens_reloaded-0.4.6-py3-none-any.whl (63.1 kB view details)

Uploaded Python 3

File details

Details for the file alphalens_reloaded-0.4.6.tar.gz.

File metadata

  • Download URL: alphalens_reloaded-0.4.6.tar.gz
  • Upload date:
  • Size: 94.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for alphalens_reloaded-0.4.6.tar.gz
Algorithm Hash digest
SHA256 24fe8cc289965e53b22cef91f1060b8ef9ab2561b4b37752d3d068f31b4ce744
MD5 85125385b6d77c620da46ced46202861
BLAKE2b-256 3d6c052bf919e25928d60b624cc5a57c4f3a2779c3b63604328b79d7db7e18e9

See more details on using hashes here.

File details

Details for the file alphalens_reloaded-0.4.6-py3-none-any.whl.

File metadata

File hashes

Hashes for alphalens_reloaded-0.4.6-py3-none-any.whl
Algorithm Hash digest
SHA256 02ad352449752b5c8fc02a1eba1572a400f484f50b4a0bf0780d78822e8486fb
MD5 80d8f8612ffefdf081999d62b2798417
BLAKE2b-256 46105c53e7b8984de8c75b67e1677b1ec2d24756ff9de25335209ab7b9c73728

See more details on using hashes here.

Supported by

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