Pretraining
curl --request POST \
--url 'https://api.example.com/pretraining?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"experiment_id": "<string>",
"circuit_id": "<string>",
"loss_expression": "<string>",
"observables": {},
"name": "",
"description": "",
"max_time": 123,
"seed": 123,
"initial_parameters": [
123
],
"options": {},
"pretrain_type": "Pretrain"
}
'import requests
url = "https://api.example.com/pretraining?HAIQU_API_KEY="
payload = {
"experiment_id": "<string>",
"circuit_id": "<string>",
"loss_expression": "<string>",
"observables": {},
"name": "",
"description": "",
"max_time": 123,
"seed": 123,
"initial_parameters": [123],
"options": {},
"pretrain_type": "Pretrain"
}
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: {},
name: '',
description: '',
max_time: 123,
seed: 123,
initial_parameters: [123],
options: {},
pretrain_type: 'Pretrain'
})
};
fetch('https://api.example.com/pretraining?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/pretraining?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' => [
],
'name' => '',
'description' => '',
'max_time' => 123,
'seed' => 123,
'initial_parameters' => [
123
],
'options' => [
],
'pretrain_type' => 'Pretrain'
]),
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/pretraining?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"experiment_id\": \"<string>\",\n \"circuit_id\": \"<string>\",\n \"loss_expression\": \"<string>\",\n \"observables\": {},\n \"name\": \"\",\n \"description\": \"\",\n \"max_time\": 123,\n \"seed\": 123,\n \"initial_parameters\": [\n 123\n ],\n \"options\": {},\n \"pretrain_type\": \"Pretrain\"\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/pretraining?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"experiment_id\": \"<string>\",\n \"circuit_id\": \"<string>\",\n \"loss_expression\": \"<string>\",\n \"observables\": {},\n \"name\": \"\",\n \"description\": \"\",\n \"max_time\": 123,\n \"seed\": 123,\n \"initial_parameters\": [\n 123\n ],\n \"options\": {},\n \"pretrain_type\": \"Pretrain\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/pretraining?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 \"name\": \"\",\n \"description\": \"\",\n \"max_time\": 123,\n \"seed\": 123,\n \"initial_parameters\": [\n 123\n ],\n \"options\": {},\n \"pretrain_type\": \"Pretrain\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": 123,
"experiment_id": "<string>",
"status": "Submitted",
"job_type": "User local job",
"creation_date": "2023-11-07T05:31:56Z",
"circuit_id": "<string>",
"loss_expression": "<string>",
"observables": {},
"name": "<string>",
"description": "<string>",
"device_id": "Haiqu OS",
"run_date": "2023-11-07T05:31:56Z",
"finish_date": "2023-11-07T05:31:56Z",
"logs": "<string>",
"quality": 123,
"info": {},
"time": 123,
"parameters": {},
"max_time": 123,
"seed": 123,
"initial_parameters": [
123
],
"options": {},
"pretrain_type": "Pretrain",
"result_vector": [
123
],
"loss": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Pretraining
Pretraining endpoint. Creates a pretraining job.
Args: user (User): User authenticated with api key. data (PretrainingSubmitModel): Pretraining job arguments. db: Database.
Returns: PretrainingJobModel: The new job object.
Raises:
HTTPException: 404 when the circuit is unavailable.
POST
/
pretraining
Pretraining
curl --request POST \
--url 'https://api.example.com/pretraining?HAIQU_API_KEY=' \
--header 'Content-Type: application/json' \
--data '
{
"experiment_id": "<string>",
"circuit_id": "<string>",
"loss_expression": "<string>",
"observables": {},
"name": "",
"description": "",
"max_time": 123,
"seed": 123,
"initial_parameters": [
123
],
"options": {},
"pretrain_type": "Pretrain"
}
'import requests
url = "https://api.example.com/pretraining?HAIQU_API_KEY="
payload = {
"experiment_id": "<string>",
"circuit_id": "<string>",
"loss_expression": "<string>",
"observables": {},
"name": "",
"description": "",
"max_time": 123,
"seed": 123,
"initial_parameters": [123],
"options": {},
"pretrain_type": "Pretrain"
}
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: {},
name: '',
description: '',
max_time: 123,
seed: 123,
initial_parameters: [123],
options: {},
pretrain_type: 'Pretrain'
})
};
fetch('https://api.example.com/pretraining?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/pretraining?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' => [
],
'name' => '',
'description' => '',
'max_time' => 123,
'seed' => 123,
'initial_parameters' => [
123
],
'options' => [
],
'pretrain_type' => 'Pretrain'
]),
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/pretraining?HAIQU_API_KEY="
payload := strings.NewReader("{\n \"experiment_id\": \"<string>\",\n \"circuit_id\": \"<string>\",\n \"loss_expression\": \"<string>\",\n \"observables\": {},\n \"name\": \"\",\n \"description\": \"\",\n \"max_time\": 123,\n \"seed\": 123,\n \"initial_parameters\": [\n 123\n ],\n \"options\": {},\n \"pretrain_type\": \"Pretrain\"\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/pretraining?HAIQU_API_KEY=")
.header("Content-Type", "application/json")
.body("{\n \"experiment_id\": \"<string>\",\n \"circuit_id\": \"<string>\",\n \"loss_expression\": \"<string>\",\n \"observables\": {},\n \"name\": \"\",\n \"description\": \"\",\n \"max_time\": 123,\n \"seed\": 123,\n \"initial_parameters\": [\n 123\n ],\n \"options\": {},\n \"pretrain_type\": \"Pretrain\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/pretraining?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 \"name\": \"\",\n \"description\": \"\",\n \"max_time\": 123,\n \"seed\": 123,\n \"initial_parameters\": [\n 123\n ],\n \"options\": {},\n \"pretrain_type\": \"Pretrain\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"user_id": 123,
"experiment_id": "<string>",
"status": "Submitted",
"job_type": "User local job",
"creation_date": "2023-11-07T05:31:56Z",
"circuit_id": "<string>",
"loss_expression": "<string>",
"observables": {},
"name": "<string>",
"description": "<string>",
"device_id": "Haiqu OS",
"run_date": "2023-11-07T05:31:56Z",
"finish_date": "2023-11-07T05:31:56Z",
"logs": "<string>",
"quality": 123,
"info": {},
"time": 123,
"parameters": {},
"max_time": 123,
"seed": 123,
"initial_parameters": [
123
],
"options": {},
"pretrain_type": "Pretrain",
"result_vector": [
123
],
"loss": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
APIKeyQueryAPIKeyHeader
Body
application/json
Submit model for pretraining variational circuits.
sympy objective as a string; "x" for a linear single-observable problem
Required string length:
1 - 1024Show child attributes
Show child attributes
Maximum string length:
200Maximum string length:
1024Response
Successful Response
Job model for pretraining variational circuits.
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
Class for pretrain_type.
Available options:
Pretrain, MpsGradient