.. skpm documentation master file, created by
   sphinx-quickstart on Fri Oct  3 15:43:52 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to SkPM's documentation!
================================

**SkPM** *(Scikit-learn for Process Mining)* is a library built upon `Scikit-learn <https://scikit-learn.org/stable/>`_ to easily write and train machine learning pipelines tailored for process mining tasks.

This work is still in progress! So far, we have focused more on feature extraction and encoding techniques to be easily used along with Scikit-learn's `pipelines <https://scikit-learn.org/dev/modules/compose.html>`_ and `grid search-related functionalities <https://scikit-learn.org/dev/modules/grid_search.html#grid-search>`_.

.. toctree::
   :maxdepth: 1
   :caption: Installation
   
   installation

.. toctree::
   :maxdepth: 1
   :caption: Tutorials
   
   examples/00_intro.ipynb
   examples/01_data_api.ipynb
   examples/02_unbiased_split.ipynb
   examples/03_pipeline_eval.ipynb

.. toctree::
   :maxdepth: 1
   :caption: API Reference