Skip to content

Commit c9532a4

Browse files
authored
Update docs (#244)
1 parent 7ab200f commit c9532a4

19 files changed

+307
-105
lines changed

_modules/torchaudio.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@
213213
<article itemprop="articleBody" id="pytorch-article" class="pytorch-article">
214214

215215
<h1>Source code for torchaudio</h1><div class="highlight"><pre>
216-
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span>
216+
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span><span class="p">,</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span><span class="p">,</span> <span class="n">unicode_literals</span>
217217
<span class="kn">import</span> <span class="nn">os.path</span>
218218

219219
<span class="kn">import</span> <span class="nn">torch</span>

_modules/torchaudio/compliance/kaldi.html

Lines changed: 147 additions & 15 deletions
Large diffs are not rendered by default.

_modules/torchaudio/datasets/vctk.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@
215215
<article itemprop="articleBody" id="pytorch-article" class="pytorch-article">
216216

217217
<h1>Source code for torchaudio.datasets.vctk</h1><div class="highlight"><pre>
218-
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span>
218+
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span><span class="p">,</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span><span class="p">,</span> <span class="n">unicode_literals</span>
219219
<span class="kn">import</span> <span class="nn">torch.utils.data</span> <span class="k">as</span> <span class="nn">data</span>
220220
<span class="kn">import</span> <span class="nn">os</span>
221221
<span class="kn">import</span> <span class="nn">os.path</span>

_modules/torchaudio/datasets/yesno.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@
215215
<article itemprop="articleBody" id="pytorch-article" class="pytorch-article">
216216

217217
<h1>Source code for torchaudio.datasets.yesno</h1><div class="highlight"><pre>
218-
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span>
218+
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span><span class="p">,</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span><span class="p">,</span> <span class="n">unicode_literals</span>
219219
<span class="kn">import</span> <span class="nn">torch.utils.data</span> <span class="k">as</span> <span class="nn">data</span>
220220
<span class="kn">import</span> <span class="nn">os</span>
221221
<span class="kn">import</span> <span class="nn">os.path</span>

_modules/torchaudio/functional.html

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,8 @@
215215
<article itemprop="articleBody" id="pytorch-article" class="pytorch-article">
216216

217217
<h1>Source code for torchaudio.functional</h1><div class="highlight"><pre>
218-
<span></span><span class="kn">import</span> <span class="nn">math</span>
218+
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span><span class="p">,</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span><span class="p">,</span> <span class="n">unicode_literals</span>
219+
<span class="kn">import</span> <span class="nn">math</span>
219220
<span class="kn">import</span> <span class="nn">torch</span>
220221

221222

@@ -278,8 +279,8 @@ <h1>Source code for torchaudio.functional</h1><div class="highlight"><pre>
278279
<span class="sd"> could be useful. If ``length`` is ``None`` then padding will be aggressively removed</span>
279280
<span class="sd"> (some loss of signal).</span>
280281

281-
<span class="sd"> [1] D. W. Griffin and J. S. Lim, Signal estimation from modified short-time Fourier transform,</span>
282-
<span class="sd"> IEEE Trans. ASSP, vol.32, no.2, pp.236243, Apr. 1984.</span>
282+
<span class="sd"> [1] D. W. Griffin and J. S. Lim, &quot;Signal estimation from modified short-time Fourier transform,&quot;</span>
283+
<span class="sd"> IEEE Trans. ASSP, vol.32, no.2, pp.236-243, Apr. 1984.</span>
283284

284285
<span class="sd"> Args:</span>
285286
<span class="sd"> stft_matrix (torch.Tensor): Output of stft where each row of a channel is a frequency and each</span>
@@ -312,6 +313,7 @@ <h1>Source code for torchaudio.functional</h1><div class="highlight"><pre>
312313
<span class="c1"># add a channel dimension</span>
313314
<span class="n">stft_matrix</span> <span class="o">=</span> <span class="n">stft_matrix</span><span class="o">.</span><span class="n">unsqueeze</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
314315

316+
<span class="n">dtype</span> <span class="o">=</span> <span class="n">stft_matrix</span><span class="o">.</span><span class="n">dtype</span>
315317
<span class="n">device</span> <span class="o">=</span> <span class="n">stft_matrix</span><span class="o">.</span><span class="n">device</span>
316318
<span class="n">fft_size</span> <span class="o">=</span> <span class="n">stft_matrix</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
317319
<span class="k">assert</span> <span class="p">(</span><span class="n">onesided</span> <span class="ow">and</span> <span class="n">n_fft</span> <span class="o">//</span> <span class="mi">2</span> <span class="o">+</span> <span class="mi">1</span> <span class="o">==</span> <span class="n">fft_size</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="ow">not</span> <span class="n">onesided</span> <span class="ow">and</span> <span class="n">n_fft</span> <span class="o">==</span> <span class="n">fft_size</span><span class="p">),</span> <span class="p">(</span>
@@ -330,7 +332,7 @@ <h1>Source code for torchaudio.functional</h1><div class="highlight"><pre>
330332
<span class="k">assert</span> <span class="mi">0</span> <span class="o">&lt;</span> <span class="n">win_length</span> <span class="o">&lt;=</span> <span class="n">n_fft</span>
331333

332334
<span class="k">if</span> <span class="n">window</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
333-
<span class="n">window</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">win_length</span><span class="p">)</span>
335+
<span class="n">window</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="n">win_length</span><span class="p">,</span> <span class="n">requires_grad</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="n">device</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span>
334336

335337
<span class="k">assert</span> <span class="n">window</span><span class="o">.</span><span class="n">dim</span><span class="p">()</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">window</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="o">==</span> <span class="n">win_length</span>
336338

@@ -353,7 +355,7 @@ <h1>Source code for torchaudio.functional</h1><div class="highlight"><pre>
353355
<span class="n">ytmp</span> <span class="o">=</span> <span class="n">ytmp</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> <span class="c1"># size (channel, n_fft, n_frames)</span>
354356

355357
<span class="n">eye</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">eye</span><span class="p">(</span><span class="n">n_fft</span><span class="p">,</span> <span class="n">requires_grad</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
356-
<span class="n">device</span><span class="o">=</span><span class="n">device</span><span class="p">)</span><span class="o">.</span><span class="n">unsqueeze</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> <span class="c1"># size (n_fft, 1, n_fft)</span>
358+
<span class="n">device</span><span class="o">=</span><span class="n">device</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dtype</span><span class="p">)</span><span class="o">.</span><span class="n">unsqueeze</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> <span class="c1"># size (n_fft, 1, n_fft)</span>
357359

