GurobiClient#

class GurobiClient#

Methods

`__init__`	__init__
`solve`	solve
`tune`	tune

Attributes

`acceptable_degrees`	acceptable_degrees property
`library_path`	library_path property
`parameters`	parameters 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 agg_fill#

agg_fill property

Return type:: int | None

property aggregate#

aggregate property

Return type:: int | None

property bar_conv_tol#

bar_conv_tol property

Return type:: float | None

property bar_correctors#

bar_correctors property

Return type:: int | None

property bar_homogeneous#

bar_homogeneous property

Return type:: int | None

property bar_iter_limit#

bar_iter_limit property

Return type:: int | None

property bar_order#

bar_order property

Return type:: int | None

property bar_qcp_conv_tol#

bar_qcp_conv_tol property

Return type:: float | None

property best_bd_stop#

best_bd_stop property

Return type:: float | None

property best_obj_stop#

best_obj_stop property

Return type:: float | None

property bqp_cuts#

bqp_cuts property

Return type:: int | None

property branch_dir#

branch_dir property

Return type:: int | None

property clique_cuts#

clique_cuts property

Return type:: int | None

property cloud_access_id#

cloud_access_id property

Return type:: str | None

property cloud_host#

cloud_host property

Return type:: str | None

property cloud_pool#

cloud_pool property

Return type:: str | None

property cloud_secret_key#

cloud_secret_key property

Return type:: str | None

property compute_server#

compute_server property

Return type:: str | None

property concurrent_jobs#

concurrent_jobs property

Return type:: int | None

property concurrent_method#

concurrent_method property

Return type:: int | None

property concurrent_mip#

concurrent_mip property

Return type:: int | None

property cover_cuts#

cover_cuts property

Return type:: int | None

property crossover#

crossover property

Return type:: int | None

property crossover_basis#

crossover_basis property

Return type:: int | None

property cs_app_name#

cs_app_name property

Return type:: str | None

property cs_auth_token#

cs_auth_token property

Return type:: str | None

property cs_batch_mode#

cs_batch_mode property

Return type:: int | None

property cs_client_log#

cs_client_log property

Return type:: int | None

property cs_group#

cs_group property

Return type:: str | None

property cs_idle_timeout#

cs_idle_timeout property

Return type:: int | None

property cs_manager#

cs_manager property

Return type:: str | None

property cs_priority#

cs_priority property

Return type:: int | None

property cs_queue_timeout#

cs_queue_timeout property

Return type:: float | None

property cs_router#

cs_router property

Return type:: str | None

property csapi_access_id#

csapi_access_id property

Return type:: str | None

property csapi_secret#

csapi_secret property

Return type:: str | None

property cstls_insecure#

cstls_insecure property

Return type:: int | None

property cut_agg_passes#

cut_agg_passes property

Return type:: int | None

property cut_passes#

cut_passes property

Return type:: int | None

property cutoff#

cutoff property

Return type:: float | None

property cuts#

cuts property

Return type:: int | None

property degen_moves#

degen_moves property

Return type:: int | None

property disconnected#

disconnected property

Return type:: int | None

property display_interval#

display_interval property

Return type:: int | None

property distributed_mip_jobs#

distributed_mip_jobs property

Return type:: int | None

property dual_reductions#

dual_reductions property

Return type:: int | None

property feas_relax_big_m#

feas_relax_big_m property

Return type:: float | None

property feasibility_tol#

feasibility_tol property

Return type:: float | None

property flow_cover_cuts#

flow_cover_cuts property

Return type:: int | None

property flow_path_cuts#

flow_path_cuts property

Return type:: int | None

property func_max_val#

func_max_val property

Return type:: float | None

property func_nonlinear#

func_nonlinear property

Return type:: int | None

property func_piece_error#

func_piece_error property

Return type:: float | None

property func_piece_length#

func_piece_length property

Return type:: float | None

property func_piece_ratio#

func_piece_ratio property

Return type:: float | None

property func_pieces#

func_pieces property

Return type:: int | None

property gomory_passes#

gomory_passes property

Return type:: int | None

property gub_cover_cuts#

gub_cover_cuts property

Return type:: int | None

property heuristics#

heuristics property

Return type:: float | None

property ignore_names#

ignore_names property

Return type:: int | None

property iis_method#

iis_method property

Return type:: int | None

property implied_cuts#

