FujitsuDA4Client¶

class FujitsuDA4Client¶

Bases: BaseClient

Methods

`__init__`
`async_solve`	async_solve
`cancel_job`
`delete_job_result`
`get_job_result`
`get_jobs`
`health_check`
`solve`	solve

Attributes

`acceptable_degrees`	Returns: amplify.AcceptableDegrees:
`parameters`	Returns: amplify.FujitsuDA4Client.Parameters:
`proxy`	Returns: str \| None:
`set_inequalities`	Returns: bool:
`set_one_way_one_hot_groups`	Returns: bool:
`set_penalty_binary_polynomial`	Returns: bool:
`set_two_way_one_hot_groups`	Returns: bool:
`token`	Returns: str:
`type_id`	Returns: str \| None:
`url`	Returns: str:
`version`	Returns: str:
`write_request_data`	Returns: pathlib.Path \| None:
`write_response_data`	Returns: pathlib.Path \| None:

class CommonError¶

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property code¶: Returns: int:

property message¶: Returns: str:

property title¶: Returns: str:

class JobStatus¶

Bases: Enum

classmethod __contains__(value)¶

Return True if value is in cls.

value is in cls if: 1) value is a member of cls, or 2) value is the value of one of the cls’s members. 3) value is a pseudo-member (flags)

classmethod __getitem__(name)¶: Return the member matching name.

classmethod __iter__()¶: Return members in definition order.

classmethod __len__()¶: Return the number of members (no aliases)

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

Canceled = 3¶

Deleted = 5¶

Done = 0¶

Error = 4¶

Running = 1¶

Waiting = 2¶

__nb_enum__ = <capsule object NULL>¶

class JobStatusInfo¶

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property job_id¶: Returns: str:

property job_status¶: Returns: amplify.FujitsuDA4Client.JobStatus:

property start_time¶: Returns: datetime.datetime:

class Parameters¶

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property gs_cutoff¶: Returns: int | None:

property gs_level¶: Returns: int | None:

property internal_penalty¶: Returns: int | None:

property max_penalty_coef¶: Returns: int | None:

property num_group¶: Returns: int | None:

property num_output_solution¶: Returns: int | None:

property num_run¶: Returns: int | None:

property one_hot_cutoff¶: Returns: int | None:

property one_hot_level¶: Returns: int | None:

property penalty_auto_mode¶: Returns: int | None:

property penalty_coef¶: Returns: int | None:

property penalty_inc_rate¶: Returns: int | None:

property target_energy¶: Returns: float | None:

property time_limit_sec¶: Returns: datetime.timedelta | None:

class Progress¶

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property energy¶: Returns: float:

property penalty_energy¶: Returns: float:

property time¶: Returns: datetime.timedelta:

QuboResponse¶: alias of Result

class QuboSolution¶

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property configuration¶: Returns: dict[str, bool]:

property energy¶: Returns: float:

property frequency¶: Returns: int:

property penalty_energy¶: Returns: float:

class QuboSolutionList¶

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property progress¶: Returns: list[amplify.FujitsuDA4Client.Progress]:

property result_status¶: Returns: bool:

property solutions¶: Returns: list[amplify.FujitsuDA4Client.QuboSolution]:

property timing¶: Returns: amplify.FujitsuDA4Client.SolverTiming:

class Result¶

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property message¶: Returns: str:

property qubo_solution¶: Returns: amplify.FujitsuDA4Client.QuboSolutionList:

property status¶: Returns: amplify.FujitsuDA4Client.JobStatus:

class SolverTiming¶

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property solve_time¶: Returns: datetime.timedelta:

property total_elapsed_time¶: Returns: datetime.timedelta:

__init__(self) → None¶

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

Parameters:

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

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

async_solve(self, objective: Poly) → str¶

async_solve(self, constraint: Constraint | ConstraintList) → str

async_solve(self, objective: Poly, constraint: Constraint | ConstraintList) → str

