.. title:: Modules

.. _modules:

Modules
=======

Abstract Runner
---------------

.. automodule:: PermutationImportance.abstract_runner
   :members:
   :undoc-members:
   :special-members:
   :private-members:
   :show-inheritance:

Data Verification
-----------------

.. automodule:: PermutationImportance.data_verification
   :members:
   :undoc-members:
   :special-members:
   :private-members:
   :show-inheritance:

Error Handling
--------------

.. automodule:: PermutationImportance.error_handling
   :members:
   :undoc-members:
   :show-inheritance:

Metrics
-------

.. automodule:: PermutationImportance.metrics
   :members:
   :undoc-members:
   :special-members:
   :private-members:
   :show-inheritance:

Multiprocessing Utils
---------------------

.. automodule:: PermutationImportance.multiprocessing_utils
   :members:
   :undoc-members:
   :special-members:
   :private-members:
   :show-inheritance:

Permutation Importance
----------------------

.. automodule:: PermutationImportance.permutation_importance
   :members:
   :undoc-members:
   :special-members:
   :private-members:
   :show-inheritance:

Result
------

.. automodule:: PermutationImportance.result
   :members: 
   :special-members:
   :private-members:
   :show-inheritance:

Scoring Strategies
------------------

.. automodule:: PermutationImportance.scoring_strategies
   :members: 
   :special-members:
   :private-members:
   :show-inheritance:

Selection Strategies
--------------------

.. automodule:: PermutationImportance.selection_strategies
   :members:
   :special-members:
   :private-members:
   :show-inheritance:

Sequential Selection
--------------------

.. automodule:: PermutationImportance.sequential_selection
   :members:
   :undoc-members:
   :special-members:
   :private-members:
   :show-inheritance:

Sklearn API
-----------

.. automodule:: PermutationImportance.sklearn_api
   :members: 
   :special-members:
   :private-members:
   :show-inheritance:

Utils
-----

.. automodule:: PermutationImportance.utils
   :members:
   :undoc-members:
   :special-members:
   :private-members:
   :show-inheritance: