explanation
===========

.. py:module:: explanation


Classes
-------

.. autoapisummary::

   explanation.Explanation


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

.. py:class:: Explanation(maps, prediction_func, data, args, run_stats, keep_all_maps=False)

   .. py:attribute:: target_map
      :type:  torch.Tensor | None


   .. py:attribute:: sufficiency_mask
      :type:  torch.Tensor | None
      :value: None



   .. py:attribute:: sufficiency_confidence
      :type:  float | None
      :value: None



   .. py:attribute:: necessity_mask
      :type:  torch.Tensor | None
      :value: None



   .. py:attribute:: complete_mask
      :type:  torch.Tensor | None
      :value: None



   .. py:attribute:: prediction_func


   .. py:attribute:: data
      :type:  rex_xai.input.input_data.Data


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


   .. py:attribute:: run_stats
      :type:  Dict[str, float]


   .. py:method:: __repr__()


   .. py:method:: extract()


   .. py:method:: blank()


   .. py:method:: set_to_true(coords, mask=None)


   .. py:method:: __build_insertion_mask(ranking, chunk_pointer, ind, mask, mask_memo)


   .. py:method:: __global(map=None, rounding=4)


   .. py:method:: __generate_circle_coordinates(centre, radius)


   .. py:method:: __draw_circle(centre, start_radius=None)


   .. py:method:: compute_masked_responsibility(mask)


   .. py:method:: __spatial(centre=None, expansion_limit=None)


   .. py:method:: __build_contrastive_masks(ranking, ind, chunk_pointer, insertion_mask, insertion_memo, deletion_mask, deletion_memo)


   .. py:method:: __complete(ranking, insertion_mask, insertion_memo, mask_shape, starting_pointer, rounding=2)


   .. py:method:: contrastive()


   .. py:method:: save(path, mask=None)


   .. py:method:: heatmap_plot(path=None)


   .. py:method:: surface_plot(path=None)


   .. py:method:: show(path=None)