GurobiClient¶

class GurobiClient¶

Bases: BaseClient

Methods

`__init__`
`solve`	solve
`tune`	tune

Attributes

`acceptable_degrees`	Returns: amplify.AcceptableDegrees:
`library_path`	Returns: str \| None:
`parameters`	Returns: amplify.GurobiClient.Parameters:
`version`	Returns: str:
`write_request_data`	Returns: str \| None:
`write_response_data`	Returns: str \| None:

class Parameters¶

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property agg_fill¶: Returns: int | None:

property aggregate¶: Returns: int | None:

property bar_conv_tol¶: Returns: float | None:

property bar_correctors¶: Returns: int | None:

property bar_homogeneous¶: Returns: int | None:

property bar_iter_limit¶: Returns: int | None:

property bar_order¶: Returns: int | None:

property bar_qcp_conv_tol¶: Returns: float | None:

property best_bd_stop¶: Returns: float | None:

property best_obj_stop¶: Returns: float | None:

property bqp_cuts¶: Returns: int | None:

property branch_dir¶: Returns: int | None:

property clique_cuts¶: Returns: int | None:

property cloud_access_id¶: Returns: str | None:

property cloud_host¶: Returns: str | None:

property cloud_pool¶: Returns: str | None:

property cloud_secret_key¶: Returns: str | None:

property compute_server¶: Returns: str | None:

property concurrent_jobs¶: Returns: int | None:

property concurrent_method¶: Returns: int | None:

property concurrent_mip¶: Returns: int | None:

property cover_cuts¶: Returns: int | None:

property crossover¶: Returns: int | None:

property crossover_basis¶: Returns: int | None:

property cs_app_name¶: Returns: str | None:

property cs_auth_token¶: Returns: str | None:

property cs_batch_mode¶: Returns: int | None:

property cs_client_log¶: Returns: int | None:

property cs_group¶: Returns: str | None:

property cs_idle_timeout¶: Returns: int | None:

property cs_manager¶: Returns: str | None:

property cs_priority¶: Returns: int | None:

property cs_queue_timeout¶: Returns: float | None:

property cs_router¶: Returns: str | None:

property csapi_access_id¶: Returns: str | None:

property csapi_secret¶: Returns: str | None:

property cstls_insecure¶: Returns: int | None:

property cut_agg_passes¶: Returns: int | None:

property cut_passes¶: Returns: int | None:

property cutoff¶: Returns: float | None:

property cuts¶: Returns: int | None:

property degen_moves¶: Returns: int | None:

property disconnected¶: Returns: int | None:

property display_interval¶: Returns: int | None:

property distributed_mip_jobs¶: Returns: int | None:

property dual_implied_cuts¶: Returns: int | None:

property dual_reductions¶: Returns: int | None:

property feas_relax_big_m¶: Returns: float | None:

property feasibility_tol¶: Returns: float | None:

property flow_cover_cuts¶: Returns: int | None:

property flow_path_cuts¶: Returns: int | None:

property func_max_val¶: Returns: float | None:

property func_nonlinear¶: Returns: int | None:

property func_piece_error¶: Returns: float | None:

property func_piece_length¶: Returns: float | None:

property func_piece_ratio¶: Returns: float | None:

property func_pieces¶: Returns: int | None:

property gomory_passes¶: Returns: int | None:

property gub_cover_cuts¶: Returns: int | None:

property heuristics¶: Returns: float | None:

property ignore_names¶: Returns: int | None:

property iis_method¶: Returns: int | None:

property implied_cuts¶: Returns: int | None:

property improve_start_gap¶: Returns: float | None:

property improve_start_nodes¶: Returns: float | None:

property improve_start_time¶: Returns: float | None:

property inf_proof_cuts¶: Returns: int | None:

property inf_unbd_info¶: Returns: int | None:

property int_feas_tol¶: Returns: float | None:

property integrality_focus¶: Returns: int | None:

property iteration_limit¶: Returns: float | None:

