Skip to main content

Performance analysis of predictive (alpha) stock factors

Project description

基于alphalens-reloaded新增功能

安装

pip install alphalens-cn

原仓库信息

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

新增功能

# tear_sheet输出到html中,使用示例
create_full_tear_sheet_html(
    ret,
    long_short=False,
    group_neutral=False,
    by_group=False,
    output_file='factor_analysis.html'
)

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_cn-0.4.8.tar.gz (104.9 kB view details)

Uploaded Source

Built Distribution

alphalens_cn-0.4.8-py3-none-any.whl (70.4 kB view details)

Uploaded Python 3

File details

Details for the file alphalens_cn-0.4.8.tar.gz.

File metadata

  • Download URL: alphalens_cn-0.4.8.tar.gz
  • Upload date:
  • Size: 104.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.0

File hashes

Hashes for alphalens_cn-0.4.8.tar.gz
Algorithm Hash digest
SHA256 635b83e76a789158a87d57db34403797d70452e2609849d861c0d2af94f5c53a
MD5 396522014ea8906db80d4ee2122ce584
BLAKE2b-256 fe2dc0a1cd0cb7f096a8fa1a79f077a6b7048f2403cc08a993086c1e28a7f6cb

See more details on using hashes here.

File details

Details for the file alphalens_cn-0.4.8-py3-none-any.whl.

File metadata

  • Download URL: alphalens_cn-0.4.8-py3-none-any.whl
  • Upload date:
  • Size: 70.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.0

File hashes

Hashes for alphalens_cn-0.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 2807b1cda9e973724fefdc8f171cd51be1330d0dec9e0d96bc3567f8d11d7666
MD5 02d42f3afcb4c657cdff08ae34397b19
BLAKE2b-256 e2c6e6c69ad3ed0ca7e6eff253ebddd1c83323f65042b558d83db5bf758d21f4

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