vectorbt 0.15.1

Python library for backtesting and analyzing trading strategies at scale

vectorbt

vectorbt is a backtesting library on steroids - it operates entirely on pandas and NumPy objects, and is accelerated by Numba to analyze trading strategies at speed and scale :fire:

In contrast to conventional libraries, vectorbt represents trading data as nd-arrays. This enables superfast computation using vectorized operations with NumPy and non-vectorized but compiled operations with Numba. It also integrates plotly.py and ipywidgets to display complex charts and dashboards akin to Tableau right in the Jupyter notebook. Due to high performance, vectorbt is able to process large amounts of data even without GPU and parallelization (both are work in progress), and enable the user to interact with data-hungry widgets without significant delays.

With vectorbt you can

• Analyze time series and engineer features
• Supercharge pandas and your favorite tools to run much faster
• Test many strategies, configurations, assets, and time ranges in one go
• Test machine learning models
• Build interactive charts/dashboards without leaving Jupyter

Installation

pip install vectorbt

See Jupyter Notebook and JupyterLab Support for Plotly figures.

Example

You can start backtesting with just a couple of lines.

Here is how much profit we would have made if we invested $100 into Bitcoin in 2014:

import yfinance as yf
import numpy as np
import pandas as pd
import vectorbt as vbt

price = yf.Ticker('BTC-USD').history(period='max')['Close']
size = pd.Series.vbt.empty_like(price, 0.)
size.iloc[0] = np.inf  # go all in
portfolio = vbt.Portfolio.from_orders(price, size, init_cash=100.)
portfolio.total_profit()

4065.1702287767293

And here is the crossover of 10-day SMA and 50-day SMA under the same conditions:

fast_ma = vbt.MA.run(price, 10)
slow_ma = vbt.MA.run(price, 50)
entries = fast_ma.ma_above(slow_ma, crossed=True)
exits = fast_ma.ma_below(slow_ma, crossed=True)
portfolio = vbt.Portfolio.from_signals(price, entries, exits, size=np.inf, init_cash=100.)
portfolio.total_profit()

6302.288201465419

For fans of hyperparameter optimization, here is a snippet for testing 10,000 window combinations of a dual SMA crossover strategy on BTC, USD and XRP from 2017 onwards, in under 5 seconds (Note: first time compiling with Numba may take a while):

# Define your params
assets = ["BTC-USD", "ETH-USD", "LTC-USD"]
yf_kwargs = dict(start='2017-1-1')
windows = np.arange(2, 101)
portfolio_kwargs = dict(size=np.inf, fees=0.001, freq='1D')

# Fetch daily price
price = {}
for asset in assets:
    price[asset] = yf.Ticker(asset).history(**yf_kwargs)['Close']
price = pd.DataFrame(price)
price.columns.name = 'asset'

# Compute moving averages for all combinations of fast and slow windows
fast_ma, slow_ma = vbt.MA.run_combs(price, window=windows, r=2, short_names=['fast', 'slow'])

# Generate crossover signals for each combination
entries = fast_ma.ma_above(slow_ma, crossed=True)
exits = fast_ma.ma_below(slow_ma, crossed=True)

# Run simulation
portfolio = vbt.Portfolio.from_signals(price, entries, exits, **portfolio_kwargs)

# Get total return, reshape to symmetric matrix, and plot the whole thing
fig = portfolio.total_return().vbt.heatmap(
    x_level='fast_window', y_level='slow_window', slider_level='asset', symmetric=True,
    trace_kwargs=dict(colorbar=dict(title='Total return', tickformat='%')))
fig.show()

Digging into each strategy configuration is as simple as indexing with pandas:

portfolio[(10, 20, 'ETH-USD')].stats()

Start                     2016-12-31 00:00:00
End                       2020-12-03 00:00:00
Duration                   1434 days 00:00:00
Init. Cash                                100
Total Profit                          51417.2
Total Return [%]                      51417.2
Benchmark Return [%]                  7594.86
Position Coverage [%]                 56.0669
Max. Drawdown [%]                     70.7334
Avg. Drawdown [%]                     9.70672
Max. Drawdown Duration      760 days 00:00:00
Avg. Drawdown Duration       29 days 12:00:00
Num. Trades                                33
Win Rate [%]                          57.5758
Best Trade [%]                        477.295
Worst Trade [%]                      -27.7724
Avg. Trade [%]                        36.1783
Max. Trade Duration          79 days 00:00:00
Avg. Trade Duration          22 days 16:00:00
Expectancy                            929.696
SQN                                    1.7616
Gross Exposure                       0.560669
Sharpe Ratio                          2.30658
Sortino Ratio                          4.1649
Calmar Ratio                          5.51501
Name: (10, 20, ETH-USD), dtype: object

portfolio[(10, 20, 'ETH-USD')].plot().show()

Motivation

While there are many other great backtesting packages for Python, vectorbt is more of a data science tool: it excels at processing performance and offers interactive tools to explore complex phenomena in trading. With it you can traverse a huge number of strategy configurations, time periods and instruments in little time, to explore where your strategy performs best and to uncover hidden patterns in data.

Take a simple Dual Moving Average Crossover strategy as example. By calculating the performance of each reasonable window combination and plotting the whole thing as a heatmap (as we do above), we can analyze how performance depends upon window size. If we additionally compute the same heatmap over multiple time periods, we may observe how performance varies with downtrends and uptrends. Finally, by running the same pipeline over other strategies such as holding and trading randomly, we can compare them and decide whether our strategy is worth executing. With vectorbt, this analysis can be done in minutes and save time and cost of getting the same insights elsewhere.

How it works?

vectorbt combines pandas, NumPy and Numba sauce to obtain orders-of-magnitude speedup over other libraries. It natively works on pandas objects, while performing all computations using NumPy and Numba under the hood. This way, it is often much faster than pandas alone:

