Skip to content

Commit

Permalink
Update gh-pages to output generated at c3d79ba
Browse files Browse the repository at this point in the history
  • Loading branch information
dennisbader committed Mar 5, 2024
1 parent eb459e9 commit 757c44f
Show file tree
Hide file tree
Showing 207 changed files with 13,855 additions and 4,605 deletions.
30 changes: 29 additions & 1 deletion README.html
Original file line number Diff line number Diff line change
Expand Up @@ -578,10 +578,38 @@ <h2>Forecasting Models<a class="headerlink" href="#forecasting-models" title="Pe
<tr class="row-odd"><td><p><a class="reference external" href="https://unit8co.github.io/darts/generated_api/darts.models.forecasting.croston.html#darts.models.forecasting.croston.Croston">Croston</a> method</p></td>
<td></td>
<td><p>🟩 🟥</p></td>
<td><p>🟥 🟥 🟥</p></td>
<td><p>🟥 🟩 🟥</p></td>
<td><p>🟥 🟥</p></td>
<td><p>🟥</p></td>
</tr>
<tr class="row-even"><td><p><strong>Global Baseline Models</strong><span class="raw-html-m2r"><br/></span>(<a class="reference external" href="https://unit8co.github.io/darts/userguide/covariates.html#global-forecasting-models-gfms">GlobalForecastingModel</a>)</p></td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://unit8co.github.io/darts/generated_api/darts.models.forecasting.global_baseline_models.html#darts.models.forecasting.global_baseline_models.GlobalNaiveAggregate">GlobalNaiveAggregate</a></p></td>
<td></td>
<td><p>🟩 🟩</p></td>
<td><p>🟥 🟥 🟥</p></td>
<td><p>🟥 🟥</p></td>
<td><p>🟩</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://unit8co.github.io/darts/generated_api/darts.models.forecasting.global_baseline_models.html#darts.models.forecasting.global_baseline_models.GlobalNaiveDrift">GlobalNaiveDrift</a></p></td>
<td></td>
<td><p>🟩 🟩</p></td>
<td><p>🟥 🟥 🟥</p></td>
<td><p>🟥 🟥</p></td>
<td><p>🟩</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://unit8co.github.io/darts/generated_api/darts.models.forecasting.global_baseline_models.html#darts.models.forecasting.global_baseline_models.GlobalNaiveSeasonal">GlobalNaiveSeasonal</a></p></td>
<td></td>
<td><p>🟩 🟩</p></td>
<td><p>🟥 🟥 🟥</p></td>
<td><p>🟥 🟥</p></td>
<td><p>🟩</p></td>
</tr>
<tr class="row-even"><td><p><strong>Regression Models</strong><span class="raw-html-m2r"><br/></span>(<a class="reference external" href="https://unit8co.github.io/darts/userguide/covariates.html#global-forecasting-models-gfms">GlobalForecastingModel</a>)</p></td>
<td></td>
<td></td>
Expand Down
1 change: 0 additions & 1 deletion _modules/darts/ad/aggregators/or_aggregator.html
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,6 @@ <h1>Source code for darts.ad.aggregators.or_aggregator</h1><div class="highlight
<span class="sd">is flagged as anomalous (logical OR).</span>
<span class="sd">&quot;&quot;&quot;</span>


<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Sequence</span>

<span class="kn">from</span> <span class="nn">darts</span> <span class="kn">import</span> <span class="n">TimeSeries</span>
Expand Down
4 changes: 2 additions & 2 deletions _modules/darts/ad/anomaly_model/forecasting_am.html
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,8 @@ <h1>Source code for darts.ad.anomaly_model.forecasting_am</h1><div class="highli
<span class="n">series</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">TimeSeries</span><span class="p">],</span>
<span class="n">name_covariates</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">TimeSeries</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert `covariates` into Sequence, if not already, and checks if their length is equal to the one of `series`.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert `covariates` into Sequence, if not already, and checks if their length is equal to the one of</span>
<span class="sd"> `series`.</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
Expand Down Expand Up @@ -683,7 +684,6 @@ <h1>Source code for darts.ad.anomaly_model.forecasting_am</h1><div class="highli
<span class="n">start</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">pd</span><span class="o">.</span><span class="n">Timestamp</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">num_samples</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TimeSeries</span><span class="p">:</span>

