Skip to content

Commit

Permalink
update doc [skip doc, skip tests]
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 24, 2021
1 parent 9aab975 commit 24b83ae
Show file tree
Hide file tree
Showing 14 changed files with 260 additions and 170 deletions.
2 changes: 2 additions & 0 deletions docs/build/html/_modules/homura/metrics/commons.html
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,8 @@ <h1>Source code for homura.metrics.commons</h1><div class="highlight"><pre>
<span class="n">target</span><span class="p">:</span> <span class="n">Tensor</span><span class="p">,</span>
<span class="n">top_k</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tensor</span><span class="p">:</span>
<span class="k">if</span> <span class="n">target</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">2</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">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="n">pred_idx</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="n">keepdim</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="k">if</span> <span class="n">top_k</span> <span class="o">==</span> <span class="mi">1</span> <span class="k">else</span> <span class="nb">input</span><span class="o">.</span><span class="n">topk</span><span class="p">(</span><span class="n">k</span><span class="o">=</span><span class="n">top_k</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">indices</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><span class="o">.</span><span class="n">expand_as</span><span class="p">(</span><span class="n">pred_idx</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="n">pred_idx</span> <span class="o">==</span> <span class="n">target</span><span class="p">)</span><span class="o">.</span><span class="n">float</span><span class="p">()</span><span class="o">.</span><span class="n">sum</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">mean</span><span class="p">()</span></div>
Expand Down
73 changes: 43 additions & 30 deletions docs/build/html/_modules/homura/trainers.html

Large diffs are not rendered by default.

43 changes: 35 additions & 8 deletions docs/build/html/_modules/homura/vision/data/visionset.html

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion docs/build/html/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -731,8 +731,9 @@ dl.glossary dt {

.classifier:before {
font-style: normal;
margin: 0.5em;
margin: 0 0.5em;
content: ":";
display: inline-block;
}

abbr, acronym {
Expand Down
5 changes: 3 additions & 2 deletions docs/build/html/_static/searchtools.js
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,9 @@ var Search = {
var results = [];

for (var prefix in objects) {
for (var name in objects[prefix]) {
for (var iMatch = 0; iMatch != objects[prefix].length; ++iMatch) {
var match = objects[prefix][iMatch];
var name = match[4];
var fullname = (prefix ? prefix + '.' : '') + name;
var fullnameLower = fullname.toLowerCase()
if (fullnameLower.indexOf(object) > -1) {
Expand All @@ -342,7 +344,6 @@ var Search = {
} else if (parts[parts.length - 1].indexOf(object) > -1) {
score += Scorer.objPartialMatch;
}
var match = objects[prefix][name];
var objname = objnames[match[1]][2];
var title = titles[match[0]];
// If more than one term searched for, we require other words to be
Expand Down
14 changes: 12 additions & 2 deletions docs/build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -803,6 +803,8 @@ <h2 id="I">I</h2>
<li><a href="homura.vision.data.html#homura.vision.data.classification.ImageNet">ImageNet (class in homura.vision.data.classification)</a>
</li>
<li><a href="homura.html#homura.register.Registry.import_modules">import_modules() (homura.register.Registry static method)</a>
</li>
<li><a href="homura.html#homura.trainers.TrainerBase.infer_batch_size">infer_batch_size() (homura.trainers.TrainerBase method)</a>
</li>
<li><a href="homura.utils.html#homura.utils.distributed.init_distributed">init_distributed() (in module homura.utils.distributed)</a>
</li>
Expand Down Expand Up @@ -1212,8 +1214,12 @@ <h2 id="T">T</h2>
<li><a href="homura.utils.html#homura.utils.containers.TensorTuple">TensorTuple (class in homura.utils.containers)</a>
</li>
<li><a href="homura.html#homura.trainers.TrainerBase.test">test() (homura.trainers.TrainerBase method)</a>
</li>
<li><a href="homura.vision.data.html#homura.vision.data.visionset.VisionSet.test_collate_fn">test_collate_fn (homura.vision.data.visionset.VisionSet attribute)</a>
</li>
<li><a href="homura.vision.data.html#homura.vision.data.visionset.VisionSet.test_loader">test_loader (homura.vision.data.visionset.VisionSet property)</a>
</li>
<li><a href="homura.vision.data.html#homura.vision.data.visionset.VisionSet.test_set">test_set (homura.vision.data.visionset.VisionSet property)</a>
</li>
<li><a href="homura.utils.html#homura.utils.benchmarks.timeit">timeit() (in module homura.utils.benchmarks)</a>
</li>
Expand All @@ -1238,6 +1244,8 @@ <h2 id="T">T</h2>
<li><a href="homura.html#homura.trainers.TrainerBase.train">train() (homura.trainers.TrainerBase method)</a>
</li>
<li><a href="homura.vision.data.html#homura.vision.data.visionset.VisionSet.train_loader">train_loader (homura.vision.data.visionset.VisionSet property)</a>
</li>
<li><a href="homura.vision.data.html#homura.vision.data.visionset.VisionSet.train_set">train_set (homura.vision.data.visionset.VisionSet property)</a>
</li>
<li><a href="homura.html#homura.trainers.TrainerBase">TrainerBase (class in homura.trainers)</a>
</li>
Expand Down Expand Up @@ -1305,12 +1313,14 @@ <h2 id="V">V</h2>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="homura.vision.data.html#homura.vision.data.visionset.VisionSet.val_loader">val_loader (homura.vision.data.visionset.VisionSet property)</a>
</li>
<li><a href="homura.html#homura.trainers.TrainerBase.verbose">verbose (homura.trainers.TrainerBase property)</a>
<li><a href="homura.vision.data.html#homura.vision.data.visionset.VisionSet.val_set">val_set (homura.vision.data.visionset.VisionSet property)</a>
</li>
<li><a href="homura.vision.data.html#homura.vision.data.visionset.VisionSet">VisionSet (class in homura.vision.data.visionset)</a>
<li><a href="homura.html#homura.trainers.TrainerBase.verbose">verbose (homura.trainers.TrainerBase property)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="homura.vision.data.html#homura.vision.data.visionset.VisionSet">VisionSet (class in homura.vision.data.visionset)</a>
</li>
<li><a href="homura.vision.data.html#homura.vision.data.visionset.VisionSetProtocol">VisionSetProtocol (class in homura.vision.data.visionset)</a>
</li>
<li><a href="homura.utils.html#homura.utils.grad_tools.vjp">vjp() (in module homura.utils.grad_tools)</a>
Expand Down
Loading

0 comments on commit 24b83ae

Please sign in to comment.