Skip to content

Commit b85ba70

Browse files
committed
auto-generating sphinx docs
1 parent 51490a7 commit b85ba70

File tree

773 files changed

+12666
-49065
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

773 files changed

+12666
-49065
lines changed

docs/master/__config__.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<link rel="stylesheet" href="_static/katex-math.css" type="text/css" />
3636
<link rel="index" title="Index" href="genindex.html" />
3737
<link rel="search" title="Search" href="search.html" />
38-
<link rel="next" title="torchvision" href="torchvision/index.html" />
38+
<link rel="next" title="PyTorch Contribution Guide" href="community/contribution_guide.html" />
3939
<link rel="prev" title="Named Tensors operator coverage" href="name_inference.html" />
4040

4141

@@ -159,7 +159,7 @@
159159

160160

161161
<div class="version">
162-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+b87f0e5 &#x25BC</a>
162+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+fa9ae67 &#x25BC</a>
163163
</div>
164164

165165

@@ -257,7 +257,7 @@
257257
<ul>
258258
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/audio">torchaudio</a></li>
259259
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/text">torchtext</a></li>
260-
<li class="toctree-l1"><a class="reference internal" href="torchvision/index.html">torchvision</a></li>
260+
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/vision">torchvision</a></li>
261261
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/elastic/">TorchElastic</a></li>
262262
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/serve">TorchServe</a></li>
263263
<li class="toctree-l1"><a class="reference external" href="http://pytorch.org/xla/">PyTorch on XLA Devices</a></li>
@@ -365,7 +365,7 @@
365365

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

368-
<a href="torchvision/index.html" class="btn btn-neutral float-right" title="torchvision" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
368+
<a href="community/contribution_guide.html" class="btn btn-neutral float-right" title="PyTorch Contribution Guide" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
369369

370370

371371
<a href="name_inference.html" class="btn btn-neutral" title="Named Tensors operator coverage" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
47 KB
Loading

docs/master/_images/add_hparam.png

62.6 KB
Loading

docs/master/_images/add_image.png

46 KB
Loading

docs/master/_images/add_images.png

74.9 KB
Loading

docs/master/_images/add_scalar.png

44.9 KB
Loading
96.8 KB
Loading

docs/master/_modules/index.html

Lines changed: 3 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+b87f0e5 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+fa9ae67 &#x25BC</a>
162162
</div>
163163

164164

