ceml
latest
User Guide
Installation
Tutorial
Advanced
Theoretical background on the computation of counterfactual explanations
FAQ
API Reference
ceml
ceml.sklearn
ceml.tfkeras
ceml.torch
ceml.costfunctions
ceml.model
ceml.optim
ceml.backend.jax
ceml.backend.torch
ceml.backend.tensorflow
ceml
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
G
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
V
|
W
|
X
|
Y
A
AffinePreprocessing (class in ceml.backend.jax.preprocessing)
B
b (ceml.sklearn.linearregression.LinearRegression attribute)
(ceml.sklearn.softmaxregression.SoftmaxRegression attribute)
BFGS (class in ceml.optim.optimizer)
build_loss() (ceml.sklearn.pipeline.PipelineCounterfactual method)
(ceml.sklearn.randomforest.RandomForestCounterfactual method)
build_program() (ceml.optim.cvx.DCQP method)
build_regularization_loss() (in module ceml.sklearn.utils)
(in module ceml.torch.utils)
build_solve_opt() (ceml.optim.cvx.ConvexQuadraticProgram method)
(ceml.optim.cvx.SDP method)
C
ceml.backend.jax.costfunctions.costfunctions
module
ceml.backend.jax.preprocessing
module
ceml.backend.tensorflow.costfunctions.costfunctions
module
ceml.backend.tensorflow.optimizer.optimizer
module
ceml.backend.torch.costfunctions.costfunctions
module
ceml.backend.torch.optimizer.optimizer
module
ceml.costfunctions.costfunctions
module
ceml.model.counterfactual
module
ceml.model.model
module
ceml.optim.cvx
module
ceml.optim.ga
module
ceml.optim.input_wrapper
module
ceml.optim.optimizer
module
ceml.sklearn.counterfactual
module
ceml.sklearn.decisiontree
module
ceml.sklearn.isolationforest
module
ceml.sklearn.knn
module
ceml.sklearn.lda
module
ceml.sklearn.linearregression
module
ceml.sklearn.lvq
module
ceml.sklearn.models
module
ceml.sklearn.naivebayes
module
ceml.sklearn.pipeline
module
ceml.sklearn.plausibility
module
ceml.sklearn.qda
module
ceml.sklearn.randomforest
module
ceml.sklearn.softmaxregression
module
ceml.sklearn.utils
module
ceml.tfkeras.counterfactual
module
ceml.torch.counterfactual
module
ceml.torch.utils
module
class_priors (ceml.sklearn.lda.Lda attribute)
(ceml.sklearn.naivebayes.GaussianNB attribute)
(ceml.sklearn.qda.Qda attribute)
complete() (ceml.optim.input_wrapper.InputWrapper method)
compute_all_counterfactuals() (ceml.sklearn.decisiontree.DecisionTreeCounterfactual method)
compute_counterfactual() (ceml.model.counterfactual.Counterfactual method)
(ceml.sklearn.counterfactual.SklearnCounterfactual method)
(ceml.sklearn.decisiontree.DecisionTreeCounterfactual method)
(ceml.sklearn.isolationforest.IsolationForestCounterfactual method)
(ceml.sklearn.pipeline.PipelineCounterfactual method)
(ceml.sklearn.randomforest.RandomForestCounterfactual method)
(ceml.tfkeras.counterfactual.TfCounterfactual method)
(ceml.torch.counterfactual.TorchCounterfactual method)
compute_fitness() (ceml.optim.ga.EvolutionaryOptimizer method)
ConjugateGradients (class in ceml.optim.optimizer)
ConvexQuadraticProgram (class in ceml.optim.cvx)
CostFunction (class in ceml.costfunctions.costfunctions)
CostFunctionDifferentiable (class in ceml.costfunctions.costfunctions)
CostFunctionDifferentiableJax (class in ceml.backend.jax.costfunctions.costfunctions)
CostFunctionDifferentiableTf (class in ceml.backend.tensorflow.costfunctions.costfunctions)
CostFunctionDifferentiableTorch (class in ceml.backend.torch.costfunctions.costfunctions)
Counterfactual (class in ceml.model.counterfactual)
CQPHelper (class in ceml.sklearn.lvq)
crossover() (ceml.optim.ga.EvolutionaryOptimizer method)
D
DCQP (class in ceml.optim.cvx)
decisiontree_generate_counterfactual() (in module ceml.sklearn.decisiontree)
DecisionTreeCounterfactual (class in ceml.sklearn.decisiontree)
desc_to_dist() (in module ceml.sklearn.utils)
(in module ceml.torch.utils)
desc_to_regcost() (in module ceml.sklearn.utils)
(in module ceml.torch.utils)
dim (ceml.sklearn.lda.Lda attribute)
(ceml.sklearn.linearregression.LinearRegression attribute)
(ceml.sklearn.lvq.LVQ attribute)
(ceml.sklearn.naivebayes.GaussianNB attribute)
(ceml.sklearn.qda.Qda attribute)
(ceml.sklearn.softmaxregression.SoftmaxRegression attribute)
dist (ceml.sklearn.knn.KNN attribute)
(ceml.sklearn.lvq.LVQ attribute)
DummyCost (class in ceml.backend.jax.costfunctions.costfunctions)
(class in ceml.backend.tensorflow.costfunctions.costfunctions)
(class in ceml.backend.torch.costfunctions.costfunctions)
E
EnsembleVotingCost (class in ceml.sklearn.randomforest)
epsilon (ceml.optim.cvx.ConvexQuadraticProgram attribute)
(ceml.optim.cvx.DCQP attribute)
(ceml.optim.cvx.SDP attribute)
EvolutionaryOptimizer (class in ceml.optim.ga)
extract_from() (ceml.optim.input_wrapper.InputWrapper method)
G
GaussianNB (class in ceml.sklearn.naivebayes)
gaussiannb_generate_counterfactual() (in module ceml.sklearn.naivebayes)
GaussianNbCounterfactual (class in ceml.sklearn.naivebayes)
generate_counterfactual() (in module ceml.sklearn.models)
(in module ceml.tfkeras.counterfactual)
(in module ceml.torch.counterfactual)
get_loss() (ceml.model.model.ModelWithLoss method)
(ceml.sklearn.isolationforest.IsolationForest method)
(ceml.sklearn.knn.KNN method)
(ceml.sklearn.lda.Lda method)
(ceml.sklearn.linearregression.LinearRegression method)
(ceml.sklearn.lvq.LVQ method)
(ceml.sklearn.naivebayes.GaussianNB method)
(ceml.sklearn.pipeline.PipelineModel method)
(ceml.sklearn.qda.Qda method)
(ceml.sklearn.randomforest.RandomForest method)
(ceml.sklearn.softmaxregression.SoftmaxRegression method)
grad() (ceml.backend.jax.costfunctions.costfunctions.CostFunctionDifferentiableJax method)
(ceml.backend.tensorflow.costfunctions.costfunctions.CostFunctionDifferentiableTf method)
(ceml.backend.torch.costfunctions.costfunctions.CostFunctionDifferentiableTorch method)
(ceml.costfunctions.costfunctions.CostFunctionDifferentiable method)
I
init() (ceml.backend.tensorflow.optimizer.optimizer.TfOptimizer method)
(ceml.backend.torch.optimizer.optimizer.TorchOptimizer method)
(ceml.optim.ga.EvolutionaryOptimizer method)
(ceml.optim.optimizer.BFGS method)
(ceml.optim.optimizer.ConjugateGradients method)
(ceml.optim.optimizer.NelderMead method)
(ceml.optim.optimizer.Powell method)
InputWrapper (class in ceml.optim.input_wrapper)
is_binary (ceml.sklearn.naivebayes.GaussianNB attribute)
(ceml.sklearn.qda.Qda attribute)
is_multiclass (ceml.sklearn.softmaxregression.SoftmaxRegression attribute)
is_optimizer_grad_based() (in module ceml.optim.optimizer)
IsolationForest (class in ceml.sklearn.isolationforest)
isolationforest_generate_counterfactual() (in module ceml.sklearn.isolationforest)
IsolationForestCost (class in ceml.sklearn.isolationforest)
IsolationForestCounterfactual (class in ceml.sklearn.isolationforest)
K
KNN (class in ceml.sklearn.knn)
knn_generate_counterfactual() (in module ceml.sklearn.knn)
KnnCounterfactual (class in ceml.sklearn.knn)
L
L1Cost (class in ceml.backend.jax.costfunctions.costfunctions)
(class in ceml.backend.tensorflow.costfunctions.costfunctions)
(class in ceml.backend.torch.costfunctions.costfunctions)
L2Cost (class in ceml.backend.jax.costfunctions.costfunctions)
(class in ceml.backend.tensorflow.costfunctions.costfunctions)
(class in ceml.backend.torch.costfunctions.costfunctions)
labels (ceml.sklearn.lvq.LVQ attribute)
Lda (class in ceml.sklearn.lda)
lda_generate_counterfactual() (in module ceml.sklearn.lda)
LdaCounterfactual (class in ceml.sklearn.lda)
LinearRegression (class in ceml.sklearn.linearregression)
linearregression_generate_counterfactual() (in module ceml.sklearn.linearregression)
LinearRegressionCounterfactual (class in ceml.sklearn.linearregression)
LMadCost (class in ceml.backend.jax.costfunctions.costfunctions)
(class in ceml.backend.tensorflow.costfunctions.costfunctions)
(class in ceml.backend.torch.costfunctions.costfunctions)
LVQ (class in ceml.sklearn.lvq)
lvq_generate_counterfactual() (in module ceml.sklearn.lvq)
LvqCounterfactual (class in ceml.sklearn.lvq)
M
MathematicalProgram (class in ceml.optim.cvx)
means (ceml.sklearn.lda.Lda attribute)
(ceml.sklearn.naivebayes.GaussianNB attribute)
(ceml.sklearn.qda.Qda attribute)
MinMaxScaler (class in ceml.backend.jax.preprocessing)
MinOfListCost (class in ceml.backend.torch.costfunctions.costfunctions)
MinOfListDistCost (class in ceml.backend.jax.costfunctions.costfunctions)
MinOfListDistExCost (class in ceml.backend.jax.costfunctions.costfunctions)
model (ceml.sklearn.counterfactual.SklearnCounterfactual attribute)
(ceml.sklearn.lvq.LVQ attribute)
Model (class in ceml.backend.jax.preprocessing)
(class in ceml.model.model)
model_class (ceml.sklearn.lvq.LVQ attribute)
models (ceml.sklearn.pipeline.PipelineModel attribute)
ModelWithLoss (class in ceml.model.model)
module
ceml.backend.jax.costfunctions.costfunctions
ceml.backend.jax.preprocessing
ceml.backend.tensorflow.costfunctions.costfunctions
ceml.backend.tensorflow.optimizer.optimizer
ceml.backend.torch.costfunctions.costfunctions
ceml.backend.torch.optimizer.optimizer
ceml.costfunctions.costfunctions
ceml.model.counterfactual
ceml.model.model
ceml.optim.cvx
ceml.optim.ga
ceml.optim.input_wrapper
ceml.optim.optimizer
ceml.sklearn.counterfactual
ceml.sklearn.decisiontree
ceml.sklearn.isolationforest
ceml.sklearn.knn
ceml.sklearn.lda
ceml.sklearn.linearregression
ceml.sklearn.lvq
ceml.sklearn.models
ceml.sklearn.naivebayes
ceml.sklearn.pipeline
ceml.sklearn.plausibility
ceml.sklearn.qda
ceml.sklearn.randomforest
ceml.sklearn.softmaxregression
ceml.sklearn.utils
ceml.tfkeras.counterfactual
ceml.torch.counterfactual
ceml.torch.utils
mutate() (ceml.optim.ga.EvolutionaryOptimizer method)
mymodel (ceml.sklearn.counterfactual.SklearnCounterfactual attribute)
N
NegLogLikelihoodCost (class in ceml.backend.jax.costfunctions.costfunctions)
(class in ceml.backend.tensorflow.costfunctions.costfunctions)
(class in ceml.backend.torch.costfunctions.costfunctions)
NelderMead (class in ceml.optim.optimizer)
Normalizer (class in ceml.backend.jax.preprocessing)
O
Optimizer (class in ceml.optim.optimizer)
P
PCA (class in ceml.backend.jax.preprocessing)
pccp (ceml.optim.cvx.DCQP attribute)
PenaltyConvexConcaveProcedure (class in ceml.optim.cvx)
pipeline_generate_counterfactual() (in module ceml.sklearn.pipeline)
PipelineCounterfactual (class in ceml.sklearn.pipeline)
PipelineModel (class in ceml.sklearn.pipeline)
PolynomialFeatures (class in ceml.backend.jax.preprocessing)
Powell (class in ceml.optim.optimizer)
predict() (ceml.backend.jax.preprocessing.MinMaxScaler method)
(ceml.backend.jax.preprocessing.Model method)
(ceml.backend.jax.preprocessing.Normalizer method)
(ceml.backend.jax.preprocessing.PCA method)
(ceml.backend.jax.preprocessing.PolynomialFeatures method)
(ceml.backend.jax.preprocessing.StandardScaler method)
(ceml.model.model.Model method)
(ceml.sklearn.isolationforest.IsolationForest method)
(ceml.sklearn.knn.KNN method)
(ceml.sklearn.lda.Lda method)
(ceml.sklearn.linearregression.LinearRegression method)
(ceml.sklearn.lvq.LVQ method)
(ceml.sklearn.naivebayes.GaussianNB method)
(ceml.sklearn.pipeline.PipelineModel method)
(ceml.sklearn.qda.Qda method)
(ceml.sklearn.randomforest.RandomForest method)
(ceml.sklearn.softmaxregression.SoftmaxRegression method)
prepare_computation_of_plausible_counterfactuals() (in module ceml.sklearn.plausibility)
prepare_optim() (in module ceml.optim.optimizer)
prototypes (ceml.sklearn.lvq.LVQ attribute)
Q
Qda (class in ceml.sklearn.qda)
qda_generate_counterfactual() (in module ceml.sklearn.qda)
QdaCounterfactual (class in ceml.sklearn.qda)
R
RandomForest (class in ceml.sklearn.randomforest)
randomforest_generate_counterfactual() (in module ceml.sklearn.randomforest)
RandomForestCounterfactual (class in ceml.sklearn.randomforest)
rebuild_model() (ceml.sklearn.counterfactual.SklearnCounterfactual method)
(ceml.sklearn.decisiontree.DecisionTreeCounterfactual method)
(ceml.sklearn.isolationforest.IsolationForestCounterfactual method)
(ceml.sklearn.knn.KnnCounterfactual method)
(ceml.sklearn.lda.LdaCounterfactual method)
(ceml.sklearn.linearregression.LinearRegressionCounterfactual method)
(ceml.sklearn.lvq.LvqCounterfactual method)
(ceml.sklearn.naivebayes.GaussianNbCounterfactual method)
(ceml.sklearn.pipeline.PipelineCounterfactual method)
(ceml.sklearn.qda.QdaCounterfactual method)
(ceml.sklearn.randomforest.RandomForestCounterfactual method)
(ceml.sklearn.softmaxregression.SoftmaxCounterfactual method)
reduce() (in module ceml.backend.jax.preprocessing)
RegularizedCost (class in ceml.backend.jax.costfunctions.costfunctions)
(class in ceml.backend.tensorflow.costfunctions.costfunctions)
(class in ceml.backend.torch.costfunctions.costfunctions)
(class in ceml.costfunctions.costfunctions)
S
score_impl() (ceml.backend.jax.costfunctions.costfunctions.DummyCost method)
(ceml.backend.jax.costfunctions.costfunctions.L1Cost method)
(ceml.backend.jax.costfunctions.costfunctions.L2Cost method)
(ceml.backend.jax.costfunctions.costfunctions.LMadCost method)
(ceml.backend.jax.costfunctions.costfunctions.MinOfListDistCost method)
(ceml.backend.jax.costfunctions.costfunctions.MinOfListDistExCost method)
(ceml.backend.jax.costfunctions.costfunctions.NegLogLikelihoodCost method)
(ceml.backend.jax.costfunctions.costfunctions.RegularizedCost method)
(ceml.backend.jax.costfunctions.costfunctions.SquaredError method)
(ceml.backend.jax.costfunctions.costfunctions.TopKMinOfListDistCost method)
(ceml.backend.tensorflow.costfunctions.costfunctions.DummyCost method)
(ceml.backend.tensorflow.costfunctions.costfunctions.L1Cost method)
(ceml.backend.tensorflow.costfunctions.costfunctions.L2Cost method)
(ceml.backend.tensorflow.costfunctions.costfunctions.LMadCost method)
(ceml.backend.tensorflow.costfunctions.costfunctions.NegLogLikelihoodCost method)
(ceml.backend.tensorflow.costfunctions.costfunctions.RegularizedCost method)
(ceml.backend.tensorflow.costfunctions.costfunctions.SquaredError method)
(ceml.backend.torch.costfunctions.costfunctions.DummyCost method)
(ceml.backend.torch.costfunctions.costfunctions.L1Cost method)
(ceml.backend.torch.costfunctions.costfunctions.L2Cost method)
(ceml.backend.torch.costfunctions.costfunctions.LMadCost method)
(ceml.backend.torch.costfunctions.costfunctions.MinOfListCost method)
(ceml.backend.torch.costfunctions.costfunctions.NegLogLikelihoodCost method)
(ceml.backend.torch.costfunctions.costfunctions.RegularizedCost method)
(ceml.backend.torch.costfunctions.costfunctions.SquaredError method)
(ceml.costfunctions.costfunctions.CostFunction method)
(ceml.costfunctions.costfunctions.RegularizedCost method)
(ceml.sklearn.isolationforest.IsolationForestCost method)
(ceml.sklearn.randomforest.EnsembleVotingCost method)
SDP (class in ceml.optim.cvx)
select_candidates() (ceml.optim.ga.EvolutionaryOptimizer method)
sigma_inv (ceml.sklearn.lda.Lda attribute)
(ceml.sklearn.qda.Qda attribute)
SklearnCounterfactual (class in ceml.sklearn.counterfactual)
SoftmaxCounterfactual (class in ceml.sklearn.softmaxregression)
SoftmaxRegression (class in ceml.sklearn.softmaxregression)
softmaxregression_generate_counterfactual() (in module ceml.sklearn.softmaxregression)
solve() (ceml.optim.cvx.DCQP method)
(ceml.sklearn.lvq.LvqCounterfactual method)
(ceml.sklearn.naivebayes.GaussianNbCounterfactual method)
(ceml.sklearn.qda.QdaCounterfactual method)
SquaredError (class in ceml.backend.jax.costfunctions.costfunctions)
(class in ceml.backend.tensorflow.costfunctions.costfunctions)
(class in ceml.backend.torch.costfunctions.costfunctions)
StandardScaler (class in ceml.backend.jax.preprocessing)
SupportAffinePreprocessing (class in ceml.optim.cvx)
T
TfCounterfactual (class in ceml.tfkeras.counterfactual)
TfOptimizer (class in ceml.backend.tensorflow.optimizer.optimizer)
TopKMinOfListDistCost (class in ceml.backend.jax.costfunctions.costfunctions)
TorchCounterfactual (class in ceml.torch.counterfactual)
TorchOptimizer (class in ceml.backend.torch.optimizer.optimizer)
V
validate() (ceml.optim.ga.EvolutionaryOptimizer method)
variances (ceml.sklearn.naivebayes.GaussianNB attribute)
W
w (ceml.sklearn.linearregression.LinearRegression attribute)
(ceml.sklearn.softmaxregression.SoftmaxRegression attribute)
X
X (ceml.sklearn.knn.KNN attribute)
Y
y (ceml.sklearn.knn.KNN attribute)
Read the Docs
v: latest
Versions
latest
stable
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds