Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@postpop
postpop committed Sep 13, 2024
1 parent d9dc125 commit 8bcb77e
Show file tree
Hide file tree
Showing 143 changed files with 2,655 additions and 3,470 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: f2b6eff1bd81e97cf224aeba3a01bf82
config: 0d0cb37fa096d078f78dc57c0de1cd95
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 2 additions & 0 deletions _modules/das/annot.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.models.html">das.models</a></li>
Expand Down Expand Up @@ -272,6 +273,7 @@
<article role="main">
<h1>Source code for das.annot</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;Utilities for dealing with annotations.&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">xarray</span> <span class="k">as</span> <span class="nn">xr</span>
<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
Expand Down
5 changes: 3 additions & 2 deletions _modules/das/augmentation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.models.html">das.models</a></li>
Expand Down Expand Up @@ -311,6 +312,7 @@ <h1>Source code for das.augmentation</h1><div class="highlight"><pre>

<span class="sd">`augs = Augmentations.from_yaml(filename)`</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span>
<span class="kn">import</span> <span class="nn">scipy.signal</span>
Expand Down Expand Up @@ -344,8 +346,7 @@ <h1>Source code for das.augmentation</h1><div class="highlight"><pre>
<span class="sd"> Parameters are callables that return parameter values.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
<span class="o">...</span></div>
<span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span> <span class="o">...</span></div>


<div class="viewcode-block" id="Constant"><a class="viewcode-back" href="../../api/das.augmentation.html#das.augmentation.Constant">[docs]</a><span class="nd">@_register_param</span>
Expand Down
2 changes: 2 additions & 0 deletions _modules/das/block_stratify.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.models.html">das.models</a></li>
Expand Down Expand Up @@ -276,6 +277,7 @@ <h1>Source code for das.block_stratify</h1><div class="highlight"><pre>
<span class="sd">- blocks are parts of the data (individual files in a file list, parts of a data array)</span>
<span class="sd">- individual blocks are assigned specific groups (train/test/val)</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">Optional</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">Any</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">TypeVar</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
Expand Down
1 change: 1 addition & 0 deletions _modules/das/cli.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.models.html">das.models</a></li>
Expand Down
2 changes: 2 additions & 0 deletions _modules/das/data.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.models.html">das.models</a></li>
Expand Down Expand Up @@ -272,6 +273,7 @@
<article role="main">
<h1>Source code for das.data</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;Utils for loading and manipulating data for training and prediction.&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">tensorflow.keras</span> <span class="k">as</span> <span class="nn">keras</span>
<span class="kn">import</span> <span class="nn">dask.array</span>
Expand Down
1 change: 1 addition & 0 deletions _modules/das/data_hash.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.models.html">das.models</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/das/evaluate.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.models.html">das.models</a></li>
Expand Down
2 changes: 2 additions & 0 deletions _modules/das/event_utils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.models.html">das.models</a></li>
Expand Down Expand Up @@ -272,6 +273,7 @@
<article role="main">
<h1>Source code for das.event_utils</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;Utilities for handling events.&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">peakutils</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Union</span>
Expand Down
2 changes: 2 additions & 0 deletions _modules/das/io.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../api/das.models.html">das.models</a></li>
Expand Down Expand Up @@ -275,6 +276,7 @@ <h1>Source code for das.io</h1><div class="highlight"><pre>
<span class="sd">Load data for training/testing.</span>
<span class="sd">See doc/data.md for a description of the data schema.</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">os.path</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">npy_dir</span>
<span class="kn">import</span> <span class="nn">zarr</span>
Expand Down
1 change: 1 addition & 0 deletions _modules/das/kapre/augmentation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.models.html">das.models</a></li>
Expand Down
2 changes: 2 additions & 0 deletions _modules/das/kapre/backend.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.models.html">das.models</a></li>
Expand Down Expand Up @@ -286,6 +287,7 @@ <h1>Source code for das.kapre.backend</h1><div class="highlight"><pre>
<span class="sd"> later I realised it&#39;d be better to just use it.</span>
<span class="sd"> * TODO: remove copied code and use librosa.</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">from</span> <span class="nn">tensorflow.keras</span> <span class="kn">import</span> <span class="n">backend</span> <span class="k">as</span> <span class="n">K</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">librosa</span>
Expand Down
1 change: 1 addition & 0 deletions _modules/das/kapre/backend_keras.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.models.html">das.models</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/das/kapre/filterbank.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.models.html">das.models</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/das/kapre/time_frequency.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.models.html">das.models</a></li>
Expand Down
1 change: 1 addition & 0 deletions _modules/das/kapre/utils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.evaluate.html">das.evaluate</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.event_utils.html">das.event_utils</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.io.html">das.io</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.loss.html">das.loss</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.make_dataset.html">das.make_dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.menagerie.html">das.menagerie</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/das.models.html">das.models</a></li>
Expand Down
Loading

0 comments on commit 8bcb77e

Please sign in to comment.