implied_cuts property

Return type:: int | None

property improve_start_gap#

improve_start_gap property

Return type:: float | None

property improve_start_nodes#

improve_start_nodes property

Return type:: float | None

property improve_start_time#

improve_start_time property

Return type:: float | None

property inf_proof_cuts#

inf_proof_cuts property

Return type:: int | None

property inf_unbd_info#

inf_unbd_info property

Return type:: int | None

property int_feas_tol#

int_feas_tol property

Return type:: float | None

property integrality_focus#

integrality_focus property

Return type:: int | None

property iteration_limit#

iteration_limit property

Return type:: float | None

property job_id#

job_id property

Return type:: str | None

property json_sol_detail#

json_sol_detail property

Return type:: int | None

property lazy_constraints#

lazy_constraints property

Return type:: int | None

property license_id#

license_id property

Return type:: int | None

property lift_project_cuts#

lift_project_cuts property

Return type:: int | None

property log_file#

log_file property

Return type:: PathLike | None

property log_to_console#

log_to_console property

Return type:: bool | None

property lp_warm_start#

lp_warm_start property

Return type:: int | None

property markowitz_tol#

markowitz_tol property

Return type:: float | None

property mem_limit#

mem_limit property

Return type:: float | None

property method#

method property

Return type:: int | None

property min_rel_nodes#

min_rel_nodes property

Return type:: int | None

property mip_focus#

mip_focus property

Return type:: int | None

property mip_gap#

mip_gap property

Return type:: float | None

property mip_gap_abs#

mip_gap_abs property

Return type:: float | None

property mip_sep_cuts#

mip_sep_cuts property

Return type:: int | None

property miqcp_method#

miqcp_method property

Return type:: int | None

property mir_cuts#

mir_cuts property

Return type:: int | None

property mixing_cuts#

mixing_cuts property

Return type:: int | None

property mod_k_cuts#

mod_k_cuts property

Return type:: int | None

property multi_obj_method#

multi_obj_method property

Return type:: int | None

property multi_obj_pre#

multi_obj_pre property

Return type:: int | None

property network_alg#

network_alg property

Return type:: int | None

property network_cuts#

network_cuts property

Return type:: int | None

property nlp_heur#

nlp_heur property

Return type:: int | None

property no_rel_heur_time#

no_rel_heur_time property

Return type:: float | None

property no_rel_heur_work#

no_rel_heur_work property

Return type:: float | None

property no_rel_heuristic#

no_rel_heuristic property

Return type:: int | None

property node_limit#

node_limit property

Return type:: float | None

property node_method#

node_method property

Return type:: int | None

property nodefile_dir#

nodefile_dir property

Return type:: PathLike | None

property nodefile_start#

nodefile_start property

Return type:: float | None

property non_convex#

non_convex property

Return type:: int | None

property norm_adjust#

norm_adjust property

Return type:: int | None

property numeric_focus#

numeric_focus property

Return type:: int | None

property obbt#

obbt property

Return type:: int | None

property obj_number#

obj_number property

Return type:: int | None

property obj_scale#

obj_scale property

Return type:: float | None

property optimality_tol#

optimality_tol property

Return type:: float | None

property output_flag#

output_flag property

Return type:: int | None

property partition_place#

partition_place property

Return type:: int | None

property perturb_value#

perturb_value property

Return type:: float | None

property pool_gap#

pool_gap property

Return type:: float | None

property pool_gap_abs#

pool_gap_abs property

Return type:: float | None

property pool_search_mode#

pool_search_mode property

Return type:: int | None

property pool_solutions#

pool_solutions property

Return type:: int | None

property pre_crush#

pre_crush property

Return type:: int | None

property pre_dep_row#

pre_dep_row property

Return type:: int | None

property pre_dual#

pre_dual property

Return type:: int | None

property pre_miqcp_form#

pre_miqcp_form property

Return type:: int | None

property pre_passes#

pre_passes property

Return type:: int | None

property pre_q_linearize#

pre_q_linearize property

Return type:: int | None

property pre_sparsify#

pre_sparsify property

Return type:: int | None

property presolve#

presolve property

Return type:: int | None

property proj_implied_cuts#

proj_implied_cuts property

Return type:: int | None

property psd_cuts#

psd_cuts property

Return type:: int | None

property psd_tol#

psd_tol property

Return type:: float | None

