Tools to Generate EstimatorV2/SamplerV2 Primitive Input#

GitHub

The tools demonstrate the generation of EstimatorV2/SamplerV2 inputs from a quantum circuit example.

Prerequisites#

  • Python 3.11 or above

Install dependencies#

pip install -f requirements.txt

Tools#

gen_estimator_inputs.py#

Generates EstimatorV2 input for the circuit introduced in IBM’s Get Started with Estimator documentation.

Usage:

usage: gen_estimator_inputs.py [-h] [--iam_url IAM_URL] backend base_url apikey crn

A tool to generate EstimatorV2 input for testing

positional arguments:
  backend     Backend name
  base_url    API endpoint
  apikey      IAM API key
  crn         Service CRN of your instance

options:
  -h, --help  show this help message and exit
  --iam_url IAM_URL  IAM endpoint

Example:

python gen_estimator_input.py ibm_marrakesh https://quantum.cloud.ibm.com/api <your apikey> <your instance>

Output:

Files

Descriptions

estimator_input_<backend_name>_params_only.json

EstimatorV2 input parameters (EstimatorV2 Schema)

estimator_input_<backend_name>.json

An input for QRMI task runner, which contains 2 properties - program_id (= estimator) and parameters (EstimatorV2 input parameters).

gen_sampler_input.py#

Generates SamplerV2 input for the circuit introduced in IBM’s Get Started with Sampler documentation.

Usage:

usage: gen_sampler_inputs.py [-h] [--iam_url IAM_URL] backend base_url apikey crn

A tool to generate SamplerV2 input for testing

positional arguments:
  backend     Backend name
  base_url    API endpoint
  apikey      IAM API key
  crn         Service CRN of your instance

options:
  -h, --help  show this help message and exit
  --iam_url IAM_URL  IAM endpoint

Example:

python gen_sampler_input.py ibm_marrakesh https://quantum.cloud.ibm.com/api <your apikey> <your instance>

Output:

Files

Descriptions

sampler_input_<backend_name>_params_only.json

SamplerV2 input parameters (SamplerV2 Schema).

sampler_input_<backend_name>.json

An input for QRMI task runner, which contains 2 properties - program_id (= sampler) and parameters (SamplerV2 input parameters).