HitachiClient¶

class HitachiClient¶

Bases: BaseClient

Methods

`__init__`
`solve`	solve

Attributes

`acceptable_degrees`	Returns: amplify.AcceptableDegrees:
`graph`	Returns: amplify.Graph:
`parameters`	Returns: amplify.HitachiClient.Parameters:
`proxy`	Returns: str \| None:
`token`	Returns: str:
`url`	Returns: str:
`version`	Returns: str:
`write_request_data`	Returns: pathlib.Path \| None:
`write_response_data`	Returns: pathlib.Path \| None:

class Parameters¶

class Outputs¶

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property averaged_energy¶: Returns: bool | None:

property averaged_spins¶: Returns: bool | None:

property energies¶: Returns: bool | None:

property execution_time¶: Returns: bool | None:

property num_outputs¶: Returns: int | None:

property spins¶: Returns: bool | None:

class TemperatureParameters¶

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property temperature_initial¶: Returns: float | None:

property temperature_num_steps¶: Returns: int | None:

property temperature_step_length¶: Returns: int | None:

property temperature_target¶: Returns: float | None:

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property num_executions¶: Returns: int | None:

property outputs¶: Returns: amplify.HitachiClient.Parameters.Outputs:

property parameters¶: Returns: amplify.HitachiClient.Parameters.TemperatureParameters:

property type¶: Returns: int:

class Result¶

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property averaged_energy¶: Returns: float | None:

property averaged_spins¶: Returns: list[tuple[int, int, float]] | None:

property energies¶: Returns: numpy.ndarray:

property execution_time¶: Returns: datetime.timedelta:

property spins¶: Returns: list[list[tuple[int, int, int]]]:

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property job_id¶: Returns: str:

property message¶: Returns: str | None:

property result¶: Returns: amplify.HitachiClient.Result.Result:

property status¶: Returns: int:

__init__(self) → None¶

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

Parameters:

token (str) – Defaults to ''.
url (str) – Defaults to ''.
proxy (str | None) – Defaults to None.

__repr__(self) → str¶

Return type:: str

__str__(self) → 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¶: Returns: amplify.AcceptableDegrees:

property graph¶: Returns: amplify.Graph:

property parameters¶: Returns: amplify.HitachiClient.Parameters:

property proxy¶: Returns: str | None:

property token¶: Returns: str:

property url¶: Returns: str:

property version¶: Returns: str:

property write_request_data¶: Returns: pathlib.Path | None:

property write_response_data¶: Returns: pathlib.Path | None: