Execute release review notes

docs/_downloads/dde96c6cfd6ff506f5048a5c797653e4/kalman_filter.py

@@ -10,7 +10,6 @@
 from progpy import LinearModel
 from progpy.state_estimators import KalmanFilter
 
-
 # Linear Model for an object thrown into the air
 class ThrownObject(LinearModel):
  """

docs/_sources/api_ref/progpy/Loading.rst

@@ -36,7 +36,7 @@ Load Estimator Classes
 
 .. autoclass:: progpy.loading.MovingAverage
 
-.. autoclass:: progpy.loading.GaussianNoiseLoadWrapper
+.. autoclass:: progpy.loading.GaussianNoiseWrapper
 
 Controllers
 ------------------

docs/_sources/npr7150.rst

@@ -561,8 +561,6 @@ The following dependencies are used in the project:
  * Future Support: Unknown- at the time of investigation, the last release was in 3.5 years ago and the last branch was updated 2 years ago. However, the code is simple and the tool is still used by many projects.
  * Other notes: validated by comparing the output of fastdtw to dtaidistance and the algorithm from the 'Towards Data Science' page (https://towardsdatascience.com/dynamic-time-warping-3933f25fcdd). Additionally, the team inspected the output of the package and it seemed reasonable. Finally, a review of open issues on their github repository and a search for known vulnerabilities yielded no concerns. It's only dependency is numpy, which is a trusted package.
 
-* 
-
 Notes for all: 
 
 * The function and performance of these tools are verified and validated as part of the automated tests and examples. [SWE-027 3.1.14.e]

docs/_sources/releases.rst

@@ -10,12 +10,8 @@ Updates in V1.6
 progpy
 **************
 * Combined previous prog_models and prog_algs packages into a single package, progpy.
-* Added new MixtureOfExperts model, which combines multiple models of the same system into a single model, where only the best of the comprised models will be used at each timestep.
-* Improvements to future load estimation:
-
- * Added ability to set random seed in GaussianLoadWrapper, allowing for repeatable experiments
- * Added wedge noise to GaussianLoadWrapper, this was a frequently requested feature that will increase noise levels as time goes on, representing the increased uncertainty further into the future.
-
+* Added new :py:class:`progpy.MixtureOfExpertsModel`, which combines multiple models of the same system into a single model, where only the best of the comprised models will be used at each timestep.
+* Added ability to set random seed in :py:class:`progpy.loading.GaussianNoiseWrapper`, allowing for repeatable experiments
 * Various bug fixes and performance improvements
 
 Upgrading from v1.5

docs/api_ref/progpy/CompositeModel.html

@@ -157,6 +157,7 @@
 <li class="toctree-l3"><a class="reference internal" href="IncludedModels.html">Included Models</a></li>
 <li class="toctree-l3"><a class="reference internal" href="LinearModel.html">LinearModel</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Loading.html">Loading</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MixtureOfExperts.html">MixtureOfExperts</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Prediction.html">Prediction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Predictor.html">Predictors</a></li>
 <li class="toctree-l3"><a class="reference internal" href="PrognosticModel.html">PrognosticsModel</a></li>

docs/api_ref/progpy/DataModel.html

@@ -157,6 +157,7 @@
 <li class="toctree-l3"><a class="reference internal" href="IncludedModels.html">Included Models</a></li>
 <li class="toctree-l3"><a class="reference internal" href="LinearModel.html">LinearModel</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Loading.html">Loading</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MixtureOfExperts.html">MixtureOfExperts</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Prediction.html">Prediction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Predictor.html">Predictors</a></li>
 <li class="toctree-l3"><a class="reference internal" href="PrognosticModel.html">PrognosticsModel</a></li>

docs/api_ref/progpy/DataSets.html

@@ -157,6 +157,7 @@
 <li class="toctree-l3"><a class="reference internal" href="IncludedModels.html">Included Models</a></li>
 <li class="toctree-l3"><a class="reference internal" href="LinearModel.html">LinearModel</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Loading.html">Loading</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MixtureOfExperts.html">MixtureOfExperts</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Prediction.html">Prediction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Predictor.html">Predictors</a></li>
 <li class="toctree-l3"><a class="reference internal" href="PrognosticModel.html">PrognosticsModel</a></li>

docs/api_ref/progpy/EnsembleModel.html

@@ -157,6 +157,7 @@
 <li class="toctree-l3"><a class="reference internal" href="IncludedModels.html">Included Models</a></li>
 <li class="toctree-l3"><a class="reference internal" href="LinearModel.html">LinearModel</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Loading.html">Loading</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MixtureOfExperts.html">MixtureOfExperts</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Prediction.html">Prediction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Predictor.html">Predictors</a></li>
 <li class="toctree-l3"><a class="reference internal" href="PrognosticModel.html">PrognosticsModel</a></li>

docs/api_ref/progpy/LinearModel.html

@@ -157,6 +157,7 @@
 <li class="toctree-l3"><a class="reference internal" href="IncludedModels.html">Included Models</a></li>
 <li class="toctree-l3 current active"><a class="current reference internal" href="#">LinearModel</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Loading.html">Loading</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MixtureOfExperts.html">MixtureOfExperts</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Prediction.html">Prediction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Predictor.html">Predictors</a></li>
 <li class="toctree-l3"><a class="reference internal" href="PrognosticModel.html">PrognosticsModel</a></li>

docs/api_ref/progpy/Loading.html

@@ -50,7 +50,7 @@
  <link rel="shortcut icon" href="../../_static/nasa_logo.ico"/>
  <link rel="index" title="Index" href="../../genindex.html" />
  <link rel="search" title="Search" href="../../search.html" />
- <link rel="next" title="Prediction" href="Prediction.html" />
+ <link rel="next" title="MixtureOfExperts" href="MixtureOfExperts.html" />
  <link rel="prev" title="LinearModel" href="LinearModel.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <meta name="docsearch:language" content="None"/>
@@ -157,6 +157,7 @@
 <li class="toctree-l3"><a class="reference internal" href="IncludedModels.html">Included Models</a></li>
 <li class="toctree-l3"><a class="reference internal" href="LinearModel.html">LinearModel</a></li>
 <li class="toctree-l3 current active"><a class="current reference internal" href="#">Loading</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MixtureOfExperts.html">MixtureOfExperts</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Prediction.html">Prediction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Predictor.html">Predictors</a></li>
 <li class="toctree-l3"><a class="reference internal" href="PrognosticModel.html">PrognosticsModel</a></li>
@@ -427,10 +428,31 @@ <h2>Load Estimator Classes<a class="headerlink" href="#load-estimator-classes" t
 </div>
 </dd></dl>
 
-<dl class="py attribute">
-<dt class="sig sig-object py" id="progpy.loading.GaussianNoiseLoadWrapper">
-<span class="sig-prename descclassname"><span class="pre">progpy.loading.</span></span><span class="sig-name descname"><span class="pre">GaussianNoiseLoadWrapper</span></span><a class="headerlink" href="#progpy.loading.GaussianNoiseLoadWrapper" title="Permalink to this definition">#</a></dt>
-<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">progpy.loading.gaussian_wrapper.GaussianNoiseWrapper</span></code></p>
+<dl class="py class">
+<dt class="sig sig-object py" id="progpy.loading.GaussianNoiseWrapper">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">progpy.loading.</span></span><span class="sig-name descname"><span class="pre">GaussianNoiseWrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fcn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><span class="pre">collections.abc.Callable</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><span class="pre">float</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">std_slope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><span class="pre">float</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">t0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><span class="pre">float</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#progpy.loading.GaussianNoiseWrapper" title="Permalink to this definition">#</a></dt>
+<dd><div class="versionadded">
+<p><span class="versionmodified added">New in version 1.5.0.</span></p>
+</div>
+<p>This is a simple wrapper for future loading functions that adds gaussian noise to the inputs. It takes a future loading function and a standard deviation and returns a new future loading function that adds gaussian noise to the inputs.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>fcn</strong> (<em>Callable</em>) – The future loading function to wrap</p></li>
+<li><p><strong>std</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – The standard deviation of the gaussian noise to add</p></li>
+</ul>
+</dd>
+<dt class="field-even">Keyword Arguments</dt>
+<dd class="field-even"><p><strong>seed</strong> (<em>{int</em><em>, </em><em>SeedSequence</em><em>, </em><em>BitGenerator</em><em>, </em><em>Generator}</em><em>, </em><em>optional</em>) – The seed for random number generator. This can be set to make results repeatable.</p>
+</dd>
+</dl>
+<p class="rubric">Example</p>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">progpy.loading</span> <span class="kn">import</span> <span class="n">GaussianNoiseLoadWrapper</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">m</span> <span class="o">=</span> <span class="n">SomeModel</span><span class="p">()</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">future_load</span> <span class="o">=</span> <span class="n">GaussianNoiseLoadWrapper</span><span class="p">(</span><span class="n">future_load</span><span class="p">,</span> <span class="n">STANDARD_DEV</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">m</span><span class="o">.</span><span class="n">simulate_to_threshold</span><span class="p">(</span><span class="n">future_load</span><span class="p">)</span>
+</pre></div>
+</div>
 </dd></dl>
 
 </section>
@@ -514,11 +536,11 @@ <h2>Controllers<a class="headerlink" href="#controllers" title="Permalink to thi
  </div>
  </a>
  <a class="right-next"
- href="Prediction.html"
+ href="MixtureOfExperts.html"
  title="next page">
  <div class="prev-next-info">
  <p class="prev-next-subtitle">next</p>
- <p class="prev-next-title">Prediction</p>
+ <p class="prev-next-title">MixtureOfExperts</p>
  </div>
  <i class="fa-solid fa-angle-right"></i>
  </a>

docs/api_ref/progpy/Prediction.html

@@ -54,7 +54,7 @@
  <link rel="index" title="Index" href="../../genindex.html" />
  <link rel="search" title="Search" href="../../search.html" />
  <link rel="next" title="Predictors" href="Predictor.html" />
- <link rel="prev" title="Loading" href="Loading.html" />
+ <link rel="prev" title="MixtureOfExperts" href="MixtureOfExperts.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <meta name="docsearch:language" content="None"/>
  </head>
@@ -160,6 +160,7 @@
 <li class="toctree-l3"><a class="reference internal" href="IncludedModels.html">Included Models</a></li>
 <li class="toctree-l3"><a class="reference internal" href="LinearModel.html">LinearModel</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Loading.html">Loading</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MixtureOfExperts.html">MixtureOfExperts</a></li>
 <li class="toctree-l3 current active"><a class="current reference internal" href="#">Prediction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Predictor.html">Predictors</a></li>
 <li class="toctree-l3"><a class="reference internal" href="PrognosticModel.html">PrognosticsModel</a></li>
@@ -514,12 +515,12 @@ <h1>Prediction<a class="headerlink" href="#prediction" title="Permalink to this
  <div class="footer-article-item"><!-- Previous / next buttons -->
 <div class="prev-next-area">
  <a class="left-prev"
- href="Loading.html"
+ href="MixtureOfExperts.html"
  title="previous page">
  <i class="fa-solid fa-angle-left"></i>
  <div class="prev-next-info">
  <p class="prev-next-subtitle">previous</p>
- <p class="prev-next-title">Loading</p>
+ <p class="prev-next-title">MixtureOfExperts</p>
  </div>
  </a>
  <a class="right-next"

docs/api_ref/progpy/PrognosticModel.html

@@ -157,6 +157,7 @@
 <li class="toctree-l3"><a class="reference internal" href="IncludedModels.html">Included Models</a></li>
 <li class="toctree-l3"><a class="reference internal" href="LinearModel.html">LinearModel</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Loading.html">Loading</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MixtureOfExperts.html">MixtureOfExperts</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Prediction.html">Prediction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Predictor.html">Predictors</a></li>
 <li class="toctree-l3 current active"><a class="current reference internal" href="#">PrognosticsModel</a></li>

docs/api_ref/progpy/SimResult.html

@@ -157,6 +157,7 @@
 <li class="toctree-l3"><a class="reference internal" href="IncludedModels.html">Included Models</a></li>
 <li class="toctree-l3"><a class="reference internal" href="LinearModel.html">LinearModel</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Loading.html">Loading</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MixtureOfExperts.html">MixtureOfExperts</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Prediction.html">Prediction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Predictor.html">Predictors</a></li>
 <li class="toctree-l3"><a class="reference internal" href="PrognosticModel.html">PrognosticsModel</a></li>

docs/api_ref/progpy/ToEPredictionProfile.html

@@ -158,6 +158,7 @@
 <li class="toctree-l3"><a class="reference internal" href="IncludedModels.html">Included Models</a></li>
 <li class="toctree-l3"><a class="reference internal" href="LinearModel.html">LinearModel</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Loading.html">Loading</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MixtureOfExperts.html">MixtureOfExperts</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Prediction.html">Prediction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Predictor.html">Predictors</a></li>
 <li class="toctree-l3"><a class="reference internal" href="PrognosticModel.html">PrognosticsModel</a></li>

docs/api_ref/progpy/UncertainData.html

@@ -160,6 +160,7 @@
 <li class="toctree-l3"><a class="reference internal" href="IncludedModels.html">Included Models</a></li>
 <li class="toctree-l3"><a class="reference internal" href="LinearModel.html">LinearModel</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Loading.html">Loading</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MixtureOfExperts.html">MixtureOfExperts</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Prediction.html">Prediction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Predictor.html">Predictors</a></li>
 <li class="toctree-l3"><a class="reference internal" href="PrognosticModel.html">PrognosticsModel</a></li>

docs/api_ref/progpy/Utils.html

@@ -157,6 +157,7 @@
 <li class="toctree-l3"><a class="reference internal" href="IncludedModels.html">Included Models</a></li>
 <li class="toctree-l3"><a class="reference internal" href="LinearModel.html">LinearModel</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Loading.html">Loading</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MixtureOfExperts.html">MixtureOfExperts</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Prediction.html">Prediction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Predictor.html">Predictors</a></li>
 <li class="toctree-l3"><a class="reference internal" href="PrognosticModel.html">PrognosticsModel</a></li>

docs/genindex.html

@@ -595,7 +595,7 @@ <h2 id="F">F</h2>
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="api_ref/progpy/Loading.html#progpy.loading.GaussianNoiseLoadWrapper">GaussianNoiseLoadWrapper (in module progpy.loading)</a>
+ <li><a href="api_ref/progpy/Loading.html#progpy.loading.GaussianNoiseWrapper">GaussianNoiseWrapper (class in progpy.loading)</a>
 </li>
  <li><a href="api_ref/progpy/Utils.html#progpy.utils.traj_gen.Trajectory.generate">generate() (progpy.utils.traj_gen.Trajectory method)</a>
 </li>

docs/glossary.html

@@ -158,6 +158,7 @@
 <li class="toctree-l3"><a class="reference internal" href="api_ref/progpy/IncludedModels.html">Included Models</a></li>
 <li class="toctree-l3"><a class="reference internal" href="api_ref/progpy/LinearModel.html">LinearModel</a></li>
 <li class="toctree-l3"><a class="reference internal" href="api_ref/progpy/Loading.html">Loading</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api_ref/progpy/MixtureOfExperts.html">MixtureOfExperts</a></li>
 <li class="toctree-l3"><a class="reference internal" href="api_ref/progpy/Prediction.html">Prediction</a></li>
 <li class="toctree-l3"><a class="reference internal" href="api_ref/progpy/Predictor.html">Predictors</a></li>
 <li class="toctree-l3"><a class="reference internal" href="api_ref/progpy/PrognosticModel.html">PrognosticsModel</a></li>