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:

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-tej-2.0.2.tar.gz (7.2 MB view details)

Uploaded Source

Built Distribution

alphalens_tej-2.0.2-py3-none-any.whl (42.2 kB view details)

Uploaded Python 3

File details

Details for the file alphalens-tej-2.0.2.tar.gz.

File metadata

  • Download URL: alphalens-tej-2.0.2.tar.gz
  • Upload date:
  • Size: 7.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for alphalens-tej-2.0.2.tar.gz
Algorithm Hash digest
SHA256 7cce4d393d51e070267a2565182f321d33455a4b80408d5dfc1d726d461af053
MD5 c67b14d19a9d21d7161268e4eaa82356
BLAKE2b-256 1644648c1522893ec3d6cb25ad11cf9d9a26ec2b04ef18a209efacb8ab28cf70

See more details on using hashes here.

File details

Details for the file alphalens_tej-2.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for alphalens_tej-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ce4c2b75687a8b95c5c2bbf619d24e8d5f193f9b511bd23e728f47af49072ddb
MD5 9d960b62ce1c8c011762789dfe0bce4b
BLAKE2b-256 ece57eada2225f1d17fc062a994d3297cc0edead2886786141d3aa103f006d3c

See more details on using hashes here.

Supported by

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