Deploying to gh-pages from @ 441697c 🚀

pytorch · Jan 3, 2024 · 921bdac · 921bdac
1 parent 11e848e
commit 921bdac
Show file tree

Hide file tree

Showing 44 changed files with 929 additions and 202 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 951ec2f7d15cc471c5801ca0c58642a5
+config: f996087fbec7ef433b55ccd29d9aaf59
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_sources/general/ContactInfo.rst.txt b/_sources/general/ContactInfo.rst.txt
diff --git a/_sources/general/ContactUs.rst.txt b/_sources/general/ContactUs.rst.txt
@@ -0,0 +1,17 @@
+Contact Us
+==========
+
+GitHub
+------
+
+*  `GitHub Issues <https://github.com/pytorch/FBGEMM/issues>`__: Use this to file
+   questions, issues, and feature requests concerning FBGEMM_GPU.
+
+*  `GitHub Discussions <https://github.com/pytorch/FBGEMM/discussions>`__: Use
+   avenuue to kick off longer discussions regarding FBGEMM_GPU.
+
+Slack
+-----
+
+Feel free to reach out to us on the ``#fbgemm`` channel in
+`Pytorch Slack <https://bit.ly/ptslack>`__.
diff --git a/_sources/general/Contributing.rst.txt b/_sources/general/Contributing.rst.txt
@@ -0,0 +1,2 @@
+.. include:: ../../../../CONTRIBUTING.md
+   :parser: myst_parser.sphinx_
diff --git a/_sources/general/DocsInstructions.rst.txt b/_sources/general/DocsInstructions.rst.txt
@@ -1,5 +1,5 @@
-Contributing Documentation
-==========================
+Building Documentation
+======================
 
 FBGEMM_GPU provides extensive comments in its source files, which provide the
 most authoritative and up-to-date documentation available for the package.
@@ -170,7 +170,8 @@ When you add descriptionss to a function, make sure that the ``#ifndef`` and
 ``#endif`` are configured correctly.
 
 All functions are grouped by a specific group for better organization.
-Make sure you add ``@defgroup`` to the code comments.
+Make sure you add ``@defgroup`` to the code comments to define the group, and
+``@ingroup`` in each docstring to associate the target method with the group.
 
 Follow these instructions to document, generate, and publish a new C++
 description:

diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -19,6 +19,8 @@ library.
    general/InstallationInstructions.rst
    general/TestInstructions.rst
    general/DocsInstructions.rst
+   general/Contributing.rst
+   general/ContactUs.rst
 
 .. _fbgemm-gpu.docs.toc.overview:
 

diff --git a/_sources/overview/jagged-tensor-ops/JaggedTensorOps.rst.txt b/_sources/overview/jagged-tensor-ops/JaggedTensorOps.rst.txt
@@ -24,7 +24,7 @@ Jagged Tensor Format
 -------------------
 
 Jagged tensors are effectively represented in FBGEMm_GPU as a three-tensor
-object.  The three tensors are: **Values**, **Max Lengths**, and **Offsets**.
+object.  The three tensors are: **Values**, **MaxLengths**, and **Offsets**.
 
 Values
 ~~~~~~

diff --git a/_sources/python-api/jagged_tensor_ops.rst.txt b/_sources/python-api/jagged_tensor_ops.rst.txt
@@ -1,37 +1,24 @@
 Jagged Tensor Operators
 =======================
 
-.. automodule:: fbgemm_gpu
-
-
 .. autofunction:: torch.ops.fbgemm.jagged_2d_to_dense
 
-
 .. autofunction:: torch.ops.fbgemm.jagged_1d_to_dense
 
-
 .. autofunction:: torch.ops.fbgemm.dense_to_jagged
 
-
 .. autofunction:: torch.ops.fbgemm.jagged_to_padded_dense
 
-
 .. autofunction:: torch.ops.fbgemm.jagged_dense_elementwise_add
 
-
 .. autofunction:: torch.ops.fbgemm.jagged_dense_elementwise_add_jagged_output
 
-
 .. autofunction:: torch.ops.fbgemm.jagged_dense_dense_elementwise_add_jagged_output
 
-
 .. autofunction:: torch.ops.fbgemm.jagged_dense_elementwise_mul
 
-
 .. autofunction:: torch.ops.fbgemm.batched_dense_vec_jagged_2d_mul
 
-
 .. autofunction:: torch.ops.fbgemm.stacked_jagged_1d_to_dense
 
-
 .. autofunction:: torch.ops.fbgemm.stacked_jagged_2d_to_dense
diff --git a/cpp-api/embedding_ops.html b/cpp-api/embedding_ops.html
@@ -258,7 +258,9 @@
 <li class="toctree-l1"><a class="reference internal" href="../general/BuildInstructions.html">Build Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/InstallationInstructions.html">Installation Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/TestInstructions.html">Testing FBGEMM_GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Contributing Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Building Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/Contributing.html">Contributing to FBGEMM / FBGEMM_GPU</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/ContactUs.html">Contact Us</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">FBGEMM_GPU Overview</span></p>
 <ul>

