Skip to content

Commit ff8deff

Browse files
will-ricewill-rice
committed
Rebuild Docs
1 parent cad90c1 commit ff8deff

21 files changed

Lines changed: 150 additions & 89 deletions

‎docs/source/_build/doctrees/environment.pickle‎

1.1 KB
Binary file not shown.

‎docs/source/_build/doctrees/spokestack.asr.doctree‎

1.88 KB
Binary file not shown.

‎docs/source/_build/html/_modules/spokestack/activation_timeout.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ <h1>
215215

216216

217217
<div class="viewcode-block" id="ActivationTimeout"><a class="viewcode-back" href="../../spokestack.activation_timeout.html#spokestack.activation_timeout.ActivationTimeout">[docs]</a><span class="k">class</span> <span class="nc">ActivationTimeout</span><span class="p">:</span>
218-
<span class="sd">&quot;&quot;&quot; Speech pipeline activation timeout</span>
218+
<span class="sd">&quot;&quot;&quot;Speech pipeline activation timeout</span>
219219

220220
<span class="sd"> Args:</span>
221221
<span class="sd"> frame_width (int): frame width of the audio (ms)</span>
@@ -233,7 +233,7 @@ <h1>
233233
<span class="bp">self</span><span class="o">.</span><span class="n">_active_length</span> <span class="o">=</span> <span class="mi">0</span>
234234

235235
<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="n">context</span><span class="p">:</span> <span class="n">SpeechContext</span><span class="p">,</span> <span class="n">frame</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
236-
<span class="sd">&quot;&quot;&quot; Main entry point that manages timeout</span>
236+
<span class="sd">&quot;&quot;&quot;Main entry point that manages timeout</span>
237237

238238
<span class="sd"> Args:</span>
239239
<span class="sd"> context (SpeechContext): the current state of the pipeline</span>

‎docs/source/_build/html/_modules/spokestack/asr/google/speech_recognizer.html‎

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ <h1>
220220
<span class="kn">import</span> <span class="nn">logging</span>
221221
<span class="kn">from</span> <span class="nn">queue</span> <span class="kn">import</span> <span class="n">Queue</span>
222222
<span class="kn">from</span> <span class="nn">threading</span> <span class="kn">import</span> <span class="n">Thread</span>
223-
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span>
223+
<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">Union</span>
224224

225225
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span> <span class="c1"># type: ignore</span>
226226
<span class="kn">from</span> <span class="nn">google.cloud</span> <span class="kn">import</span> <span class="n">speech</span> <span class="c1"># type: ignore</span>
@@ -236,33 +236,49 @@ <h1>
236236
<span class="sd">&quot;&quot;&quot;Transforms speech into text using Google&#39;s ASR.</span>
237237

238238
<span class="sd"> Args:</span>
239-
<span class="sd"> cred_path (str): path to google credentials</span>
240-
<span class="sd"> language (str): language of input audio</span>
239+
<span class="sd"> language (str): The language of given audio as a</span>
240+
<span class="sd"> [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)</span>
241+
<span class="sd"> language tag. Example: &quot;en-US&quot;</span>
242+
<span class="sd"> credentials (Union[None, str, dict]): Dictionary of Google API credentials</span>
243+
<span class="sd"> or path to credentials. if set to None</span>
244+
<span class="sd"> credentials will be pulled from the</span>
245+
<span class="sd"> environment variable:</span>
246+
<span class="sd"> GOOGLE_APPLICATION_CREDENTIALS</span>
241247
<span class="sd"> sample_rate (int): sample rate of the input audio (Hz)</span>
242248
<span class="sd"> **kwargs (optional): additional keyword arguments</span>
243249
<span class="sd"> &quot;&quot;&quot;</span>
244250

