Quick Start

Installation

Amplify-BBOpt has been tested in environments where the Amplify SDK is available and Python version 3.10 or higher is installed.

First, check that your Python version meets this requirement:

$ python3 --version

You can install Amplify-BBOpt from PyPI using the following command:

$ python3 -m pip install -U amplify-bbopt

Note

If you want to use PyTorch implementations before version 1.3.0 (TorchFMTrainer and TorchFM), please install amplify-bbopt with the torch option:

$ python3 -m pip install -U "amplify-bbopt[torch]"

Once installed successfully, you can check the installed version as follows:

>>> import amplify_bbopt
>>> amplify_bbopt.__version__
1.3.0

API Token

To use the Ising machine available in Amplify-BBOpt, an API token for the Amplify Annealing Engine is required.

You can obtain this token for free by registering as an Amplify user.