Installation

Installation Options

There are two alternatives to install the library:

  1. Install from the provided wheel package
  2. Build from the source code

Requirements

The library requires Python 3.6+. The requirements.txt lists the necessary packages. The following packages are used currently:

joblib
numpy
pandas
scikit-learn>=0.22.0
scipy
seaborn>=0.9.0

Wheel Package

The library is provided as a wheel package. You can install the library from the wheel package using the following commands:

git clone https://github.com/fidelity/mabwiser.git
cd mabwiser
pip install dist/mabwiser-X.X.X-py3-none-any.whl

Important

Don’t forget to replace X.X.X with the current version number.

Source Code

Alternatively, you can build a wheel package on your platform from scratch using the source code:

git clone https://github.com/fidelity/mabwiser.git
cd mabwiser
pip install setuptools wheel # if wheel is not installed
python setup.py bdist_wheel
pip install dist/mabwiser-X.X.X-py3-none-any.whl

Test Your Setup

To confirm that cloning was successful, run the tests included in the project.

All tests should pass.

git clone https://github.com/fidelity/mabwiser.git
cd mabwiser
python -m unittest discover tests

To confirm that installation was successful, try importing MABWiser in a Python shell or notebook.

from mabwiser.mab import MAB, LearningPolicy, NeighborhoodPolicy

For examples of how to use the library, refer to Usage Examples.

Upgrade the Library

To upgrade to the latest version of the library, run git pull origin master in the repo folder, and then run pip install --upgrade --no-cache-dir dist/mabwiser-X.X.X-py3-none-any.whl.