property job_id¶: Returns: str | None:

property json_sol_detail¶: Returns: int | None:

property lazy_constraints¶: Returns: int | None:

property license_id¶: Returns: int | None:

property lift_project_cuts¶: Returns: int | None:

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

property log_to_console¶: Returns: bool | None:

property lp_warm_start¶: Returns: int | None:

property markowitz_tol¶: Returns: float | None:

property mem_limit¶: Returns: float | None:

property method¶: Returns: int | None:

property min_rel_nodes¶: Returns: int | None:

property mip_focus¶: Returns: int | None:

property mip_gap¶: Returns: float | None:

property mip_gap_abs¶: Returns: float | None:

property mip_sep_cuts¶: Returns: int | None:

property miqcp_method¶: Returns: int | None:

property mir_cuts¶: Returns: int | None:

property mixing_cuts¶: Returns: int | None:

property mod_k_cuts¶: Returns: int | None:

property multi_obj_method¶: Returns: int | None:

property multi_obj_pre¶: Returns: int | None:

property network_alg¶: Returns: int | None:

property network_cuts¶: Returns: int | None:

property nlp_heur¶: Returns: int | None:

property no_rel_heur_time¶: Returns: float | None:

property no_rel_heur_work¶: Returns: float | None:

property no_rel_heuristic¶: Returns: int | None:

property node_limit¶: Returns: float | None:

property node_method¶: Returns: int | None:

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

property nodefile_start¶: Returns: float | None:

property non_convex¶: Returns: int | None:

property norm_adjust¶: Returns: int | None:

property numeric_focus¶: Returns: int | None:

property obbt¶: Returns: int | None:

property obj_number¶: Returns: int | None:

property obj_scale¶: Returns: float | None:

property optimality_tol¶: Returns: float | None:

property output_flag¶: Returns: int | None:

property partition_place¶: Returns: int | None:

property perturb_value¶: Returns: float | None:

property pool_gap¶: Returns: float | None:

property pool_gap_abs¶: Returns: float | None:

property pool_search_mode¶: Returns: int | None:

property pool_solutions¶: Returns: int | None:

property pre_crush¶: Returns: int | None:

property pre_dep_row¶: Returns: int | None:

property pre_dual¶: Returns: int | None:

property pre_miqcp_form¶: Returns: int | None:

property pre_passes¶: Returns: int | None:

property pre_q_linearize¶: Returns: int | None:

property pre_sparsify¶: Returns: int | None:

property presolve¶: Returns: int | None:

property proj_implied_cuts¶: Returns: int | None:

property psd_cuts¶: Returns: int | None:

property psd_tol¶: Returns: float | None:

property pump_passes¶: Returns: int | None:

property qcp_dual¶: Returns: int | None:

property quad¶: Returns: int | None:

property record¶: Returns: int | None:

property relax_lift_cuts¶: Returns: int | None:

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

property rins¶: Returns: int | None:

property rlt_cuts¶: Returns: int | None:

property scale_flag¶: Returns: int | None:

property scenario_number¶: Returns: int | None:

property seed¶: Returns: int | None:

property server_password¶: Returns: str | None:

property server_timeout¶: Returns: int | None:

property sift_method¶: Returns: int | None:

property sifting¶: Returns: int | None:

property simplex_pricing¶: Returns: int | None:

property soft_mem_limit¶: Returns: float | None:

property sol_files¶: Returns: str | None:

property solution_limit¶: Returns: int | None:

property solution_number¶: Returns: int | None:

property solution_target¶: Returns: int | None:

property start_node_limit¶: Returns: int | None:

property start_number¶: Returns: int | None:

property strong_cg_cuts¶: Returns: int | None:

property sub_mip_cuts¶: Returns: int | None:

property sub_mip_nodes¶: Returns: int | None:

property symmetry¶: Returns: int | None:

property thread_limit¶: Returns: int | None:

property threads¶: Returns: int | None:

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

