Skip to content

Commit

Permalink
docs: improve penalties landing page
Browse files Browse the repository at this point in the history
  • Loading branch information
Tveten committed Feb 3, 2025
1 parent e225c44 commit 54dd0c9
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docs/source/api_reference/penalties.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Penalties
=========
Penalties govern the trade-off between the number of change points and the fit of the
model. They are used by all detectors in ``skchange``.

Base
----

.. currentmodule:: skchange.penalties

Expand All @@ -10,15 +15,56 @@ Penalties
:template: class.rst

BasePenalty

Constant penalties
------------------
The penalty for each additional change point in the model is constant.

.. autosummary::
:toctree: auto_generated/
:template: class.rst

ConstantPenalty
BICPenalty
ChiSquarePenalty


Linear penalties
------------------
The penalty for each additional change point in the model is linear in the number of
variables affected by the change.
Only relevant for multivariate data and detectors supporting variable identification.

.. autosummary::
:toctree: auto_generated/
:template: class.rst

LinearPenalty
LinearChiSquarePenalty

Nonlinear penalties
------------------
The penalty for each additional change point in the model is non-linear in the number of
variables affected by the change.
Only relevant for multivariate data and detectors supporting variable identification.

.. autosummary::
:toctree: auto_generated/
:template: class.rst

NonLinearPenalty
NonLinearChiSquarePenalty

Composition
-----------

.. autosummary::
:toctree: auto_generated/
:template: class.rst

MinimumPenalty


Utility functions
-----------------

Expand Down

0 comments on commit 54dd0c9

Please sign in to comment.