admin/scribe
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docu updated

Browse Source
This commit is contained in:
ortizcruz
2023-09-18 18:37:34 +02:00
parent e76b7b51a5
commit 125ee7c6f5
34 changed files with 332 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/_build/html/_sources/autotranscript.app.rst.txt
Vendored
+8
View File
@@ -4,6 +4,14 @@ autotranscript.app package
Submodules
----------
autotranscript.app.gradio\_app module
-------------------------------------
.. automodule:: autotranscript.app.gradio_app
:members:
:undoc-members:
:show-inheritance:
autotranscript.app.qtfaststart module
-------------------------------------
docs/_build/html/_sources/autotranscript.rst.txt
Vendored
+8
View File
@@ -28,6 +28,14 @@ autotranscript.autotranscript module
:undoc-members:
:show-inheritance:
autotranscript.cli module
-------------------------
.. automodule:: autotranscript.cli
:members:
:undoc-members:
:show-inheritance:
autotranscript.diarisation module
---------------------------------
docs/_build/html/_sources/gradio_app.rst.txt
Vendored
-7
View File
@@ -1,7 +0,0 @@
gradio\_app module
==================
.. automodule:: gradio_app
:members:
:undoc-members:
:show-inheritance:
docs/_build/html/_sources/index.rst.txt
Vendored
+6 -12
View File
@@ -1,14 +1,14 @@
.. AutoTranscript documentation master file, created by
sphinx-quickstart on Thu Aug 31 08:17:31 2023.
.. ScrAIbe documentation master file, created by
sphinx-quickstart on Mon Sep 18 18:17:08 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to AutoTranscript's documentation!
==========================================
Welcome to ScrAIbe's documentation!
===================================
`AutoTranscript`: Fully Automated Transcription using AI
`ScrAIbe` is a state-of-the-art, PyTorch based multilingual speech-to-text framework to generate fully automated transcriptions.
`AutoTranscript` is a PyTorch based interface speech-to-text tool to generate fully automated transcriptions. AutoTranscript uses AI models containing speaker diarization models:
Beyond transcription, ScrAIbe supports advanced functions, such as speaker diarization and speaker recognition.
.. toctree::
@@ -19,9 +19,3 @@ Welcome to AutoTranscript's documentation!
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
docs/_build/html/_sources/modules.rst.txt
Vendored
-1
View File
@@ -6,7 +6,6 @@ autotranscript
app
autotranscript
gradio_app
setup
test_autotranscript
transcribe
docs/_build/html/app.html
Vendored
+17
View File
@@ -16,6 +16,8 @@
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="autotranscript package" href="autotranscript.html" />
<link rel="prev" title="autotranscript" href="modules.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -63,11 +65,26 @@
<h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">autotranscript</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">app module</a></li>
<li class="toctree-l2"><a class="reference internal" href="autotranscript.html">autotranscript package</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
<li class="toctree-l2"><a class="reference internal" href="test_autotranscript.html">test_autotranscript module</a></li>
<li class="toctree-l2"><a class="reference internal" href="transcribe.html">transcribe module</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="modules.html">autotranscript</a><ul>
<li>Previous: <a href="modules.html" title="previous chapter">autotranscript</a></li>
<li>Next: <a href="autotranscript.html" title="next chapter">autotranscript package</a></li>
</ul></li>
</ul></li>
</ul>
</div>
docs/_build/html/autotranscript.app.html
Vendored
+87
View File
@@ -16,6 +16,8 @@
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="setup module" href="setup.html" />
<link rel="prev" title="autotranscript package" href="autotranscript.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -37,6 +39,74 @@
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
</section>
<section id="module-autotranscript.app.gradio_app">
<span id="autotranscript-app-gradio-app-module"></span><h2>autotranscript.app.gradio_app module<a class="headerlink" href="#module-autotranscript.app.gradio_app" title="Permalink to this heading"></a></h2>
<section id="gradio-audio-transcription-app">
<h3>Gradio Audio Transcription App.<a class="headerlink" href="#gradio-audio-transcription-app" title="Permalink to this heading"></a></h3>
<p>This module provides an interface to transcribe audio files using the
AutoTranscribe model. Users can either upload an audio file or record their speech
live for transcription. The application supports multiple languages and provides
options to specify the number of speakers and the language of the audio.</p>
<dl class="simple">
<dt>Attributes:</dt><dd><p>LANGUAGES (list): A list of supported languages for transcription.</p>
</dd>
<dt>Usage:</dt><dd><p>Run this script to start the Gradio web interface for audio transcription.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="autotranscript.app.gradio_app.GradioTranscriptionInterface">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">GradioTranscriptionInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="autotranscript.html#autotranscript.autotranscript.AutoTranscribe" title="autotranscript.autotranscript.AutoTranscribe"><span class="pre">AutoTranscribe</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#autotranscript.app.gradio_app.GradioTranscriptionInterface" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Interface handling the interaction between Gradio UI and the Audio Transcription system.</p>
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.app.gradio_app.GradioTranscriptionInterface.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="autotranscript.html#autotranscript.autotranscript.AutoTranscribe" title="autotranscript.autotranscript.AutoTranscribe"><span class="pre">AutoTranscribe</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#autotranscript.app.gradio_app.GradioTranscriptionInterface.__init__" title="Permalink to this definition"></a></dt>
<dd><p>Initializes the GradioTranscriptionInterface with a transcription model.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>model (AutoTranscribe): Model responsible for audio transcription tasks.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.app.gradio_app.GradioTranscriptionInterface.auto_transcribe">
<span class="sig-name descname"><span class="pre">auto_transcribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_speakers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">translation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">language</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#autotranscript.app.gradio_app.GradioTranscriptionInterface.auto_transcribe" title="Permalink to this definition"></a></dt>
<dd><p>Shortcut method for the AutoTranscribe task.</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>tuple: Transcribed text (str), JSON output (dict)</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.app.gradio_app.GradioTranscriptionInterface.perform_diarisation">
<span class="sig-name descname"><span class="pre">perform_diarisation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_speakers</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#autotranscript.app.gradio_app.GradioTranscriptionInterface.perform_diarisation" title="Permalink to this definition"></a></dt>
<dd><p>Shortcut method for the Diarisation task.</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>str: JSON output of diarisation result.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.app.gradio_app.GradioTranscriptionInterface.transcribe">
<span class="sig-name descname"><span class="pre">transcribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">translation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">language</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#autotranscript.app.gradio_app.GradioTranscriptionInterface.transcribe" title="Permalink to this definition"></a></dt>
<dd><p>Shortcut method for the Transcribe task.</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>str: Transcribed text.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="autotranscript.app.gradio_app.gradio_Interface">
<span class="sig-name descname"><span class="pre">gradio_Interface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="autotranscript.html#autotranscript.autotranscript.AutoTranscribe" title="autotranscript.autotranscript.AutoTranscribe"><span class="pre">AutoTranscribe</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><span class="sig-paren">)</span><a class="headerlink" href="#autotranscript.app.gradio_app.gradio_Interface" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</section>
</section>
<section id="module-autotranscript.app.qtfaststart">
<span id="autotranscript-app-qtfaststart-module"></span><h2>autotranscript.app.qtfaststart module<a class="headerlink" href="#module-autotranscript.app.qtfaststart" title="Permalink to this heading"></a></h2>
<p>This file contains a modified version of qtfaststart by qtfaststart
@@ -185,11 +255,28 @@ like “ftyp” or “moov”.</p>
<h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">autotranscript</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="app.html">app module</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="autotranscript.html">autotranscript package</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
<li class="toctree-l2"><a class="reference internal" href="test_autotranscript.html">test_autotranscript module</a></li>
<li class="toctree-l2"><a class="reference internal" href="transcribe.html">transcribe module</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="modules.html">autotranscript</a><ul>
<li><a href="autotranscript.html">autotranscript package</a><ul>
<li>Previous: <a href="autotranscript.html" title="previous chapter">autotranscript package</a></li>
<li>Next: <a href="setup.html" title="next chapter">setup module</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
docs/_build/html/autotranscript.html
Vendored
+113 -23
View File
@@ -16,6 +16,8 @@
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="autotranscript.app package" href="autotranscript.app.html" />
<link rel="prev" title="app module" href="app.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -40,6 +42,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="autotranscript.app.html">autotranscript.app package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="autotranscript.app.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="autotranscript.app.html#module-autotranscript.app.gradio_app">autotranscript.app.gradio_app module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autotranscript.app.html#gradio-audio-transcription-app">Gradio Audio Transcription App.</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="autotranscript.app.html#module-autotranscript.app.qtfaststart">autotranscript.app.qtfaststart module</a></li>
<li class="toctree-l2"><a class="reference internal" href="autotranscript.app.html#module-autotranscript.app">Module contents</a></li>
</ul>
@@ -215,6 +221,54 @@ get_audio_file: Gets an audio file as an AudioProcessor object.</p>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.autotranscript.AutoTranscribe.__repr__">
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#autotranscript.autotranscript.AutoTranscribe.__repr__" title="Permalink to this definition"></a></dt>
<dd><p>Return repr(self).</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.autotranscript.AutoTranscribe.autotranscribe">
<span class="sig-name descname"><span class="pre">autotranscribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">audio_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">torch.Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">numpy.ndarray</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remove_original</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#autotranscript.transcript_exporter.Transcript" title="autotranscript.transcript_exporter.Transcript"><span class="pre">Transcript</span></a></span></span><a class="headerlink" href="#autotranscript.autotranscript.AutoTranscribe.autotranscribe" title="Permalink to this definition"></a></dt>
<dd><p>Transcribes an audio file using the whisper model and pyannote diarization model.</p>
<dl>
<dt>Args:</dt><dd><dl class="simple">
<dt>audio_file (Union[str, torch.Tensor, ndarray]): </dt><dd><p>Path to audio file or a tensor representing the audio.</p>
</dd>
<dt>remove_original (bool, optional): If True, the original audio file will</dt><dd><p>be removed after transcription.</p>
</dd>
</dl>
<p><a href="#id3"><span class="problematic" id="id4">*</span></a>args: Additional positional arguments for diarization and transcription.
<a href="#id5"><span class="problematic" id="id6">**</span></a>kwargs: Additional keyword arguments for diarization and transcription.</p>
</dd>
<dt>Returns:</dt><dd><dl class="simple">
<dt>Transcript: A Transcript object containing the transcription,</dt><dd><p>which can be exported to different formats.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.autotranscript.AutoTranscribe.diarization">
<span class="sig-name descname"><span class="pre">diarization</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">audio_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">torch.Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">numpy.ndarray</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#autotranscript.autotranscript.AutoTranscribe.diarization" title="Permalink to this definition"></a></dt>
<dd><p>Perform diarization on an audio file using the pyannote diarization model.</p>
<dl class="simple">
<dt>Args:</dt><dd><dl class="simple">
<dt>audio_file (Union[str, torch.Tensor, ndarray]):</dt><dd><p>The audio source which can either be a path to the audio file or a tensor representation.</p>
</dd>
<dt><a href="#id7"><span class="problematic" id="id8">**</span></a>kwargs: </dt><dd><p>Additional keyword arguments for diarization.</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><dl class="simple">
<dt>dict: </dt><dd><p>A dictionary containing the results of the diarization process.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.autotranscript.AutoTranscribe.get_audio_file">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_audio_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">audio_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">torch.Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">numpy.ndarray</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#autotranscript.audio.AudioProcessor" title="autotranscript.audio.AudioProcessor"><span class="pre">AudioProcessor</span></a></span></span><a class="headerlink" href="#autotranscript.autotranscript.AutoTranscribe.get_audio_file" title="Permalink to this definition"></a></dt>
@@ -224,8 +278,8 @@ get_audio_file: Gets an audio file as an AudioProcessor object.</p>
<dt>audio_file (Union[str, torch.Tensor, ndarray]): Path to the audio file or </dt><dd><p>a tensor representing the audio.</p>
</dd>
</dl>
<p><a href="#id3"><span class="problematic" id="id4">*</span></a>args: Additional positional arguments.
<a href="#id5"><span class="problematic" id="id6">**</span></a>kwargs: Additional keyword arguments.</p>
<p><a href="#id9"><span class="problematic" id="id10">*</span></a>args: Additional positional arguments.
<a href="#id11"><span class="problematic" id="id12">**</span></a>kwargs: Additional keyword arguments.</p>
</dd>
<dt>Returns:</dt><dd><dl class="simple">
<dt>AudioProcessor: An object containing the waveform and sample rate in</dt><dd><p>torch.Tensor format.</p>
@@ -251,20 +305,18 @@ shred (bool, optional): If True, the audio file will be shredded,</p>
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.autotranscript.AutoTranscribe.transcribe">
<span class="sig-name descname"><span class="pre">transcribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">audio_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">torch.Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">numpy.ndarray</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remove_original</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#autotranscript.transcript_exporter.Transcript" title="autotranscript.transcript_exporter.Transcript"><span class="pre">Transcript</span></a></span></span><a class="headerlink" href="#autotranscript.autotranscript.AutoTranscribe.transcribe" title="Permalink to this definition"></a></dt>
<dd><p>Transcribes an audio file using the whisper model and pyannote diarization model.</p>
<dl>
<span class="sig-name descname"><span class="pre">transcribe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">audio_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">torch.Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">numpy.ndarray</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#autotranscript.autotranscript.AutoTranscribe.transcribe" title="Permalink to this definition"></a></dt>
<dd><p>Transcribe the provided audio file.</p>
<dl class="simple">
<dt>Args:</dt><dd><dl class="simple">
<dt>audio_file (Union[str, torch.Tensor, ndarray]): </dt><dd><p>Path to audio file or a tensor representing the audio.</p>
<dt>audio_file (Union[str, torch.Tensor, ndarray]):</dt><dd><p>The audio source, which can either be a path or a tensor representation.</p>
</dd>
<dt>remove_original (bool, optional): If True, the original audio file will</dt><dd><p>be removed after transcription.</p>
<dt><a href="#id13"><span class="problematic" id="id14">**</span></a>kwargs: </dt><dd><p>Additional keyword arguments for transcription.</p>
</dd>
</dl>
<p><a href="#id7"><span class="problematic" id="id8">*</span></a>args: Additional positional arguments for diarization and transcription.
<a href="#id9"><span class="problematic" id="id10">**</span></a>kwargs: Additional keyword arguments for diarization and transcription.</p>
</dd>
<dt>Returns:</dt><dd><dl class="simple">
<dt>Transcript: A Transcript object containing the transcription,</dt><dd><p>which can be exported to different formats.</p>
<dt>str:</dt><dd><p>The transcribed text from the audio source.</p>
</dd>
</dl>
</dd>
@@ -273,9 +325,17 @@ shred (bool, optional): If True, the audio file will be shredded,</p>
</dd></dl>
</section>
</section>
<section id="module-autotranscript.cli">
<span id="autotranscript-cli-module"></span><h2>autotranscript.cli module<a class="headerlink" href="#module-autotranscript.cli" title="Permalink to this heading"></a></h2>
<p>Command-Line Interface (CLI) for the AutoTranscribe class,
allowing for user interaction to transcribe and diarize audio files.
The function includes arguments for specifying the audio files, model paths,
output formats, and other options necessary for transcription.</p>
<dl class="py function">
<dt class="sig sig-object py" id="autotranscript.autotranscript.cli">
<span class="sig-name descname"><span class="pre">cli</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#autotranscript.autotranscript.cli" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="autotranscript.cli.cli">
<span class="sig-name descname"><span class="pre">cli</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#autotranscript.cli.cli" title="Permalink to this definition"></a></dt>
<dd><p>Command-Line Interface (CLI) for the AutoTranscribe class, allowing for user interaction to transcribe
and diarize audio files. The function includes arguments for specifying the audio files, model paths,
output formats, and other options necessary for transcription.</p>
@@ -283,7 +343,6 @@ output formats, and other options necessary for transcription.</p>
user-friendly way to access the AutoTranscribe class functionalities.</p>
</dd></dl>
</section>
</section>
<section id="module-autotranscript.diarisation">
<span id="autotranscript-diarisation-module"></span><h2>autotranscript.diarisation module<a class="headerlink" href="#module-autotranscript.diarisation" title="Permalink to this heading"></a></h2>
@@ -372,7 +431,7 @@ to the diarization process.</p>
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.diarisation.Diariser.load_model">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'/home/ortizcruzc/.cache/torch/models/pyannote/config.yaml'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></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">cache_token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_dir</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">Path</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'/home/ortizcruzc/.cache/torch/models/pyannote'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hparams_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span></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><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">pyannote.audio.Pipeline</span></span></span><a class="headerlink" href="#autotranscript.diarisation.Diariser.load_model" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'/home/ortizcruzc/.cache/torch/models/pyannote/config.yaml'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_auth_token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></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">cache_token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_dir</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">Path</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'/home/ortizcruzc/.cache/torch/models/pyannote'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hparams_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Path</span><span class="p"><span class="pre">]</span></span></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="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">pyannote.audio.Pipeline</span></span></span><a class="headerlink" href="#autotranscript.diarisation.Diariser.load_model" title="Permalink to this definition"></a></dt>
<dd><p>Loads a pretrained model from pyannote.audio,
either from a local cache or online repository.</p>
<dl>
@@ -383,7 +442,9 @@ either from a local cache or online repository.</p>
<p>token: Optional HUGGINGFACE_TOKEN for authenticated access.
cache_token: Whether to cache the token locally for future use.
cache_dir: Directory for caching models.
hparams_file: Path to a YAML file containing hyperparameters.</p>
hparams_file: Path to a YAML file containing hyperparameters.
args: Additional arguments only to avoid errors.
kwargs: Additional keyword arguments only to avoid errors.</p>
</dd>
<dt>Returns:</dt><dd><p>Pipeline: A pyannote.audio Pipeline object, encapsulating the loaded model.</p>
</dd>
@@ -483,9 +544,9 @@ the load_model method for available options.</p>
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.transcriber.Transcriber.load_model">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'medium'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">download_root</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'/home/ortizcruzc/.cache/torch/models/whisper'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">torch.device</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></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">in_memory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#autotranscript.transcriber.Transcriber" title="autotranscript.transcriber.Transcriber"><span class="pre">Transcriber</span></a></span></span><a class="headerlink" href="#autotranscript.transcriber.Transcriber.load_model" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'medium'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">download_root</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'/home/ortizcruzc/.cache/torch/models/whisper'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">torch.device</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></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">in_memory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#autotranscript.transcriber.Transcriber" title="autotranscript.transcriber.Transcriber"><span class="pre">Transcriber</span></a></span></span><a class="headerlink" href="#autotranscript.transcriber.Transcriber.load_model" title="Permalink to this definition"></a></dt>
<dd><p>Load whisper model.</p>
<dl class="simple">
<dl>
<dt>Args:</dt><dd><dl class="simple">
<dt>model (str): Whisper model. Available models include:</dt><dd><ul class="simple">
<li><p>‘tiny.en’</p></li>
@@ -508,6 +569,8 @@ the load_model method for available options.</p>
<dt>in_memory (bool, optional): Whether to load model in memory. </dt><dd><p>Defaults to False.</p>
</dd>
</dl>
<p>args: Additional arguments only to avoid errors.
kwargs: Additional keyword arguments only to avoid errors.</p>
</dd>
<dt>Returns:</dt><dd><p>Transcriber: A Transcriber object initialized with the specified model.</p>
</dd>
@@ -533,8 +596,8 @@ save_path (str): The path to save the transcript.</p>
<dd><p>Transcribe an audio file.</p>
<dl>
<dt>Args:</dt><dd><p>audio (Union[str, Tensor, nparray]): The audio file to transcribe.
<a href="#id11"><span class="problematic" id="id12">*</span></a>args: Additional arguments.
<a href="#id13"><span class="problematic" id="id14">**</span></a>kwargs: Additional keyword arguments,</p>
<a href="#id15"><span class="problematic" id="id16">*</span></a>args: Additional arguments.
<a href="#id17"><span class="problematic" id="id18">**</span></a>kwargs: Additional keyword arguments,</p>
<blockquote>
<div><p>such as the language of the audio file.</p>
</div></blockquote>
@@ -601,7 +664,7 @@ contain speaker and segment information.</p>
<dt>Args:</dt><dd><p>args (list): List of speaker names. These will be mapped sequentially to the speakers.
kwargs (dict): Dictionary with speaker names as keys and list of segments as values.</p>
</dd>
<dt>Returns:</dt><dd><p>dict: Dictionary with speaker names as keys and the corresponding annotation as values.</p>
<dt>Returns:</dt><dd><p>dict: Dictionary with speaker names as keys and list of segments as values.</p>
</dd>
<dt>Raises:</dt><dd><dl class="simple">
<dt>ValueError: If the number of speaker names does not match the number </dt><dd><p>of speakers, or if an unknown speaker is found.</p>
@@ -611,6 +674,18 @@ kwargs (dict): Dictionary with speaker names as keys and list of segments as val
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.transcript_exporter.Transcript.from_json">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#autotranscript.transcript_exporter.Transcript" title="autotranscript.transcript_exporter.Transcript"><span class="pre">Transcript</span></a></span></span><a class="headerlink" href="#autotranscript.transcript_exporter.Transcript.from_json" title="Permalink to this definition"></a></dt>
<dd><p>Load transcript from json file</p>
<dl class="simple">
<dt>Args:</dt><dd><p>path (str): path to json file</p>
</dd>
<dt>Returns:</dt><dd><p>Transcript: Transcript object</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.transcript_exporter.Transcript.get_dict">
<span class="sig-name descname"><span class="pre">get_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#autotranscript.transcript_exporter.Transcript.get_dict" title="Permalink to this definition"></a></dt>
@@ -641,7 +716,7 @@ kwargs (dict): Dictionary with speaker names as keys and list of segments as val
<dl class="py method">
<dt class="sig sig-object py" id="autotranscript.transcript_exporter.Transcript.get_json">
<span class="sig-name descname"><span class="pre">get_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#autotranscript.transcript_exporter.Transcript.get_json" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">get_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_annotation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#autotranscript.transcript_exporter.Transcript.get_json" title="Permalink to this definition"></a></dt>
<dd><p>Get transcript as json string
:return: transcript as json string
:rtype: str</p>
@@ -677,8 +752,8 @@ MD, HTML, TEX, and PDF. The file format is determined by the extension of
the path.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>path (str): Path to save the file, including the desired file extension.
<a href="#id15"><span class="problematic" id="id16">*</span></a>args: Additional positional arguments to be passed to the specific save methods.
<a href="#id17"><span class="problematic" id="id18">**</span></a>kwargs: Additional keyword arguments to be passed to the specific save methods.</p>
<a href="#id19"><span class="problematic" id="id20">*</span></a>args: Additional positional arguments to be passed to the specific save methods.
<a href="#id21"><span class="problematic" id="id22">**</span></a>kwargs: Additional keyword arguments to be passed to the specific save methods.</p>
</dd>
<dt>Raises:</dt><dd><p>ValueError: If the file format specified in the path is unknown.</p>
</dd>
@@ -784,11 +859,26 @@ the path.</p>
<h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">autotranscript</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="app.html">app module</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">autotranscript package</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
<li class="toctree-l2"><a class="reference internal" href="test_autotranscript.html">test_autotranscript module</a></li>
<li class="toctree-l2"><a class="reference internal" href="transcribe.html">transcribe module</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="modules.html">autotranscript</a><ul>
<li>Previous: <a href="app.html" title="previous chapter">app module</a></li>
<li>Next: <a href="autotranscript.app.html" title="next chapter">autotranscript.app package</a></li>
</ul></li>
</ul></li>
</ul>
</div>
docs/_build/html/genindex.html
Vendored
+48 -8
View File
@@ -60,6 +60,8 @@
<li><a href="autotranscript.html#autotranscript.autotranscript.AutoTranscribe.__init__">(AutoTranscribe method)</a>
</li>
<li><a href="autotranscript.html#autotranscript.diarisation.Diariser.__init__">(Diariser method)</a>
</li>
<li><a href="autotranscript.app.html#autotranscript.app.gradio_app.GradioTranscriptionInterface.__init__">(GradioTranscriptionInterface method)</a>
</li>
<li><a href="autotranscript.html#autotranscript.transcriber.Transcriber.__init__">(Transcriber method)</a>
</li>
@@ -72,6 +74,8 @@
<ul>
<li><a href="autotranscript.html#autotranscript.audio.AudioProcessor.__repr__">(AudioProcessor method)</a>
</li>
<li><a href="autotranscript.html#autotranscript.autotranscript.AutoTranscribe.__repr__">(AutoTranscribe method)</a>
</li>
<li><a href="autotranscript.html#autotranscript.diarisation.Diariser.__repr__">(Diariser method)</a>
</li>
@@ -100,8 +104,12 @@
<li><a href="autotranscript.app.html#autotranscript.app.qtfaststart.Atom">Atom (class in autotranscript.app.qtfaststart)</a>
</li>
<li><a href="autotranscript.html#autotranscript.audio.AudioProcessor">AudioProcessor (class in autotranscript.audio)</a>
</li>
<li><a href="autotranscript.app.html#autotranscript.app.gradio_app.GradioTranscriptionInterface.auto_transcribe">auto_transcribe() (GradioTranscriptionInterface method)</a>
</li>
<li><a href="autotranscript.html#autotranscript.autotranscript.AutoTranscribe">AutoTranscribe (class in autotranscript.autotranscript)</a>
</li>
<li><a href="autotranscript.html#autotranscript.autotranscript.AutoTranscribe.autotranscribe">autotranscribe() (AutoTranscribe method)</a>
</li>
<li>
autotranscript
@@ -115,6 +123,13 @@
<ul>
<li><a href="autotranscript.app.html#module-autotranscript.app">module</a>
</li>
</ul></li>
<li>
autotranscript.app.gradio_app
<ul>
<li><a href="autotranscript.app.html#module-autotranscript.app.gradio_app">module</a>
</li>
</ul></li>
<li>
@@ -124,6 +139,8 @@
<li><a href="autotranscript.app.html#module-autotranscript.app.qtfaststart">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
autotranscript.audio
@@ -131,13 +148,18 @@
<li><a href="autotranscript.html#module-autotranscript.audio">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
autotranscript.autotranscript
<ul>
<li><a href="autotranscript.html#module-autotranscript.autotranscript">module</a>
</li>
</ul></li>
<li>
autotranscript.cli
<ul>
<li><a href="autotranscript.html#module-autotranscript.cli">module</a>
</li>
</ul></li>
<li>
@@ -181,7 +203,7 @@
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="autotranscript.html#autotranscript.autotranscript.cli">cli() (in module autotranscript.autotranscript)</a>
<li><a href="autotranscript.html#autotranscript.cli.cli">cli() (in module autotranscript.cli)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
@@ -199,8 +221,12 @@
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="autotranscript.html#autotranscript.diarisation.Diariser.diarization">diarization() (Diariser method)</a>
<li><a href="autotranscript.html#autotranscript.autotranscript.AutoTranscribe.diarization">diarization() (AutoTranscribe method)</a>
<ul>
<li><a href="autotranscript.html#autotranscript.diarisation.Diariser.diarization">(Diariser method)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
@@ -211,13 +237,15 @@
</li>
<li><a href="autotranscript.app.html#autotranscript.app.qtfaststart.FastStartSetupError">FastStartSetupError</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="autotranscript.app.html#autotranscript.app.qtfaststart.find_atoms">find_atoms() (in module autotranscript.app.qtfaststart)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="autotranscript.html#autotranscript.diarisation.Diariser.format_diarization_output">format_diarization_output() (Diariser static method)</a>
</li>
<li><a href="autotranscript.html#autotranscript.audio.AudioProcessor.from_file">from_file() (AudioProcessor class method)</a>
</li>
<li><a href="autotranscript.html#autotranscript.transcript_exporter.Transcript.from_json">from_json() (Transcript class method)</a>
</li>
</ul></td>
</tr></table>
@@ -235,10 +263,10 @@
</li>
<li><a href="autotranscript.app.html#autotranscript.app.qtfaststart.get_index">get_index() (in module autotranscript.app.qtfaststart)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="autotranscript.html#autotranscript.transcript_exporter.Transcript.get_json">get_json() (Transcript method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="autotranscript.html#autotranscript.transcript_exporter.Transcript.get_md">get_md() (Transcript method)</a>
</li>
<li><a href="autotranscript.html#autotranscript.transcript_exporter.Transcript.get_tex">get_tex() (Transcript method)</a>
@@ -246,6 +274,10 @@
<li><a href="autotranscript.html#autotranscript.version.get_version">get_version() (in module autotranscript.version)</a>
</li>
<li><a href="autotranscript.html#autotranscript.version.git_version">git_version() (in module autotranscript.version)</a>
</li>
<li><a href="autotranscript.app.html#autotranscript.app.gradio_app.gradio_Interface">gradio_Interface() (in module autotranscript.app.gradio_app)</a>
</li>
<li><a href="autotranscript.app.html#autotranscript.app.gradio_app.GradioTranscriptionInterface">GradioTranscriptionInterface (class in autotranscript.app.gradio_app)</a>
</li>
</ul></td>
</tr></table>
@@ -280,12 +312,16 @@
<li><a href="autotranscript.html#module-autotranscript">autotranscript</a>
</li>
<li><a href="autotranscript.app.html#module-autotranscript.app">autotranscript.app</a>
</li>
<li><a href="autotranscript.app.html#module-autotranscript.app.gradio_app">autotranscript.app.gradio_app</a>
</li>
<li><a href="autotranscript.app.html#module-autotranscript.app.qtfaststart">autotranscript.app.qtfaststart</a>
</li>
<li><a href="autotranscript.html#module-autotranscript.audio">autotranscript.audio</a>
</li>
<li><a href="autotranscript.html#module-autotranscript.autotranscript">autotranscript.autotranscript</a>
</li>
<li><a href="autotranscript.html#module-autotranscript.cli">autotranscript.cli</a>
</li>
<li><a href="autotranscript.html#module-autotranscript.diarisation">autotranscript.diarisation</a>
</li>
@@ -313,6 +349,8 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="app.html#app.parse_contents">parse_contents() (in module app)</a>
</li>
<li><a href="autotranscript.app.html#autotranscript.app.gradio_app.GradioTranscriptionInterface.perform_diarisation">perform_diarisation() (GradioTranscriptionInterface method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
@@ -369,6 +407,8 @@
<li><a href="autotranscript.html#autotranscript.autotranscript.AutoTranscribe.transcribe">transcribe() (AutoTranscribe method)</a>
<ul>
<li><a href="autotranscript.app.html#autotranscript.app.gradio_app.GradioTranscriptionInterface.transcribe">(GradioTranscriptionInterface method)</a>
</li>
<li><a href="autotranscript.html#autotranscript.transcriber.Transcriber.transcribe">(Transcriber method)</a>
</li>
</ul></li>
docs/_build/html/gradio_app.html
Vendored
-120
View File
@@ -1,120 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<title>gradio_app module &#8212; AutoTranscript documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="setup module" href="setup.html" />
<link rel="prev" title="autotranscript.app package" href="autotranscript.app.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="gradio-app-module">
<h1>gradio_app module<a class="headerlink" href="#gradio-app-module" title="Permalink to this heading"></a></h1>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">AutoTranscript</a></h1>
<h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">autotranscript</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="app.html">app module</a></li>
<li class="toctree-l2"><a class="reference internal" href="autotranscript.html">autotranscript package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">gradio_app module</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
<li class="toctree-l2"><a class="reference internal" href="test_autotranscript.html">test_autotranscript module</a></li>
<li class="toctree-l2"><a class="reference internal" href="transcribe.html">transcribe module</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="modules.html">autotranscript</a><ul>
<li>Previous: <a href="autotranscript.app.html" title="previous chapter">autotranscript.app package</a></li>
<li>Next: <a href="setup.html" title="next chapter">setup module</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2023, Jacob Schmieder.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/gradio_app.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
docs/_build/html/index.html
Vendored
+5 -14
View File
@@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<title>Welcome to AutoTranscript’s documentation! &#8212; AutoTranscript documentation</title>
<title>Welcome to ScrAIbe’s documentation! &#8212; AutoTranscript documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -33,17 +33,16 @@
<div class="body" role="main">
<section id="welcome-to-autotranscript-s-documentation">
<h1>Welcome to AutoTranscript’s documentation!<a class="headerlink" href="#welcome-to-autotranscript-s-documentation" title="Permalink to this heading"></a></h1>
<p><cite>AutoTranscript</cite>: Fully Automated Transcription using AI</p>
<p><cite>AutoTranscript</cite> is a PyTorch based interface speech-to-text tool to generate fully automated transcriptions. AutoTranscript uses AI models containing speaker diarization models:</p>
<section id="welcome-to-scraibe-s-documentation">
<h1>Welcome to ScrAIbe’s documentation!<a class="headerlink" href="#welcome-to-scraibe-s-documentation" title="Permalink to this heading"></a></h1>
<p><cite>ScrAIbe</cite> is a state-of-the-art, PyTorch based multilingual speech-to-text framework to generate fully automated transcriptions.</p>
<p>Beyond transcription, ScrAIbe supports advanced functions, such as speaker diarization and speaker recognition.</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">autotranscript</a><ul>
<li class="toctree-l2"><a class="reference internal" href="app.html">app module</a></li>
<li class="toctree-l2"><a class="reference internal" href="autotranscript.html">autotranscript package</a></li>
<li class="toctree-l2"><a class="reference internal" href="gradio_app.html">gradio_app module</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
<li class="toctree-l2"><a class="reference internal" href="test_autotranscript.html">test_autotranscript module</a></li>
<li class="toctree-l2"><a class="reference internal" href="transcribe.html">transcribe module</a></li>
@@ -51,14 +50,6 @@
</li>
</ul>
</div>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
docs/_build/html/modules.html
Vendored
+4 -4
View File
@@ -17,7 +17,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="app module" href="app.html" />
<link rel="prev" title="Welcome to AutoTranscript’s documentation!" href="index.html" />
<link rel="prev" title="Welcome to ScrAIbe’s documentation!" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -43,6 +43,7 @@
<li class="toctree-l2"><a class="reference internal" href="autotranscript.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autotranscript.app.html">autotranscript.app package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="autotranscript.app.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="autotranscript.app.html#module-autotranscript.app.gradio_app">autotranscript.app.gradio_app module</a></li>
<li class="toctree-l4"><a class="reference internal" href="autotranscript.app.html#module-autotranscript.app.qtfaststart">autotranscript.app.qtfaststart module</a></li>
<li class="toctree-l4"><a class="reference internal" href="autotranscript.app.html#module-autotranscript.app">Module contents</a></li>
</ul>
@@ -58,6 +59,7 @@
<li class="toctree-l3"><a class="reference internal" href="autotranscript.html#autotranscribe-class">AutoTranscribe Class</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="autotranscript.html#module-autotranscript.cli">autotranscript.cli module</a></li>
<li class="toctree-l2"><a class="reference internal" href="autotranscript.html#module-autotranscript.diarisation">autotranscript.diarisation module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="autotranscript.html#diarisation-class">Diarisation Class</a></li>
</ul>
@@ -72,7 +74,6 @@
<li class="toctree-l2"><a class="reference internal" href="autotranscript.html#module-autotranscript">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gradio_app.html">gradio_app module</a></li>
<li class="toctree-l1"><a class="reference internal" href="setup.html">setup module</a></li>
<li class="toctree-l1"><a class="reference internal" href="test_autotranscript.html">test_autotranscript module</a></li>
<li class="toctree-l1"><a class="reference internal" href="transcribe.html">transcribe module</a></li>
@@ -102,7 +103,6 @@
<li class="toctree-l1 current"><a class="current reference internal" href="#">autotranscript</a><ul>
<li class="toctree-l2"><a class="reference internal" href="app.html">app module</a></li>
<li class="toctree-l2"><a class="reference internal" href="autotranscript.html">autotranscript package</a></li>
<li class="toctree-l2"><a class="reference internal" href="gradio_app.html">gradio_app module</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
<li class="toctree-l2"><a class="reference internal" href="test_autotranscript.html">test_autotranscript module</a></li>
<li class="toctree-l2"><a class="reference internal" href="transcribe.html">transcribe module</a></li>
@@ -114,7 +114,7 @@
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">Welcome to AutoTranscript’s documentation!</a></li>
<li>Previous: <a href="index.html" title="previous chapter">Welcome to ScrAIbe’s documentation!</a></li>
<li>Next: <a href="app.html" title="next chapter">app module</a></li>
</ul></li>
</ul>
docs/_build/html/objects.inv
Vendored
BIN
View File
Binary file not shown.
docs/_build/html/py-modindex.html
Vendored
+10
View File
@@ -61,6 +61,11 @@
<td>&#160;&#160;&#160;
<a href="autotranscript.app.html#module-autotranscript.app"><code class="xref">autotranscript.app</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="autotranscript.app.html#module-autotranscript.app.gradio_app"><code class="xref">autotranscript.app.gradio_app</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
@@ -76,6 +81,11 @@
<td>&#160;&#160;&#160;
<a href="autotranscript.html#module-autotranscript.autotranscript"><code class="xref">autotranscript.autotranscript</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="autotranscript.html#module-autotranscript.cli"><code class="xref">autotranscript.cli</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
docs/_build/html/searchindex.js
Vendored
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/_build/html/setup.html
Vendored
+2 -3
View File
@@ -17,7 +17,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="test_autotranscript module" href="test_autotranscript.html" />
<link rel="prev" title="gradio_app module" href="gradio_app.html" />
<link rel="prev" title="autotranscript.app package" href="autotranscript.app.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -60,7 +60,6 @@
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">autotranscript</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="app.html">app module</a></li>
<li class="toctree-l2"><a class="reference internal" href="autotranscript.html">autotranscript package</a></li>
<li class="toctree-l2"><a class="reference internal" href="gradio_app.html">gradio_app module</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">setup module</a></li>
<li class="toctree-l2"><a class="reference internal" href="test_autotranscript.html">test_autotranscript module</a></li>
<li class="toctree-l2"><a class="reference internal" href="transcribe.html">transcribe module</a></li>
@@ -73,7 +72,7 @@
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="modules.html">autotranscript</a><ul>
<li>Previous: <a href="gradio_app.html" title="previous chapter">gradio_app module</a></li>
<li>Previous: <a href="autotranscript.app.html" title="previous chapter">autotranscript.app package</a></li>
<li>Next: <a href="test_autotranscript.html" title="next chapter">test_autotranscript module</a></li>
</ul></li>
</ul></li>
docs/_build/html/test_autotranscript.html
Vendored
-1
View File
@@ -60,7 +60,6 @@
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">autotranscript</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="app.html">app module</a></li>
<li class="toctree-l2"><a class="reference internal" href="autotranscript.html">autotranscript package</a></li>
<li class="toctree-l2"><a class="reference internal" href="gradio_app.html">gradio_app module</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">test_autotranscript module</a></li>
<li class="toctree-l2"><a class="reference internal" href="transcribe.html">transcribe module</a></li>
docs/_build/html/transcribe.html
Vendored
-1
View File
@@ -59,7 +59,6 @@
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">autotranscript</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="app.html">app module</a></li>
<li class="toctree-l2"><a class="reference internal" href="autotranscript.html">autotranscript package</a></li>
<li class="toctree-l2"><a class="reference internal" href="gradio_app.html">gradio_app module</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
<li class="toctree-l2"><a class="reference internal" href="test_autotranscript.html">test_autotranscript module</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">transcribe module</a></li>