>>> import numpy as np
>>> import pandas as pd
>>> import vectorbt as vbt

>>> big_ts = pd.DataFrame(np.random.uniform(size=(1000, 1000)))

# pandas
>>> %timeit big_ts.expanding().max()
48.4 ms ± 557 µs per loop (mean ± std. dev. of 7 runs, 10 loops each)

# vectorbt
>>> %timeit big_ts.vbt.expanding_max()
8.82 ms ± 121 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)

In contrast to most other similar backtesting libraries where backtesting is limited to simple arrays (price, signals, etc.), vectorbt is optimized for working with multi-dimensional data: it treats index of a DataFrame as time axis and columns as distinct features that should be backtest, and performs computations on the entire matrix at once, without slow Python loops.

To make the library easier to use, vectorbt introduces a namespace (accessor) to pandas objects (see extending pandas). This way, user can easily switch between pandas and vectorbt functionality. Moreover, each vectorbt method is flexible towards inputs and can work on both Series and DataFrames.

Features

• Extends pandas using a custom vbt accessor -> Compatible with any library
• For high performance, most operations are done strictly using NumPy and Numba -> Much faster than comparable operations in pandas

# pandas
>>> %timeit big_ts + 1
242 ms ± 3.58 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)

# vectorbt
>>> %timeit big_ts.vbt + 1
3.32 ms ± 19.7 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)

• Helper functions for combining, transforming, and indexing NumPy and pandas objects
  • NumPy-like broadcasting for pandas, among other features

# pandas
>>> pd.Series([1, 2, 3]) + pd.DataFrame([[1, 2, 3]])
   0  1  2
0  2  4  6

# vectorbt
>>> pd.Series([1, 2, 3]).vbt + pd.DataFrame([[1, 2, 3]])
   0  1  2
0  2  3  4
1  3  4  5
2  4  5  6

• Compiled versions of common pandas functions, such as rolling, groupby, and resample

# pandas
>>> %timeit big_ts.rolling(2).apply(np.mean, raw=True)
7.32 s ± 431 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)

# vectorbt
>>> mean_nb = njit(lambda col, i, x: np.mean(x))
>>> %timeit big_ts.vbt.rolling_apply(2, mean_nb)
86.2 ms ± 7.97 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)

• Drawdown analysis

>>> pd.Series([2, 1, 3, 2]).vbt.drawdowns().plot().show()

• Functions for working with signals
  • Entry, exit and random signal generation
  • Ranking and distance functions

>>> pd.Series([False, True, True, True]).vbt.signals.first()
0    False
1     True
2    False
3    False
dtype: bool

• Signal factory for building iterative signal generators
  • Also includes a range of basic generators such for random signals

>>> rand = vbt.RAND.run(n=[0, 1, 2], input_shape=(6,), seed=42)
>>> rand.entries
rand_n      0      1      2
0       False   True   True
1       False  False  False
2       False  False  False
3       False  False   True
4       False  False  False
5       False  False  False
>>> rand.exits
rand_n      0      1      2
0       False  False  False
1       False  False   True
2       False  False  False
3       False   True  False
4       False  False   True
5       False  False  False

• Functions for working with returns
  • Compiled versions of metrics found in empyrical

>>> pd.Series([0.01, -0.01, 0.01]).vbt.returns(freq='1D').sharpe_ratio()
5.515130702591433

• Class for modeling portfolios
  • Accepts signals, orders, and custom order function
  • Supports long and short positions
  • Supports individual and multi-asset mixed portfolios
  • Provides metrics and tools for analyzing returns, orders, trades and positions

>>> price = [1., 2., 3., 2., 1.]
>>> entries = [True, False, True, False, False]
>>> exits = [False, True, False, True, False]
>>> portfolio = vbt.Portfolio.from_signals(price, entries, exits, freq='1D')
>>> portfolio.trades().plot().show()

• A range of basic technical indicators with full Numba support
  • Moving average, Bollinger Bands, RSI, Stochastic, MACD, and more
  • Each offers methods for generating signals and plotting
  • Each allows arbitrary parameter combinations, from arrays to Cartesian products

>>> vbt.MA.run([1, 2, 3], window=[2, 3], ewm=[False, True]).ma
ma_window     2         3
ma_ewm    False      True 
0           NaN       NaN
1           1.5       NaN
2           2.5  2.428571

• Indicator factory for building complex technical indicators with ease
  • Supports TA-Lib indicators out of the box

>>> SMA = vbt.IndicatorFactory.from_talib('SMA')
>>> SMA.run([1., 2., 3.], timeperiod=[2, 3]).real
sma_timeperiod    2    3
0               NaN  NaN
1               1.5  NaN
2               2.5  2.0

• Interactive Plotly-based widgets to visualize backtest results
  • Full integration with ipywidgets for displaying interactive dashboards in Jupyter

>>> a = np.random.normal(0, 4, size=10000)
>>> pd.Series(a).vbt.box(horizontal=True, trace_kwargs=dict(boxmean='sd')).show()

Documentation

Example notebooks

• Assessing performance of DMAC on Bitcoin
• Comparing effectiveness of stop signals
• Backtesting per trading session

Note: you need to run the notebook to play with widgets.

Dashboards

• Detecting and backtesting common candlestick patterns

How to contribute

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

First, you need to install vectorbt from the repository:

pip uninstall vectorbt
git clone https://github.com/polakowo/vectorbt.git
cd vectorbt
pip install -e .

After making changes, make sure you did not break any functionality:

pytest

Please make sure to update tests as appropriate.

Disclaimer

This software is for educational purposes only. Do not risk money which you are afraid to lose. USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR TRADING RESULTS.