property token_server¶: Returns: str | None:

property ts_port¶: Returns: int | None:

property tune_cleanup¶: Returns: float | None:

property tune_criterion¶: Returns: int | None:

property tune_dynamic_jobs¶: Returns: int | None:

property tune_jobs¶: Returns: int | None:

property tune_metric¶: Returns: int | None:

property tune_output¶: Returns: int | None:

property tune_results¶: Returns: int | None:

property tune_target_mip_gap¶: Returns: float | None:

property tune_target_time¶: Returns: float | None:

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

property tune_trials¶: Returns: int | None:

property update_mode¶: Returns: int | None:

property username¶: Returns: str | None:

property var_branch¶: Returns: int | None:

property wls_access_id¶: Returns: str | None:

property wls_config¶: Returns: str | None:

property wls_proxy¶: Returns: str | None:

property wls_secret¶: Returns: str | None:

property wls_token¶: Returns: str | None:

property wls_token_duration¶: Returns: int | None:

property wls_token_refresh¶: Returns: float | None:

property work_limit¶: Returns: float | None:

property worker_password¶: Returns: str | None:

property worker_pool¶: Returns: str | None:

property zero_half_cuts¶: Returns: int | None:

property zero_obj_nodes¶: Returns: int | None:

class Result¶

class OptimizationStatusCode¶

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

Cutoff = 6¶

InfOrUnbd = 4¶

Infeasible = 3¶

Inprogress = 14¶

Interrupted = 11¶

IterationLimit = 7¶

Loaded = 1¶

MemLimit = 17¶

NodeLimit = 8¶

Numeric = 12¶

Optimal = 2¶

SolutionLimit = 10¶

Suboptimal = 13¶

TimeLimit = 9¶

Unbounded = 5¶

Unknown = 0¶

UserObjLimit = 15¶

WorkLimit = 16¶

__nb_enum__ = <capsule object NULL>¶

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property bar_iter_count¶: Returns: int | None:

property bound_vio¶: Returns: float | None:

property constr_vio¶: Returns: float | None:

property farkas_proof¶: Returns: float | None:

property int_vio¶: Returns: float | None:

property iter_count¶: Returns: float | None:

property mip_gap¶: Returns: float | None:

property node_count¶: Returns: float | None:

property obj_bound¶: Returns: float | None:

property obj_bound_c¶: Returns: float | None:

property obj_val¶: Returns: float | None:

property pool_obj_bound¶: Returns: float | None:

property pool_obj_val¶: Returns: numpy.ndarray:

property runtime¶: Returns: datetime.timedelta:

property sol_count¶: Returns: int | None:

property status¶: Returns: amplify.GurobiClient.Result.OptimizationStatusCode:

property time_stamps¶: Returns: list[tuple[float, datetime.timedelta]]:

property var_names¶: Returns: list[str] | None:

property x¶: Returns: numpy.ndarray:

property xn¶: Returns: list[numpy.ndarray[dtype=float64, writable=False]] | None:

__init__(self) → None¶

__init__(self, library_path: str) → None

Parameters:: library_path (str)

__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.GurobiClient.Result:

Overload 2.

Args:

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

Returns:

amplify.GurobiClient.Result:

Overload 3.

Args:

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

Returns:

amplify.GurobiClient.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])

tune(self, objective: Poly | Matrix) → None¶

tune(self, constraint: Constraint | ConstraintList) → None

tune(self, objective: Poly | Matrix, constraint: Constraint | ConstraintList) → None

tune

Overload 1.

Args:

objective (amplify.Poly | amplify.Matrix)

Overload 2.

Args:

constraint (amplify.Constraint | amplify.ConstraintList)

Overload 3.

Args:

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

property acceptable_degrees¶: Returns: amplify.AcceptableDegrees:

property library_path¶: Returns: str | None:

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

property version¶: Returns: str:

property write_request_data¶: Returns: str | None:

property write_response_data¶: Returns: str | None: