docu updated

docs/_build/html/autotranscript.app.html

@@ -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>