src.ml_cfexplainer.utils package

Submodules

src.ml_cfexplainer.utils.AE_architecture module

Created on Sun Nov 29 16:52:27 2020

@author: trduong

class src.ml_cfexplainer.utils.AE_architecture.autoencoder(index_age, index_hours, index_workclass, index_education, index_marital_status, index_occupation, index_race, index_gender)

Bases: torch.nn.modules.module.Module

forward(x)

Defines the computation performed at every call.

Should be overridden by all subclasses.

Note

Although the recipe for forward pass needs to be defined within this function, one should call the Module instance afterwards instead of this since the former takes care of running the registered hooks while the latter silently ignores them.

training: bool

src.ml_cfexplainer.utils.AE_train module

src.ml_cfexplainer.utils.auto-encoder-train module

src.ml_cfexplainer.utils.blackbox-model-train module

src.ml_cfexplainer.utils.blackboxmodel module

class src.ml_cfexplainer.utils.blackboxmodel.BlackBox(inp_shape)

Bases: torch.nn.modules.module.Module

forward(x)

Defines the computation performed at every call.

Should be overridden by all subclasses.

Note

Although the recipe for forward pass needs to be defined within this function, one should call the Module instance afterwards instead of this since the former takes care of running the registered hooks while the latter silently ignores them.

training: bool

src.ml_cfexplainer.utils.calculate_loss module

src.ml_cfexplainer.utils.datagen module

src.ml_cfexplainer.utils.dataloader module

class src.ml_cfexplainer.utils.dataloader.DataLoader(params)

Bases: object

A data interface for public data.

get_features_range()

get_data_type(col)

Infers data type of a feature from the training data.

one_hot_encode_data(data)

One-hot-encodes the data.

normalize_data(df)

Normalizes continuous features to make them fall in the range [0,1].

de_normalize_data(df)

De-normalizes continuous features from [0,1] range to original range.

get_minx_maxx(normalized=True)

Gets the min/max value of features in normalized or de-normalized form.

split_data(data)

get_mads_from_training_data(normalized=False)

Computes Median Absolute Deviation of features.

get_data_params()

Gets all data related params for DiCE.

get_encoded_categorical_feature_indexes()

Gets the column indexes categorical features after one-hot-encoding.

get_indexes_of_features_to_vary(features_to_vary='all')

Gets indexes from feature names of one-hot-encoded data.

from_dummies(data, prefix_sep='_')

Gets the original data from dummy encoded data with k levels.

get_decimal_precisions()

“Gets the precision of continuous features in the data.

get_decoded_data(data)

Gets the original data from dummy encoded data.

prepare_df_for_encoding()

Facilitates prepare_query_instance() function.

prepare_query_instance(query_instance, encode)

Prepares user defined test input for DiCE.

get_dev_data(model_interface, desired_class, filter_threshold=0.5)

Constructs dev data by extracting part of the test data for which finding counterfactuals make sense.

src.ml_cfexplainer.utils.helpers module

src.ml_cfexplainer.utils.preprocess_adult module

src.ml_cfexplainer.utils.vae_model module

class src.ml_cfexplainer.utils.vae_model.CF_VAE(data_size, encoded_size, d)

Bases: torch.nn.modules.module.Module

encoder(x)

decoder(z)

sample_latent_code(mean, logvar)

normal_likelihood(x, mean, logvar, raxis=1)

forward(x, c)

Defines the computation performed at every call.

Should be overridden by all subclasses.

Note

Although the recipe for forward pass needs to be defined within this function, one should call the Module instance afterwards instead of this since the former takes care of running the registered hooks while the latter silently ignores them.

compute_elbo(x, c, pred_model)

training: bool

class src.ml_cfexplainer.utils.vae_model.AutoEncoder(data_size, encoded_size, d)

Bases: torch.nn.modules.module.Module

encoder(x)

decoder(z)

sample_latent_code(mean, logvar)

normal_likelihood(x, mean, logvar, raxis=1)

forward(x)

Defines the computation performed at every call.

Should be overridden by all subclasses.

Note

Although the recipe for forward pass needs to be defined within this function, one should call the Module instance afterwards instead of this since the former takes care of running the registered hooks while the latter silently ignores them.

training: bool

Module contents