AmplifyAEClientΒΆ

class AmplifyAEClientΒΆ

Bases: BaseClient

Methods

__init__

solve

solve

Attributes

acceptable_degrees

Returns: amplify.AcceptableDegrees:

async_threshold_ms

Returns: datetime.timedelta | None:

compression

Returns: bool:

parameters

Returns: amplify.AmplifyAEClient.Parameters:

proxy

Returns: str | None:

solver

Returns: amplify.AmplifyAEClient.Solver:

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ΒΆ
__init__(*args, **kwargs)ΒΆ
__repr__(self) strΒΆ
Return type:

str

__str__(self) strΒΆ
Return type:

str

property duplicate_solutionsΒΆ

Returns: bool | None:

property num_gpusΒΆ

Returns: int | None:

property penalty_weight_calibrationΒΆ

Returns: bool | None:

property time_limit_msΒΆ

Returns: datetime.timedelta | None:

class ResultΒΆ
class SolutionΒΆ
class StatusΒΆ

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

Feasible = 1ΒΆ
Infeasible = 0ΒΆ
Optimal = 2ΒΆ
__nb_enum__ = <capsule object NULL>ΒΆ
__init__(*args, **kwargs)ΒΆ
__repr__(self) strΒΆ
Return type:

str

__str__(self) strΒΆ
Return type:

str

property objectiveΒΆ

Returns: float:

property statusΒΆ

Returns: amplify.AmplifyAEClient.Result.Solution.Status:

property time_stamp_msΒΆ

Returns: datetime.timedelta:

property valuesΒΆ

Returns: numpy.ndarray:

__init__(*args, **kwargs)ΒΆ
__repr__(self) strΒΆ
Return type:

str

__str__(self) strΒΆ
Return type:

str

property execution_time_msΒΆ

Returns: datetime.timedelta:

property num_flipsΒΆ

Returns: int:

property num_gpusΒΆ

Returns: int:

property num_samplingsΒΆ

Returns: int:

property queue_time_msΒΆ

Returns: datetime.timedelta:

property solutionsΒΆ

Returns: list[amplify.AmplifyAEClient.Result.Solution]:

property started_atΒΆ

Returns: datetime.datetime:

property submitted_atΒΆ

Returns: datetime.datetime:

property versionΒΆ

Returns: str:

property warningsΒΆ

Returns: list[str]:

class SolverΒΆ

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

Constraint = 0ΒΆ
Pubo = 1ΒΆ
Qubo = 2ΒΆ
__nb_enum__ = <capsule object NULL>ΒΆ
__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,
constraint: Constraint | ConstraintList,
dry_run: Literal[False] = False,
) Result
solve(
self,
objective: Poly | Matrix,
constraint: Constraint | ConstraintList,
dry_run: Literal[False] = False,
) Result
solve(self, objective: Poly | Matrix, dry_run: Literal[True]) None
solve(self, constraint: Constraint | ConstraintList, dry_run: Literal[True]) None
solve(
self,
objective: Poly | Matrix,
constraint: Constraint | ConstraintList,
dry_run: Literal[True],
) None

solve

Overload 1.

Args:
  • objective (amplify.Poly | amplify.Matrix)

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

Returns:

amplify.AmplifyAEClient.Result:

Overload 2.

Args:
  • constraint (amplify.Constraint | amplify.ConstraintList)

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

Returns:

amplify.AmplifyAEClient.Result:

Overload 3.

Args:
  • objective (amplify.Poly | amplify.Matrix)

  • constraint (amplify.Constraint | amplify.ConstraintList)

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

Returns:

amplify.AmplifyAEClient.Result:

Overload 4.

Args:
  • objective (amplify.Poly | amplify.Matrix)

  • dry_run (typing.Literal[True])

Overload 5.

Args:
  • constraint (amplify.Constraint | amplify.ConstraintList)

  • dry_run (typing.Literal[True])

Overload 6.

Args:
  • objective (amplify.Poly | amplify.Matrix)

  • constraint (amplify.Constraint | amplify.ConstraintList)

  • dry_run (typing.Literal[True])

property acceptable_degreesΒΆ

Returns: amplify.AcceptableDegrees:

property async_threshold_msΒΆ

Returns: datetime.timedelta | None:

property compressionΒΆ

Returns: bool:

property parametersΒΆ

Returns: amplify.AmplifyAEClient.Parameters:

property proxyΒΆ

Returns: str | None:

property solverΒΆ

Returns: amplify.AmplifyAEClient.Solver:

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: