.. pyramid-learn documentation master file, created by
   sphinx-quickstart on Sun Oct 12 00:07:24 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: ../logo/logo_banner.png
   :align: center
   :width: 600
   :alt: midlearn logo

|

Welcome to pyramid-learn documentation!
=======================================

**pyramid-learn** is a Python wrapper for the **midr** R package to explain black-box models, with a **scikit-learn** compatible API.

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   Installation <installation>
   Quick Start <quick-start>
   Python API <api>
   R API - midr <https://ryo-asashi.github.io/midr/>
   R API - midnight <https://ryo-asashi.github.io/midnight/>