FixstarsClient

class FixstarsClient

Bases: BaseClient

Client for Fixstars Amplify Annealing Engine (Amplify AE) v0, a QUBO solver that runs simulated annealing on GPUs. This engine is deprecated. Use AmplifyAEClient for Amplify AE v1.

Methods

__init__
solve	Send the objective function and the constraints to the solver.

Attributes

acceptable_degrees	Degrees of the polynomial that the solver accepts.
async_threshold
compression	Whether the client compresses the body of the request.
objective_format	Format of the objective function in the request.
parameters	Parameters that the client sends with every request.
proxy	URL of the proxy that the client goes through, or None for no proxy.
token	API token of the user.
url	URL of the service that the client sends to.
version	Version of the service.
write_request_data	Path of the file that receives a copy of the request, or None to write none.
write_response_data	Path of the file that receives a copy of the response, or None to write none.

class Parameters

Parameters that the client sends with every request.

class Outputs

__init__(*args, **kwargs)

__repr__(self) → str

Return type:

str

__str__(self) → str

Return type:

str

property duplicate

property energies

property feasibilities

property num_outputs

property sort

property spins

__init__(*args, **kwargs)

__repr__(self) → str

Return type:

str

__str__(self) → str

Return type:

str

property num_gpus

property outputs

property penalty_calibration

property timeout

class Result

Raw response that the solver returned.

class ExecutionParameters

__init__(*args, **kwargs)

__repr__(self) → str

Return type:

str

__str__(self) → str

Return type:

str

property num_gpus

property num_iterations

property penalty_calibration

property penalty_multipliers

property timeout

property version

Version of the service.

Reading this property sends a request to the service.

Return type:

str

class ExecutionTime

__init__(*args, **kwargs)

__repr__(self) → str

Return type:

str

__str__(self) → str

Return type:

str

property annealing_time

property cpu_time

property queue_time

property time_stamps

__init__(*args, **kwargs)

__repr__(self) → str

Return type:

str

__str__(self) → str

Return type:

str

property energies

property execution_parameters

property execution_time

property feasibilities

property message

property spins

__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

Send the objective function and the constraints to the solver.

This method takes the polynomial that the solver accepts, so it runs no conversion of the model. Use solve() to solve a model that needs a conversion. It returns the raw response of the solver.

Overload 1.

Args:

• objective (amplify.Poly | amplify.Matrix): The objective function that the solver minimizes.

• dry_run (typing.Literal[False]): When True, ask the service to check the request, and return None. Defaults to False.

Returns:

amplify.FixstarsClient.Result:

Overload 2.

Args:

• constraint (amplify.Constraint | amplify.ConstraintList): The constraints that the solution must satisfy.

• dry_run (typing.Literal[False]): When True, ask the service to check the request, and return None. Defaults to False.

Returns:

amplify.FixstarsClient.Result:

Overload 3.

Args:

• objective (amplify.Poly | amplify.Matrix): The objective function that the solver minimizes.

• constraint (amplify.Constraint | amplify.ConstraintList): The constraints that the solution must satisfy.

• dry_run (typing.Literal[False]): When True, ask the service to check the request, and return None. Defaults to False.

Returns:

amplify.FixstarsClient.Result:

Overload 4.

Args:

• objective (amplify.Poly | amplify.Matrix): The objective function that the solver minimizes.

• dry_run (typing.Literal[True]): When True, ask the service to check the request, and return None.

Overload 5.

Args:

• constraint (amplify.Constraint | amplify.ConstraintList): The constraints that the solution must satisfy.

• dry_run (typing.Literal[True]): When True, ask the service to check the request, and return None.

Overload 6.

Args:

• objective (amplify.Poly | amplify.Matrix): The objective function that the solver minimizes.

• constraint (amplify.Constraint | amplify.ConstraintList): The constraints that the solution must satisfy.

• dry_run (typing.Literal[True]): When True, ask the service to check the request, and return None.

property acceptable_degrees

Degrees of the polynomial that the solver accepts.

solve() reads it to decide the conversion of the model.

Return type:

AcceptableDegrees

property async_threshold

property compression

Whether the client compresses the body of the request.

Compression costs CPU time and it makes the request smaller.

Return type:

bool

property objective_format

Format of the objective function in the request.

See ObjectiveFormat. The answer does not depend on this choice.

Return type:

ObjectiveFormat

property parameters

Parameters that the client sends with every request.

Return type:

Parameters

property proxy

URL of the proxy that the client goes through, or None for no proxy.

Return type:

str | None

property token

API token of the user.

The client needs it for every request. Its text never appears in the output of repr().

Return type:

str

property url

URL of the service that the client sends to.

Return type:

str

property version

Version of the service.

Reading this property sends a request to the service.

Return type:

str

property write_request_data

Path of the file that receives a copy of the request, or None to write none.

Use it to inspect what the client sends.

Return type:

Path | None

property write_response_data

Path of the file that receives a copy of the response, or None to write none.

Return type:

Path | None