diff --git a/cpp-api/input_combine.html b/cpp-api/input_combine.html
@@ -259,7 +259,9 @@
 <li class="toctree-l1"><a class="reference internal" href="../general/BuildInstructions.html">Build Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/InstallationInstructions.html">Installation Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/TestInstructions.html">Testing FBGEMM_GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Contributing Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Building Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/Contributing.html">Contributing to FBGEMM / FBGEMM_GPU</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/ContactUs.html">Contact Us</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">FBGEMM_GPU Overview</span></p>
 <ul>

diff --git a/cpp-api/jagged_tensor_ops.html b/cpp-api/jagged_tensor_ops.html
@@ -259,7 +259,9 @@
 <li class="toctree-l1"><a class="reference internal" href="../general/BuildInstructions.html">Build Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/InstallationInstructions.html">Installation Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/TestInstructions.html">Testing FBGEMM_GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Contributing Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Building Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/Contributing.html">Contributing to FBGEMM / FBGEMM_GPU</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/ContactUs.html">Contact Us</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">FBGEMM_GPU Overview</span></p>
 <ul>

diff --git a/cpp-api/layout_transform_ops.html b/cpp-api/layout_transform_ops.html
@@ -259,7 +259,9 @@
 <li class="toctree-l1"><a class="reference internal" href="../general/BuildInstructions.html">Build Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/InstallationInstructions.html">Installation Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/TestInstructions.html">Testing FBGEMM_GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Contributing Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Building Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/Contributing.html">Contributing to FBGEMM / FBGEMM_GPU</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/ContactUs.html">Contact Us</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">FBGEMM_GPU Overview</span></p>
 <ul>

diff --git a/cpp-api/memory_utils.html b/cpp-api/memory_utils.html
@@ -259,7 +259,9 @@
 <li class="toctree-l1"><a class="reference internal" href="../general/BuildInstructions.html">Build Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/InstallationInstructions.html">Installation Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/TestInstructions.html">Testing FBGEMM_GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Contributing Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Building Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/Contributing.html">Contributing to FBGEMM / FBGEMM_GPU</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/ContactUs.html">Contact Us</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">FBGEMM_GPU Overview</span></p>
 <ul>

diff --git a/cpp-api/merge_pooled_embeddings.html b/cpp-api/merge_pooled_embeddings.html
@@ -259,7 +259,9 @@
 <li class="toctree-l1"><a class="reference internal" href="../general/BuildInstructions.html">Build Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/InstallationInstructions.html">Installation Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/TestInstructions.html">Testing FBGEMM_GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Contributing Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Building Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/Contributing.html">Contributing to FBGEMM / FBGEMM_GPU</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/ContactUs.html">Contact Us</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">FBGEMM_GPU Overview</span></p>
 <ul>

diff --git a/cpp-api/quantize_ops.html b/cpp-api/quantize_ops.html
@@ -259,7 +259,9 @@
 <li class="toctree-l1"><a class="reference internal" href="../general/BuildInstructions.html">Build Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/InstallationInstructions.html">Installation Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/TestInstructions.html">Testing FBGEMM_GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Contributing Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Building Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/Contributing.html">Contributing to FBGEMM / FBGEMM_GPU</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/ContactUs.html">Contact Us</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">FBGEMM_GPU Overview</span></p>
 <ul>

diff --git a/cpp-api/sparse_ops.html b/cpp-api/sparse_ops.html
@@ -259,7 +259,9 @@
 <li class="toctree-l1"><a class="reference internal" href="../general/BuildInstructions.html">Build Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/InstallationInstructions.html">Installation Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/TestInstructions.html">Testing FBGEMM_GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Contributing Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Building Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/Contributing.html">Contributing to FBGEMM / FBGEMM_GPU</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/ContactUs.html">Contact Us</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">FBGEMM_GPU Overview</span></p>
 <ul>

diff --git a/cpp-api/split_table_batched_embeddings.html b/cpp-api/split_table_batched_embeddings.html
@@ -259,7 +259,9 @@
 <li class="toctree-l1"><a class="reference internal" href="../general/BuildInstructions.html">Build Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/InstallationInstructions.html">Installation Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../general/TestInstructions.html">Testing FBGEMM_GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Contributing Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/DocsInstructions.html">Building Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/Contributing.html">Contributing to FBGEMM / FBGEMM_GPU</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../general/ContactUs.html">Contact Us</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">FBGEMM_GPU Overview</span></p>
 <ul>

diff --git a/general/BuildInstructions.html b/general/BuildInstructions.html
@@ -259,7 +259,9 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Build Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="InstallationInstructions.html">Installation Instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="TestInstructions.html">Testing FBGEMM_GPU</a></li>
-<li class="toctree-l1"><a class="reference internal" href="DocsInstructions.html">Contributing Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="DocsInstructions.html">Building Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Contributing.html">Contributing to FBGEMM / FBGEMM_GPU</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ContactUs.html">Contact Us</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">FBGEMM_GPU Overview</span></p>
 <ul>