Skip to content

Commit

Permalink
Update Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sooftware committed Mar 4, 2020
1 parent 0cd7b3e commit 3621e29
Show file tree
Hide file tree
Showing 69 changed files with 4,392 additions and 221 deletions.
Binary file added docs/build/doctrees/Distance.doctree
Binary file not shown.
Binary file added docs/build/doctrees/Evaluator.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/Feature.doctree
Binary file not shown.
Binary file added docs/build/doctrees/Label.doctree
Binary file not shown.
Binary file added docs/build/doctrees/Load.doctree
Binary file not shown.
Binary file added docs/build/doctrees/Loader.doctree
Binary file not shown.
Binary file added docs/build/doctrees/Lr.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/Models.doctree
Binary file not shown.
Binary file added docs/build/doctrees/Trainer.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/notes/intro.doctree
Binary file not shown.
24 changes: 17 additions & 7 deletions docs/build/html/Dataset.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Loss" href="Loss.html" />
<link rel="prev" title="Feature" href="Feature.html" />
<link rel="next" title="Distance" href="Distance.html" />
<link rel="prev" title="Trainer" href="Trainer.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -93,12 +93,22 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="Models.html">Models</a></li>
</ul>
<p class="caption"><span class="caption-text">Package Reference</span></p>
<p class="caption"><span class="caption-text">train</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Evaluator.html">Evaluator</a></li>
<li class="toctree-l1"><a class="reference internal" href="Loss.html">Loss</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lr.html">Lr</a></li>
<li class="toctree-l1"><a class="reference internal" href="Trainer.html">Trainer</a></li>
</ul>
<p class="caption"><span class="caption-text">Utils</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Feature.html">Feature</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Dataset</a></li>
<li class="toctree-l1"><a class="reference internal" href="Loss.html">Loss</a></li>
<li class="toctree-l1"><a class="reference internal" href="Distance.html">Distance</a></li>
<li class="toctree-l1"><a class="reference internal" href="Feature.html">Feature</a></li>
<li class="toctree-l1"><a class="reference internal" href="Hparams.html">Hparams</a></li>
<li class="toctree-l1"><a class="reference internal" href="Label.html">Label</a></li>
<li class="toctree-l1"><a class="reference internal" href="Load.html">Load</a></li>
<li class="toctree-l1"><a class="reference internal" href="Loader.html">Loader</a></li>
</ul>


Expand Down Expand Up @@ -262,10 +272,10 @@

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="Loss.html" class="btn btn-neutral float-right" title="Loss" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="Distance.html" class="btn btn-neutral float-right" title="Distance" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="Feature.html" class="btn btn-neutral float-left" title="Feature" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="Trainer.html" class="btn btn-neutral float-left" title="Trainer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>

Expand Down
241 changes: 241 additions & 0 deletions docs/build/html/Distance.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,241 @@


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Distance &mdash; Korean Speech Recognition 1.0 documentation</title>








<script type="text/javascript" src="_static/js/modernizr.min.js"></script>


<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>

<script type="text/javascript" src="_static/js/theme.js"></script>




<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Feature" href="Feature.html" />
<link rel="prev" title="Dataset" href="Dataset.html" />
</head>

<body class="wy-body-for-nav">


<div class="wy-grid-for-nav">

<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="index.html" class="icon icon-home"> Korean Speech Recognition



</a>




<div class="version">
1.0
</div>




<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>


</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">






<p class="caption"><span class="caption-text">Notes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/Preparation.html">Preparation before Training</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/More-details.html">More Details</a></li>
</ul>
<p class="caption"><span class="caption-text">Architecture</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Models.html">Models</a></li>
</ul>
<p class="caption"><span class="caption-text">train</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Evaluator.html">Evaluator</a></li>
<li class="toctree-l1"><a class="reference internal" href="Loss.html">Loss</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lr.html">Lr</a></li>
<li class="toctree-l1"><a class="reference internal" href="Trainer.html">Trainer</a></li>
</ul>
<p class="caption"><span class="caption-text">Utils</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Dataset.html">Dataset</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Distance</a></li>
<li class="toctree-l1"><a class="reference internal" href="Feature.html">Feature</a></li>
<li class="toctree-l1"><a class="reference internal" href="Hparams.html">Hparams</a></li>
<li class="toctree-l1"><a class="reference internal" href="Label.html">Label</a></li>
<li class="toctree-l1"><a class="reference internal" href="Load.html">Load</a></li>
<li class="toctree-l1"><a class="reference internal" href="Loader.html">Loader</a></li>
</ul>



</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" aria-label="top navigation">

<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Korean Speech Recognition</a>

</nav>


<div class="wy-nav-content">

<div class="rst-content">

















<div role="navigation" aria-label="breadcrumbs navigation">

<ul class="wy-breadcrumbs">

<li><a href="index.html">Docs</a> &raquo;</li>

<li>Distance</li>


<li class="wy-breadcrumbs-aside">


<a href="_sources/Distance.rst.txt" rel="nofollow"> View page source</a>


</li>

</ul>


<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<div class="section" id="module-utils.distance">
<span id="distance"></span><h1>Distance<a class="headerlink" href="#module-utils.distance" title="Permalink to this headline"></a></h1>
<dl class="function">
<dt id="utils.distance.char_distance">
<code class="descclassname">utils.distance.</code><code class="descname">char_distance</code><span class="sig-paren">(</span><em>target</em>, <em>y_hat</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/utils/distance.html#char_distance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#utils.distance.char_distance" title="Permalink to this definition"></a></dt>
<dd><p>get Levenshtein distance</p>
</dd></dl>

<dl class="function">
<dt id="utils.distance.get_distance">
<code class="descclassname">utils.distance.</code><code class="descname">get_distance</code><span class="sig-paren">(</span><em>targets</em>, <em>y_hats</em>, <em>id2char</em>, <em>eos_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/utils/distance.html#get_distance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#utils.distance.get_distance" title="Permalink to this definition"></a></dt>
<dd><p>get character distance</p>
</dd></dl>

</div>


</div>

</div>
<footer>

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="Feature.html" class="btn btn-neutral float-right" title="Feature" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="Dataset.html" class="btn btn-neutral float-left" title="Dataset" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>


<hr/>

<div role="contentinfo">
<p>
&copy; Copyright 2020, SooHwan Kim

</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

</div>
</div>

</section>

</div>



<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>






</body>
</html>
Loading

0 comments on commit 3621e29

Please sign in to comment.