property pump_passes#

pump_passes property

Return type:: int | None

property qcp_dual#

qcp_dual property

Return type:: int | None

property quad#

quad property

Return type:: int | None

property record#

record property

Return type:: int | None

property relax_lift_cuts#

relax_lift_cuts property

Return type:: int | None

property result_file#

result_file property

Return type:: PathLike | None

property rins#

rins property

Return type:: int | None

property rlt_cuts#

rlt_cuts property

Return type:: int | None

property scale_flag#

scale_flag property

Return type:: int | None

property scenario_number#

scenario_number property

Return type:: int | None

property seed#

seed property

Return type:: int | None

property server_password#

server_password property

Return type:: str | None

property server_timeout#

server_timeout property

Return type:: int | None

property sift_method#

sift_method property

Return type:: int | None

property sifting#

sifting property

Return type:: int | None

property simplex_pricing#

simplex_pricing property

Return type:: int | None

property soft_mem_limit#

soft_mem_limit property

Return type:: float | None

property sol_files#

sol_files property

Return type:: str | None

property solution_limit#

solution_limit property

Return type:: int | None

property solution_number#

solution_number property

Return type:: int | None

property solution_target#

solution_target property

Return type:: int | None

property start_node_limit#

start_node_limit property

Return type:: int | None

property start_number#

start_number property

Return type:: int | None

property strong_cg_cuts#

strong_cg_cuts property

Return type:: int | None

property sub_mip_cuts#

sub_mip_cuts property

Return type:: int | None

property sub_mip_nodes#

sub_mip_nodes property

Return type:: int | None

property symmetry#

symmetry property

Return type:: int | None

property threads#

threads property

Return type:: int | None

property time_limit#

time_limit property

Return type:: timedelta | None

property token_server#

token_server property

Return type:: str | None

property ts_port#

ts_port property

Return type:: int | None

property tune_cleanup#

tune_cleanup property

Return type:: float | None

property tune_criterion#

tune_criterion property

Return type:: int | None

property tune_dynamic_jobs#

tune_dynamic_jobs property

Return type:: int | None

property tune_jobs#

tune_jobs property

Return type:: int | None

property tune_metric#

tune_metric property

Return type:: int | None

property tune_output#

tune_output property

Return type:: int | None

property tune_results#

tune_results property

Return type:: int | None

property tune_target_mip_gap#

tune_target_mip_gap property

Return type:: float | None

property tune_target_time#

tune_target_time property

Return type:: float | None

property tune_time_limit#

tune_time_limit property

Return type:: timedelta | None

property tune_trials#

tune_trials property

Return type:: int | None

property update_mode#

update_mode property

Return type:: int | None

property username#

username property

Return type:: str | None

property var_branch#

var_branch property

Return type:: int | None

property wls_access_id#

wls_access_id property

Return type:: str | None

property wls_secret#

wls_secret property

Return type:: str | None

property wls_token#

wls_token property

Return type:: str | None

property wls_token_duration#

wls_token_duration property

Return type:: int | None

property wls_token_refresh#

wls_token_refresh property

Return type:: float | None

property work_limit#

work_limit property

Return type:: float | None

property worker_password#

worker_password property

Return type:: str | None

property worker_pool#

worker_pool property

Return type:: str | None

property zero_half_cuts#

zero_half_cuts property

Return type:: int | None

property zero_obj_nodes#

zero_obj_nodes property

Return type:: int | None

class Result#

class OptimizationStatusCode#

__eq__(value, /)#: Return self==value.

__ge__(value, /)#: Return self>=value.

__gt__(value, /)#: Return self>value.

__hash__()#: Return hash(self).

__index__()#: Return self converted to an integer, if self is suitable for use as an index into a list.

__init__(*args, **kwargs)#

__int__()#: int(self)

__le__(value, /)#: Return self<=value.

__lt__(value, /)#: Return self<value.

__ne__(value, /)#: Return self!=value.

__repr__(self) → str#

__repr__

Return type:: str

__str__(self) → str#

__str__

Return type:: str

Cutoff = Cutoff#

InfOrUnbd = InfOrUnbd#

Infeasible = Infeasible#

Inprogress = Inprogress#

Interrupted = Interrupted#

IterationLimit = IterationLimit#

Loaded = Loaded#

MemLimit = MemLimit#

NodeLimit = NodeLimit#

