config

config management

Classes

Args	args argument object
CausalArgs	Creates a causal args object

Functions

read_config_file(path)
rex_ascii()
cmdargs_parser()	parses command line flags
cmdargs()
match_strategy(strategy_string)	gets explanation extraction strategy
match_queue_style(qs)
shared_args(cmd_args, args)	parses shared args
find_config_path()
apply_dict_to_args(source, args[, allowed_values])
validate_numeric_arg_within_bounds(n, lower, upper)
validate_numeric_arg_more_than(n, lower)
process_config_dict(config_file_args, args)
process_custom_script(script, args)
process_cmd_args(cmd_args, args)
load_config([config_path])
get_all_args()	parses all arguments from config file and command line
validate_args(args)	Validates a CausalArgs object.

Module Contents

class config.Args

args argument object

config_location: str | None = None

path: str = ''

model = None

mode: str | None = None

shape: None = None

db: str | None = None

gpu: bool = True

seed: int | float | None = None

script: types.ModuleType | None = None

script_location = None

processed = False

context = False

context_location: str | None = None

occlusion_noise: float | None = None

means = None

stds = None

norm: float | None = 255.0

binary_threshold = None

intra_op_num_threads = 8

inter_op_num_threads = 8

ort_logger = 3

verbosity = 1

progress_bar = True

output = None

surface: str | None = None

heatmap: str | None = None

info = True

raw: bool = False

colour: int = 200

mark_segments = False

alpha = 0.2

all = False

grid = False

heatmap_colours = 'magma'

multi_style = 'composite'

no_extract = False

strategy: rex_xai.utils._utils.Strategy

complete = False

chunk_size = 10

minimum_confidence_threshold = 0.0

batch_size: int = 1

multi_class: bool = False

spatial_initial_radius: int = 25

spatial_radius_eta: float = 0.2

no_expansions = 4

spotlights: int = 10

spotlight_size: int = 20

spotlight_eta: float = 0.2

spotlight_step: int = 5

spotlight_objective_function: str = 'none'

max_spotlight_budget = 40

permitted_overlap: float = 0.0

analyse = None

insertion_step = 100

normalise_curves = True

get_dict_repr()

__repr__()

Return type:

str

class config.CausalArgs

Bases: Args

Creates a causal args object

config_location = None

tree_depth: int = 10

search_limit: int | None = None

mask_value: int | float | str = 0

confidence_filter = 0.0

min_box_size: int = 10

segmentation = False

data_location: str | None = None

distribution: rex_xai.mutants.distributions.Distribution

distribution_args: List | None = None

blend = 0.0

weighted: bool = False

iters = 20

concentrate = False

negative_responsibility = False

use_bounding_box: bool = False

queue_len = 1

queue_style

responsibility_style = 'multiplicative'

get_dict_repr()

__repr__()

Return type:

str

config.read_config_file(path)

config.rex_ascii()

config.cmdargs_parser()

parses command line flags

config.cmdargs()

config.match_strategy(strategy_string)

gets explanation extraction strategy

config.match_queue_style(qs)

Parameters:

qs (str)

Return type:

rex_xai.utils._utils.Queue

config.shared_args(cmd_args, args)

parses shared args

Parameters:

args (CausalArgs)

config.find_config_path()

config.apply_dict_to_args(source, args, allowed_values=None)

config.validate_numeric_arg_within_bounds(n, lower, upper)

config.validate_numeric_arg_more_than(n, lower)

config.process_config_dict(config_file_args, args)

config.process_custom_script(script, args)

config.process_cmd_args(cmd_args, args)

config.load_config(config_path=None)

config.get_all_args()

parses all arguments from config file and command line

config.validate_args(args)

Validates a CausalArgs object.

Parameters:

args (CausalArgs) – configuration values for ReX