Back to Community
plot_cumulative_returns taking 3 argument where document only has 2

plot_cumulative_returns function of the alphalens module

https://quantopian.github.io/alphalens/alphalens.html#alphalens.plotting.plot_cumulative_returns

takes 3 argument where document only has 2.
What is the correct way of using this function?

Thank you.

4 responses

actually I looked at the code and the third arg is pandas.Dateoffset object.

Hi,

I ran into this issue too. The documentation seems outdated.

Looking at the source code, the function takes indeed 3 non-optional arguments:
https://github.com/quantopian/alphalens/blob/master/alphalens/plotting.py#L714

def plot_cumulative_returns(factor_returns, period, freq, title=None, ax=None):  
    """  
    Plots the cumulative returns of the returns series passed in.  
    Parameters  
    ----------  
    factor_returns : pd.Series  
        Period wise returns of dollar neutral portfolio weighted by factor  
        value.  
    period: pandas.Timedelta or string  
        Length of period for which the returns are computed (e.g. 1 day)  
        if 'period' is a string it must follow pandas.Timedelta constructor  
        format (e.g. '1 days', '1D', '30m', '3h', '1D1h', etc)  
    freq : pandas DateOffset  
        Used to specify a particular trading calendar e.g. BusinessDay or Day  
        Usually this is inferred from utils.infer_trading_calendar, which is  
        called by either get_clean_factor_and_forward_returns or  
        compute_forward_returns  

I guess you need to add the 3rd argument 'freq'. Here is a working example, assuming you already have the first two parameters:

from pandas.tseries.offsets import BDay  
al.plotting.plot_cumulative_returns(factor_returns=factor_returns, period=period, freq=BDay())  

Hi all,

We are aware of this issue, and will be pushing a fix to the tutorial soon. We apologize for the confusion.

Disclaimer

The material on this website is provided for informational purposes only and does not constitute an offer to sell, a solicitation to buy, or a recommendation or endorsement for any security or strategy, nor does it constitute an offer to provide investment advisory services by Quantopian. In addition, the material offers no opinion with respect to the suitability of any security or specific investment. No information contained herein should be regarded as a suggestion to engage in or refrain from any investment-related course of action as none of Quantopian nor any of its affiliates is undertaking to provide investment advice, act as an adviser to any plan or entity subject to the Employee Retirement Income Security Act of 1974, as amended, individual retirement account or individual retirement annuity, or give advice in a fiduciary capacity with respect to the materials presented herein. If you are an individual retirement or other investor, contact your financial advisor or other fiduciary unrelated to Quantopian about whether any given investment idea, strategy, product or service described herein may be appropriate for your circumstances. All investments involve risk, including loss of principal. Quantopian makes no guarantees as to the accuracy or completeness of the views expressed in the website. The views are subject to change, and may have become unreliable for various reasons, including changes in market conditions or economic circumstances.

Just bumped into this error, thanks for clear things up