Skip to content

Commit

Permalink
Update Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sooftware committed Mar 21, 2020
1 parent 5a7cee2 commit b70409c
Show file tree
Hide file tree
Showing 148 changed files with 2,976 additions and 678 deletions.
249 changes: 249 additions & 0 deletions docs/Checkpoint.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,249 @@


<!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>Checkpoint &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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></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="Dataset" href="Dataset.html" />
<link rel="prev" title="Models" href="Models.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">Intro</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">Package Reference</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Checkpoint</a></li>
<li class="toctree-l1"><a class="reference internal" href="Dataset.html">Dataset</a></li>
<li class="toctree-l1"><a class="reference internal" href="Evaluator.html">Evaluator</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="Loader.html">Loader</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="Trainer.html">Trainer</a></li>
<li class="toctree-l1"><a class="reference internal" href="Utils.html">Utils</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>Checkpoint</li>


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


<a href="_sources/Checkpoint.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-package.checkpoint">
<span id="checkpoint"></span><h1>Checkpoint<a class="headerlink" href="#module-package.checkpoint" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="package.checkpoint.CheckPoint">
<em class="property">class </em><code class="descclassname">package.checkpoint.</code><code class="descname">CheckPoint</code><span class="sig-paren">(</span><em>model=None</em>, <em>epoch=None</em>, <em>train_dataset_list=None</em>, <em>valid_dataset=None</em>, <em>time_step=None</em>, <em>total_time_step=None</em>, <em>hparams=None</em>, <em>queue=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/package/checkpoint.html#CheckPoint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#package.checkpoint.CheckPoint" title="Permalink to this definition"></a></dt>
<dd><p>The Checkpoint class manages the saving and loading of a model during training. It allows training to be suspended
and resumed at a later time (e.g. when running on a cluster using sequential jobs).</p>
<p>To make a checkpoint, initialize a Checkpoint object with the following args; then call that object’s save() method
to write parameters to disk.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>model</strong> (<a class="reference external" href="https://pytorch.org/docs/master/nn.html#torch.nn.Module" title="(in PyTorch vmaster (1.5.0a0+f515d87 ))"><em>torch.nn.Module</em></a>) – seq2seq model being trained</li>
<li><strong>optimizer</strong> (<em>torch.nn</em>) – stores the state of the optimizer</li>
<li><strong>epoch</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)"><em>int</em></a>) – current epoch (an epoch is a loop through the full training data)</li>
<li><strong>time_step</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)"><em>int</em></a>) – number of examples seen within the current epoch</li>
<li><strong>batch_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)"><em>int</em></a>) – mini batch size</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>


</div>

</div>
<footer>

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

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


<a href="Models.html" class="btn btn-neutral float-left" title="Models" 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>
8 changes: 4 additions & 4 deletions docs/Dataset.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Evaluator" href="Evaluator.html" />
<link rel="prev" title="Models" href="Models.html" />
<link rel="prev" title="Checkpoint" href="Checkpoint.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -86,8 +86,7 @@

<p class="caption"><span class="caption-text">Notes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html">Korean-Speech-Recognition</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html#intro">Intro</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html">Intro</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>
Expand All @@ -97,6 +96,7 @@
</ul>
<p class="caption"><span class="caption-text">Package Reference</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Checkpoint.html">Checkpoint</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="Evaluator.html">Evaluator</a></li>
<li class="toctree-l1"><a class="reference internal" href="Feature.html">Feature</a></li>
Expand Down Expand Up @@ -263,7 +263,7 @@
<a href="Evaluator.html" class="btn btn-neutral float-right" title="Evaluator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


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

</div>

Expand Down
6 changes: 3 additions & 3 deletions docs/Evaluator.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,7 @@

<p class="caption"><span class="caption-text">Notes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html">Korean-Speech-Recognition</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html#intro">Intro</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html">Intro</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>
Expand All @@ -97,6 +96,7 @@
</ul>
<p class="caption"><span class="caption-text">Package Reference</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Checkpoint.html">Checkpoint</a></li>
<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="#">Evaluator</a></li>
<li class="toctree-l1"><a class="reference internal" href="Feature.html">Feature</a></li>
Expand Down Expand Up @@ -179,7 +179,7 @@
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>model</strong> (<a class="reference external" href="https://pytorch.org/docs/master/nn.html#torch.nn.Module" title="(in PyTorch vmaster (1.5.0a0+2b79bab ))"><em>torch.nn.Module</em></a>) – Model to be evaluated</li>
<li><strong>model</strong> (<a class="reference external" href="https://pytorch.org/docs/master/nn.html#torch.nn.Module" title="(in PyTorch vmaster (1.5.0a0+f515d87 ))"><em>torch.nn.Module</em></a>) – Model to be evaluated</li>
<li><strong>queue</strong> (<em>queue</em>) – queue for threading</li>
<li><strong>criterion</strong> (<em>torch.nn</em>) – one of PyTorch’s loss function. Refer to <a class="reference external" href="http://pytorch.org/docs/master/nn.html#loss-functions">http://pytorch.org/docs/master/nn.html#loss-functions</a> for a list of them.</li>
<li><strong>device</strong> (<em>torch.cuda</em>) – device used (‘cuda’ or ‘cpu’)</li>
Expand Down
6 changes: 3 additions & 3 deletions docs/Feature.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,7 @@

