Forge Client Library

This package contains functions for easily interfacing with Forge.

Installation

To install with pip:

pip install qcware

To install from source, you must first install poetry. Then, execute the following:

git clone https://github.com/qcware/platform_client_library_python.git
cd platform_client_library_python
poetry build
cd dist
pip install qcware-7.0.0-py3-none-any.whl

API Key

To use the client library, you will need an API key. You can sign up for one at https://forge.qcware.com.

To access your API key, log in to Forge and navigate to the API page. Your API key should be plainly visible there.

A Tiny Program

The following code snippet illustrates how you might run Forge client code locally. Please make sure that you have installed the client library and obtained an API key before running the Python code presented below.

# configuration
from qcware.forge.config import set_api_key, set_host
set_api_key('YOUR-API-KEY-HERE')
set_host('https://api.forge.qcware.com')

# specify the problem (for more details, see the "Getting Started" Jupyter notebook on Forge)
from qcware.forge import optimization
from qcware.types import PolynomialObjective, Constraints, BinaryProblem

qubo = {
    (0, 0): 1,
    (0, 1): 1,
    (1, 1): 1,
    (1, 2): 1,
    (2, 2): -1
}

qubo_objective = PolynomialObjective(
    polynomial=qubo,
    num_variables=3,
    domain='boolean'
)

# run a CPU-powered brute force solution
results = optimization.brute_force_minimize(
    objective=qubo_objective,
    backend='qcware/cpu'
)
print(results)

If the client code has been properly installed and configured, the above code should display a result similar to the following:

Objective value: -1
Solution: [0, 0, 1]

For further guidance on running client code to solve machine learning problems, optimization problems, and more, please read through the documentation made available at https://qcware.readthedocs.io as well as the Jupyter notebooks made available on Forge.

Metadata

Release files for qcware 7.4.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qcware 7.4.3
File	Size	Uploaded
qcware-7.4.3.tar.gz	55.1 kB	May 11, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for qcware 7.4.3
File	Interpreter	ABI	Platform	Reset
qcware-7.4.3-py3-none-any.whl 84.9 kB May 11, 2022	Python 3	none	any	Details

Total release size: 140.0 kB

Release files / qcware-7.4.3.tar.gz

Download URL	qcware-7.4.3.tar.gz
Size	55.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`babe930b3d4a79335c5ed2175e247166cef10d5f70915227059b15132e22b0df`
BLAKE2b-256 checksum How to use checksums	`f7b5bfa98e87562234f12ce56e8ebff47bafdd8a911cd374765a8943c7feee8e`
Upload date	May 11, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.1.12 CPython/3.10.1 Linux/5.13.0-1021-aws`

Release files / qcware-7.4.3-py3-none-any.whl

Download URL	qcware-7.4.3-py3-none-any.whl
Size	84.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`7dbf378feff8e466a809960879a4b1c50b7dac6de906d1f9711f2772f364446a`
BLAKE2b-256 checksum How to use checksums	`e6b9cf0b67ea84061c4ca96057a9ec95171443075a1862f6b184c753f29b0640`
Upload date	May 11, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.1.12 CPython/3.10.1 Linux/5.13.0-1021-aws`