<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compute the historical forecasts that would have been obtained by this model on the `series`.</span>

<span class="sd"> `retrain` is set to False if possible (this is not supported by all models). If set to True, it will always</span>
Expand Down
4 changes: 1 addition & 3 deletions _modules/darts/ad/detectors/quantile_detector.html
Original file line number Diff line number Diff line change
Expand Up @@ -237,9 +237,7 @@ <h1>Source code for darts.ad.detectors.quantile_detector</h1><div class="highlig
<span class="k">return</span> <span class="p">(</span>
<span class="n">q</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">)</span>
<span class="k">else</span> <span class="p">[</span><span class="n">q</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">)</span>
<span class="k">else</span> <span class="n">q</span>
<span class="k">else</span> <span class="p">[</span><span class="n">q</span><span class="p">]</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">)</span> <span class="k">else</span> <span class="n">q</span>
<span class="p">)</span>

<span class="n">low</span> <span class="o">=</span> <span class="n">_prep_quantile</span><span class="p">(</span><span class="n">low_quantile</span><span class="p">)</span>
Expand Down
4 changes: 1 addition & 3 deletions _modules/darts/ad/detectors/threshold_detector.html
Original file line number Diff line number Diff line change
Expand Up @@ -230,9 +230,7 @@ <h1>Source code for darts.ad.detectors.threshold_detector</h1><div class="highli
<span class="k">return</span> <span class="p">(</span>
<span class="n">q</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">)</span>
<span class="k">else</span> <span class="p">[</span><span class="n">q</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">)</span>
<span class="k">else</span> <span class="n">q</span>
<span class="k">else</span> <span class="p">[</span><span class="n">q</span><span class="p">]</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">q</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">)</span> <span class="k">else</span> <span class="n">q</span>
<span class="p">)</span>

<span class="n">low</span> <span class="o">=</span> <span class="n">_prep_thresholds</span><span class="p">(</span><span class="n">low_threshold</span><span class="p">)</span>
Expand Down
2 changes: 1 addition & 1 deletion _modules/darts/ad/scorers/scorers.html
Original file line number Diff line number Diff line change
Expand Up @@ -695,7 +695,7 @@ <h1>Source code for darts.ad.scorers.scorers</h1><div class="highlight"><pre>
<span class="n">_assert_same_length</span><span class="p">(</span><span class="n">list_actual_series</span><span class="p">,</span> <span class="n">list_pred_series</span><span class="p">)</span>

<span class="n">anomaly_scores</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="p">(</span><span class="n">s1</span><span class="p">,</span> <span class="n">s2</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">list_actual_series</span><span class="p">,</span> <span class="n">list_pred_series</span><span class="p">):</span>
<span class="k">for</span> <span class="n">s1</span><span class="p">,</span> <span class="n">s2</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">list_actual_series</span><span class="p">,</span> <span class="n">list_pred_series</span><span class="p">):</span>
<span class="n">_sanity_check_two_series</span><span class="p">(</span><span class="n">s1</span><span class="p">,</span> <span class="n">s2</span><span class="p">)</span>
<span class="n">s1</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_assert_deterministic</span><span class="p">(</span><span class="n">s1</span><span class="p">,</span> <span class="s2">&quot;actual_series&quot;</span><span class="p">)</span>
<span class="n">s2</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_assert_deterministic</span><span class="p">(</span><span class="n">s2</span><span class="p">,</span> <span class="s2">&quot;pred_series&quot;</span><span class="p">)</span>
Expand Down
1 change: 1 addition & 0 deletions _modules/darts/dataprocessing/pipeline.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ <h1>Source code for darts.dataprocessing.pipeline</h1><div class="highlight"><pr
<span class="sd">Pipeline</span>
<span class="sd">--------</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">from</span> <span class="nn">copy</span> <span class="kn">import</span> <span class="n">deepcopy</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Iterator</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">,</span> <span class="n">Union</span>

Expand Down
1 change: 1 addition & 0 deletions _modules/darts/dataprocessing/transformers/midas.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ <h1>Source code for darts.dataprocessing.transformers.midas</h1><div class="high
<span class="sd">Mixed-data sampling (MIDAS) Transformer</span>
<span class="sd">---------------------------------------</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">,</span> <span class="n">Union</span>

<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,6 @@ <h1>Source code for darts.dataprocessing.transformers.reconciliation</h1><div cl
<span class="sd">It can be added to a ``TimeSeries`` using e.g., the :meth:`TimeSeries.with_hierarchy` method.</span>
<span class="sd">&quot;&quot;&quot;</span>


<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Optional</span>

<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ <h1>Source code for darts.dataprocessing.transformers.static_covariates_transfor
<span class="sd">Static Covariates Transformer</span>
<span class="sd">------</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">OrderedDict</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">,</span> <span class="n">Tuple</span>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ <h1>Source code for darts.dataprocessing.transformers.window_transformer</h1><di
<span class="n">forecasting_safe</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
<span class="n">keep_non_transformed</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<span class="n">include_current</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
<span class="n">keep_names</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;WindowTransformer&quot;</span><span class="p">,</span>
<span class="n">n_jobs</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<span class="n">verbose</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
Expand Down Expand Up @@ -291,11 +292,15 @@ <h1>Source code for darts.dataprocessing.transformers.window_transformer</h1><di

<span class="sd"> keep_non_transformed</span>
<span class="sd"> ``False`` to return the transformed components only, ``True`` to return all original components along</span>
<span class="sd"> the transformed ones. Default is ``False``.</span>
<span class="sd"> the transformed ones. Default is ``False``. If the series has a hierarchy, must be set to ``False``.</span>

<span class="sd"> include_current</span>
<span class="sd"> ``True`` to include the current time step in the window, ``False`` to exclude it. Default is ``True``.</span>

<span class="sd"> keep_names</span>
<span class="sd"> Whether the transformed components should keep the original component names or. Must be set to ``False``</span>
<span class="sd"> if `keep_non_transformed = True` or the number of transformation is greater than 1.</span>

<span class="sd"> name</span>
<span class="sd"> A specific name for the transformer.</span>

Expand All @@ -315,6 +320,7 @@ <h1>Source code for darts.dataprocessing.transformers.window_transformer</h1><di
<span class="bp">self</span><span class="o">.</span><span class="n">treat_na</span> <span class="o">=</span> <span class="n">treat_na</span>
<span class="bp">self</span><span class="o">.</span><span class="n">forecasting_safe</span> <span class="o">=</span> <span class="n">forecasting_safe</span>
<span class="bp">self</span><span class="o">.</span><span class="n">include_current</span> <span class="o">=</span> <span class="n">include_current</span>
<span class="bp">self</span><span class="o">.</span><span class="n">keep_names</span> <span class="o">=</span> <span class="n">keep_names</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">n_jobs</span><span class="p">,</span> <span class="n">verbose</span><span class="p">)</span>

<div class="viewcode-block" id="WindowTransformer.ts_transform"><a class="viewcode-back" href="../../../../generated_api/darts.dataprocessing.transformers.window_transformer.html#darts.dataprocessing.transformers.window_transformer.WindowTransformer.ts_transform">[docs]</a> <span class="nd">@staticmethod</span>
Expand Down
Loading

0 comments on commit 757c44f

Please sign in to comment.