245251
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
246252
<span class="bp">self</span><span class="p">,</span>
247-
<span class="n">cred_path</span><span class="p">,</span>
248-
<span class="n">language</span><span class="o">=</span><span class="s2">&quot;en-US&quot;</span><span class="p">,</span>
249-
<span class="n">sample_rate</span><span class="o">=</span><span class="mi">16000</span><span class="p">,</span>
253+
<span class="n">language</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
254+
<span class="n">credentials</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="kc">None</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="nb">dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
255+
<span class="n">sample_rate</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">16000</span><span class="p">,</span>
250256
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
251257
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
252-
253-
<span class="n">credentials</span> <span class="o">=</span> <span class="n">service_account</span><span class="o">.</span><span class="n">Credentials</span><span class="o">.</span><span class="n">from_service_account_file</span><span class="p">(</span><span class="n">cred_path</span><span class="p">)</span>
254-
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">speech</span><span class="o">.</span><span class="n">SpeechClient</span><span class="p">(</span><span class="n">credentials</span><span class="o">=</span><span class="n">credentials</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
258+
<span class="k">if</span> <span class="n">credentials</span><span class="p">:</span>
259+
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">credentials</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
260+
<span class="n">credentials</span> <span class="o">=</span> <span class="n">service_account</span><span class="o">.</span><span class="n">Credentials</span><span class="o">.</span><span class="n">from_service_account_file</span><span class="p">(</span>
261+
<span class="n">credentials</span>
262+
<span class="p">)</span>
263+
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">credentials</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
264+
<span class="n">credentials</span> <span class="o">=</span> <span class="n">service_account</span><span class="o">.</span><span class="n">Credentials</span><span class="o">.</span><span class="n">from_service_account_info</span><span class="p">(</span>
265+
<span class="n">credentials</span>
266+
<span class="p">)</span>
267+
<span class="k">else</span><span class="p">:</span>
268+
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
269+
<span class="s2">&quot;Invalid Credentials: Only dict, str, or None accepted&quot;</span>
270+
<span class="p">)</span>
271+
272+
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">speech</span><span class="o">.</span><span class="n">SpeechClient</span><span class="p">(</span><span class="n">credentials</span><span class="o">=</span><span class="n">credentials</span><span class="p">)</span>
255273
<span class="bp">self</span><span class="o">.</span><span class="n">_config</span> <span class="o">=</span> <span class="n">speech</span><span class="o">.</span><span class="n">StreamingRecognitionConfig</span><span class="p">(</span>
256274
<span class="n">config</span><span class="o">=</span><span class="n">speech</span><span class="o">.</span><span class="n">RecognitionConfig</span><span class="p">(</span>
257275
<span class="n">encoding</span><span class="o">=</span><span class="n">speech</span><span class="o">.</span><span class="n">RecognitionConfig</span><span class="o">.</span><span class="n">AudioEncoding</span><span class="o">.</span><span class="n">LINEAR16</span><span class="p">,</span>
258276
<span class="n">sample_rate_hertz</span><span class="o">=</span><span class="n">sample_rate</span><span class="p">,</span>
259277
<span class="n">language_code</span><span class="o">=</span><span class="n">language</span><span class="p">,</span>
260278
<span class="n">enable_automatic_punctuation</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
261279
<span class="p">),</span>
262-
<span class="n">interim_results</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
280+
<span class="n">interim_results</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
263281
<span class="p">)</span>
264-
<span class="bp">self</span><span class="o">.</span><span class="n">_sample_rate</span> <span class="o">=</span> <span class="n">sample_rate</span>
265-
<span class="bp">self</span><span class="o">.</span><span class="n">_language</span> <span class="o">=</span> <span class="n">language</span>
266282
<span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="p">:</span> <span class="n">Queue</span> <span class="o">=</span> <span class="n">Queue</span><span class="p">()</span>
267283
<span class="bp">self</span><span class="o">.</span><span class="n">_thread</span><span class="p">:</span> <span class="n">Any</span> <span class="o">=</span> <span class="kc">None</span>
268284

@@ -273,7 +289,7 @@ <h1>
273289
<span class="sd"> context (SpeechContext): current state of the speech pipeline</span>
274290
<span class="sd"> frame (np.ndarray): numpy array of PCM-16 audio.</span>
275291

276-
<span class="sd"> Returns:</span>
292+
<span class="sd"> Returns: None</span>
277293

278294
<span class="sd"> &quot;&quot;&quot;</span>
279295
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_thread</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">context</span><span class="o">.</span><span class="n">is_active</span><span class="p">:</span>
@@ -291,17 +307,21 @@ <h1>
291307
<span class="bp">self</span><span class="o">.</span><span class="n">_thread</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
292308

293309
<span class="k">def</span> <span class="nf">_receive</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
294-
295310
<span class="k">for</span> <span class="n">response</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">streaming_recognize</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_config</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_drain</span><span class="p">()):</span>
296311
<span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">response</span><span class="o">.</span><span class="n">results</span><span class="p">[:</span><span class="mi">1</span><span class="p">]:</span>
297312
<span class="k">for</span> <span class="n">alternative</span> <span class="ow">in</span> <span class="n">result</span><span class="o">.</span><span class="n">alternatives</span><span class="p">[:</span><span class="mi">1</span><span class="p">]:</span>
298313
<span class="n">context</span><span class="o">.</span><span class="n">transcript</span> <span class="o">=</span> <span class="n">alternative</span><span class="o">.</span><span class="n">transcript</span>
299314
<span class="n">context</span><span class="o">.</span><span class="n">confidence</span> <span class="o">=</span> <span class="n">alternative</span><span class="o">.</span><span class="n">confidence</span>
315+
<span class="k">if</span> <span class="n">context</span><span class="o">.</span><span class="n">transcript</span><span class="p">:</span>
316+
<span class="n">context</span><span class="o">.</span><span class="n">event</span><span class="p">(</span><span class="s2">&quot;partial_recognize&quot;</span><span class="p">)</span>
300317