@@ -256,7 +256,7 @@
256256
<ul>
257257
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/audio">torchaudio</a></li>
258258
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/text">torchtext</a></li>
259-
<li class="toctree-l1"><a class="reference internal" href="../torchvision/index.html">torchvision</a></li>
259+
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/vision">torchvision</a></li>
260260
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/elastic/">TorchElastic</a></li>
261261
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/serve">TorchServe</a></li>
262262
<li class="toctree-l1"><a class="reference external" href="http://pytorch.org/xla/">PyTorch on XLA Devices</a></li>
@@ -503,48 +503,7 @@ <h1>All modules for which code is available</h1>
503503
<li><a href="torch/utils/data/distributed.html">torch.utils.data.distributed</a></li>
504504
<li><a href="torch/utils/data/sampler.html">torch.utils.data.sampler</a></li>
505505
<li><a href="torch/utils/mobile_optimizer.html">torch.utils.mobile_optimizer</a></li>
506-
</ul><li><a href="torchvision.html">torchvision</a></li>
507-
<ul><li><a href="torchvision/datasets/celeba.html">torchvision.datasets.celeba</a></li>
508-
<li><a href="torchvision/datasets/cifar.html">torchvision.datasets.cifar</a></li>
509-
<li><a href="torchvision/datasets/cityscapes.html">torchvision.datasets.cityscapes</a></li>
510-
<li><a href="torchvision/datasets/coco.html">torchvision.datasets.coco</a></li>
511-
<li><a href="torchvision/datasets/fakedata.html">torchvision.datasets.fakedata</a></li>
512-
<li><a href="torchvision/datasets/flickr.html">torchvision.datasets.flickr</a></li>
513-
<li><a href="torchvision/datasets/folder.html">torchvision.datasets.folder</a></li>
514-
<li><a href="torchvision/datasets/hmdb51.html">torchvision.datasets.hmdb51</a></li>
515-
<li><a href="torchvision/datasets/imagenet.html">torchvision.datasets.imagenet</a></li>
516-
<li><a href="torchvision/datasets/kinetics.html">torchvision.datasets.kinetics</a></li>
517-
<li><a href="torchvision/datasets/lsun.html">torchvision.datasets.lsun</a></li>
518-
<li><a href="torchvision/datasets/mnist.html">torchvision.datasets.mnist</a></li>
519-
<li><a href="torchvision/datasets/phototour.html">torchvision.datasets.phototour</a></li>
520-
<li><a href="torchvision/datasets/sbd.html">torchvision.datasets.sbd</a></li>
521-
<li><a href="torchvision/datasets/sbu.html">torchvision.datasets.sbu</a></li>
522-
<li><a href="torchvision/datasets/stl10.html">torchvision.datasets.stl10</a></li>
523-
<li><a href="torchvision/datasets/svhn.html">torchvision.datasets.svhn</a></li>
524-
<li><a href="torchvision/datasets/ucf101.html">torchvision.datasets.ucf101</a></li>
525-
<li><a href="torchvision/datasets/usps.html">torchvision.datasets.usps</a></li>
526-
<li><a href="torchvision/datasets/voc.html">torchvision.datasets.voc</a></li>
527-
<li><a href="torchvision/io/video.html">torchvision.io.video</a></li>
528-
<li><a href="torchvision/models/alexnet.html">torchvision.models.alexnet</a></li>
529-
<li><a href="torchvision/models/densenet.html">torchvision.models.densenet</a></li>
530-
<li><a href="torchvision/models/detection/faster_rcnn.html">torchvision.models.detection.faster_rcnn</a></li>
531-
<li><a href="torchvision/models/detection/keypoint_rcnn.html">torchvision.models.detection.keypoint_rcnn</a></li>
532-
<li><a href="torchvision/models/detection/mask_rcnn.html">torchvision.models.detection.mask_rcnn</a></li>
533-
<li><a href="torchvision/models/googlenet.html">torchvision.models.googlenet</a></li>
534-
<li><a href="torchvision/models/inception.html">torchvision.models.inception</a></li>
535-
<li><a href="torchvision/models/mnasnet.html">torchvision.models.mnasnet</a></li>
536-
<li><a href="torchvision/models/mobilenet.html">torchvision.models.mobilenet</a></li>
537-
<li><a href="torchvision/models/resnet.html">torchvision.models.resnet</a></li>
538-
<li><a href="torchvision/models/segmentation/segmentation.html">torchvision.models.segmentation.segmentation</a></li>
539-
<li><a href="torchvision/models/shufflenetv2.html">torchvision.models.shufflenetv2</a></li>
540-
<li><a href="torchvision/models/squeezenet.html">torchvision.models.squeezenet</a></li>
541-
<li><a href="torchvision/models/vgg.html">torchvision.models.vgg</a></li>
542-
<li><a href="torchvision/models/video/resnet.html">torchvision.models.video.resnet</a></li>
543-
<li><a href="torchvision/ops/roi_align.html">torchvision.ops.roi_align</a></li>
544-
<li><a href="torchvision/ops/roi_pool.html">torchvision.ops.roi_pool</a></li>
545-
<li><a href="torchvision/transforms/functional.html">torchvision.transforms.functional</a></li>
546-
<li><a href="torchvision/transforms/transforms.html">torchvision.transforms.transforms</a></li>
547-
<li><a href="torchvision/utils.html">torchvision.utils</a></li>
506+
<li><a href="torch/utils/tensorboard/writer.html">torch.utils.tensorboard.writer</a></li>
548507
</ul></ul>
549508

550509
</article>

docs/master/_modules/torch.html

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+b87f0e5 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+fa9ae67 &#x25BC</a>
162162
</div>
163163

164164

@@ -256,7 +256,7 @@
256256
<ul>
257257
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/audio">torchaudio</a></li>
258258
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/text">torchtext</a></li>
259-
<li class="toctree-l1"><a class="reference internal" href="../torchvision/index.html">torchvision</a></li>
259+
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/vision">torchvision</a></li>
260260
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/elastic/">TorchElastic</a></li>
261261
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/serve">TorchServe</a></li>
262262
<li class="toctree-l1"><a class="reference external" href="http://pytorch.org/xla/">PyTorch on XLA Devices</a></li>
@@ -341,7 +341,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
341341
<span></span>
342342
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
343343
<span class="sd">The torch package contains data structures for multi-dimensional</span>
344-
<span class="sd">tensors. It also defines mathematical operations that can be performed over these tensors.</span>
344+
<span class="sd">tensors and defines mathematical operations over these tensors.</span>
345345
<span class="sd">Additionally, it provides many utilities for efficient serializing of</span>
346346
<span class="sd">Tensors and arbitrary types, and other useful utilities.</span>
347347

@@ -562,7 +562,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
562562
<span class="k">return</span> <span class="n">module</span> <span class="o">+</span> <span class="n">class_name</span>
563563

564564

565-
<span class="k">def</span> <span class="nf">is_tensor</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
565+
<div class="viewcode-block" id="is_tensor"><a class="viewcode-back" href="../generated/torch.is_tensor.html#torch.is_tensor">[docs]</a><span class="k">def</span> <span class="nf">is_tensor</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
566566
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns True if `obj` is a PyTorch tensor.</span>
567567