async_solve

Overload 1.

Args:

objective (amplify.Poly)

Returns:

str:

Overload 2.

Args:

constraint (amplify.Constraint | amplify.ConstraintList)

Returns:

str:

Overload 3.

Args:

objective (amplify.Poly)
constraint (amplify.Constraint | amplify.ConstraintList)

Returns:

str:

cancel_job(self, job_id: str) → JobStatus¶

Parameters:: job_id (str)
Return type:: JobStatus

delete_job_result(self, job_id: str) → Result¶

Parameters:: job_id (str)
Return type:: Result

get_job_result(self, job_id: str) → Result¶

Parameters:: job_id (str)
Return type:: Result

get_jobs(self) → list[JobStatusInfo]¶

Return type:: list[JobStatusInfo]

health_check(self) → CommonError | None¶

Return type:: CommonError | None

solve( self, objective: Poly | Matrix, dry_run: Literal[False] = False, retry_after_delete: bool = True, delete_after_solve: bool = True, ) → Result¶

solve( self, constraint: Constraint | ConstraintList, dry_run: Literal[False] = False, retry_after_delete: bool = True, delete_after_solve: bool = True, ) → Result

solve( self, objective: Poly | Matrix, constraint: Constraint | ConstraintList, dry_run: Literal[False] = False, retry_after_delete: bool = True, delete_after_solve: bool = True, ) → Result

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

solve( self, constraint: Constraint | ConstraintList, dry_run: Literal[True], retry_after_delete: bool = True, delete_after_solve: bool = True, ) → None

solve( self, objective: Poly | Matrix, constraint: Constraint | ConstraintList, dry_run: Literal[True], retry_after_delete: bool = True, delete_after_solve: bool = True, ) → None

solve

Overload 1.

Args:

objective (amplify.Poly | amplify.Matrix)
dry_run (typing.Literal[False]): Defaults to False.
retry_after_delete (bool): Defaults to True.
delete_after_solve (bool): Defaults to True.

Returns:

amplify.FujitsuDA4Client.Result:

Overload 2.

Args:

constraint (amplify.Constraint | amplify.ConstraintList)
dry_run (typing.Literal[False]): Defaults to False.
retry_after_delete (bool): Defaults to True.
delete_after_solve (bool): Defaults to True.

Returns:

amplify.FujitsuDA4Client.Result:

Overload 3.

Args:

objective (amplify.Poly | amplify.Matrix)
constraint (amplify.Constraint | amplify.ConstraintList)
dry_run (typing.Literal[False]): Defaults to False.
retry_after_delete (bool): Defaults to True.
delete_after_solve (bool): Defaults to True.

Returns:

amplify.FujitsuDA4Client.Result:

Overload 4.

Args:

objective (amplify.Poly | amplify.Matrix)
dry_run (typing.Literal[True])
retry_after_delete (bool): Defaults to True.
delete_after_solve (bool): Defaults to True.

Overload 5.

Args:

constraint (amplify.Constraint | amplify.ConstraintList)
dry_run (typing.Literal[True])
retry_after_delete (bool): Defaults to True.
delete_after_solve (bool): Defaults to True.

Overload 6.

Args:

objective (amplify.Poly | amplify.Matrix)
constraint (amplify.Constraint | amplify.ConstraintList)
dry_run (typing.Literal[True])
retry_after_delete (bool): Defaults to True.
delete_after_solve (bool): Defaults to True.

property acceptable_degrees¶: Returns: amplify.AcceptableDegrees:

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

property proxy¶: Returns: str | None:

property set_inequalities¶: Returns: bool:

property set_one_way_one_hot_groups¶: Returns: bool:

property set_penalty_binary_polynomial¶: Returns: bool:

property set_two_way_one_hot_groups¶: Returns: bool:

property token¶: Returns: str:

property type_id¶: Returns: str | None:

property url¶: Returns: str:

property version¶: Returns: str:

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

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