Skip to content

Commit

Permalink
adding sections to api doc
Browse files Browse the repository at this point in the history
  • Loading branch information
21ch216 committed Feb 7, 2025
1 parent 930bcdc commit f5c852c
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion doc/source/api/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
API
=============
====

The content of the exposed ReLife API. It is where one can find details about object interfaces (how many parameters
are needeed by a function, what are their types, etc.).

.. currentmodule:: relife


Usual API
----------



.. rubric:: Lifetime models

Lifetime models are objects whose exposed interface can answer basic probility functions of the survival analysis. In
Expand Down Expand Up @@ -62,6 +68,10 @@ data.
policies.RunToFailure
policies.AgeReplacementPolicy


Core objects
------------

.. rubric:: Likelihoods

.. autosummary::
Expand Down

0 comments on commit f5c852c

Please sign in to comment.