rex_xai.lib
===========

.. py:module:: rex_xai.lib


Classes
-------

.. autoapisummary::

   rex_xai.lib.ReX


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

.. py:class:: ReX(model, model_shape, device, mode, prediction_function = None)

   .. py:attribute:: args
      :type:  rex_xai.input.config.CausalArgs


   .. py:attribute:: model


   .. py:attribute:: model_shape
      :type:  List[int | str] | Tuple[int | str]


   .. py:attribute:: device
      :type:  str | torch.device


   .. py:attribute:: mode
      :type:  str


   .. py:attribute:: explanation
      :value: None



   .. py:attribute:: prediction_function
      :value: None



   .. py:attribute:: data
      :value: None



   .. py:attribute:: maps
      :type:  rex_xai.responsibility.resp_maps.ResponsibilityMaps | None
      :value: None



   .. py:attribute:: stats
      :type:  Dict[str, float] | None
      :value: None



   .. py:method:: set_tabular_data(path, data=None)


   .. py:method:: set_input(input)


   .. py:method:: set_transformed_data(transformed_data)


   .. py:method:: set_rgb_image(path)


   .. py:method:: show_target()


   .. py:method:: get_default_prediction_function()


   .. py:method:: set_target()


   .. py:method:: set_prediction_function(function)


   .. py:method:: calculate_responsibility(args = None)


   .. py:method:: generate_explanation_object()


   .. py:method:: extract_sufficient_explanation()


   .. py:method:: extract_contrastive_explanation()


   .. py:method:: extract_complete_explanation()


   .. py:method:: analyse()


   .. py:method:: rerun_with(new_args)


   .. py:method:: show()