568568
<span class="sd"> Note that this function is simply doing ``isinstance(obj, Tensor)``.</span>
@@ -573,16 +573,16 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
573573
<span class="sd"> Args:</span>
574574
<span class="sd"> obj (Object): Object to test</span>
575575
<span class="sd"> &quot;&quot;&quot;</span>
576-
<span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">)</span>
576+
<span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">)</span></div>
577577

578578

579-
<span class="k">def</span> <span class="nf">is_storage</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
579+
<div class="viewcode-block" id="is_storage"><a class="viewcode-back" href="../generated/torch.is_storage.html#torch.is_storage">[docs]</a><span class="k">def</span> <span class="nf">is_storage</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
580580
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Returns True if `obj` is a PyTorch storage object.</span>
581581

582582
<span class="sd"> Args:</span>
583583
<span class="sd"> obj (Object): Object to test</span>
584584
<span class="sd"> &quot;&quot;&quot;</span>
585-
<span class="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="ow">in</span> <span class="n">_storage_classes</span>
585+
<span class="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="ow">in</span> <span class="n">_storage_classes</span></div>
586586

587587

588588
<span class="k">def</span> <span class="nf">set_default_tensor_type</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
@@ -612,6 +612,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
612612
<span class="k">def</span> <span class="nf">set_default_dtype</span><span class="p">(</span><span class="n">d</span><span class="p">):</span>
613613
<span class="sa">r</span><span class="sd">&quot;&quot;&quot;Sets the default floating point dtype to :attr:`d`.</span>
614614
<span class="sd"> This dtype is:</span>
615+
615616
<span class="sd"> 1. The inferred dtype for python floats in :func:`torch.tensor`.</span>
616617
<span class="sd"> 2. Used to infer dtype for python complex numbers. The default complex dtype is set to</span>
617618
<span class="sd"> ``torch.complex128`` if default floating point dtype is ``torch.float64``,</span>
@@ -622,7 +623,7 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
622623
<span class="sd"> Args:</span>
623624
<span class="sd"> d (:class:`torch.dtype`): the floating point dtype to make the default</span>
624625

625-
<span class="sd"> Example::</span>
626+
<span class="sd"> Example:</span>
626627
<span class="sd"> &gt;&gt;&gt; # initial default for floating point is torch.float32</span>
627628
<span class="sd"> &gt;&gt;&gt; torch.tensor([1.2, 3]).dtype</span>
628629
<span class="sd"> torch.float32</span>
@@ -671,8 +672,8 @@ <h1>Source code for torch</h1><div class="highlight"><pre>
671672
<span class="k">pass</span>
672673

673674

674-
<div class="viewcode-block" id="FloatStorage"><a class="viewcode-back" href="../storage.html#torch.FloatStorage">[docs]</a><span class="k">class</span> <span class="nc">FloatStorage</span><span class="p">(</span><span class="n">_C</span><span class="o">.</span><span class="n">FloatStorageBase</span><span class="p">,</span> <span class="n">_StorageBase</span><span class="p">):</span>
675-
<span class="k">pass</span></div>
675+
<span class="k">class</span> <span class="nc">FloatStorage</span><span class="p">(</span><span class="n">_C</span><span class="o">.</span><span class="n">FloatStorageBase</span><span class="p">,</span> <span class="n">_StorageBase</span><span class="p">):</span>
676+
<span class="k">pass</span>
676677

677678

678679
<span class="k">class</span> <span class="nc">HalfStorage</span><span class="p">(</span><span class="n">_C</span><span class="o">.</span><span class="n">HalfStorageBase</span><span class="p">,</span> <span class="n">_StorageBase</span><span class="p">):</span>

docs/master/_modules/torch/__config__.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158

159159

160160
<div class="version">
161-
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+b87f0e5 &#x25BC</a>
161+
<a href='http://pytorch.org/docs/versions.html'>1.7.0a0+fa9ae67 &#x25BC</a>
162162
</div>
163163

164164

@@ -256,7 +256,7 @@
256256
<ul>
257257
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/audio">torchaudio</a></li>
258258
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/text">torchtext</a></li>
259-
<li class="toctree-l1"><a class="reference internal" href="../../torchvision/index.html">torchvision</a></li>
259+
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/vision">torchvision</a></li>
260260
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/elastic/">TorchElastic</a></li>
261261
<li class="toctree-l1"><a class="reference external" href="https://pytorch.org/serve">TorchServe</a></li>
262262
<li class="toctree-l1"><a class="reference external" href="http://pytorch.org/xla/">PyTorch on XLA Devices</a></li>

0 commit comments

Comments
 (0)