358360
<span class="c1"># this does overlap add where the frames of ytmp are added such that the i&#39;th frame of</span>
359361
<span class="c1"># ytmp is added starting at i*hop_length in the output</span>

_modules/torchaudio/kaldi_io.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,8 @@
215215
<article itemprop="articleBody" id="pytorch-article" class="pytorch-article">
216216

217217
<h1>Source code for torchaudio.kaldi_io</h1><div class="highlight"><pre>
218-
<span></span><span class="c1"># To use this file, the dependency (https://github.com/vesis84/kaldi-io-for-python)</span>
218+
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span><span class="p">,</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span><span class="p">,</span> <span class="n">unicode_literals</span>
219+
<span class="c1"># To use this file, the dependency (https://github.com/vesis84/kaldi-io-for-python)</span>
219220
<span class="c1"># needs to be installed. This is a light wrapper around kaldi_io that returns</span>
220221
<span class="c1"># torch.Tensors.</span>
221222
<span class="kn">import</span> <span class="nn">torch</span>

_modules/torchaudio/sox_effects.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@
215215
<article itemprop="articleBody" id="pytorch-article" class="pytorch-article">
216216

217217
<h1>Source code for torchaudio.sox_effects</h1><div class="highlight"><pre>
218-
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span>
218+
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span><span class="p">,</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span><span class="p">,</span> <span class="n">unicode_literals</span>
219219
<span class="kn">import</span> <span class="nn">torch</span>
220220
<span class="kn">import</span> <span class="nn">_torch_sox</span>
221221

_modules/torchaudio/transforms.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@
215215
<article itemprop="articleBody" id="pytorch-article" class="pytorch-article">
216216

217217
<h1>Source code for torchaudio.transforms</h1><div class="highlight"><pre>
218-
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span>
218+
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span><span class="p">,</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span><span class="p">,</span> <span class="n">unicode_literals</span>
219219
<span class="kn">from</span> <span class="nn">warnings</span> <span class="k">import</span> <span class="n">warn</span>
220220
<span class="kn">import</span> <span class="nn">math</span>
221221
<span class="kn">import</span> <span class="nn">torch</span>

_sources/compliance.kaldi.rst.txt

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,20 @@ produce similar outputs.
1515
Functions
1616
---------
1717

18+
:hidden:`spectrogram`
19+
~~~~~~~~~~~~~~~~~~~~~~~~~~
20+
21+
.. autofunction:: spectrogram
22+
1823
:hidden:`fbank`
1924
~~~~~~~~~~~~~~~~~~~~~~~~~~
2025

2126
.. autofunction:: fbank
2227

23-
:hidden:`spectrogram`
28+
:hidden:`mfcc`
2429
~~~~~~~~~~~~~~~~~~~~~~~~~~
2530

26-
.. autofunction:: spectrogram
31+
.. autofunction:: mfcc
2732

2833
:hidden:`resample_waveform`
2934
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)