Skip to content

Installation

Requirements

  • Python: 3.6+
  • Pip Dependencies: attrs, deepspeed, fairscale, horovod, mypy_extensions (python_version < '3.8'), torch
  • Optional Pip Dependencies: mpi4py
  • Build Dependencies: apex (NVIDIA)
  • Tested OS: Unix (Ubuntu 16.04, Ubuntu 18.04), OSX (10.14.6)

(Required for FP16 Support) Install NVIDIA Apex

If you are planning on using mixed-precision (aka FP16), please install Apex so that stoke supports all FP16 methods. If you are not planning on using mixed precision, this step can actually be skipped (as all imports are in a try/except and are only conditionally imported).

Follow the instructions here.

(Optional) OpenMPI Support

Follow the instructions here or here

Also, refer to the Dockerfile here

PyPi

pip install stoke

PyPi From Source

pip install git+https://github.com/fidelity/stoke

Build From Source

git clone https://github.com/fidelity/stoke
cd stoke
pip install setuptools wheel
python setup.py bdist_wheel
pip install /dist/stoke-X.X.XxX-py3-none-any.whl
Back to top