Skip to content

Commit

Permalink
Deploying to gh-pages from @ 930bcdc 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
21ch216 committed Feb 6, 2025
1 parent ef97fdc commit 834a7ca
Show file tree
Hide file tree
Showing 81 changed files with 3,254 additions and 3,247 deletions.
Binary file modified _images/user_guide_demo_renewal_theory_6_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/user_guide_demo_renewal_theory_7_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions _modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -429,14 +429,14 @@
<article class="bd-article">

<h1>All modules for which code is available</h1>
<ul><li><a href="relife/distributions.html">relife.distributions</a></li>
<li><a href="relife/likelihoods.html">relife.likelihoods</a></li>
<li><a href="relife/model/base.html">relife.model.base</a></li>
<li><a href="relife/model/nested.html">relife.model.nested</a></li>
<li><a href="relife/nonparametric.html">relife.nonparametric</a></li>
<ul><li><a href="relife/core/likelihoods.html">relife.core.likelihoods</a></li>
<li><a href="relife/core/model.html">relife.core.model</a></li>
<li><a href="relife/core/nested_model.html">relife.core.nested_model</a></li>
<li><a href="relife/models/distributions.html">relife.models.distributions</a></li>
<li><a href="relife/models/nonparametric.html">relife.models.nonparametric</a></li>
<li><a href="relife/models/regression.html">relife.models.regression</a></li>
<li><a href="relife/policies/age_replacement.html">relife.policies.age_replacement</a></li>
<li><a href="relife/policies/run_to_failure.html">relife.policies.run_to_failure</a></li>
<li><a href="relife/regression.html">relife.regression</a></li>
</ul>

</article>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<!DOCTYPE html>


<html lang="en" data-content_root="../../" >
<html lang="en" data-content_root="../../../" >

<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>relife.likelihoods &#8212; ReLife</title>
<title>relife.core.likelihoods &#8212; ReLife</title>



Expand All @@ -26,31 +26,31 @@
</noscript>

<!-- Loaded before other Sphinx assets -->
<link href="../../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../../../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../../../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />

<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="../../_static/css/custom.css?v=733aff7d" />
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../../../_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/custom.css?v=733aff7d" />

<!-- So that users can add custom icons -->
<script src="../../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<script src="../../../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../_static/copybutton.js?v=f281be69"></script>
<script src="../../_static/design-tabs.js?v=f930bc37"></script>
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../../_static/copybutton.js?v=f281be69"></script>
<script src="../../../_static/design-tabs.js?v=f930bc37"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/relife/likelihoods';</script>
<script src="../../_static/custom-icon.js?v=74687d30"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/relife/core/likelihoods';</script>
<script src="../../../_static/custom-icon.js?v=74687d30"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="" />
Expand All @@ -72,7 +72,7 @@
<dialog id="pst-search-dialog">

<form class="bd-search d-flex align-items-center"
action="../../search.html"
action="../../../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
Expand Down Expand Up @@ -108,7 +108,7 @@



<a class="navbar-brand logo" href="../../index.html">
<a class="navbar-brand logo" href="../../../index.html">



Expand All @@ -119,8 +119,8 @@



<img src="../../_static/logo.png" class="logo__image only-light" alt="ReLife - Home"/>
<img src="../../_static/logo.png" class="logo__image only-dark pst-js-only" alt="ReLife - Home"/>
<img src="../../../_static/logo.png" class="logo__image only-light" alt="ReLife - Home"/>
<img src="../../../_static/logo.png" class="logo__image only-dark pst-js-only" alt="ReLife - Home"/>


</a></div>
Expand All @@ -136,28 +136,28 @@
<ul class="bd-navbar-elements navbar-nav">

<li class="nav-item ">
<a class="nav-link nav-internal" href="../../get_started/index.html">
<a class="nav-link nav-internal" href="../../../get_started/index.html">
Get started
</a>
</li>


