HitachiClient

class HitachiClient

Bases: AmplifyClient

Methods

__init__	__init__
solve	solve

Attributes

acceptable_degrees	acceptable_degrees property
graph	graph property
parameters	parameters property
proxy	proxy property
token	token property
url	url property
version	version property
write_request_data	write_request_data property
write_response_data	write_response_data property

class Parameters

class Outputs

__init__(*args, **kwargs)

__repr__(self) → str

__repr__

Return type:

str

__str__(self) → str

__str__

Return type:

str

property averaged_energy

averaged_energy property

Return type:

bool | None

property averaged_spins

averaged_spins property

Return type:

bool | None

property energies

energies property

Return type:

bool | None

property execution_time

execution_time property

Return type:

bool | None

property num_outputs

num_outputs property

Return type:

int | None

property spins

spins property

Return type:

bool | None

class TemperatureParameters

__init__(*args, **kwargs)

__repr__(self) → str

__repr__

Return type:

str

__str__(self) → str

__str__

Return type:

str

property temperature_initial

temperature_initial property

Return type:

float | None

property temperature_num_steps

temperature_num_steps property

Return type:

int | None

property temperature_step_length

temperature_step_length property

Return type:

int | None

property temperature_target

temperature_target property

Return type:

float | None

__init__(*args, **kwargs)

__repr__(self) → str

__repr__

Return type:

str

__str__(self) → str

__str__

Return type:

str

property num_executions

num_executions property

Return type:

int | None

property outputs

outputs property

Return type:

Outputs

property parameters

parameters property

Return type:

TemperatureParameters

property type

type property

Return type:

int

class Result

class Result

__init__(*args, **kwargs)

__repr__(self) → str

__repr__

Return type:

str

__str__(self) → str

__str__

Return type:

str

property averaged_energy

averaged_energy property

Return type:

float | None

property averaged_spins

averaged_spins property

Return type:

list[tuple[int, int, float]] | None

property energies

energies property

Return type:

ndarray

property execution_time

execution_time property

Return type:

timedelta

property spins

spins property

Return type:

list[list[tuple[int, int, int]]]

__init__(*args, **kwargs)

__repr__(self) → str

__repr__

Return type:

str

__str__(self) → str

__str__

Return type:

str

property job_id

job_id property

Return type:

str

property message

message property

Return type:

str | None

property result

result property

Return type:

Result

property status

status property

Return type:

int

__init__(self) → None

__init__(self, token: str = '', url: str = '', proxy: str | None = None) → None

__init__

Parameters:

• token (str) – Defaults to ''.

• url (str) – Defaults to ''.

• proxy (str | None) – Defaults to None.

__repr__(self) → str

__repr__

Return type:

str

__str__(self) → str

__str__

Return type:

str

solve(self, objective: Poly | Matrix, dry_run: Literal[False] = False) → Result

solve(self, objective: Poly | Matrix, dry_run: Literal[True]) → None

solve

Overload 1.

Args:

• objective (amplify.Poly | amplify.Matrix)

• dry_run (typing.Literal[False]): Defaults to False.

Returns:

amplify.HitachiClient.Result:

Overload 2.

Args:

• objective (amplify.Poly | amplify.Matrix)

• dry_run (typing.Literal[True])

property acceptable_degrees

acceptable_degrees property

Return type:

AcceptableDegrees

property graph

graph property

Return type:

Graph

property parameters

parameters property

Return type:

Parameters

property proxy

proxy property

Return type:

str | None

property token

token property

Return type:

str

property url

url property

Return type:

str

property version

version property

Return type:

str

property write_request_data

write_request_data property

Return type:

Path | None

property write_response_data

write_response_data property

Return type:

Path | None