0.6
Getting started
Introduction
Installation
Using Environments
How to
Use Observation Functions
Use Reward Functions
Create New Functions
Create New Environments
Generate Problem Instances
Practical Tutorials
Configuring the Solver with Bandits
Branching with Imitation Learning
Reference
Environments
Observations
Rewards
Informations
SCIP Interface
Instance Generators
Utilities
Discussion
Differences with OpenAi Gym
Seeding
Ecole Theoretical Model
Developer Zone
Contribution Guidelines
Example Contribute Observation Function
Ecole
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
__init__() (ecole.dynamics.BranchingDynamics method)
(ecole.dynamics.ConfiguringDynamics method)
(ecole.environment.Environment method)
(ecole.information.Nothing method)
(ecole.instance.CapacitatedFacilityLocationGenerator method)
(ecole.instance.CombinatorialAuctionGenerator method)
(ecole.instance.IndependentSetGenerator method)
(ecole.instance.IndependentSetGenerator.GraphType method)
(ecole.instance.SetCoverGenerator method)
(ecole.observation.Khalil2016 method)
(ecole.observation.Khalil2016Obs method)
(ecole.observation.Khalil2016Obs.Features method)
(ecole.observation.MilpBipartite method)
(ecole.observation.MilpBipartiteObs method)
(ecole.observation.MilpBipartiteObs.ConstraintFeatures method)
(ecole.observation.MilpBipartiteObs.VariableFeatures method)
(ecole.observation.NodeBipartite method)
(ecole.observation.NodeBipartiteObs method)
(ecole.observation.NodeBipartiteObs.ColumnFeatures method)
(ecole.observation.NodeBipartiteObs.RowFeatures method)
(ecole.observation.Pseudocosts method)
(ecole.observation.StrongBranchingScores method)
(ecole.RandomEngine method)
(ecole.reward.Arithmetic method)
(ecole.reward.Constant method)
(ecole.reward.IsDone method)
(ecole.reward.LpIterations method)
(ecole.reward.NNodes method)
(ecole.reward.SolvingTime method)
(ecole.scip.Model method)
(ecole.typing.Dynamics method)
(ecole.typing.InformationFunction method)
(ecole.typing.InstanceGenerator method)
(ecole.typing.ObservationFunction method)
(ecole.typing.RewardFunction method)
A
active_coef_weight1_count (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight1_max (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight1_mean (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight1_min (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight1_stddev (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight1_sum (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight2_count (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight2_max (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight2_mean (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight2_min (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight2_stddev (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight2_sum (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight3_count (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight3_max (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight3_mean (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight3_min (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight3_stddev (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight3_sum (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight4_count (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight4_max (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight4_mean (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight4_min (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight4_stddev (ecole.observation.Khalil2016Obs.Features attribute)
active_coef_weight4_sum (ecole.observation.Khalil2016Obs.Features attribute)
add_item_prob (ecole.instance.CombinatorialAuctionGenerator property)
additivity (ecole.instance.CombinatorialAuctionGenerator property)
affinity (ecole.instance.IndependentSetGenerator property)
Arithmetic (class in ecole.reward)
as_pyscipopt() (ecole.scip.Model method)
average_incumbent_value (ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
B
barabasi_albert (ecole.instance.IndependentSetGenerator attribute)
(ecole.instance.IndependentSetGenerator.GraphType attribute)
before_reset() (ecole.information.Nothing method)
(ecole.observation.Khalil2016 method)
(ecole.observation.MilpBipartite method)
(ecole.observation.NodeBipartite method)
(ecole.observation.Pseudocosts method)
(ecole.observation.StrongBranchingScores method)
(ecole.reward.Arithmetic method)
(ecole.reward.Constant method)
(ecole.reward.IsDone method)
(ecole.reward.LpIterations method)
(ecole.reward.NNodes method)
(ecole.reward.SolvingTime method)
(ecole.typing.InformationFunction method)
(ecole.typing.ObservationFunction method)
(ecole.typing.RewardFunction method)
bias (ecole.observation.MilpBipartiteObs.ConstraintFeatures attribute)
(ecole.observation.NodeBipartiteObs.RowFeatures attribute)
Branching (class in ecole.environment)
BranchingDynamics (class in ecole.dynamics)
budget_factor (ecole.instance.CombinatorialAuctionGenerator property)
C
CapacitatedFacilityLocationGenerator (class in ecole.instance)
capacity_interval (ecole.instance.CapacitatedFacilityLocationGenerator property)
ceil_dist (ecole.observation.Khalil2016Obs.Features attribute)
coef_neg_rhs_ratio_max (ecole.observation.Khalil2016Obs.Features attribute)
coef_neg_rhs_ratio_min (ecole.observation.Khalil2016Obs.Features attribute)
coef_pos_rhs_ratio_max (ecole.observation.Khalil2016Obs.Features attribute)
coef_pos_rhs_ratio_min (ecole.observation.Khalil2016Obs.Features attribute)
column_features (ecole.observation.NodeBipartiteObs property)
CombinatorialAuctionGenerator (class in ecole.instance)
Configuring (class in ecole.environment)
ConfiguringDynamics (class in ecole.dynamics)
Constant (class in ecole.reward)
constraint_features (ecole.observation.MilpBipartiteObs property)
continuous_assignment (ecole.instance.CapacitatedFacilityLocationGenerator property)
copy_orig() (ecole.scip.Model method)
D
demand_interval (ecole.instance.CapacitatedFacilityLocationGenerator property)
density (ecole.instance.SetCoverGenerator property)
disable_cuts() (ecole.scip.Model method)
disable_presolve() (ecole.scip.Model method)
discard() (ecole.RandomEngine method)
dual_solution_value (ecole.observation.NodeBipartiteObs.RowFeatures attribute)
Dynamics (class in ecole.typing)
E
edge_features (ecole.observation.MilpBipartiteObs property)
(ecole.observation.NodeBipartiteObs property)
edge_probability (ecole.instance.IndependentSetGenerator property)
Environment (class in ecole.environment)
erdos_renyi (ecole.instance.IndependentSetGenerator attribute)
(ecole.instance.IndependentSetGenerator.GraphType attribute)
extract() (ecole.information.Nothing method)
(ecole.observation.Khalil2016 method)
(ecole.observation.MilpBipartite method)
(ecole.observation.NodeBipartite method)
(ecole.observation.Pseudocosts method)
(ecole.observation.StrongBranchingScores method)
(ecole.reward.Arithmetic method)
(ecole.reward.Constant method)
(ecole.reward.IsDone method)
(ecole.reward.LpIterations method)
(ecole.reward.NNodes method)
(ecole.reward.SolvingTime method)
(ecole.typing.InformationFunction method)
(ecole.typing.ObservationFunction method)
(ecole.typing.RewardFunction method)
F
features (ecole.observation.Khalil2016Obs property)
fixed_cost_cste_interval (ecole.instance.CapacitatedFacilityLocationGenerator property)
fixed_cost_scale_interval (ecole.instance.CapacitatedFacilityLocationGenerator property)
from_file() (ecole.scip.Model static method)
from_pyscipopt() (ecole.scip.Model static method)
G
generate_instance() (ecole.instance.CapacitatedFacilityLocationGenerator static method)
(ecole.instance.CombinatorialAuctionGenerator static method)
(ecole.instance.IndependentSetGenerator static method)
(ecole.instance.SetCoverGenerator static method)
(ecole.typing.InstanceGenerator static method)
get_param() (ecole.scip.Model method)
get_params() (ecole.scip.Model method)
graph_type (ecole.instance.IndependentSetGenerator property)
H
has_lower_bound (ecole.observation.MilpBipartiteObs.VariableFeatures attribute)
(ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
has_upper_bound (ecole.observation.MilpBipartiteObs.VariableFeatures attribute)
(ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
I
incumbent_value (ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
IndependentSetGenerator (class in ecole.instance)
IndependentSetGenerator.GraphType (class in ecole.instance)
InformationFunction (class in ecole.typing)
InstanceGenerator (class in ecole.typing)
integers (ecole.instance.CombinatorialAuctionGenerator property)
is_basis_basic (ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
is_basis_lower (ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
is_basis_upper (ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
is_basis_zero (ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
is_solution_at_lower_bound (ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
is_solution_at_upper_bound (ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
is_solved() (ecole.scip.Model method)
is_tight (ecole.observation.NodeBipartiteObs.RowFeatures attribute)
is_type_binary (ecole.observation.MilpBipartiteObs.VariableFeatures attribute)
(ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
is_type_continuous (ecole.observation.MilpBipartiteObs.VariableFeatures attribute)
(ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
is_type_implicit_integer (ecole.observation.MilpBipartiteObs.VariableFeatures attribute)
(ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
is_type_integer (ecole.observation.MilpBipartiteObs.VariableFeatures attribute)
(ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
IsDone (class in ecole.reward)
K
Khalil2016 (class in ecole.observation)
Khalil2016Obs (class in ecole.observation)
Khalil2016Obs.Features (class in ecole.observation)
L
lower_bound (ecole.observation.MilpBipartiteObs.VariableFeatures attribute)
LpIterations (class in ecole.reward)
M
max_coef (ecole.instance.SetCoverGenerator property)
max_n_sub_bids (ecole.instance.CombinatorialAuctionGenerator property)
max_seed (ecole.RandomEngine attribute)
max_value (ecole.instance.CombinatorialAuctionGenerator property)
MilpBipartite (class in ecole.observation)
MilpBipartiteObs (class in ecole.observation)
MilpBipartiteObs.ConstraintFeatures (class in ecole.observation)
MilpBipartiteObs.VariableFeatures (class in ecole.observation)
min_seed (ecole.RandomEngine attribute)
min_value (ecole.instance.CombinatorialAuctionGenerator property)
Model (class in ecole.scip)
N
n_bids (ecole.instance.CombinatorialAuctionGenerator property)
n_cols (ecole.instance.SetCoverGenerator property)
n_customers (ecole.instance.CapacitatedFacilityLocationGenerator property)
n_cutoff_down (ecole.observation.Khalil2016Obs.Features attribute)
n_cutoff_down_ratio (ecole.observation.Khalil2016Obs.Features attribute)
n_cutoff_up (ecole.observation.Khalil2016Obs.Features attribute)
n_cutoff_up_ratio (ecole.observation.Khalil2016Obs.Features attribute)
n_dynamic_features (ecole.observation.Khalil2016Obs attribute)
n_facilities (ecole.instance.CapacitatedFacilityLocationGenerator property)
n_items (ecole.instance.CombinatorialAuctionGenerator property)
n_nodes (ecole.instance.IndependentSetGenerator property)
n_rows (ecole.instance.SetCoverGenerator property)
(ecole.observation.Khalil2016Obs.Features attribute)
n_static_features (ecole.observation.Khalil2016Obs attribute)
name (ecole.instance.IndependentSetGenerator.GraphType property)
(ecole.observation.Khalil2016Obs.Features property)
(ecole.observation.MilpBipartiteObs.ConstraintFeatures property)
(ecole.observation.MilpBipartiteObs.VariableFeatures property)
(ecole.observation.NodeBipartiteObs.ColumnFeatures property)
(ecole.observation.NodeBipartiteObs.RowFeatures property)
neg_coef_neg_coef_ratio_max (ecole.observation.Khalil2016Obs.Features attribute)
neg_coef_neg_coef_ratio_min (ecole.observation.Khalil2016Obs.Features attribute)
neg_coef_pos_coef_ratio_max (ecole.observation.Khalil2016Obs.Features attribute)
neg_coef_pos_coef_ratio_min (ecole.observation.Khalil2016Obs.Features attribute)
NNodes (class in ecole.reward)
NodeBipartite (class in ecole.observation)
NodeBipartiteObs (class in ecole.observation)
NodeBipartiteObs.ColumnFeatures (class in ecole.observation)
NodeBipartiteObs.RowFeatures (class in ecole.observation)
normed_reduced_cost (ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
Nothing (class in ecole.information)
(in module ecole.observation)
O
obj_coef (ecole.observation.Khalil2016Obs.Features attribute)
obj_coef_neg_part (ecole.observation.Khalil2016Obs.Features attribute)
obj_coef_pos_part (ecole.observation.Khalil2016Obs.Features attribute)
objective (ecole.observation.MilpBipartiteObs.VariableFeatures attribute)
(ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
objective_cosine_similarity (ecole.observation.NodeBipartiteObs.RowFeatures attribute)
ObservationFunction (class in ecole.typing)
P
pos_coef_neg_coef_ratio_max (ecole.observation.Khalil2016Obs.Features attribute)
pos_coef_neg_coef_ratio_min (ecole.observation.Khalil2016Obs.Features attribute)
pos_coef_pos_coef_ratio_max (ecole.observation.Khalil2016Obs.Features attribute)
pos_coef_pos_coef_ratio_min (ecole.observation.Khalil2016Obs.Features attribute)
presolve() (ecole.scip.Model method)
prob_basic() (ecole.scip.Model static method)
pseudocost_down (ecole.observation.Khalil2016Obs.Features attribute)
pseudocost_product (ecole.observation.Khalil2016Obs.Features attribute)
pseudocost_ratio (ecole.observation.Khalil2016Obs.Features attribute)
pseudocost_sum (ecole.observation.Khalil2016Obs.Features attribute)
pseudocost_up (ecole.observation.Khalil2016Obs.Features attribute)
Pseudocosts (class in ecole.observation)
R
RandomEngine (class in ecole)
ratio (ecole.instance.CapacitatedFacilityLocationGenerator property)
resale_factor (ecole.instance.CombinatorialAuctionGenerator property)
reset() (ecole.environment.Environment method)
reset_dynamics() (ecole.dynamics.BranchingDynamics method)
(ecole.dynamics.ConfiguringDynamics method)
(ecole.typing.Dynamics method)
RewardFunction (class in ecole.typing)
row_features (ecole.observation.NodeBipartiteObs property)
rows_deg_max (ecole.observation.Khalil2016Obs.Features attribute)
rows_deg_mean (ecole.observation.Khalil2016Obs.Features attribute)
rows_deg_min (ecole.observation.Khalil2016Obs.Features attribute)
rows_deg_stddev (ecole.observation.Khalil2016Obs.Features attribute)
rows_dynamic_deg_max (ecole.observation.Khalil2016Obs.Features attribute)
rows_dynamic_deg_max_ratio (ecole.observation.Khalil2016Obs.Features attribute)
rows_dynamic_deg_mean (ecole.observation.Khalil2016Obs.Features attribute)
rows_dynamic_deg_mean_ratio (ecole.observation.Khalil2016Obs.Features attribute)
rows_dynamic_deg_min (ecole.observation.Khalil2016Obs.Features attribute)
rows_dynamic_deg_min_ratio (ecole.observation.Khalil2016Obs.Features attribute)
rows_dynamic_deg_stddev (ecole.observation.Khalil2016Obs.Features attribute)
rows_neg_coefs_count (ecole.observation.Khalil2016Obs.Features attribute)
rows_neg_coefs_max (ecole.observation.Khalil2016Obs.Features attribute)
rows_neg_coefs_mean (ecole.observation.Khalil2016Obs.Features attribute)
rows_neg_coefs_min (ecole.observation.Khalil2016Obs.Features attribute)
rows_neg_coefs_stddev (ecole.observation.Khalil2016Obs.Features attribute)
rows_pos_coefs_count (ecole.observation.Khalil2016Obs.Features attribute)
rows_pos_coefs_max (ecole.observation.Khalil2016Obs.Features attribute)
rows_pos_coefs_mean (ecole.observation.Khalil2016Obs.Features attribute)
rows_pos_coefs_min (ecole.observation.Khalil2016Obs.Features attribute)
rows_pos_coefs_stddev (ecole.observation.Khalil2016Obs.Features attribute)
S
scaled_age (ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
(ecole.observation.NodeBipartiteObs.RowFeatures attribute)
seed() (ecole.environment.Environment method)
(ecole.instance.CapacitatedFacilityLocationGenerator method)
(ecole.instance.CombinatorialAuctionGenerator method)
(ecole.instance.IndependentSetGenerator method)
(ecole.instance.SetCoverGenerator method)
(ecole.RandomEngine method)
(ecole.typing.InstanceGenerator method)
(in module ecole)
set_dynamics_random_state() (ecole.dynamics.BranchingDynamics method)
(ecole.dynamics.ConfiguringDynamics method)
(ecole.typing.Dynamics method)
set_param() (ecole.scip.Model method)
set_params() (ecole.scip.Model method)
SetCoverGenerator (class in ecole.instance)
slack (ecole.observation.Khalil2016Obs.Features attribute)
solution_frac (ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
solution_value (ecole.observation.NodeBipartiteObs.ColumnFeatures attribute)
solve() (ecole.scip.Model method)
SolvingTime (class in ecole.reward)
spawn_random_engine() (in module ecole)
step() (ecole.environment.Environment method)
step_dynamics() (ecole.dynamics.BranchingDynamics method)
(ecole.dynamics.ConfiguringDynamics method)
(ecole.typing.Dynamics method)
StrongBranchingScores (class in ecole.observation)
T
transform_prob() (ecole.scip.Model method)
U
upper_bound (ecole.observation.MilpBipartiteObs.VariableFeatures attribute)
V
value (ecole.instance.IndependentSetGenerator.GraphType property)
(ecole.observation.Khalil2016Obs.Features property)
(ecole.observation.MilpBipartiteObs.ConstraintFeatures property)
(ecole.observation.MilpBipartiteObs.VariableFeatures property)
(ecole.observation.NodeBipartiteObs.ColumnFeatures property)
(ecole.observation.NodeBipartiteObs.RowFeatures property)
value_deviation (ecole.instance.CombinatorialAuctionGenerator property)
variable_features (ecole.observation.MilpBipartiteObs property)
W
warnings (ecole.instance.CombinatorialAuctionGenerator property)
write_problem() (ecole.scip.Model method)