sharkpy.shapash_integration
===========================

.. py:module:: sharkpy.shapash_integration


Attributes
----------

.. autoapisummary::

   sharkpy.shapash_integration.SmartExplainer


Functions
---------

.. autoapisummary::

   sharkpy.shapash_integration.explain_with_shapash


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

.. py:data:: SmartExplainer
   :value: None


.. py:function:: explain_with_shapash(self, title_story=None, display=True)

   Create an interactive dashboard using Shapash to explain the model's predictions.

   :param title_story: Title for the Shapash dashboard
   :type title_story: str, optional
   :param display: Whether to display the dashboard immediately (default: True)
   :type display: bool, optional

   :returns: **app** -- The Shapash web application object
   :rtype: shapash.webapp.smart_app.SmartApp

   .. rubric:: Notes

   - Requires the `shapash` package to be installed.
   - Warning: The dashboard may expose sensitive data from your features and predictions. Use caution with untrusted environments.