<li class="nav-item ">
<a class="nav-link nav-internal" href="../../user_guide/index.html">
<a class="nav-link nav-internal" href="../../../user_guide/index.html">
User’s guide
</a>
</li>


<li class="nav-item ">
<a class="nav-link nav-internal" href="../../api/index.html">
<a class="nav-link nav-internal" href="../../../api/index.html">
API
</a>
</li>


<li class="nav-item ">
<a class="nav-link nav-internal" href="../../learn/index.html">
<a class="nav-link nav-internal" href="../../../learn/index.html">
Learn
</a>
</li>
Expand All @@ -171,14 +171,14 @@
<ul id="pst-nav-more-links" class="dropdown-menu">

<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="../../contributor_guide/index.html">
<a class="nav-link dropdown-item nav-internal" href="../../../contributor_guide/index.html">
Contributor’s guide
</a>
</li>


<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="../../future/index.html">
<a class="nav-link dropdown-item nav-internal" href="../../../future/index.html">
Future improvements
</a>
</li>
Expand Down Expand Up @@ -286,42 +286,42 @@
<ul class="bd-navbar-elements navbar-nav">

<li class="nav-item ">
<a class="nav-link nav-internal" href="../../get_started/index.html">
<a class="nav-link nav-internal" href="../../../get_started/index.html">
Get started
</a>
</li>


<li class="nav-item ">
<a class="nav-link nav-internal" href="../../user_guide/index.html">
<a class="nav-link nav-internal" href="../../../user_guide/index.html">
User’s guide
</a>
</li>


<li class="nav-item ">
<a class="nav-link nav-internal" href="../../api/index.html">
<a class="nav-link nav-internal" href="../../../api/index.html">
API
</a>
</li>


<li class="nav-item ">
<a class="nav-link nav-internal" href="../../learn/index.html">
<a class="nav-link nav-internal" href="../../../learn/index.html">
Learn
</a>
</li>


<li class="nav-item ">
<a class="nav-link nav-internal" href="../../contributor_guide/index.html">
<a class="nav-link nav-internal" href="../../../contributor_guide/index.html">
Contributor’s guide
</a>
</li>


<li class="nav-item ">
<a class="nav-link nav-internal" href="../../future/index.html">
<a class="nav-link nav-internal" href="../../../future/index.html">
Future improvements
</a>
</li>
Expand Down Expand Up @@ -407,14 +407,14 @@
<ul class="bd-breadcrumbs">

<li class="breadcrumb-item breadcrumb-home">
<a href="../../index.html" class="nav-link" aria-label="Home">
<a href="../../../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>

<li class="breadcrumb-item"><a href="../index.html" class="nav-link">Module code</a></li>
<li class="breadcrumb-item"><a href="../../index.html" class="nav-link">Module code</a></li>

<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">relife.likelihoods</span></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">relife.core.likelihoods</span></li>
</ul>
</nav>
</div>
Expand All @@ -431,7 +431,7 @@
<div id="searchbox"></div>
<article class="bd-article">

<h1>Source code for relife.likelihoods</h1><div class="highlight"><pre>
<h1>Source code for relife.core.likelihoods</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>

<span class="kn">from</span><span class="w"> </span><span class="nn">abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">abstractmethod</span>
Expand All @@ -445,7 +445,7 @@ <h1>Source code for relife.likelihoods</h1><div class="highlight"><pre>
<span class="kn">from</span><span class="w"> </span><span class="nn">relife.data</span><span class="w"> </span><span class="kn">import</span> <span class="n">LifetimeData</span>

<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span> <span class="c1"># avoid circular imports due to typing</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">relife.model</span><span class="w"> </span><span class="kn">import</span> <span class="n">ParametricLifetimeModel</span><span class="p">,</span> <span class="n">ParametricModel</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.model</span><span class="w"> </span><span class="kn">import</span> <span class="n">ParametricLifetimeModel</span><span class="p">,</span> <span class="n">ParametricModel</span>


