[Doc] Add doc on how to define operator computation (#4)

hidet-org · Oct 31, 2022 · c0c8f9f · c0c8f9f
1 parent e2e1ed1
commit c0c8f9f
Show file tree

Hide file tree

Showing 30 changed files with 737 additions and 47 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,6 @@
 sphinx
 sphinx-gallery
+sphinx-copybutton
 autodocsumm
 sphinx-book-theme
 matplotlib

diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css
@@ -23,4 +23,41 @@ div.container-xl {
 
 .sphx-glr-script-out .highlight pre {
     background-color: #e9ecef !important;
+}
+
+div.sphx-glr-download a {
+    background-color: #0084c845 !important;
+    background-image: none !important;
+}
+
+div.sphx-glr-download a:hover {
+    background-color: rgba(0, 132, 200, 0.5) !important;
+    background-image: none !important;
+}
+
+dt.sig {
+    letter-spacing: 0;
+    font-family: Menlo,Monaco,Consolas,SFMono-Regular,"Liberation Mono","Courier New",monospace;
+    /*font-family: ;*/
+    /*font-size=1em;*/
+}
+
+span.sig-name {
+    color: #0558b7;
+}
+em.sig-param {
+    font-style: normal;
+}
+em.property {
+    font-style: normal;
+}
+code {
+    font-family: monospace;
+}
+code {
+    color: #3e3ead;
+}
+
+.heading-style, h1, h2, h3, h4, h5, h6 {
+    font-family: Ubuntu, system-ui;
 }
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -45,8 +45,11 @@
     'sphinx.ext.viewcode',
     'sphinx.ext.coverage',
     'sphinx.ext.todo',
+    'sphinx.ext.graphviz',
+    'sphinx.ext.doctest',
     "sphinx_gallery.gen_gallery",
     'sphinxcontrib.googleanalytics',
+    'sphinx_copybutton',
     'autodocsumm',
 ]
 
@@ -77,7 +80,7 @@
 intersphinx_mapping = {
     'torch': ('https://pytorch.org/docs/stable', None),
     'torchvision': ('https://pytorch.org/vision/stable', None),
-    "python": ("https://docs.python.org/3", None),
+    # "python": ("https://docs.python.org/3", None),
 }
 
 # -- Options for HTML output -------------------------------------------------
@@ -115,3 +118,8 @@
     'filename_pattern': r'/*\.py',
     "download_all_examples": False,
 }
+
+copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
+copybutton_prompt_is_regexp = True
+
+graphviz_output_format = "svg"
diff --git a/docs/source/getting-started/install.rst b/docs/source/getting-started/install.rst
@@ -1,26 +1,31 @@
 Installation
 ============
 
-Install from pip
+Install via pip
 ----------------
 
-.. note::
+.. todo::
   :class: margin
 
-  Currently, hidet is not open-sourced yet. Please ask Yaoyao get access to the GitHub repository.
-
-  In the future, we will publish hidet to The `Python Package Index (PyPI) <https://pypi.org/>`_.
+  Coming soon.
 
 Run the following command to install ``hidet`` package directly using python pip:
 
 .. code-block:: console
 
-  $ pip install git+ssh://git@github.com/yaoyaoding/hidet.git
+  $ pip install hidet
 
 
 Install from source
 -------------------
 
+.. note::
+  :class: margin
+
+  Currently, hidet is not open-sourced yet. Please ask Yaoyao get access to the GitHub repository.
+
+  In the future, we will publish hidet to The `Python Package Index (PyPI) <https://pypi.org/>`_.
+
 If you are a developer of Hidet, it is better to install hidet from source.
 
 Clone the code

diff --git a/docs/source/how-to-guides/add-new-operator/index.rst b/docs/source/how-to-guides/add-new-operator/index.rst
@@ -5,14 +5,21 @@ Hidet is designed to be extensible. It is easy to add new operators to Hidet. Th
 an operator.
 
 1. **Rule-based Scheduling**
-   Define the mathematical computation of the operator, and use Hidet's rule-based scheduler to implement the
-   computation.
+   Define the mathematical computation of the operator, and Hidet will automatically schedule the computation into
+   parallel tensor program with Hidet's rule-based scheduler.
 2. **Template-based Scheduling**
