update doc [skip doc, skip tests]

moskomule · Dec 20, 2021 · bce62b4 · bce62b4
1 parent 721b03a
commit bce62b4
Show file tree

Hide file tree

Showing 30 changed files with 394 additions and 327 deletions.
diff --git a/docs/build/html/_modules/homura/liblog.html b/docs/build/html/_modules/homura/liblog.html
@@ -74,7 +74,7 @@ <h1>Source code for homura.liblog</h1><div class="highlight"><pre>
 <span class="kn">import</span> <span class="nn">sys</span>
 <span class="kn">import</span> <span class="nn">threading</span>
 <span class="kn">import</span> <span class="nn">warnings</span>
-<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">TextIO</span>
+<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TextIO</span>
 
 <span class="kn">import</span> <span class="nn">tqdm</span> <span class="k">as</span> <span class="nn">_tqdm</span>
 <span class="kn">from</span> <span class="nn">tqdm.contrib</span> <span class="kn">import</span> <span class="n">DummyTqdmFile</span>
@@ -186,7 +186,7 @@ <h1>Source code for homura.liblog</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="set_file_handler"><a class="viewcode-back" href="../../homura.html#homura.liblog.set_file_handler">[docs]</a><span class="k">def</span> <span class="nf">set_file_handler</span><span class="p">(</span><span class="n">log_file</span><span class="p">:</span> <span class="nb">str</span> <span class="ow">or</span> <span class="n">TextIO</span><span class="p">,</span> <span class="n">level</span><span class="p">:</span> <span class="nb">str</span> <span class="ow">or</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span>
- <span class="n">formatter</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">formatter</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
  <span class="n">_configure_root_logger</span><span class="p">()</span>
  <span class="n">fh</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">FileHandler</span><span class="p">(</span><span class="n">log_file</span><span class="p">)</span>
  <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">level</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
@@ -200,7 +200,7 @@ <h1>Source code for homura.liblog</h1><div class="highlight"><pre>
 
 <span class="c1"># internal APIs</span>
 <div class="viewcode-block" id="set_tqdm_handler"><a class="viewcode-back" href="../../homura.html#homura.liblog.set_tqdm_handler">[docs]</a><span class="k">def</span> <span class="nf">set_tqdm_handler</span><span class="p">(</span><span class="n">level</span><span class="p">:</span> <span class="nb">str</span> <span class="ow">or</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">,</span>
- <span class="n">formatter</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">formatter</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
  <span class="sd">&quot;&quot;&quot; An alternative handler to avoid disturbing tqdm</span>
 <span class="sd"> &quot;&quot;&quot;</span>
 
@@ -258,7 +258,7 @@ <h1>Source code for homura.liblog</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="log_once"><a class="viewcode-back" href="../../homura.html#homura.liblog.log_once">[docs]</a><span class="k">def</span> <span class="nf">log_once</span><span class="p">(</span><span class="n">logger</span><span class="p">,</span>
  <span class="n">message</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
- <span class="n">key</span><span class="o">=</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">key</span><span class="o">=</span><span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
  <span class="sd">&quot;&quot;&quot; Log message only once.</span>
 
 <span class="sd"> :param logger: e.g., `print`, `logger.info`</span>
@@ -276,7 +276,7 @@ <h1>Source code for homura.liblog</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="print_once"><a class="viewcode-back" href="../../homura.html#homura.liblog.print_once">[docs]</a><span class="k">def</span> <span class="nf">print_once</span><span class="p">(</span><span class="n">message</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
- <span class="n">key</span><span class="o">=</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="n">key</span><span class="o">=</span><span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
  <span class="sd">&quot;&quot;&quot; `print` version of `log_once`</span>
 <span class="sd"> &quot;&quot;&quot;</span>
 

diff --git a/docs/build/html/_modules/homura/lr_scheduler.html b/docs/build/html/_modules/homura/lr_scheduler.html
@@ -67,11 +67,10 @@
  <div itemprop="articleBody">
 
  <h1>Source code for homura.lr_scheduler</h1><div class="highlight"><pre>
-<span></span><span class="kn">import</span> <span class="nn">math</span>
+<span></span><span class="kn">import</span> <span class="nn">bisect</span>
+<span class="kn">import</span> <span class="nn">math</span>
 <span class="kn">import</span> <span class="nn">warnings</span>
-<span class="kn">import</span> <span class="nn">bisect</span>
 <span class="kn">from</span> <span class="nn">functools</span> <span class="kn">import</span> <span class="n">partial</span>
-<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span>
 
 <span class="kn">from</span> <span class="nn">torch.optim</span> <span class="kn">import</span> <span class="n">lr_scheduler</span> <span class="k">as</span> <span class="n">_lr_scheduler</span>
 
@@ -89,7 +88,7 @@ <h1>Source code for homura.lr_scheduler</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="MultiStepWithWarmup"><a class="viewcode-back" href="../../homura.html#homura.lr_scheduler.MultiStepWithWarmup">[docs]</a><span class="k">def</span> <span class="nf">MultiStepWithWarmup</span><span class="p">(</span><span class="n">warmup</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
- <span class="n">milestones</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">int</span><span class="p">],</span>
+ <span class="n">milestones</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">int</span><span class="p">],</span>
  <span class="n">gamma</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.1</span><span class="p">,</span>
  <span class="n">last_epoch</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span><span class="p">):</span>
  <span class="k">return</span> <span class="n">partial</span><span class="p">(</span><span class="n">_lr_scheduler</span><span class="o">.</span><span class="n">LambdaLR</span><span class="p">,</span>
@@ -120,6 +119,17 @@ <h1>Source code for homura.lr_scheduler</h1><div class="highlight"><pre>
  <span class="k">return</span> <span class="n">partial</span><span class="p">(</span><span class="n">_lr_scheduler</span><span class="o">.</span><span class="n">ReduceLROnPlateau</span><span class="p">,</span> <span class="o">**</span><span class="nb">locals</span><span class="p">())</span></div>
 
 
+<div class="viewcode-block" id="InverseSquareRootWithWarmup"><a class="viewcode-back" href="../../homura.html#homura.lr_scheduler.InverseSquareRootWithWarmup">[docs]</a><span class="k">def</span> <span class="nf">InverseSquareRootWithWarmup</span><span class="p">(</span><span class="n">warmup_epochs</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
+ <span class="n">last_epoch</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span><span class="p">):</span>
+ <span class="sd">&quot;&quot;&quot; inverse square root with warmup: $\\sqrt{w} \\min(1/\\sqrt{e}, e/\\sqrt{e}^3)$, where $w$ is `warmup_epochs` and</span>
+<span class="sd"> `e` is the current epoch</span>
+
+<span class="sd"> &quot;&quot;&quot;</span>
+ <span class="k">return</span> <span class="n">partial</span><span class="p">(</span><span class="n">_lr_scheduler</span><span class="o">.</span><span class="n">LambdaLR</span><span class="p">,</span>
+ <span class="n">lr_lambda</span><span class="o">=</span><span class="n">inverse_square_root_with_warmup</span><span class="p">(</span><span class="n">warmup_epochs</span><span class="p">),</span>
+ <span class="n">last_epoch</span><span class="o">=</span><span class="n">last_epoch</span><span class="p">)</span></div>
+
+
 <div class="viewcode-block" id="CosineAnnealingWithWarmup"><a class="viewcode-back" href="../../homura.html#homura.lr_scheduler.CosineAnnealingWithWarmup">[docs]</a><span class="k">def</span> <span class="nf">CosineAnnealingWithWarmup</span><span class="p">(</span><span class="n">total_epochs</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
  <span class="n">warmup_epochs</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
  <span class="n">min_lr</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
@@ -161,7 +171,7 @@ <h1>Source code for homura.lr_scheduler</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="multistep_with_warmup"><a class="viewcode-back" href="../../homura.html#homura.lr_scheduler.multistep_with_warmup">[docs]</a><span class="k">def</span> <span class="nf">multistep_with_warmup</span><span class="p">(</span><span class="n">warmup_epochs</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
- <span class="n">milestones</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">int</span><span class="p">],</span>
+ <span class="n">milestones</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">int</span><span class="p">],</span>
  <span class="n">gamma</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.1</span><span class="p">,</span>
  <span class="p">):</span>
  <span class="k">def</span> <span class="nf">f</span><span class="p">(</span><span class="n">epoch</span><span class="p">):</span>
@@ -170,6 +180,16 @@ <h1>Source code for homura.lr_scheduler</h1><div class="highlight"><pre>
  <span class="k">return</span> <span class="n">gamma</span> <span class="o">**</span> <span class="n">bisect</span><span class="o">.</span><span class="n">bisect_right</span><span class="p">(</span><span class="n">milestones</span><span class="p">,</span> <span class="n">epoch</span><span class="p">)</span>
 
  <span class="k">return</span> <span class="n">f</span></div>
+
+
+<div class="viewcode-block" id="inverse_square_root_with_warmup"><a class="viewcode-back" href="../../homura.html#homura.lr_scheduler.inverse_square_root_with_warmup">[docs]</a><span class="k">def</span> <span class="nf">inverse_square_root_with_warmup</span><span class="p">(</span><span class="n">warmup_epochs</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
+ <span class="p">):</span>
+ <span class="k">def</span> <span class="nf">f</span><span class="p">(</span><span class="n">epoch</span><span class="p">):</span>
+ <span class="n">epoch</span> <span class="o">+=</span> <span class="mi">1</span>
+ <span class="n">factor</span> <span class="o">=</span> <span class="n">warmup_epochs</span> <span class="o">**</span> <span class="mf">0.5</span>
+ <span class="k">return</span> <span class="n">factor</span> <span class="o">*</span> <span class="nb">min</span><span class="p">(</span><span class="n">epoch</span> <span class="o">**</span> <span class="o">-</span><span class="mf">0.5</span><span class="p">,</span> <span class="n">epoch</span> <span class="o">*</span> <span class="n">warmup_epochs</span> <span class="o">**</span> <span class="o">-</span><span class="mf">1.5</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">f</span></div>
 </pre></div>
 
  </div>

diff --git a/docs/build/html/_modules/homura/metrics/commons.html b/docs/build/html/_modules/homura/metrics/commons.html
@@ -67,7 +67,7 @@
  <div itemprop="articleBody">
 
  <h1>Source code for homura.metrics.commons</h1><div class="highlight"><pre>
-<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span>
+<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">import</span> <span class="nn">torch</span>
 <span class="kn">from</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="n">Tensor</span>
@@ -83,7 +83,7 @@ <h1>Source code for homura.metrics.commons</h1><div class="highlight"><pre>
 
 <span class="k">def</span> <span class="nf">_base</span><span class="p">(</span><span class="nb">input</span><span class="p">:</span> <span class="n">Tensor</span><span class="p">,</span>
  <span class="n">target</span><span class="p">:</span> <span class="n">Tensor</span>
- <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">Tensor</span><span class="p">,</span> <span class="n">Tensor</span><span class="p">]:</span>
+ <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">Tensor</span><span class="p">,</span> <span class="n">Tensor</span><span class="p">]:</span>
  <span class="n">classes</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="nb">input</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="n">device</span><span class="o">=</span><span class="nb">input</span><span class="o">.</span><span class="n">device</span><span class="p">)</span>
  <span class="n">pred</span> <span class="o">=</span> <span class="nb">input</span><span class="o">.</span><span class="n">argmax</span><span class="p">(</span><span class="n">dim</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">view</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
  <span class="n">target</span> <span class="o">=</span> <span class="n">target</span><span class="o">.</span><span class="n">view</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>

diff --git a/docs/build/html/_modules/homura/modules/attention.html b/docs/build/html/_modules/homura/modules/attention.html
@@ -67,7 +67,7 @@
  <div itemprop="articleBody">
 
  <h1>Source code for homura.modules.attention</h1><div class="highlight"><pre>
-<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Tuple</span>
+<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">import</span> <span class="nn">torch</span>
 <span class="kn">from</span> <span class="nn">torch</span> <span class="kn">import</span> <span class="n">nn</span>
@@ -94,9 +94,9 @@ <h1>Source code for homura.modules.attention</h1><div class="highlight"><pre>
  <span class="n">query</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span>
  <span class="n">key</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span>
  <span class="n">value</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span>
- <span class="n">mask</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
- <span class="n">additive_mask</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
- <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">]:</span>
+ <span class="n">mask</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+ <span class="n">additive_mask</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+ <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">]:</span>
  <span class="sd">&quot;&quot;&quot; See `functional.attention.kv_attention` for details</span>
 
 <span class="sd"> :param query:</span>