<span class="k">class</span><span class="w"> </span><span class="nc">Likelihood</span><span class="p">(</span><span class="n">Protocol</span><span class="p">):</span>
Expand Down Expand Up @@ -499,15 +499,15 @@ <h1>Source code for relife.likelihoods</h1><div class="highlight"><pre>


<div class="viewcode-block" id="LikelihoodFromLifetimes">
<a class="viewcode-back" href="../../api/likelihood/relife.likelihoods.LikelihoodFromLifetimes.html#relife.likelihoods.LikelihoodFromLifetimes">[docs]</a>
<a class="viewcode-back" href="../../../api/likelihood/relife.core.likelihoods.LikelihoodFromLifetimes.html#relife.core.likelihoods.LikelihoodFromLifetimes">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">LikelihoodFromLifetimes</span><span class="p">(</span><span class="n">Likelihood</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Generic likelihood object for parametric lifetime models</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> model : ParametricLifetimeModel</span>
<span class="sd"> Underlying model used to compute probability functions</span>
<span class="sd"> Underlying core used to compute probability functions</span>
<span class="sd"> lifetime_data : LifetimeData</span>
<span class="sd"> Observed lifetime data used one which the likelihood is evaluated</span>
<span class="sd"> model_args : tuple of zero or more ndarray, default is ()</span>
Expand All @@ -520,7 +520,7 @@ <h1>Source code for relife.likelihoods</h1><div class="highlight"><pre>
<span class="n">lifetime_data</span><span class="p">:</span> <span class="n">LifetimeData</span><span class="p">,</span>
<span class="n">model_args</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">NDArray</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">],</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">(),</span>
<span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">model</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> <span class="c1"># a copy is made as likelihood modifies model.params</span>
<span class="bp">self</span><span class="o">.</span><span class="n">model</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> <span class="c1"># a copy is made as likelihood modifies core.params</span>
<span class="bp">self</span><span class="o">.</span><span class="n">lifetime_data</span> <span class="o">=</span> <span class="n">lifetime_data</span>
<span class="bp">self</span><span class="o">.</span><span class="n">model_args</span> <span class="o">=</span> <span class="n">model_args</span>

Expand Down Expand Up @@ -636,7 +636,7 @@ <h1>Source code for relife.likelihoods</h1><div class="highlight"><pre>
<span class="p">)</span>

<div class="viewcode-block" id="LikelihoodFromLifetimes.negative_log">
<a class="viewcode-back" href="../../api/likelihood/relife.likelihoods.LikelihoodFromLifetimes.html#relife.likelihoods.LikelihoodFromLifetimes.negative_log">[docs]</a>
<a class="viewcode-back" href="../../../api/likelihood/relife.core.likelihoods.LikelihoodFromLifetimes.html#relife.core.likelihoods.LikelihoodFromLifetimes.negative_log">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">negative_log</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">params</span><span class="p">:</span> <span class="n">NDArray</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">],</span>
Expand All @@ -651,7 +651,7 @@ <h1>Source code for relife.likelihoods</h1><div class="highlight"><pre>


<div class="viewcode-block" id="LikelihoodFromLifetimes.jac_negative_log">
<a class="viewcode-back" href="../../api/likelihood/relife.likelihoods.LikelihoodFromLifetimes.html#relife.likelihoods.LikelihoodFromLifetimes.jac_negative_log">[docs]</a>
<a class="viewcode-back" href="../../../api/likelihood/relife.core.likelihoods.LikelihoodFromLifetimes.html#relife.core.likelihoods.LikelihoodFromLifetimes.jac_negative_log">[docs]</a>
<span class="nd">@override</span>
<span class="k">def</span><span class="w"> </span><span class="nf">jac_negative_log</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
Expand Down Expand Up @@ -759,8 +759,8 @@ <h1>Source code for relife.likelihoods</h1><div class="highlight"><pre>
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>

<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
Expand Down
Loading

0 comments on commit 834a7ca

Please sign in to comment.