301318
<span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">is_final</span><span class="p">:</span>
302319
<span class="k">if</span> <span class="n">context</span><span class="o">.</span><span class="n">transcript</span><span class="p">:</span>
303320
<span class="n">context</span><span class="o">.</span><span class="n">event</span><span class="p">(</span><span class="s2">&quot;recognize&quot;</span><span class="p">)</span>
304321
<span class="n">_LOG</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;recognize event&quot;</span><span class="p">)</span>
322+
<span class="k">else</span><span class="p">:</span>
323+
<span class="n">context</span><span class="o">.</span><span class="n">event</span><span class="p">(</span><span class="s2">&quot;timeout&quot;</span><span class="p">)</span>
324+
<span class="n">_LOG</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;timeout event&quot;</span><span class="p">)</span>
305325

306326
<span class="k">def</span> <span class="nf">_drain</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
307327
<span class="k">while</span> <span class="n">data</span> <span class="o">:=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="o">.</span><span class="n">get</span><span class="p">():</span>
@@ -317,8 +337,8 @@ <h1>
317337

318338
<div class="viewcode-block" id="GoogleSpeechRecognizer.reset"><a class="viewcode-back" href="../../../../spokestack.asr.html#spokestack.asr.google.speech_recognizer.GoogleSpeechRecognizer.reset">[docs]</a> <span class="k">def</span> <span class="nf">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
319339
<span class="sd">&quot;&quot;&quot; resets recognizer &quot;&quot;&quot;</span>
320-
<span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="o">.</span><span class="n">empty</span><span class="p">()</span>
321340
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_thread</span><span class="p">:</span>
341+
<span class="bp">self</span><span class="o">.</span><span class="n">_queue</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
322342
<span class="bp">self</span><span class="o">.</span><span class="n">_thread</span><span class="o">.</span><span class="n">join</span><span class="p">()</span>
323343
<span class="bp">self</span><span class="o">.</span><span class="n">_thread</span> <span class="o">=</span> <span class="kc">None</span></div>
324344

‎docs/source/_build/html/_modules/spokestack/context.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ <h1>Source code for spokestack.context</h1>
225225
<span class="bp">self</span><span class="o">.</span><span class="n">_handlers</span><span class="p">:</span> <span class="nb">dict</span> <span class="o">=</span> <span class="p">{}</span>
226226

227227
<div class="viewcode-block" id="SpeechContext.add_handler"><a class="viewcode-back" href="../../spokestack.context.html#spokestack.context.SpeechContext.add_handler">[docs]</a> <span class="k">def</span> <span class="nf">add_handler</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">function</span><span class="p">:</span> <span class="n">Callable</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
228-
<span class="sd">&quot;&quot;&quot; Adds a handler to the context</span>
228+
<span class="sd">&quot;&quot;&quot;Adds a handler to the context</span>
229229

230230
<span class="sd"> Args:</span>
231231
<span class="sd"> name (str): The name of the event handler</span>
@@ -235,7 +235,7 @@ <h1>Source code for spokestack.context</h1>
235235
<span class="bp">self</span><span class="o">.</span><span class="n">_handlers</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">function</span></div>
236236

237237
<div class="viewcode-block" id="SpeechContext.event"><a class="viewcode-back" href="../../spokestack.context.html#spokestack.context.SpeechContext.event">[docs]</a> <span class="k">def</span> <span class="nf">event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
238-
<span class="sd">&quot;&quot;&quot; Calls the event handler</span>
238+
<span class="sd">&quot;&quot;&quot;Calls the event handler</span>
239239

240240
<span class="sd"> Args:</span>
241241
<span class="sd"> name (str): The name of the event handler</span>

‎docs/source/_build/html/_modules/spokestack/io/pyaudio.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ <h1>Source code for spokestack.io.pyaudio</h1>
286286

287287

288288
<div class="viewcode-block" id="PyAudioOutput"><a class="viewcode-back" href="../../../spokestack.io.html#spokestack.io.pyaudio.PyAudioOutput">[docs]</a><span class="k">class</span> <span class="nc">PyAudioOutput</span><span class="p">:</span>
289-
<span class="sd">&quot;&quot;&quot; Outputs audio to the default system output</span>
289+
<span class="sd">&quot;&quot;&quot;Outputs audio to the default system output</span>
290290

291291
<span class="sd"> Args:</span>
292292
<span class="sd"> num_channels (int): number of audio channels</span>
@@ -305,7 +305,7 @@ <h1>Source code for spokestack.io.pyaudio</h1>
305305
<span class="p">)</span>
306306

307307
<div class="viewcode-block" id="PyAudioOutput.write"><a class="viewcode-back" href="../../../spokestack.io.html#spokestack.io.pyaudio.PyAudioOutput.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">frame</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
308-
<span class="sd">&quot;&quot;&quot; Writes a single frame of audio to output</span>
308+
<span class="sd">&quot;&quot;&quot;Writes a single frame of audio to output</span>
309309

310310
<span class="sd"> Args:</span>
311311
<span class="sd"> frame (bytes): a single frame of audio</span>

0 commit comments

Comments
 (0)