-   Besides the computation, also give the concrete implementation of the operator.
+   Besides the computation, user can also give the concrete implementation of the operator to achieve better performance
+   for complex operators.
 
 .. toctree::
   :maxdepth: 1
-  :caption: Two Methods
+  :caption: Define Computation
+
+  ../../gallery/how-to-guides/add-new-operator-compute-definition
+
+.. toctree::
+  :maxdepth: 1
+  :caption: Two Scheduling Methods
 
   ../../gallery/how-to-guides/add-new-operator-rule-based
   ../../gallery/how-to-guides/add-new-operator-template-based
diff --git a/docs/source/how-to-guides/index.rst b/docs/source/how-to-guides/index.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -43,7 +43,7 @@ Hidet is an open-source DNN inference framework, it features
   :maxdepth: 1
   :caption: Notes
 
-  notes/hidet-cache
+  notes/operator-cache
   notes/visualize-flow-graph
 
 .. toctree::

diff --git a/docs/source/notes/hidet-cache.rst → docs/source/notes/operator-cache.rst b/docs/source/notes/hidet-cache.rst → docs/source/notes/operator-cache.rst
@@ -1,8 +1,7 @@
-Hidet Cache
-===========
+Operator Cache
+==============
 
 .. todo::
 
   Will come soon.
 
-
diff --git a/docs/source/python_api/driver.rst b/docs/source/python_api/driver.rst
@@ -0,0 +1,6 @@
+hidet.driver
+------------
+
+.. automodule:: hidet.driver
+  :members:
+  :autosummary:
diff --git a/docs/source/python_api/index.rst b/docs/source/python_api/index.rst
@@ -6,6 +6,8 @@ Python API
    :caption: Python API
 
    root
+   driver
+   ir/index
    graph/index
    runtime/index
    utils/index

diff --git a/docs/source/python_api/ir/compute.rst b/docs/source/python_api/ir/compute.rst
@@ -0,0 +1,13 @@
+hidet.ir.compute
+================
+
+.. tip::
+
+  Please refer to :doc:`here </gallery/how-to-guides/add-new-operator-compute-definition>` for how to use these compute
+  primitives to define a computation task.
+
+
+.. automodule:: hidet.ir.compute
+  :members:
+  :imported-members:
+  :autosummary:
diff --git a/docs/source/python_api/ir/expr.rst b/docs/source/python_api/ir/expr.rst
@@ -0,0 +1,6 @@
+hidet.ir.expr
+=============
+
+.. automodule:: hidet.ir.expr
+  :members:
+  :autosummary:
diff --git a/docs/source/python_api/ir/func.rst b/docs/source/python_api/ir/func.rst
@@ -0,0 +1,6 @@
+hidet.ir.func
+=============
+
+.. automodule:: hidet.ir.func
+  :members:
+  :autosummary:
diff --git a/docs/source/python_api/ir/index.rst b/docs/source/python_api/ir/index.rst
@@ -0,0 +1,13 @@
+hidet.ir
+========
+
+.. toctree::
+  :caption: Submodules
+
+  type
+  expr
+  stmt
+  func
+  compute
+  task
+
diff --git a/docs/source/python_api/ir/stmt.rst b/docs/source/python_api/ir/stmt.rst
@@ -0,0 +1,6 @@
+hidet.ir.stmt
+=============
+
+.. automodule:: hidet.ir.stmt
+  :members:
+  :autosummary:
diff --git a/docs/source/python_api/ir/task.rst b/docs/source/python_api/ir/task.rst
@@ -0,0 +1,6 @@
+hidet.ir.task
+=============
+
+.. automodule:: hidet.ir.task
+  :members:
+  :autosummary:
diff --git a/docs/source/python_api/ir/type.rst b/docs/source/python_api/ir/type.rst
@@ -0,0 +1,6 @@
+hidet.ir.type
+=============
+
+.. automodule:: hidet.ir.type
+  :members:
+  :autosummary:
diff --git a/docs/source/python_api/root.rst b/docs/source/python_api/root.rst
@@ -4,6 +4,6 @@ hidet
 
 .. automodule:: hidet
   :members:
-  :exclude-members: FlowGraph, Tensor, Operator
+  :exclude-members: FlowGraph, Tensor, Operator, Task
   :imported-members:
   :autosummary: