From f5c852cfb4ef2e65e8f4733f88a627a8682d9e3e Mon Sep 17 00:00:00 2001 From: 21ch216 Date: Fri, 7 Feb 2025 10:16:36 +0100 Subject: [PATCH] adding sections to api doc --- doc/source/api/index.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst index 5e83fe2..18e0e92 100644 --- a/doc/source/api/index.rst +++ b/doc/source/api/index.rst @@ -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 @@ -62,6 +68,10 @@ data. policies.RunToFailure policies.AgeReplacementPolicy + +Core objects +------------ + .. rubric:: Likelihoods .. autosummary::