.. pmlayer documentation master file, created by
   sphinx-quickstart on Thu Oct  6 14:33:51 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Documentation of pmlayer
=======================================

Partially monotome layer (``pmlayer``) is a library for neural network models.
It provides several neural network layers to add monotonicity constraints on neural network models.
The current library is implemented to be used in PyTorch models.

.. toctree::
   :maxdepth: 1
   :caption: Overview:

   overview
   howtouse

How to install
------------------

.. code-block:: shell

    pip install pmlayer

Citation
------------------

Please consider citing this paper: `H. Yanagisawa, K. Miyaguchi, and T. Katsuki, "Hierarchical Lattice Layer for Partially Monotone Regression," NeurIPS 2022. <https://openreview.net/forum?id=zAuiZpZ478l>`_

.. toctree::
   :maxdepth: 1
   :caption: Tutorial:

   tutorial_torch_HLattice
   tutorial_torch_PiecewiseLinear
   tutorial_auxiliary_network


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

   torch_HLattice
   torch_PiecewiseLinear
   torch_PMLinear