The PyePAL API reference
========================

The PAL package
-----------------

Core functions
...............

.. automodule:: pyepal.pal.core
    :members:
    :show-inheritance:
    :special-members:


Base class
...............

.. automodule:: pyepal.pal.pal_base
    :members:
    :show-inheritance:
    :special-members:


For GPy models
........................

.. automodule:: pyepal.pal.pal_gpy
    :members:
    :show-inheritance:
    :special-members:


For coregionalized GPy models
..................................

.. automodule:: pyepal.pal.pal_coregionalized
    :members:
    :show-inheritance:
    :special-members:


For sklearn GPR models
........................

.. automodule:: pyepal.pal.pal_sklearn
    :members:
    :show-inheritance:
    :special-members:
    :private-members:


For quantile regression with LightGBM
.......................................

.. automodule:: pyepal.pal.pal_gbdt
    :members:
    :show-inheritance:
    :special-members:


For GPR with GPFlow
.......................................

.. automodule:: pyepal.pal.pal_gpflowgpr
    :members:
    :show-inheritance:
    :special-members:

For GPR with BoTorch
.......................................

.. automodule:: pyepal.pal.pal_botorch
    :members:
    :show-inheritance:
    :special-members:


For GBDT with CatBoost
.......................................

.. automodule:: pyepal.pal.pal_catboost
    :members:
    :show-inheritance:
    :special-members:



Schedules for hyperparameter optimization
...........................................

.. automodule:: pyepal.pal.schedules
    :members:
    :show-inheritance:
    :special-members:


Utilities for multiobjective optimization
...........................................

.. automodule:: pyepal.pal.utils
    :members:
    :show-inheritance:
    :special-members:


Utilities for plotting
...........................................

.. automodule:: pyepal.plotting
    :members:
    :show-inheritance:
    :special-members:



Input validation
...........................................

.. automodule:: pyepal.pal.validate_inputs
    :members:
    :show-inheritance:
    :special-members:




The models package
-------------------

Helper functions for GPR with GPy
...................................

.. automodule:: pyepal.models.gpr
    :members:
    :show-inheritance:
    :special-members:


Helper functions for GPR with BoTorch
........................................

.. automodule:: pyepal.models.botorch_gp
    :members:
    :show-inheritance:
    :special-members: