Variational
curl --request POST \
--url 'https://api.example.com/variational?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"experiment_id": "<string>",
"circuit_id": "<string>",
"loss_expression": "<string>",
"observables": {},
"device_id": "<string>",
"shots": 1000,
"options": {},
"initial_parameters": [
123
],
"optimizer_options": {
"type": "nft",
"randomized_order": false,
"reset_interval": 32,
"maxfev": 200,
"maxiter": 100,
"eps": 1e-32
},
"use_mitigation": false,
"use_compression": false,
"compression_options": {
"compression_level": "balanced",
"noise_profile": "default",
"fine_tuning": "disabled",
"approximation_level": 50
},
"name": "",
"description": ""
}
'import requests
url = "https://api.example.com/variational?HAIQU_API_KEY="
payload = {
"experiment_id": "<string>",
"circuit_id": "<string>",
"loss_expression": "<string>",
"observables": {},
"device_id": "<string>",
"shots": 1000,
"options": {},
"initial_parameters": [123],
"optimizer_options": {
"type": "nft",
"randomized_order": False,
"reset_interval": 32,
"maxfev": 200,
"maxiter": 100,
"eps": 1e-32
},
"use_mitigation": False,
"use_compression": False,
"compression_options": {
"compression_level": "balanced",
"noise_profile": "default",
"fine_tuning": "disabled",
"approximation_level": 50
},
"name": "",
"description": ""
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
experiment_id: '<string>',
circuit_id: '<string>',
loss_expression: '<string>',
observables: {},
device_id: '<string>',
shots: 1000,
options: {},
initial_parameters: [123],
optimizer_options: {
type: 'nft',
randomized_order: false,
reset_interval: 32,
maxfev: 200,
maxiter: 100,
eps: 1e-32
},
use_mitigation: false,
use_compression: false,
compression_options: {
compression_level: 'balanced',
noise_profile: 'default',
fine_tuning: 'disabled',
approximation_level: 50
},
name: '',
description: ''
})
};
fetch('https://api.example.com/variational?HAIQU_API_KEY=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/variational?HAIQU_API_KEY=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'experiment_id' => '<string>',
'circuit_id' => '<string>',
'loss_expression' => '<string>',
'observables' => [
],
'device_id' => '<string>',
'shots' => 1000,
'options' => [
],
'initial_parameters' => [
123
],
'optimizer_options' => [
'type' => 'nft',
'randomized_order' => false,
'reset_interval' => 32,
'maxfev' => 200,
'maxiter' => 100,
'eps' => 1e-32
],
'use_mitigation' => false,
'use_compression' => false,
'compression_options' => [
'compression_level' => 'balanced',
'noise_profile' => 'default',
'fine_tuning' => 'disabled',
'approximation_level' => 50
],
'name' => '',
'description' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/variational?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"experiment_id\": \"<string>\",\n \"circuit_id\": \"<string>\",\n \"loss_expression\": \"<string>\",\n \"observables\": {},\n \"device_id\": \"<string>\",\n \"shots\": 1000,\n \"options\": {},\n \"initial_parameters\": [\n 123\n ],\n \"optimizer_options\": {\n \"type\": \"nft\",\n \"randomized_order\": false,\n \"reset_interval\": 32,\n \"maxfev\": 200,\n \"maxiter\": 100,\n \"eps\": 1e-32\n },\n \"use_mitigation\": false,\n \"use_compression\": false,\n \"compression_options\": {\n \"compression_level\": \"balanced\",\n \"noise_profile\": \"default\",\n \"fine_tuning\": \"disabled\",\n \"approximation_level\": 50\n },\n \"name\": \"\",\n \"description\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/variational?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"experiment_id\": \"<string>\",\n \"circuit_id\": \"<string>\",\n \"loss_expression\": \"<string>\",\n \"observables\": {},\n \"device_id\": \"<string>\",\n \"shots\": 1000,\n \"options\": {},\n \"initial_parameters\": [\n 123\n ],\n \"optimizer_options\": {\n \"type\": \"nft\",\n \"randomized_order\": false,\n \"reset_interval\": 32,\n \"maxfev\": 200,\n \"maxiter\": 100,\n \"eps\": 1e-32\n },\n \"use_mitigation\": false,\n \"use_compression\": false,\n \"compression_options\": {\n \"compression_level\": \"balanced\",\n \"noise_profile\": \"default\",\n \"fine_tuning\": \"disabled\",\n \"approximation_level\": 50\n },\n \"name\": \"\",\n \"description\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/variational?HAIQU_API_KEY=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"experiment_id\": \"<string>\",\n \"circuit_id\": \"<string>\",\n \"loss_expression\": \"<string>\",\n \"observables\": {},\n \"device_id\": \"<string>\",\n \"shots\": 1000,\n \"options\": {},\n \"initial_parameters\": [\n 123\n ],\n \"optimizer_options\": {\n \"type\": \"nft\",\n \"randomized_order\": false,\n \"reset_interval\": 32,\n \"maxfev\": 200,\n \"maxiter\": 100,\n \"eps\": 1e-32\n },\n \"use_mitigation\": false,\n \"use_compression\": false,\n \"compression_options\": {\n \"compression_level\": \"balanced\",\n \"noise_profile\": \"default\",\n \"fine_tuning\": \"disabled\",\n \"approximation_level\": 50\n },\n \"name\": \"\",\n \"description\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": 123,
"experiment_id": "<string>",
"status": "Submitted",
"job_type": "User local job",
"device_id": "<string>",
"creation_date": "2023-11-07T05:31:56Z",
"circuit_id": "<string>",
"loss_expression": "<string>",
"observables": {},
"shots": 123,
"name": "<string>",
"description": "<string>",
"run_date": "2023-11-07T05:31:56Z",
"finish_date": "2023-11-07T05:31:56Z",
"logs": "<string>",
"quality": 123,
"info": {},
"time": 123,
"parameters": {},
"options": {},
"optimizer_options": {},
"use_mitigation": false,
"optimal_parameters": [
123
],
"min_loss": 123,
"loss_history": [
123
],
"weights_history": [
[
123
]
],
"compression_stats": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Variational
Variational optimization endpoint. Creates a variational job.
Args: user (User): User authenticated with api key. data (VariationalProblemSubmitModel): Variational job arguments. db: Database.
Returns: VariationalJobModel: The new job object.
Raises:
HTTPException: 404 when the circuit is unavailable.
POST
/
variational
Variational
curl --request POST \
--url 'https://api.example.com/variational?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"experiment_id": "<string>",
"circuit_id": "<string>",
"loss_expression": "<string>",
"observables": {},
"device_id": "<string>",
"shots": 1000,
"options": {},
"initial_parameters": [
123
],
"optimizer_options": {
"type": "nft",
"randomized_order": false,
"reset_interval": 32,
"maxfev": 200,
"maxiter": 100,
"eps": 1e-32
},
"use_mitigation": false,
"use_compression": false,
"compression_options": {
"compression_level": "balanced",
"noise_profile": "default",
"fine_tuning": "disabled",
"approximation_level": 50
},
"name": "",
"description": ""
}
'import requests
url = "https://api.example.com/variational?HAIQU_API_KEY="
payload = {
"experiment_id": "<string>",
"circuit_id": "<string>",
"loss_expression": "<string>",
"observables": {},
"device_id": "<string>",
"shots": 1000,
"options": {},
"initial_parameters": [123],
"optimizer_options": {
"type": "nft",
"randomized_order": False,
"reset_interval": 32,
"maxfev": 200,
"maxiter": 100,
"eps": 1e-32
},
"use_mitigation": False,
"use_compression": False,
"compression_options": {
"compression_level": "balanced",
"noise_profile": "default",
"fine_tuning": "disabled",
"approximation_level": 50
},
"name": "",
"description": ""
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
experiment_id: '<string>',
circuit_id: '<string>',
loss_expression: '<string>',
observables: {},
device_id: '<string>',
shots: 1000,
options: {},
initial_parameters: [123],
optimizer_options: {
type: 'nft',
randomized_order: false,
reset_interval: 32,
maxfev: 200,
maxiter: 100,
eps: 1e-32
},
use_mitigation: false,
use_compression: false,
compression_options: {
compression_level: 'balanced',
noise_profile: 'default',
fine_tuning: 'disabled',
approximation_level: 50
},
name: '',
description: ''
})
};
fetch('https://api.example.com/variational?HAIQU_API_KEY=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/variational?HAIQU_API_KEY=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'experiment_id' => '<string>',
'circuit_id' => '<string>',
'loss_expression' => '<string>',
'observables' => [
],
'device_id' => '<string>',
'shots' => 1000,
'options' => [
],
'initial_parameters' => [
123
],
'optimizer_options' => [
'type' => 'nft',
'randomized_order' => false,
'reset_interval' => 32,
'maxfev' => 200,
'maxiter' => 100,
'eps' => 1e-32
],
'use_mitigation' => false,
'use_compression' => false,
'compression_options' => [
'compression_level' => 'balanced',
'noise_profile' => 'default',
'fine_tuning' => 'disabled',
'approximation_level' => 50
],
'name' => '',
'description' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/variational?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"experiment_id\": \"<string>\",\n \"circuit_id\": \"<string>\",\n \"loss_expression\": \"<string>\",\n \"observables\": {},\n \"device_id\": \"<string>\",\n \"shots\": 1000,\n \"options\": {},\n \"initial_parameters\": [\n 123\n ],\n \"optimizer_options\": {\n \"type\": \"nft\",\n \"randomized_order\": false,\n \"reset_interval\": 32,\n \"maxfev\": 200,\n \"maxiter\": 100,\n \"eps\": 1e-32\n },\n \"use_mitigation\": false,\n \"use_compression\": false,\n \"compression_options\": {\n \"compression_level\": \"balanced\",\n \"noise_profile\": \"default\",\n \"fine_tuning\": \"disabled\",\n \"approximation_level\": 50\n },\n \"name\": \"\",\n \"description\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/variational?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"experiment_id\": \"<string>\",\n \"circuit_id\": \"<string>\",\n \"loss_expression\": \"<string>\",\n \"observables\": {},\n \"device_id\": \"<string>\",\n \"shots\": 1000,\n \"options\": {},\n \"initial_parameters\": [\n 123\n ],\n \"optimizer_options\": {\n \"type\": \"nft\",\n \"randomized_order\": false,\n \"reset_interval\": 32,\n \"maxfev\": 200,\n \"maxiter\": 100,\n \"eps\": 1e-32\n },\n \"use_mitigation\": false,\n \"use_compression\": false,\n \"compression_options\": {\n \"compression_level\": \"balanced\",\n \"noise_profile\": \"default\",\n \"fine_tuning\": \"disabled\",\n \"approximation_level\": 50\n },\n \"name\": \"\",\n \"description\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/variational?HAIQU_API_KEY=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"experiment_id\": \"<string>\",\n \"circuit_id\": \"<string>\",\n \"loss_expression\": \"<string>\",\n \"observables\": {},\n \"device_id\": \"<string>\",\n \"shots\": 1000,\n \"options\": {},\n \"initial_parameters\": [\n 123\n ],\n \"optimizer_options\": {\n \"type\": \"nft\",\n \"randomized_order\": false,\n \"reset_interval\": 32,\n \"maxfev\": 200,\n \"maxiter\": 100,\n \"eps\": 1e-32\n },\n \"use_mitigation\": false,\n \"use_compression\": false,\n \"compression_options\": {\n \"compression_level\": \"balanced\",\n \"noise_profile\": \"default\",\n \"fine_tuning\": \"disabled\",\n \"approximation_level\": 50\n },\n \"name\": \"\",\n \"description\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": 123,
"experiment_id": "<string>",
"status": "Submitted",
"job_type": "User local job",
"device_id": "<string>",
"creation_date": "2023-11-07T05:31:56Z",
"circuit_id": "<string>",
"loss_expression": "<string>",
"observables": {},
"shots": 123,
"name": "<string>",
"description": "<string>",
"run_date": "2023-11-07T05:31:56Z",
"finish_date": "2023-11-07T05:31:56Z",
"logs": "<string>",
"quality": 123,
"info": {},
"time": 123,
"parameters": {},
"options": {},
"optimizer_options": {},
"use_mitigation": false,
"optimal_parameters": [
123
],
"min_loss": 123,
"loss_history": [
123
],
"weights_history": [
[
123
]
],
"compression_stats": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
APIKeyQueryAPIKeyHeader
Body
application/json
Submit model for variational problem execution.
Loss expression in terms of observables, e.g. "x / y"
Required string length:
1 - 1024Show child attributes
Show child attributes
Maximum string length:
200Number of measurement shots (must be >= 1)
Required range:
x >= 1Configuration options for the NFT (Nakanishi-Fujii-Todo) optimizer.
The NFT algorithm is a gradient-free optimizer designed for variational quantum algorithms. For detailed information about the algorithm, see the paper: https://arxiv.org/abs/1903.12166
Preconditions: NFT requires the following conditions on the parameterized quantum circuit:
1. Parameters must be independent: each parameter must appear in exactly one
gate (no reusing the same parameter across multiple gates).
2. Parameterized gates must be rotations of the form ``R_j(θ_j) = exp(-i*θ_j*A_j/2)``
where ``A_j² = I`` (e.g., RX, RY, RZ gates satisfy this).
3. The cost function must be a sum of expectation values of Hermitian operators:
``L(θ) = Σ_k w_k ⟨ψ_k|U†(θ) H_k U(θ)|ψ_k⟩``.
Scaling: NFT updates one parameter at a time. Each full sweep through N parameters requires ≥2N function evaluations (depending on reset_interval).
Args: randomized_order: If True, shuffles the order of parameters to update each lap (full sweep through all parameters). Default: False. reset_interval: How often to reset the recycled loss value. Set to 0 to disable resets. Default: 32. maxfev: Maximum number of function evaluations (circuit executions). Optimization stops when this limit is reached. Default: 200. maxiter: Maximum number of iterations (parameter updates). Default: 100. eps: Small epsilon value to avoid division by zero in the analytic solution. Default: 1e-32.
Notes: Stopping criterion: Optimization stops when either maxfev or maxiter is reached, whichever comes first.
Function evaluations per iteration: Each iteration uses 2-3 function
evaluations. The very first iteration and the first iteration of each
reset interval use 3 evaluations. Subsequent iterations reuse the
previous optimal value, requiring only 2 evaluations.
Result histories: ``job.result().loss_history`` and
``weights_history`` record one entry per NFT iteration (parameter
update), not per circuit evaluation. History length therefore tracks
``maxiter``, not ``maxfev``.
Example: >>> from haiqu.sdk.qml import NFTOptimizerOptions >>> optimizer = NFTOptimizerOptions(maxfev=500, maxiter=200)
- NFTOptimizerOptions
- ScipyOptimizerOptions
Show child attributes
Show child attributes
Options for compression-in-training in variational optimization.
Show child attributes
Show child attributes
Maximum string length:
200Maximum string length:
1024Response
Successful Response
Job returned for variational problem execution.
Class for job status.
Available options:
Submitted, Initializing, Queued, Validating, Running, Cancelled, Done, Error Class for job types.
Available options:
User local job, Analytics, Device specific analytics, Data Loading, Hybrid, Run, State Compression, Transpilation, Variational, Pretraining, SKQD Show child attributes
Show child attributes