.. _api_ref:

=============
API Reference
=============

This is the class and function reference of PiML.
Please refer to the user guide for further details, as the class and function raw specifications may not be enough to give full guidelines on their uses.


Data Pipeline
=======================================================

Functions
--------------

.. currentmodule:: piml

.. autosummary::

   Experiment.data_loader
   Experiment.data_summary
   Experiment.data_prepare
   Experiment.data_quality
   Experiment.eda
   Experiment.feature_select
   Experiment.get_data
   Experiment.get_raw_data
   Experiment.get_feature_names
   Experiment.get_feature_types
   Experiment.get_target_name

Outlier Detection Algorithms
----------------------------
.. currentmodule:: piml

.. autosummary::
   :nosignatures:
   :toctree: generated/
   :template: class.rst

   data.outlier_detection.PCA
   data.outlier_detection.CBLOF
   data.outlier_detection.KMeansTree
   data.outlier_detection.IsolationForest
   data.outlier_detection.OneClassSVM
   data.outlier_detection.KNN
   data.outlier_detection.HBOS
   data.outlier_detection.ECOD


Model Training
=======================================================

.. currentmodule:: piml

.. autosummary::

   Experiment.model_train
   Experiment.model_tune
   Experiment.model_save
   Experiment.model_interpret
   Experiment.make_pipeline
   Experiment.register
   Experiment.get_model_list
   Experiment.get_interpretable_model_list
   Experiment.get_model
   Experiment.get_model_config
   Experiment.get_leaderboard
   Experiment.get_leaderboard_registered


Post-hoc Explainability
=======================================================

.. currentmodule:: piml

.. autosummary::

   Experiment.model_explain


Interpretable Models
=======================================================

.. currentmodule:: piml

.. autosummary::
   :nosignatures:
   :toctree: generated/
   :template: class.rst

   models.GLMRegressor
   models.GLMClassifier
   models.GAMRegressor
   models.GAMClassifier
   models.TreeRegressor
   models.TreeClassifier
   models.FIGSRegressor
   models.FIGSClassifier
   models.XGB1Classifier
   models.XGB1Regressor
   models.XGB2Classifier
   models.XGB2Regressor
   models.ExplainableBoostingRegressor
   models.ExplainableBoostingClassifier
   models.GAMINetRegressor
   models.GAMINetClassifier
   models.ReluDNNRegressor
   models.ReluDNNClassifier


Outcome Testing
=======================================================

Integrated Functions
--------------------------------------------------------

.. currentmodule:: piml

.. autosummary::

   Experiment.model_diagnose
   Experiment.model_compare
   Experiment.model_fairness
   Experiment.model_fairness_compare
   Experiment.model_fairness_solas
   Experiment.segmented_diagnose


Scored Test Function
--------------------------------------------------------

.. currentmodule:: piml.scored_test

.. autosummary::
   :nosignatures:
   :toctree: generated/
   :template: function.rst

   test_accuracy_table
   test_accuracy_residual
   test_accuracy_plot
   test_weakspot
   test_overfit
   test_reliability_table
   test_reliability_distance
   test_reliability_marginal
   test_reliability_perf
   test_reliability_calibration
   test_resilience_perf
   test_resilience_distance
   test_resilience_shift_histogram
   test_resilience_shift_density