============
Installation
============

Installation is extremely straightforward via pip::

    $ pip install qhoptim

Or, install directly from source::

    $ git clone https://github.com/facebookresearch/qhoptim.git
    $ cd qhoptim
    $ pip install .

Dependencies
============

You must have Python 3.6 or above to use this library.

The PyTorch component of this library works with PyTorch 1.0 or newer.

The TensorFlow component of this library works with TensorFlow 1.12 or newer.

Uninstallation
==============

Uninstallation is similarly straightforward::

   $ pip uninstall qhoptim