cfl
latest
Getting Started
Install CFL
What is Causal Feature Learning?
CFL Package In-Depth Tutorial
CFL Package Quick Start
In-Depth Feature Tutorials
CondDensityEstimator Hyperparameter Tuning with Optuna
CauseClusterer and EffectClusterer Hyperparameter Tuning
Built-in Macrostate Visualizations
How to add new CondDensityEstimators, CauseClusterers, and EffectClusterers to CFL
Dataset Applications
Applying CFL to the Visual Bars Dataset
Applying CFL to the El NiƱo Dataset
Contribute to CFL
Contribute to CFL
More Info
Background: Visual Bars Data
Some Notes on Conditional Density Estimators (CDEs)
Some Notes on Clustering
How to Use Data Version Control (DVC)
cfl
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
_
__build_block() (cfl.experiment.Experiment method)
__for_continuous_Y() (in module cfl.visualization.cde_diagnostic)
__init__() (cfl.block.Block method)
(cfl.clustering.cause_clusterer.CauseClusterer method)
(cfl.clustering.clusterer_model.ClustererModel method)
(cfl.clustering.effect_clusterer.EffectClusterer method)
(cfl.clustering.snn.SNN method)
(cfl.cond_density_estimation.cde_model.CDEModel method)
(cfl.cond_density_estimation.condDensityEstimator.CondDensityEstimator method)
(cfl.cond_density_estimation.condExpBase.CondExpBase method)
(cfl.cond_density_estimation.condExpCNN.CondExpCNN method)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY method)
(cfl.cond_density_estimation.condExpMod.CondExpMod method)
(cfl.cond_density_estimation.condExpRidgeRegCV.CondExpRidgeCV method)
(cfl.dataset.Dataset method)
(cfl.experiment.Experiment method)
__load_params() (cfl.experiment.Experiment method)
__make_exp_dir() (cfl.experiment.Experiment method)
__pyx_scatter_gt_legend() (in module cfl.visualization.cde_diagnostic)
__save_params() (cfl.experiment.Experiment method)
__save_results() (cfl.experiment.Experiment method)
_build_network() (cfl.cond_density_estimation.condExpBase.CondExpBase method)
,
[1]
(cfl.cond_density_estimation.condExpCNN.CondExpCNN method)
,
[1]
(cfl.cond_density_estimation.condExpDIY.CondExpDIY method)
,
[1]
(cfl.cond_density_estimation.condExpMod.CondExpMod method)
,
[1]
_categorical_Y() (in module cfl.clustering.Y_given_Xmacro)
_check_block_params() (cfl.block.Block method)
_check_format_model_params() (cfl.cond_density_estimation.condExpBase.CondExpBase method)
,
[1]
(cfl.cond_density_estimation.condExpCNN.CondExpCNN method)
,
[1]
(cfl.cond_density_estimation.condExpDIY.CondExpDIY method)
,
[1]
(cfl.cond_density_estimation.condExpMod.CondExpMod method)
,
[1]
_compute_cond_prob() (in module cfl.post_cfl.macro_cond_prob)
_compute_density() (in module cfl.post_cfl.intervention_rec)
_continuous_Y() (in module cfl.clustering.Y_given_Xmacro)
_create_model() (cfl.clustering.cause_clusterer.CauseClusterer method)
,
[1]
(cfl.clustering.effect_clusterer.EffectClusterer method)
,
[1]
(cfl.cond_density_estimation.condDensityEstimator.CondDensityEstimator method)
,
[1]
_discard_boundary_samples() (in module cfl.post_cfl.intervention_rec)
_get_default_block_params() (cfl.block.Block method)
(cfl.clustering.cause_clusterer.CauseClusterer method)
,
[1]
(cfl.clustering.effect_clusterer.EffectClusterer method)
,
[1]
(cfl.cond_density_estimation.condDensityEstimator.CondDensityEstimator method)
,
[1]
_get_default_model_params() (cfl.cond_density_estimation.condExpBase.CondExpBase method)
(cfl.cond_density_estimation.condExpCNN.CondExpCNN method)
,
[1]
(cfl.cond_density_estimation.condExpDIY.CondExpDIY method)
(cfl.cond_density_estimation.condExpMod.CondExpMod method)
,
[1]
_get_high_density_samples() (in module cfl.post_cfl.intervention_rec)
_get_recommendations() (in module cfl.post_cfl.intervention_rec)
_graph_results() (cfl.cond_density_estimation.condExpBase.CondExpBase method)
,
[1]
(cfl.cond_density_estimation.condExpCNN.CondExpCNN method)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY method)
(cfl.cond_density_estimation.condExpMod.CondExpMod method)
_kl_divergence() (in module cfl.post_cfl.microvariable_importance)
_plot() (in module cfl.visualization.basic_visualizations)
_plot_1D() (in module cfl.visualization.basic_visualizations)
_plot_2D() (in module cfl.visualization.basic_visualizations)
_plot_3D() (in module cfl.visualization.basic_visualizations)
_plot_results() (in module cfl.post_cfl.intervention_rec)
_score() (in module cfl.clustering.cluster_tuning_util)
A
add_dataset() (cfl.experiment.Experiment method)
,
[1]
alpha (cfl.cond_density_estimation.condExpRidgeRegCV.CondExpRidgeCV attribute)
B
Block (class in cfl.block)
block_names (cfl.experiment.Experiment attribute)
block_params (cfl.clustering.cause_clusterer.CauseClusterer attribute)
(cfl.clustering.effect_clusterer.EffectClusterer attribute)
(cfl.cond_density_estimation.condDensityEstimator.CondDensityEstimator attribute)
(cfl.experiment.Experiment attribute)
blocks (cfl.experiment.Experiment attribute)
C
CauseClusterer (class in cfl.clustering.cause_clusterer)
cde_diagnostic() (in module cfl.visualization.cde_diagnostic)
CDEModel (class in cfl.cond_density_estimation.cde_model)
cfl
module
cfl.block
module
cfl.clustering
module
cfl.clustering.cause_clusterer
module
cfl.clustering.cluster_tuning_util
module
cfl.clustering.clusterer_model
module
cfl.clustering.effect_clusterer
module
cfl.clustering.snn
module
cfl.clustering.Y_given_Xmacro
module
cfl.cond_density_estimation
module
cfl.cond_density_estimation.cde_model
module
cfl.cond_density_estimation.condDensityEstimator
module
cfl.cond_density_estimation.condExpBase
module
cfl.cond_density_estimation.condExpCNN
module
cfl.cond_density_estimation.condExpDIY
module
cfl.cond_density_estimation.condExpMod
module
cfl.cond_density_estimation.condExpRidgeRegCV
module
cfl.dataset
module
cfl.experiment
module
cfl.post_cfl
module
cfl.post_cfl.intervention_rec
module
cfl.post_cfl.macro_cond_prob
module
cfl.post_cfl.microvariable_importance
module
cfl.post_cfl.post_cfl_util
module
cfl.util
module
cfl.util.data_processing
module
cfl.util.experiment_loading
module
cfl.util.find_xlbl_locations
module
cfl.util.input_val
module
cfl.visualization
module
cfl.visualization.basic_visualizations
module
cfl.visualization.cde_diagnostic
module
cfl.visualization.clustering_to_sankey
module
cfl.visualization.data_sample_visualizations
module
check_params() (in module cfl.util.input_val)
ClustererModel (class in cfl.clustering.clusterer_model)
components_ (cfl.clustering.snn.SNN.self attribute)
compute_macro_cond_prob() (in module cfl.post_cfl.macro_cond_prob)
compute_microvariable_importance() (in module cfl.post_cfl.microvariable_importance)
compute_predictive_error() (in module cfl.clustering.cluster_tuning_util)
CondDensityEstimator (class in cfl.cond_density_estimation.condDensityEstimator)
CondExpBase (class in cfl.cond_density_estimation.condExpBase)
CondExpCNN (class in cfl.cond_density_estimation.condExpCNN)
CondExpDIY (class in cfl.cond_density_estimation.condExpDIY)
CondExpMod (class in cfl.cond_density_estimation.condExpMod)
CondExpRidgeCV (class in cfl.cond_density_estimation.condExpRidgeRegCV)
convert_lbls_to_sankey_nodes() (in module cfl.visualization.clustering_to_sankey)
core_sample_indices_ (cfl.clustering.snn.SNN.self attribute)
D
data_info (cfl.clustering.cause_clusterer.CauseClusterer attribute)
(cfl.clustering.effect_clusterer.EffectClusterer attribute)
(cfl.cond_density_estimation.condDensityEstimator.CondDensityEstimator attribute)
(cfl.cond_density_estimation.condExpBase.CondExpBase attribute)
(cfl.cond_density_estimation.condExpCNN.CondExpCNN attribute)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY attribute)
(cfl.cond_density_estimation.condExpMod.CondExpMod attribute)
(cfl.cond_density_estimation.condExpRidgeRegCV.CondExpRidgeCV attribute)
(cfl.experiment.Experiment attribute)
Dataset (class in cfl.dataset)
datasets (cfl.experiment.Experiment attribute)
default_params (cfl.cond_density_estimation.condExpBase.CondExpBase attribute)
(cfl.cond_density_estimation.condExpCNN.CondExpCNN attribute)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY attribute)
(cfl.cond_density_estimation.condExpMod.CondExpMod attribute)
discriminate_clusters() (in module cfl.post_cfl.microvariable_importance)
discrimination_KL() (in module cfl.post_cfl.microvariable_importance)
E
EffectClusterer (class in cfl.clustering.effect_clusterer)
exp_load() (in module cfl.util.experiment_loading)
Experiment (class in cfl.experiment)
F
fit() (cfl.clustering.snn.SNN method)
fit_predict() (cfl.clustering.clusterer_model.ClustererModel method)
,
[1]
(cfl.clustering.snn.SNN method)
G
get_block_params() (cfl.clustering.cause_clusterer.CauseClusterer method)
,
[1]
(cfl.clustering.effect_clusterer.EffectClusterer method)
,
[1]
(cfl.cond_density_estimation.condDensityEstimator.CondDensityEstimator method)
,
[1]
get_cfl_results() (cfl.dataset.Dataset method)
get_data_info() (cfl.experiment.Experiment method)
get_dataset() (cfl.experiment.Experiment method)
,
[1]
get_exp_path() (in module cfl.post_cfl.post_cfl_util)
get_fig_path() (in module cfl.util.experiment_loading)
get_in_sample_idx() (cfl.dataset.Dataset method)
get_model_params() (cfl.cond_density_estimation.cde_model.CDEModel method)
(cfl.cond_density_estimation.condExpBase.CondExpBase method)
,
[1]
(cfl.cond_density_estimation.condExpCNN.CondExpCNN method)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY method)
(cfl.cond_density_estimation.condExpMod.CondExpMod method)
(cfl.cond_density_estimation.condExpRidgeRegCV.CondExpRidgeCV method)
,
[1]
get_name() (cfl.block.Block method)
(cfl.dataset.Dataset method)
get_next_dirname() (in module cfl.experiment)
get_out_sample_idx() (cfl.dataset.Dataset method)
get_parameter_combinations() (in module cfl.clustering.cluster_tuning_util)
get_params() (cfl.block.Block method)
get_recommendations() (in module cfl.post_cfl.intervention_rec)
get_save_path() (cfl.experiment.Experiment method)
get_user_params() (in module cfl.clustering.cluster_tuning_util)
get_X() (cfl.dataset.Dataset method)
get_Y() (cfl.dataset.Dataset method)
I
is_trained (cfl.experiment.Experiment attribute)
is_trained() (cfl.block.Block method)
L
labels_ (cfl.clustering.snn.SNN.self attribute)
load_block() (cfl.block.Block method)
(cfl.clustering.cause_clusterer.CauseClusterer method)
,
[1]
(cfl.clustering.effect_clusterer.EffectClusterer method)
,
[1]
(cfl.cond_density_estimation.condDensityEstimator.CondDensityEstimator method)
,
[1]
load_dataset_results() (cfl.experiment.Experiment method)
load_macrolbls() (in module cfl.post_cfl.post_cfl_util)
load_model() (cfl.cond_density_estimation.cde_model.CDEModel method)
(cfl.cond_density_estimation.condExpBase.CondExpBase method)
,
[1]
(cfl.cond_density_estimation.condExpCNN.CondExpCNN method)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY method)
(cfl.cond_density_estimation.condExpMod.CondExpMod method)
(cfl.cond_density_estimation.condExpRidgeRegCV.CondExpRidgeCV method)
,
[1]
load_network() (cfl.cond_density_estimation.condExpBase.CondExpBase method)
,
[1]
(cfl.cond_density_estimation.condExpCNN.CondExpCNN method)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY method)
(cfl.cond_density_estimation.condExpMod.CondExpMod method)
load_pyx() (in module cfl.post_cfl.post_cfl_util)
load_results_from_file() (cfl.experiment.Experiment method)
M
model (cfl.clustering.cause_clusterer.CauseClusterer attribute)
(cfl.clustering.effect_clusterer.EffectClusterer attribute)
(cfl.cond_density_estimation.condDensityEstimator.CondDensityEstimator attribute)
(cfl.cond_density_estimation.condExpBase.CondExpBase attribute)
(cfl.cond_density_estimation.condExpCNN.CondExpCNN attribute)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY attribute)
(cfl.cond_density_estimation.condExpMod.CondExpMod attribute)
(cfl.cond_density_estimation.condExpRidgeRegCV.CondExpRidgeCV attribute)
model_params (cfl.cond_density_estimation.condExpBase.CondExpBase attribute)
(cfl.cond_density_estimation.condExpCNN.CondExpCNN attribute)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY attribute)
(cfl.cond_density_estimation.condExpMod.CondExpMod attribute)
(cfl.cond_density_estimation.condExpRidgeRegCV.CondExpRidgeCV attribute)
module
cfl
cfl.block
cfl.clustering
cfl.clustering.cause_clusterer
cfl.clustering.cluster_tuning_util
cfl.clustering.clusterer_model
cfl.clustering.effect_clusterer
cfl.clustering.snn
cfl.clustering.Y_given_Xmacro
cfl.cond_density_estimation
cfl.cond_density_estimation.cde_model
cfl.cond_density_estimation.condDensityEstimator
cfl.cond_density_estimation.condExpBase
cfl.cond_density_estimation.condExpCNN
cfl.cond_density_estimation.condExpDIY
cfl.cond_density_estimation.condExpMod
cfl.cond_density_estimation.condExpRidgeRegCV
cfl.dataset
cfl.experiment
cfl.post_cfl
cfl.post_cfl.intervention_rec
cfl.post_cfl.macro_cond_prob
cfl.post_cfl.microvariable_importance
cfl.post_cfl.post_cfl_util
cfl.util
cfl.util.data_processing
cfl.util.experiment_loading
cfl.util.find_xlbl_locations
cfl.util.input_val
cfl.visualization
cfl.visualization.basic_visualizations
cfl.visualization.cde_diagnostic
cfl.visualization.clustering_to_sankey
cfl.visualization.data_sample_visualizations
N
name (cfl.clustering.cause_clusterer.CauseClusterer attribute)
(cfl.clustering.effect_clusterer.EffectClusterer attribute)
(cfl.cond_density_estimation.condDensityEstimator.CondDensityEstimator attribute)
(cfl.cond_density_estimation.condExpBase.CondExpBase attribute)
(cfl.cond_density_estimation.condExpCNN.CondExpCNN attribute)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY attribute)
(cfl.cond_density_estimation.condExpMod.CondExpMod attribute)
(cfl.cond_density_estimation.condExpRidgeRegCV.CondExpRidgeCV attribute)
O
one_hot_decode() (in module cfl.util.data_processing)
one_hot_encode() (in module cfl.util.data_processing)
P
plot_disc_vals() (in module cfl.post_cfl.microvariable_importance)
predict() (cfl.block.Block method)
(cfl.clustering.cause_clusterer.CauseClusterer method)
,
[1]
(cfl.clustering.effect_clusterer.EffectClusterer method)
,
[1]
(cfl.cond_density_estimation.cde_model.CDEModel method)
(cfl.cond_density_estimation.condDensityEstimator.CondDensityEstimator method)
,
[1]
(cfl.cond_density_estimation.condExpBase.CondExpBase method)
,
[1]
(cfl.cond_density_estimation.condExpCNN.CondExpCNN method)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY method)
(cfl.cond_density_estimation.condExpMod.CondExpMod method)
(cfl.cond_density_estimation.condExpRidgeRegCV.CondExpRidgeCV method)
,
[1]
(cfl.experiment.Experiment method)
,
[1]
pyx_scatter() (in module cfl.visualization.cde_diagnostic)
R
retrieve_results() (cfl.experiment.Experiment method)
rows_where_each_x_class_occurs() (in module cfl.util.find_xlbl_locations)
S
sample_Y_dist() (in module cfl.clustering.Y_given_Xmacro)
save_block() (cfl.block.Block method)
(cfl.clustering.cause_clusterer.CauseClusterer method)
,
[1]
(cfl.clustering.effect_clusterer.EffectClusterer method)
,
[1]
(cfl.cond_density_estimation.condDensityEstimator.CondDensityEstimator method)
,
[1]
save_model() (cfl.cond_density_estimation.cde_model.CDEModel method)
(cfl.cond_density_estimation.condExpBase.CondExpBase method)
,
[1]
(cfl.cond_density_estimation.condExpCNN.CondExpCNN method)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY method)
(cfl.cond_density_estimation.condExpMod.CondExpMod method)
(cfl.cond_density_estimation.condExpRidgeRegCV.CondExpRidgeCV method)
,
[1]
save_network() (cfl.cond_density_estimation.condExpBase.CondExpBase method)
,
[1]
(cfl.cond_density_estimation.condExpCNN.CondExpCNN method)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY method)
(cfl.cond_density_estimation.condExpMod.CondExpMod method)
save_path (cfl.experiment.Experiment attribute)
scores (cfl.cond_density_estimation.condExpRidgeRegCV.CondExpRidgeCV attribute)
set_cfl_results() (cfl.dataset.Dataset method)
set_in_sample_idx() (cfl.dataset.Dataset method)
set_out_sample_idx() (cfl.dataset.Dataset method)
SNN (class in cfl.clustering.snn)
snn() (in module cfl.clustering.snn)
standardize_train_test() (in module cfl.util.data_processing)
suggest_elbow_idx() (in module cfl.clustering.cluster_tuning_util)
T
train() (cfl.block.Block method)
(cfl.clustering.cause_clusterer.CauseClusterer method)
,
[1]
(cfl.clustering.effect_clusterer.EffectClusterer method)
,
[1]
(cfl.cond_density_estimation.cde_model.CDEModel method)
(cfl.cond_density_estimation.condDensityEstimator.CondDensityEstimator method)
,
[1]
(cfl.cond_density_estimation.condExpBase.CondExpBase method)
,
[1]
(cfl.cond_density_estimation.condExpCNN.CondExpCNN method)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY method)
(cfl.cond_density_estimation.condExpMod.CondExpMod method)
(cfl.cond_density_estimation.condExpRidgeRegCV.CondExpRidgeCV method)
,
[1]
(cfl.experiment.Experiment method)
,
[1]
trained (cfl.clustering.cause_clusterer.CauseClusterer attribute)
(cfl.clustering.effect_clusterer.EffectClusterer attribute)
(cfl.cond_density_estimation.condExpBase.CondExpBase attribute)
(cfl.cond_density_estimation.condExpCNN.CondExpCNN attribute)
(cfl.cond_density_estimation.condExpDIY.CondExpDIY attribute)
(cfl.cond_density_estimation.condExpMod.CondExpMod attribute)
(cfl.cond_density_estimation.condExpRidgeRegCV.CondExpRidgeCV attribute)
tune() (in module cfl.clustering.cluster_tuning_util)
V
validate_data_info() (in module cfl.util.input_val)
verbose (cfl.experiment.Experiment attribute)
view_class_examples() (in module cfl.visualization.data_sample_visualizations)
view_random_example() (in module cfl.visualization.data_sample_visualizations)
visualize_cond_prob() (in module cfl.post_cfl.macro_cond_prob)
visualize_errors() (in module cfl.clustering.cluster_tuning_util)
visualize_macrostates() (in module cfl.visualization.basic_visualizations)
Read the Docs
v: latest
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds