Installation

Installation instructions for installing and using the shamboflow package.

Requirements

ShamboFlow can run on all devices irrespective of whether the system has a eligible GPU or not.

The package will use the GPU automatically if it finds a CUDA enabled GPU.

To use your GPU to perform operations, ensure CUDA toolkit is installed on your device.

Run the following command in your terminal to check for the version of the CUDA toolkit you have installed:

$ nvidia-smi

The package was tested with CUDA 12.x, but it should also work with 11.x

To use CUDA 11.x install the python package cupy-cuda11x along with shamboflow. (Maybe also remove cupy-cuda12x that installs along with this package.

---

Install

The easiest (and the only) way to install and use this package is to get it using pip.

$ pip install shamboflow

To update ShamboFlow to the latest version, add --upgrade flag to the above command.