config
======

.. py:module:: config

.. autoapi-nested-parse::

   config management



Classes
-------

.. autoapisummary::

   config.Args
   config.CausalArgs


Functions
---------

.. autoapisummary::

   config.read_config_file
   config.rex_ascii
   config.cmdargs_parser
   config.cmdargs
   config.match_strategy
   config.match_queue_style
   config.shared_args
   config.find_config_path
   config.apply_dict_to_args
   config.validate_numeric_arg_within_bounds
   config.validate_numeric_arg_more_than
   config.process_config_dict
   config.process_custom_script
   config.process_cmd_args
   config.load_config
   config.get_all_args
   config.validate_args


Module Contents
---------------

.. py:class:: Args

   args argument object


   .. py:attribute:: config_location
      :type:  Optional[str]
      :value: None



   .. py:attribute:: path
      :type:  str
      :value: ''



   .. py:attribute:: model
      :value: None



   .. py:attribute:: mode
      :type:  Optional[str]
      :value: None



   .. py:attribute:: shape
      :type:  None
      :value: None



   .. py:attribute:: db
      :type:  Optional[str]
      :value: None



   .. py:attribute:: gpu
      :type:  bool
      :value: True



   .. py:attribute:: seed
      :type:  Union[int, float, None]
      :value: None



   .. py:attribute:: script
      :type:  Optional[types.ModuleType]
      :value: None



   .. py:attribute:: script_location
      :value: None



   .. py:attribute:: processed
      :value: False



   .. py:attribute:: context
      :value: False



   .. py:attribute:: context_location
      :type:  Optional[str]
      :value: None



   .. py:attribute:: occlusion_noise
      :type:  Optional[float]
      :value: None



   .. py:attribute:: means
      :value: None



   .. py:attribute:: stds
      :value: None



   .. py:attribute:: norm
      :type:  Optional[float]
      :value: 255.0



   .. py:attribute:: binary_threshold
      :value: None



   .. py:attribute:: intra_op_num_threads
      :value: 8



   .. py:attribute:: inter_op_num_threads
      :value: 8



   .. py:attribute:: ort_logger
      :value: 3



   .. py:attribute:: verbosity
      :value: 1



   .. py:attribute:: progress_bar
      :value: True



   .. py:attribute:: output
      :value: None



   .. py:attribute:: surface
      :type:  Optional[str]
      :value: None



   .. py:attribute:: heatmap
      :type:  Optional[str]
      :value: None



   .. py:attribute:: info
      :value: True



   .. py:attribute:: raw
      :type:  bool
      :value: False



   .. py:attribute:: colour
      :type:  int
      :value: 200



   .. py:attribute:: mark_segments
      :value: False



   .. py:attribute:: alpha
      :value: 0.2



   .. py:attribute:: all
      :value: False



   .. py:attribute:: grid
      :value: False



   .. py:attribute:: heatmap_colours
      :value: 'magma'



   .. py:attribute:: multi_style
      :value: 'composite'



   .. py:attribute:: no_extract
      :value: False



   .. py:attribute:: strategy
      :type:  rex_xai.utils._utils.Strategy


   .. py:attribute:: complete
      :value: False



   .. py:attribute:: chunk_size
      :value: 10



   .. py:attribute:: minimum_confidence_threshold
      :value: 0.0



   .. py:attribute:: batch_size
      :type:  int
      :value: 1



   .. py:attribute:: multi_class
      :type:  bool
      :value: False



   .. py:attribute:: spatial_initial_radius
      :type:  int
      :value: 25



   .. py:attribute:: spatial_radius_eta
      :type:  float
      :value: 0.2



   .. py:attribute:: no_expansions
      :value: 4



   .. py:attribute:: spotlights
      :type:  int
      :value: 10



   .. py:attribute:: spotlight_size
      :type:  int
      :value: 20



   .. py:attribute:: spotlight_eta
      :type:  float
      :value: 0.2



   .. py:attribute:: spotlight_step
      :type:  int
      :value: 5



   .. py:attribute:: spotlight_objective_function
      :type:  str
      :value: 'none'



   .. py:attribute:: max_spotlight_budget
      :value: 40



   .. py:attribute:: permitted_overlap
      :type:  float
      :value: 0.0



   .. py:attribute:: analyse
      :value: None



   .. py:attribute:: insertion_step
      :value: 100



   .. py:attribute:: normalise_curves
      :value: True



   .. py:method:: get_dict_repr()


   .. py:method:: __repr__()


.. py:class:: CausalArgs

   Bases: :py:obj:`Args`


   Creates a causal args object


   .. py:attribute:: config_location
      :value: None



   .. py:attribute:: tree_depth
      :type:  int
      :value: 10



   .. py:attribute:: search_limit
      :type:  Optional[int]
      :value: None



   .. py:attribute:: mask_value
      :type:  Union[int, float, str]
      :value: 0



   .. py:attribute:: confidence_filter
      :value: 0.0



   .. py:attribute:: min_box_size
      :type:  int
      :value: 10



   .. py:attribute:: segmentation
      :value: False



   .. py:attribute:: data_location
      :type:  Optional[str]
      :value: None



   .. py:attribute:: distribution
      :type:  rex_xai.mutants.distributions.Distribution


   .. py:attribute:: distribution_args
      :type:  Optional[List]
      :value: None



   .. py:attribute:: blend
      :value: 0.0



   .. py:attribute:: weighted
      :type:  bool
      :value: False



   .. py:attribute:: iters
      :value: 20



   .. py:attribute:: concentrate
      :value: False



   .. py:attribute:: negative_responsibility
      :value: False



   .. py:attribute:: use_bounding_box
      :type:  bool
      :value: False



   .. py:attribute:: queue_len
      :value: 1



   .. py:attribute:: queue_style


   .. py:attribute:: responsibility_style
      :value: 'multiplicative'



   .. py:method:: get_dict_repr()


   .. py:method:: __repr__()


.. py:function:: read_config_file(path)

.. py:function:: rex_ascii()

.. py:function:: cmdargs_parser()

   parses command line flags


.. py:function:: cmdargs()

.. py:function:: match_strategy(strategy_string)

   gets explanation extraction strategy


.. py:function:: match_queue_style(qs)

.. py:function:: shared_args(cmd_args, args)

   parses shared args


.. py:function:: find_config_path()

.. py:function:: apply_dict_to_args(source, args, allowed_values=None)

.. py:function:: validate_numeric_arg_within_bounds(n, lower, upper)

.. py:function:: validate_numeric_arg_more_than(n, lower)

.. py:function:: process_config_dict(config_file_args, args)

.. py:function:: process_custom_script(script, args)

.. py:function:: process_cmd_args(cmd_args, args)

.. py:function:: load_config(config_path=None)

.. py:function:: get_all_args()

   parses all arguments from config file and command line


.. py:function:: validate_args(args)

   Validates a CausalArgs object.

   :param args: configuration values for ReX