AmplifyAEClient

class AmplifyAEClient

Bases: BaseClient

Methods

__init__	__init__
solve	solve

Attributes

acceptable_degrees	acceptable_degrees property
async_threshold_ms	async_threshold_ms property
compression	compression property
parameters	parameters property
proxy	proxy property
solver	solver 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

__init__(*args, **kwargs)

__repr__(self) → str

__repr__

Return type:

str

__str__(self) → str

__str__

Return type:

str

property duplicate_solutions

duplicate_solutions property

Return type:

bool | None

property num_gpus

num_gpus property

Return type:

int | None

property penalty_weight_calibration

penalty_weight_calibration property

Return type:

bool | None

property time_limit_ms

time_limit_ms property

Return type:

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

__repr__

Return type:

str

__str__(self) → str

__str__

Return type:

str

Feasible = 1

Infeasible = 0

Optimal = 2

__nb_enum__ = <capsule object NULL>

__init__(*args, **kwargs)

__repr__(self) → str

__repr__

Return type:

str

__str__(self) → str

__str__

Return type:

str

property objective

objective property

Return type:

float

property status

status property

Return type:

Status

property time_stamp_ms

time_stamp_ms property

Return type:

timedelta

property values

values property

Return type:

ndarray

__init__(*args, **kwargs)

__repr__(self) → str

__repr__

Return type:

str

__str__(self) → str

__str__

Return type:

str

property execution_time_ms

execution_time_ms property

Return type:

timedelta

property num_flips

num_flips property

Return type:

int

property num_gpus

num_gpus property

Return type:

int

property num_samplings

num_samplings property

Return type:

int

property queue_time_ms

queue_time_ms property

Return type:

timedelta

property solutions

solutions property

Return type:

list[Solution]

property started_at

started_at property

Return type:

datetime

property submitted_at

submitted_at property

Return type:

datetime

property version

version property

Return type:

str

property warnings

warnings property

Return type:

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

__repr__

Return type:

str

__str__(self) → str

__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

__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,

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

acceptable_degrees property

Return type:

AcceptableDegrees

property async_threshold_ms

async_threshold_ms property

Return type:

timedelta | None

property compression

compression property

Return type:

bool

property parameters

parameters property

Return type:

Parameters

property proxy

proxy property

Return type:

str | None

property solver

solver property

Return type:

Solver

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