OCEAN
User Guide
Overview
Mathematical Model
Low-level Internals
Installation
Quickstart
Visual Examples
Data Preparation
Explainer Guide
Custom Dataset Example
API Reference
API Reference
OCEAN
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
V
|
W
|
X
_
__init__() (Indexer method)
_add_objective() (Model method)
,
[1]
_add_soft_l1_binary() (Model method)
_add_soft_l1_continuous() (Model method)
_add_soft_l1_discrete() (Model method)
_add_soft_l1_ohe() (Model method)
_encode_weighted_sum_constraint() (Model method)
_get_function() (TreeManager method)
,
[1]
,
[2]
_get_intervals_cost() (Model method)
_get_length() (TreeManager method)
_set_isolation() (Model method)
_set_majority_class() (Model method)
,
[1]
,
[2]
_set_mapper() (FeatureManager method)
,
[1]
,
[2]
_set_trees() (TreeManager method)
,
[1]
,
[2]
_set_weights() (TreeManager method)
,
[1]
,
[2]
A
adaboost (Tree property)
add() (Feature method)
add_exactly_one() (BaseModel method)
add_garbage() (GarbageManager method)
,
[1]
,
[2]
add_hard() (BaseModel method)
add_objective() (Model method)
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
add_soft() (BaseModel method)
add_var() (BaseModel method)
apply() (Mapper method)
B
BaseExplainer (class in ocean.typing)
BaseExplanation (class in ocean.typing)
BaseModel (class in ocean.cp)
(class in ocean.maxsat)
(class in ocean.mip)
BINARY (Feature.Type attribute)
(TreeVar.FlowType attribute)
build() (ConstraintProgramBuilder method)
(FeatureVar method)
,
[1]
,
[2]
(Model method)
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
(TreeVar method)
,
[1]
,
[2]
build_features() (FeatureManager method)
,
[1]
,
[2]
,
[3]
,
[4]
build_trees() (TreeManager method)
,
[1]
,
[2]
,
[3]
,
[4]
build_vars() (BaseModel method)
,
[1]
,
[2]
C
children_left (SKLearnTree attribute)
children_right (SKLearnTree attribute)
cleanup() (BaseExplainer method)
(Model method)
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
clear_majority_class() (Model method)
,
[1]
code (Node property)
CODE_LEVEL (Mapper attribute)
codes (Feature property)
(Mapper property)
columns (Mapper property)
ConstraintProgramBuilder (class in ocean.cp)
ConstraintProgrammingExplainer (in module ocean)
CONTINUOUS (Feature.Type attribute)
(TreeVar.FlowType attribute)
cost (MaxSATSolver property)
CP (Model.Type attribute)
D
DEFAULT_EPSILON (Model attribute)
,
[1]
,
[2]
DEFAULT_NUM_EPSILON (Model attribute)
DEFAULT_SCORE_SCALE (TreeManager attribute)
delete() (MaxSATSolver method)
DISCRETE (Feature.Type attribute)
E
estimators (TreeManager property)
,
[1]
explain() (BaseExplainer method)
(Explainer method)
,
[1]
,
[2]
Explainer (class in ocean.cp)
(class in ocean.maxsat)
(class in ocean.mip)
Explanation (class in ocean.cp)
(class in ocean.maxsat)
(class in ocean.mip)
explanation (FeatureManager property)
,
[1]
F
Feature (class in ocean.feature)
feature (Node property)
(SKLearnTree attribute)
Feature.Type (class in ocean.feature)
FEATURE_VAR_FMT (FeatureManager attribute)
,
[1]
FeatureManager (class in ocean.cp)
(class in ocean.cp._managers._feature)
(class in ocean.maxsat)
(class in ocean.maxsat._managers._feature)
(class in ocean.mip._managers._feature)
FeatureVar (class in ocean.cp)
(class in ocean.maxsat)
(class in ocean.mip)
FLOW_VAR_NAME_FMT (TreeVar attribute)
format_continuous_value() (Explanation method)
format_discrete_value() (Explanation method)
,
[1]
,
[2]
format_value() (Explanation method)
,
[1]
ftype (Feature property)
function (TreeManager property)
,
[1]
G
garbage_list() (GarbageManager method)
GarbageManager (class in ocean.cp._managers._garbage)
(class in ocean.maxsat._managers._garbage)
(class in ocean.mip._managers._garbage)
get() (Indexer method)
get_anytime_solutions() (BaseExplainer method)
(Explainer method)
,
[1]
,
[2]
get_distance() (BaseExplainer method)
(Explainer method)
,
[1]
,
[2]
get_intervals_cost() (Model method)
,
[1]
get_objective_value() (BaseExplainer method)
(Explainer method)
,
[1]
,
[2]
get_solving_status() (BaseExplainer method)
(Explainer method)
,
[1]
,
[2]
get_values_cost() (Model method)
get_var() (BaseModel method)
I
idx (Mapper property)
Indexer (class in ocean.abc._mapper)
invalidate_solver_state() (BaseModel method)
is_binary (Feature property)
is_continuous (Feature property)
is_discrete (Feature property)
is_multi_level (Mapper property)
is_numeric (Feature property)
is_one_hot_encoded (Feature property)
L
L1() (Model method)
,
[1]
,
[2]
,
[3]
L2() (Model static method)
,
[1]
leaves (Tree property)
left (Node property)
length (Node property)
(TreeVar property)
levels (Feature property)
load_adult() (in module ocean.datasets)
load_compas() (in module ocean.datasets)
load_credit() (in module ocean.datasets)
logit (Tree property)
M
Mapper (class in ocean.abc)
mapper (FeatureManager property)
,
[1]
max_depth (SKLearnTree attribute)
(Tree property)
MAXSAT (Model.Type attribute)
MaxSATExplainer (in module ocean)
MaxSATSolver (class in ocean.maxsat)
mget() (FeatureVar method)
MIP (Model.Type attribute)
MixedIntegerProgramExplainer (in module ocean)
Model (class in ocean.cp)
(class in ocean.cp._model)
(class in ocean.maxsat)
(class in ocean.maxsat._model)
(class in ocean.mip)
(class in ocean.mip._model)
model() (MaxSATSolver method)
Model.Type (class in ocean.cp)
(class in ocean.maxsat)
(class in ocean.mip)
module
ocean
ocean.abc
ocean.cp
ocean.datasets
ocean.feature
ocean.maxsat
ocean.mip
ocean.tree
ocean.typing
N
n_classes (TreeManager property)
,
[1]
n_columns (FeatureManager property)
,
[1]
(Mapper property)
n_estimators (TreeManager property)
,
[1]
n_features (FeatureManager property)
,
[1]
n_levels (Mapper property)
n_node_samples (SKLearnTree attribute)
n_nodes (Tree property)
n_samples (Node property)
n_trees (TreeManager property)
,
[1]
NAME_LEVEL (Mapper attribute)
names (Mapper property)
Node (class in ocean.tree)
node_count (SKLearnTree attribute)
node_id (Node property)
nodes_at() (Tree method)
NUM_BINARY_CLASS (TreeManager attribute)
O
objvarget() (FeatureVar method)
ocean
module
ocean.abc
module
ocean.cp
module
ocean.datasets
module
ocean.feature
module
ocean.maxsat
module
ocean.mip
module
ocean.tree
module
ocean.typing
module
ONE_HOT_ENCODED (Feature.Type attribute)
P
parse_ensembles() (in module ocean.tree)
parse_features() (in module ocean.feature)
parse_tree() (in module ocean.tree)
parse_trees() (in module ocean.tree)
PATH_VAR_NAME_FMT (TreeVar attribute)
,
[1]
Q
query (BaseExplanation property)
(Explanation property)
,
[1]
,
[2]
R
reduce() (Mapper method)
remove_garbage() (GarbageManager method)
,
[1]
,
[2]
right (Node property)
root (Tree attribute)
S
score_scale (TreeManager property)
set_majority_class() (Model method)
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
shape (Tree property)
(TreeManager property)
,
[1]
sigma (Node property)
SKLearnTree (class in ocean.typing)
solve() (MaxSATSolver method)
solver_epoch (BaseModel property)
state_token (MaxSATSolver property)
state_version (MaxSATSolver property)
Status (Explainer attribute)
synced_counts (MaxSATSolver property)
T
threshold (Node property)
(SKLearnTree attribute)
thresholds (Feature property)
to_numpy() (BaseExplanation method)
(Explanation method)
,
[1]
,
[2]
to_series() (BaseExplanation method)
(Explanation method)
,
[1]
,
[2]
Tree (class in ocean.tree)
TREE_VAR_FMT (TreeManager attribute)
,
[1]
TreeManager (class in ocean.cp)
(class in ocean.cp._managers._tree)
(class in ocean.maxsat)
(class in ocean.maxsat._managers._tree)
(class in ocean.mip._managers._tree)
trees (TreeManager property)
,
[1]
TreeVar (class in ocean.cp)
(class in ocean.maxsat)
(class in ocean.mip)
TreeVar.FlowType (class in ocean.mip)
V
value (BaseExplanation property)
(Explanation property)
,
[1]
,
[2]
(Node property)
(SKLearnTree attribute)
(TreeVar property)
vget() (Explanation method)
,
[1]
,
[2]
(FeatureManager method)
,
[1]
,
[2]
,
[3]
,
[4]
vpool (BaseModel attribute)
W
weighted_function() (TreeManager method)
,
[1]
,
[2]
,
[3]
,
[4]
weighted_x() (FeatureVar method)
weights (TreeManager property)
,
[1]
X
x (BaseExplanation property)
(Explanation property)
,
[1]
,
[2]
X_VAR_NAME_FMT (FeatureVar attribute)
,
[1]
,
[2]
xgb_margin_function() (TreeManager method)
xgboost (Tree property)
XGBOOST_DEFAULT_CLASS (TreeManager attribute)
xget() (FeatureVar method)
,
[1]
,
[2]