<p class="caption"><span class="caption-text">Notes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html">Korean-Speech-Recognition</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html#intro">Intro</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html">Intro</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>
Expand All @@ -97,6 +96,7 @@
</ul>
<p class="caption"><span class="caption-text">Package Reference</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Checkpoint.html">Checkpoint</a></li>
<li class="toctree-l1"><a class="reference internal" href="Dataset.html">Dataset</a></li>
<li class="toctree-l1"><a class="reference internal" href="Evaluator.html">Evaluator</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Feature</a></li>
Expand Down Expand Up @@ -289,7 +289,7 @@
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>feat</strong> (<a class="reference external" href="https://pytorch.org/docs/master/tensors.html#torch.Tensor" title="(in PyTorch vmaster (1.5.0a0+2b79bab ))"><em>torch.Tensor</em></a>) – input data feature</li>
<li><strong>feat</strong> (<a class="reference external" href="https://pytorch.org/docs/master/tensors.html#torch.Tensor" title="(in PyTorch vmaster (1.5.0a0+f515d87 ))"><em>torch.Tensor</em></a>) – input data feature</li>
<li><strong>T</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)"><em>int</em></a>) – Hyper Parameter for Time Masking to limit time masking length</li>
<li><strong>F</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)"><em>int</em></a>) – Hyper Parameter for Freq Masking to limit freq masking length</li>
<li><strong>time_mask_num</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)"><em>int</em></a>) – how many time-masked area to make</li>
Expand Down
6 changes: 3 additions & 3 deletions docs/Hparams.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,7 @@

<p class="caption"><span class="caption-text">Notes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html">Korean-Speech-Recognition</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html#intro">Intro</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes/intro.html">Intro</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>
Expand All @@ -97,6 +96,7 @@
</ul>
<p class="caption"><span class="caption-text">Package Reference</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Checkpoint.html">Checkpoint</a></li>
<li class="toctree-l1"><a class="reference internal" href="Dataset.html">Dataset</a></li>
<li class="toctree-l1"><a class="reference internal" href="Evaluator.html">Evaluator</a></li>
<li class="toctree-l1"><a class="reference internal" href="Feature.html">Feature</a></li>
Expand Down Expand Up @@ -173,7 +173,7 @@
<span id="hparams"></span><h1>Hparams<a class="headerlink" href="#module-package.hparams" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="package.hparams.HyperParams">
<em class="property">class </em><code class="descclassname">package.hparams.</code><code class="descname">HyperParams</code><span class="sig-paren">(</span><em>use_bidirectional=True</em>, <em>use_attention=True</em>, <em>use_label_smooth=True</em>, <em>input_reverse=True</em>, <em>use_augment=True</em>, <em>use_pickle=False</em>, <em>use_pyramidal=True</em>, <em>use_cuda=True</em>, <em>pack_by_length=True</em>, <em>augment_ratio=1.0</em>, <em>hidden_size=256</em>, <em>dropout=0.5</em>, <em>listener_layer_size=5</em>, <em>speller_layer_size=3</em>, <em>batch_size=12</em>, <em>worker_num=1</em>, <em>max_epochs=40</em>, <em>use_multistep_lr=False</em>, <em>init_lr=0.0001</em>, <em>high_plateau_lr=0.001</em>, <em>low_plateau_lr=3e-05</em>, <em>teacher_forcing=0.9</em>, <em>seed=1</em>, <em>max_len=328</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/package/hparams.html#HyperParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#package.hparams.HyperParams" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">package.hparams.</code><code class="descname">HyperParams</code><span class="sig-paren">(</span><em>use_bidirectional=True</em>, <em>use_attention=True</em>, <em>use_label_smooth=True</em>, <em>input_reverse=True</em>, <em>use_augment=True</em>, <em>use_pickle=False</em>, <em>use_pyramidal=False</em>, <em>use_cuda=True</em>, <em>pack_by_length=True</em>, <em>augment_ratio=1.0</em>, <em>hidden_size=256</em>, <em>dropout=0.5</em>, <em>listener_layer_size=5</em>, <em>speller_layer_size=3</em>, <em>batch_size=8</em>, <em>worker_num=1</em>, <em>max_epochs=40</em>, <em>use_multistep_lr=False</em>, <em>init_lr=0.0001</em>, <em>high_plateau_lr=0.0003</em>, <em>low_plateau_lr=1e-05</em>, <em>teacher_forcing=0.9</em>, <em>seed=1</em>, <em>max_len=151</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/package/hparams.html#HyperParams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#package.hparams.HyperParams" title="Permalink to this definition"></a></dt>
<dd><p>Hyperparameters</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
Expand Down
Loading

0 comments on commit b70409c

Please sign in to comment.