Numeric = Numeric#

Optimal = Optimal#

SolutionLimit = SolutionLimit#

Suboptimal = Suboptimal#

TimeLimit = TimeLimit#

Unbounded = Unbounded#

Unknown = Unknown#

UserObjLimit = UserObjLimit#

WorkLimit = WorkLimit#

__name__ = 'OptimizationStatusCode'#

__init__(*args, **kwargs)#

__repr__(self) → str#

__repr__

Return type:: str

__str__(self) → str#

__str__

Return type:: str

property bar_iter_count#

bar_iter_count property

Return type:: int | None

property bound_vio#

bound_vio property

Return type:: float | None

property constr_vio#

constr_vio property

Return type:: float | None

property farkas_proof#

farkas_proof property

Return type:: float | None

property int_vio#

int_vio property

Return type:: float | None

property iter_count#

iter_count property

Return type:: float | None

property mip_gap#

mip_gap property

Return type:: float | None

property node_count#

node_count property

Return type:: float | None

property obj_bound#

obj_bound property

Return type:: float | None

property obj_bound_c#

obj_bound_c property

Return type:: float | None

property obj_val#

obj_val property

Return type:: float | None

property pool_obj_bound#

pool_obj_bound property

Return type:: float | None

property pool_obj_val#

pool_obj_val property

Return type:: ndarray | None

property runtime#

runtime property

Return type:: timedelta

property sol_count#

sol_count property

Return type:: int | None

property status#

status property

Return type:: OptimizationStatusCode

property time_stamps#

time_stamps property

Return type:: list[tuple[float, timedelta]]

property var_names#

var_names property

Return type:: list[str] | None

property x#

x property

Return type:: ndarray | None

property xn#

xn property

Return type:: list[ndarray[Any, dtype[numpy.float64], writable[False]]] | None

__init__(self) → None#

__init__(self, library_path: str) → None

__init__

Parameters:: library_path (str) –

__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

Overloading:

1. solve(self, objective: Union[amplify.Poly, amplify.Matrix], dry_run: Literal[False] = False) -> amplify.GurobiClient.Result

Args:

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

Returns:

amplify.GurobiClient.Result:

2. solve(self, constraint: Union[amplify.Constraint, amplify.ConstraintList], dry_run: Literal[False] = False) -> amplify.GurobiClient.Result

Args:

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

Returns:

amplify.GurobiClient.Result:

3. solve(self, objective: Union[amplify.Poly, amplify.Matrix], constraint: Union[amplify.Constraint, amplify.ConstraintList], dry_run: Literal[False] = False) -> amplify.GurobiClient.Result

Args:

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

Returns:

amplify.GurobiClient.Result:

4. solve(self, objective: Union[amplify.Poly, amplify.Matrix], dry_run: Literal[True]) -> None

Args:

objective (amplify.Poly | amplify.Matrix):
dry_run (Literal[True]):

5. solve(self, constraint: Union[amplify.Constraint, amplify.ConstraintList], dry_run: Literal[True]) -> None

Args:

constraint (amplify.Constraint | amplify.ConstraintList):
dry_run (Literal[True]):

6. solve(self, objective: Union[amplify.Poly, amplify.Matrix], constraint: Union[amplify.Constraint, amplify.ConstraintList], dry_run: Literal[True]) -> None

Args:

objective (amplify.Poly | amplify.Matrix):
constraint (amplify.Constraint | amplify.ConstraintList):
dry_run (Literal[True]):

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

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

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

tune

Overloading:

1. tune(self, objective: Union[amplify.Poly, amplify.Matrix]) -> None

Args:

objective (amplify.Poly | amplify.Matrix):

2. tune(self, constraint: Union[amplify.Constraint, amplify.ConstraintList]) -> None

Args:

constraint (amplify.Constraint | amplify.ConstraintList):

3. tune(self, objective: Union[amplify.Poly, amplify.Matrix], constraint: Union[amplify.Constraint, amplify.ConstraintList]) -> None

Args:

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

property acceptable_degrees#

acceptable_degrees property

Return type:: AcceptableDegrees

property library_path#

library_path property

Return type:: str | None

property parameters#

parameters property

Return type:: Parameters

property version#

version property

Return type:: str

property write_request_data#

write_request_data property

Return type:: str | None

property write_response_data#

write_response_data property

Return type:: str | None