FujitsuDA4ClientΒΆ

class FujitsuDA4ClientΒΆ

Bases: AmplifyClient

Methods

__init__

__init__

async_solve

async_solve

cancel_job

cancel_job

delete_job_result

delete_job_result

get_job_result

get_job_result

get_jobs

get_jobs

health_check

health_check

solve

solve

Attributes

acceptable_degrees

acceptable_degrees property

parameters

parameters property

proxy

proxy property

set_inequalities

set_inequalities property

set_one_way_one_hot_groups

set_one_way_one_hot_groups property

set_penalty_binary_polynomial

set_penalty_binary_polynomial property

set_two_way_one_hot_groups

set_two_way_one_hot_groups property

token

token property

type_id

type_id property

url

url property

version

version property

write_request_data

write_request_data property

write_response_data

write_response_data property

class CommonErrorΒΆ
__init__(*args, **kwargs)ΒΆ
__repr__(self) strΒΆ

__repr__

Return type:

str

__str__(self) strΒΆ

__str__

Return type:

str

property codeΒΆ

code property

Return type:

int

property messageΒΆ

message property

Return type:

str

property titleΒΆ

title property

Return type:

str

class JobStatusΒΆ

Bases: Enum

__repr__(self) strΒΆ

__repr__

Return type:

str

__str__(self) strΒΆ

__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ΒΆ

__repr__

Return type:

str

__str__(self) strΒΆ

__str__

Return type:

str

property job_idΒΆ

job_id property

Return type:

str

property job_statusΒΆ

job_status property

Return type:

JobStatus

property start_timeΒΆ

start_time property

Return type:

datetime

class ParametersΒΆ
__init__(*args, **kwargs)ΒΆ
__repr__(self) strΒΆ

__repr__

Return type:

str

__str__(self) strΒΆ

__str__

Return type:

str

property gs_cutoffΒΆ

gs_cutoff property

Return type:

int | None

property gs_levelΒΆ

gs_level property

Return type:

int | None

property internal_penaltyΒΆ

internal_penalty property

Return type:

int | None

property max_penalty_coefΒΆ

max_penalty_coef property

Return type:

int | None

property num_groupΒΆ

num_group property

Return type:

int | None

property num_output_solutionΒΆ

num_output_solution property

Return type:

int | None

property num_runΒΆ

num_run property

Return type:

int | None

property one_hot_cutoffΒΆ

one_hot_cutoff property

Return type:

int | None

property one_hot_levelΒΆ

one_hot_level property

Return type:

int | None

property penalty_auto_modeΒΆ

penalty_auto_mode property

Return type:

int | None

property penalty_coefΒΆ

penalty_coef property

Return type:

int | None

property penalty_inc_rateΒΆ

penalty_inc_rate property

Return type:

int | None

property target_energyΒΆ

target_energy property

Return type:

float | None

property time_limit_secΒΆ

time_limit_sec property

Return type:

timedelta | None

class ProgressΒΆ
__init__(*args, **kwargs)ΒΆ
__repr__(self) strΒΆ

__repr__

Return type:

str

__str__(self) strΒΆ

__str__

Return type:

str

property energyΒΆ

energy property

Return type:

float

property penalty_energyΒΆ

penalty_energy property

Return type:

float

property timeΒΆ

time property

Return type:

timedelta

QuboResponseΒΆ

alias of Result

class QuboSolutionΒΆ
__init__(*args, **kwargs)ΒΆ
__repr__(self) strΒΆ

__repr__

Return type:

str

__str__(self) strΒΆ

__str__

Return type:

str

property configurationΒΆ

configuration property

Return type:

dict[str, bool]

property energyΒΆ

energy property

Return type:

float

property frequencyΒΆ

frequency property

Return type:

int

property penalty_energyΒΆ

penalty_energy property

Return type:

float

class QuboSolutionListΒΆ
__init__(*args, **kwargs)ΒΆ
__repr__(self) strΒΆ

__repr__

Return type:

str

__str__(self) strΒΆ

__str__

Return type:

str

property progressΒΆ

progress property

Return type:

list[Progress]

property result_statusΒΆ

result_status property

Return type:

bool

property solutionsΒΆ

solutions property

Return type:

list[QuboSolution]

property timingΒΆ

timing property

Return type:

SolverTiming

class ResultΒΆ
__init__(*args, **kwargs)ΒΆ
__repr__(self) strΒΆ

__repr__

Return type:

str

__str__(self) strΒΆ

__str__

Return type:

str

property messageΒΆ

message property

Return type:

str

property qubo_solutionΒΆ

qubo_solution property

Return type:

QuboSolutionList

property statusΒΆ

status property

Return type:

JobStatus

class SolverTimingΒΆ
__init__(*args, **kwargs)ΒΆ
__repr__(self) strΒΆ

__repr__

Return type:

str

__str__(self) strΒΆ

__str__

Return type:

str

property solve_timeΒΆ

solve_time property

Return type:

timedelta

property total_elapsed_timeΒΆ

total_elapsed_time property

Return type:

timedelta

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

__init__

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ΒΆ

__repr__

Return type:

str

__str__(self) strΒΆ

__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ΒΆ

cancel_job

Parameters:

job_id (str)

Return type:

JobStatus

delete_job_result(self, job_id: str) ResultΒΆ

delete_job_result

Parameters:

job_id (str)

Return type:

Result

get_job_result(self, job_id: str) ResultΒΆ

get_job_result

Parameters:

job_id (str)

Return type:

Result

get_jobs(self) list[JobStatusInfo]ΒΆ

get_jobs

Return type:

list[JobStatusInfo]

health_check(self) CommonError | NoneΒΆ

health_check

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ΒΆ

acceptable_degrees property

Return type:

AcceptableDegrees

property parametersΒΆ

parameters property

Return type:

Parameters

property proxyΒΆ

proxy property

Return type:

str | None

property set_inequalitiesΒΆ

set_inequalities property

Return type:

bool

property set_one_way_one_hot_groupsΒΆ

set_one_way_one_hot_groups property

Return type:

bool

property set_penalty_binary_polynomialΒΆ

set_penalty_binary_polynomial property

Return type:

bool

property set_two_way_one_hot_groupsΒΆ

set_two_way_one_hot_groups property

Return type:

bool

property tokenΒΆ

token property

Return type:

str

property type_idΒΆ

type_id property

Return type:

str | None

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