diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 2cbe684..c0bf5da 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,7 +13,7 @@ build: # Build documentation in the "docs/" directory with Sphinx sphinx: - configuration: docs/conf.py + configuration: docs/source/conf.py # Optional but recommended, declare the Python requirements required # to build your documentation diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 30eb3ab..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,44 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# For the full list of built-in configuration values, see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Project information ----------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information - -import sphinx_rtd_theme -import os -import sys - -# Temporary fix to ensure that the stgraph codebase can be accessed -sys.path.insert(0, os.path.abspath("../python")) - -html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - -html_theme = "sphinx_rtd_theme" -html_static_path = ["_static"] -html_logo = "_static/STGraph_docs_logo.png" -html_theme_options = { - "logo_only": True, - "display_version": False, -} - -html_css_files = ["custom.css"] - -project = "STGraph" -copyright = "2024, Joel Mathew Cherian, Nithin Puthalath Manoj" -author = "Joel Mathew Cherian, Nithin Puthalath Manoj" -release = "1.1.0" - -# -- General configuration --------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration - -extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"] - -templates_path = ["_templates"] -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] - - -# -- Options for HTML output ------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/docs/source/conf.py b/docs/source/conf.py index 5c2f10c..171ba68 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,65 +1,50 @@ # Configuration file for the Sphinx documentation builder. # -# This file only contains a selection of the most common options. For a full -# list see the documentation: +# For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html -# -- Path setup -------------------------------------------------------------- +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os +import sphinx_rtd_theme +import os import sys -import pathlib -# sys.path.insert(0, os.path.abspath('.')) -sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix()) +# Temporary fix to ensure that the stgraph codebase can be accessed +sys.path.insert(0, os.path.abspath("../../stgraph")) +html_theme = "sphinx_rtd_theme" +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] -# -- Project information ----------------------------------------------------- - -project = "STGraph" -copyright = "2023, Nithin Puthalath Manoj, Joel Mathew Cherian" -author = "Nithin Puthalath Manoj, Joel Mathew Cherian" +html_theme = "sphinx_rtd_theme" +html_static_path = ["_static"] +html_logo = "_static/STGraph_docs_logo.png" +html_theme_options = { + "logo_only": True, + "display_version": False, +} -# The full version, including alpha/beta/rc tags -release = "1.0.0" +html_css_files = ["custom.css"] +project = "STGraph" +copyright = "2024, Joel Mathew Cherian, Nithin Puthalath Manoj" +author = "Joel Mathew Cherian, Nithin Puthalath Manoj" +release = "1.1.0" # -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. extensions = [ "sphinx.ext.autodoc", + "sphinx.ext.viewcode", + 'sphinx.ext.intersphinx', "sphinx.ext.autosummary", - "sphinx.ext.napoleon", + "sphinx.ext.napoleon" ] -# Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = "sphinx_rtd_theme" - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -html_css_files = [ - 'custom.css', -] \ No newline at end of file +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/docs/source/generated/modules.rst b/docs/source/generated/modules.rst new file mode 100644 index 0000000..a42e13f --- /dev/null +++ b/docs/source/generated/modules.rst @@ -0,0 +1,7 @@ +stgraph +======= + +.. toctree:: + :maxdepth: 4 + + stgraph diff --git a/docs/source/generated/stgraph.benchmark_tools.BenchmarkTable.rst b/docs/source/generated/stgraph.benchmark_tools.BenchmarkTable.rst deleted file mode 100644 index 5cbd8df..0000000 --- a/docs/source/generated/stgraph.benchmark_tools.BenchmarkTable.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. role:: hidden - :class: hidden-section -.. currentmodule:: stgraph.benchmark_tools - - -BenchmarkTable -============== - -.. autoclass:: BenchmarkTable - :show-inheritance: - :members: \ No newline at end of file diff --git a/docs/source/generated/stgraph.compiler.backend.mxnet.rst b/docs/source/generated/stgraph.compiler.backend.mxnet.rst new file mode 100644 index 0000000..832e1e7 --- /dev/null +++ b/docs/source/generated/stgraph.compiler.backend.mxnet.rst @@ -0,0 +1,10 @@ +stgraph.compiler.backend.mxnet package +====================================== + +Module contents +--------------- + +.. automodule:: stgraph.compiler.backend.mxnet + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.backend.pytorch.rst b/docs/source/generated/stgraph.compiler.backend.pytorch.rst new file mode 100644 index 0000000..f9194bf --- /dev/null +++ b/docs/source/generated/stgraph.compiler.backend.pytorch.rst @@ -0,0 +1,29 @@ +stgraph.compiler.backend.pytorch package +======================================== + +Submodules +---------- + +stgraph.compiler.backend.pytorch.torch\_callback module +------------------------------------------------------- + +.. automodule:: stgraph.compiler.backend.pytorch.torch_callback + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.backend.pytorch.torch\_kernel\_wrapper module +-------------------------------------------------------------- + +.. automodule:: stgraph.compiler.backend.pytorch.torch_kernel_wrapper + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.compiler.backend.pytorch + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.backend.rst b/docs/source/generated/stgraph.compiler.backend.rst new file mode 100644 index 0000000..095c29e --- /dev/null +++ b/docs/source/generated/stgraph.compiler.backend.rst @@ -0,0 +1,39 @@ +stgraph.compiler.backend package +================================ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + stgraph.compiler.backend.mxnet + stgraph.compiler.backend.pytorch + stgraph.compiler.backend.tensorflow + +Submodules +---------- + +stgraph.compiler.backend.callback module +---------------------------------------- + +.. automodule:: stgraph.compiler.backend.callback + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.backend.kernel\_wrapper module +----------------------------------------------- + +.. automodule:: stgraph.compiler.backend.kernel_wrapper + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.compiler.backend + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.backend.tensorflow.rst b/docs/source/generated/stgraph.compiler.backend.tensorflow.rst new file mode 100644 index 0000000..6339661 --- /dev/null +++ b/docs/source/generated/stgraph.compiler.backend.tensorflow.rst @@ -0,0 +1,10 @@ +stgraph.compiler.backend.tensorflow package +=========================================== + +Module contents +--------------- + +.. automodule:: stgraph.compiler.backend.tensorflow + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.code_gen.rst b/docs/source/generated/stgraph.compiler.code_gen.rst new file mode 100644 index 0000000..7187d74 --- /dev/null +++ b/docs/source/generated/stgraph.compiler.code_gen.rst @@ -0,0 +1,77 @@ +stgraph.compiler.code\_gen package +================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + stgraph.compiler.code_gen.templates + +Submodules +---------- + +stgraph.compiler.code\_gen.code\_gen module +------------------------------------------- + +.. automodule:: stgraph.compiler.code_gen.code_gen + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.code\_gen.compiler module +------------------------------------------ + +.. automodule:: stgraph.compiler.code_gen.compiler + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.code\_gen.cuda\_check module +--------------------------------------------- + +.. automodule:: stgraph.compiler.code_gen.cuda_check + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.code\_gen.cuda\_driver module +---------------------------------------------- + +.. automodule:: stgraph.compiler.code_gen.cuda_driver + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.code\_gen.cuda\_error module +--------------------------------------------- + +.. automodule:: stgraph.compiler.code_gen.cuda_error + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.code\_gen.device\_info module +---------------------------------------------- + +.. automodule:: stgraph.compiler.code_gen.device_info + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.code\_gen.kernel\_context module +------------------------------------------------- + +.. automodule:: stgraph.compiler.code_gen.kernel_context + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.compiler.code_gen + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.code_gen.templates.fa.rst b/docs/source/generated/stgraph.compiler.code_gen.templates.fa.rst new file mode 100644 index 0000000..571660c --- /dev/null +++ b/docs/source/generated/stgraph.compiler.code_gen.templates.fa.rst @@ -0,0 +1,10 @@ +stgraph.compiler.code\_gen.templates.fa package +=============================================== + +Module contents +--------------- + +.. automodule:: stgraph.compiler.code_gen.templates.fa + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.code_gen.templates.rst b/docs/source/generated/stgraph.compiler.code_gen.templates.rst new file mode 100644 index 0000000..21ba80d --- /dev/null +++ b/docs/source/generated/stgraph.compiler.code_gen.templates.rst @@ -0,0 +1,19 @@ +stgraph.compiler.code\_gen.templates package +============================================ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + stgraph.compiler.code_gen.templates.fa + stgraph.compiler.code_gen.templates.v2 + +Module contents +--------------- + +.. automodule:: stgraph.compiler.code_gen.templates + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.code_gen.templates.v2.rst b/docs/source/generated/stgraph.compiler.code_gen.templates.v2.rst new file mode 100644 index 0000000..d2016b6 --- /dev/null +++ b/docs/source/generated/stgraph.compiler.code_gen.templates.v2.rst @@ -0,0 +1,10 @@ +stgraph.compiler.code\_gen.templates.v2 package +=============================================== + +Module contents +--------------- + +.. automodule:: stgraph.compiler.code_gen.templates.v2 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.debugging.rst b/docs/source/generated/stgraph.compiler.debugging.rst new file mode 100644 index 0000000..6851655 --- /dev/null +++ b/docs/source/generated/stgraph.compiler.debugging.rst @@ -0,0 +1,29 @@ +stgraph.compiler.debugging package +================================== + +Submodules +---------- + +stgraph.compiler.debugging.print\_variables module +-------------------------------------------------- + +.. automodule:: stgraph.compiler.debugging.print_variables + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.debugging.stgraph\_logger module +------------------------------------------------- + +.. automodule:: stgraph.compiler.debugging.stgraph_logger + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.compiler.debugging + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.op.agg.rst b/docs/source/generated/stgraph.compiler.op.agg.rst new file mode 100644 index 0000000..e106425 --- /dev/null +++ b/docs/source/generated/stgraph.compiler.op.agg.rst @@ -0,0 +1,21 @@ +stgraph.compiler.op.agg package +=============================== + +Submodules +---------- + +stgraph.compiler.op.agg.agg\_op module +-------------------------------------- + +.. automodule:: stgraph.compiler.op.agg.agg_op + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.compiler.op.agg + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.op.mxnet.rst b/docs/source/generated/stgraph.compiler.op.mxnet.rst new file mode 100644 index 0000000..e0fac95 --- /dev/null +++ b/docs/source/generated/stgraph.compiler.op.mxnet.rst @@ -0,0 +1,10 @@ +stgraph.compiler.op.mxnet package +================================= + +Module contents +--------------- + +.. automodule:: stgraph.compiler.op.mxnet + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.op.pytorch.rst b/docs/source/generated/stgraph.compiler.op.pytorch.rst new file mode 100644 index 0000000..d7fdd92 --- /dev/null +++ b/docs/source/generated/stgraph.compiler.op.pytorch.rst @@ -0,0 +1,21 @@ +stgraph.compiler.op.pytorch package +=================================== + +Submodules +---------- + +stgraph.compiler.op.pytorch.torch\_op module +-------------------------------------------- + +.. automodule:: stgraph.compiler.op.pytorch.torch_op + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.compiler.op.pytorch + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.op.rst b/docs/source/generated/stgraph.compiler.op.rst new file mode 100644 index 0000000..cb65d23 --- /dev/null +++ b/docs/source/generated/stgraph.compiler.op.rst @@ -0,0 +1,40 @@ +stgraph.compiler.op package +=========================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + stgraph.compiler.op.agg + stgraph.compiler.op.mxnet + stgraph.compiler.op.pytorch + stgraph.compiler.op.tensorflow + +Submodules +---------- + +stgraph.compiler.op.op module +----------------------------- + +.. automodule:: stgraph.compiler.op.op + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.op.op\_factory module +-------------------------------------- + +.. automodule:: stgraph.compiler.op.op_factory + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.compiler.op + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.op.tensorflow.rst b/docs/source/generated/stgraph.compiler.op.tensorflow.rst new file mode 100644 index 0000000..d4d0adb --- /dev/null +++ b/docs/source/generated/stgraph.compiler.op.tensorflow.rst @@ -0,0 +1,10 @@ +stgraph.compiler.op.tensorflow package +====================================== + +Module contents +--------------- + +.. automodule:: stgraph.compiler.op.tensorflow + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.passes.rst b/docs/source/generated/stgraph.compiler.passes.rst new file mode 100644 index 0000000..0770597 --- /dev/null +++ b/docs/source/generated/stgraph.compiler.passes.rst @@ -0,0 +1,77 @@ +stgraph.compiler.passes package +=============================== + +Submodules +---------- + +stgraph.compiler.passes.cf module +--------------------------------- + +.. automodule:: stgraph.compiler.passes.cf + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.passes.cse module +---------------------------------- + +.. automodule:: stgraph.compiler.passes.cse + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.passes.dce module +---------------------------------- + +.. automodule:: stgraph.compiler.passes.dce + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.passes.dependency\_analysis module +--------------------------------------------------- + +.. automodule:: stgraph.compiler.passes.dependency_analysis + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.passes.fusion module +------------------------------------- + +.. automodule:: stgraph.compiler.passes.fusion + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.passes.mem\_planning module +-------------------------------------------- + +.. automodule:: stgraph.compiler.passes.mem_planning + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.passes.peephole module +--------------------------------------- + +.. automodule:: stgraph.compiler.passes.peephole + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.passes.visualize module +---------------------------------------- + +.. automodule:: stgraph.compiler.passes.visualize + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.compiler.passes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.rst b/docs/source/generated/stgraph.compiler.rst new file mode 100644 index 0000000..9c120ec --- /dev/null +++ b/docs/source/generated/stgraph.compiler.rst @@ -0,0 +1,98 @@ +stgraph.compiler package +======================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + stgraph.compiler.backend + stgraph.compiler.code_gen + stgraph.compiler.debugging + stgraph.compiler.op + stgraph.compiler.passes + stgraph.compiler.val + +Submodules +---------- + +stgraph.compiler.autodiff module +-------------------------------- + +.. automodule:: stgraph.compiler.autodiff + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.execution\_unit module +--------------------------------------- + +.. automodule:: stgraph.compiler.execution_unit + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.executor module +-------------------------------- + +.. automodule:: stgraph.compiler.executor + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.node module +---------------------------- + +.. automodule:: stgraph.compiler.node + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.program module +------------------------------- + +.. automodule:: stgraph.compiler.program + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.registry module +-------------------------------- + +.. automodule:: stgraph.compiler.registry + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.schema module +------------------------------ + +.. automodule:: stgraph.compiler.schema + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.stgraph module +------------------------------- + +.. automodule:: stgraph.compiler.stgraph + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.utils module +----------------------------- + +.. automodule:: stgraph.compiler.utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.compiler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.val.mxnet.rst b/docs/source/generated/stgraph.compiler.val.mxnet.rst new file mode 100644 index 0000000..182c26a --- /dev/null +++ b/docs/source/generated/stgraph.compiler.val.mxnet.rst @@ -0,0 +1,10 @@ +stgraph.compiler.val.mxnet package +================================== + +Module contents +--------------- + +.. automodule:: stgraph.compiler.val.mxnet + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.val.pytorch.rst b/docs/source/generated/stgraph.compiler.val.pytorch.rst new file mode 100644 index 0000000..68f01f5 --- /dev/null +++ b/docs/source/generated/stgraph.compiler.val.pytorch.rst @@ -0,0 +1,21 @@ +stgraph.compiler.val.pytorch package +==================================== + +Submodules +---------- + +stgraph.compiler.val.pytorch.torch\_val module +---------------------------------------------- + +.. automodule:: stgraph.compiler.val.pytorch.torch_val + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.compiler.val.pytorch + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.val.rst b/docs/source/generated/stgraph.compiler.val.rst new file mode 100644 index 0000000..963f15e --- /dev/null +++ b/docs/source/generated/stgraph.compiler.val.rst @@ -0,0 +1,39 @@ +stgraph.compiler.val package +============================ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + stgraph.compiler.val.mxnet + stgraph.compiler.val.pytorch + stgraph.compiler.val.tensorflow + +Submodules +---------- + +stgraph.compiler.val.val module +------------------------------- + +.. automodule:: stgraph.compiler.val.val + :members: + :undoc-members: + :show-inheritance: + +stgraph.compiler.val.val\_factory module +---------------------------------------- + +.. automodule:: stgraph.compiler.val.val_factory + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.compiler.val + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.compiler.val.tensorflow.rst b/docs/source/generated/stgraph.compiler.val.tensorflow.rst new file mode 100644 index 0000000..9d0aea7 --- /dev/null +++ b/docs/source/generated/stgraph.compiler.val.tensorflow.rst @@ -0,0 +1,10 @@ +stgraph.compiler.val.tensorflow package +======================================= + +Module contents +--------------- + +.. automodule:: stgraph.compiler.val.tensorflow + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.dataset.CoraDataLoader.CoraDataLoader.rst b/docs/source/generated/stgraph.dataset.CoraDataLoader.CoraDataLoader.rst deleted file mode 100644 index 2e5d7f9..0000000 --- a/docs/source/generated/stgraph.dataset.CoraDataLoader.CoraDataLoader.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. role:: hidden - :class: hidden-section -.. currentmodule:: stgraph.dataset.CoraDataLoader - - -CoraDataLoader -============== - -.. autoclass:: CoraDataLoader - :show-inheritance: - :members: \ No newline at end of file diff --git a/docs/source/generated/stgraph.dataset.dynamic.rst b/docs/source/generated/stgraph.dataset.dynamic.rst new file mode 100644 index 0000000..9ea08a7 --- /dev/null +++ b/docs/source/generated/stgraph.dataset.dynamic.rst @@ -0,0 +1,29 @@ +stgraph.dataset.dynamic package +=============================== + +Submodules +---------- + +stgraph.dataset.dynamic.england\_covid\_dataloader module +--------------------------------------------------------- + +.. automodule:: stgraph.dataset.dynamic.england_covid_dataloader + :members: + :undoc-members: + :show-inheritance: + +stgraph.dataset.dynamic.stgraph\_dynamic\_dataset module +-------------------------------------------------------- + +.. automodule:: stgraph.dataset.dynamic.stgraph_dynamic_dataset + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.dataset.dynamic + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.dataset.rst b/docs/source/generated/stgraph.dataset.rst new file mode 100644 index 0000000..b26db64 --- /dev/null +++ b/docs/source/generated/stgraph.dataset.rst @@ -0,0 +1,31 @@ +stgraph.dataset package +======================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + stgraph.dataset.dynamic + stgraph.dataset.static + stgraph.dataset.temporal + +Submodules +---------- + +stgraph.dataset.stgraph\_dataset module +--------------------------------------- + +.. automodule:: stgraph.dataset.stgraph_dataset + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.dataset + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.dataset.static.rst b/docs/source/generated/stgraph.dataset.static.rst new file mode 100644 index 0000000..40d916b --- /dev/null +++ b/docs/source/generated/stgraph.dataset.static.rst @@ -0,0 +1,29 @@ +stgraph.dataset.static package +============================== + +Submodules +---------- + +stgraph.dataset.static.cora\_dataloader module +---------------------------------------------- + +.. automodule:: stgraph.dataset.static.cora_dataloader + :members: + :undoc-members: + :show-inheritance: + +stgraph.dataset.static.stgraph\_static\_dataset module +------------------------------------------------------ + +.. automodule:: stgraph.dataset.static.stgraph_static_dataset + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.dataset.static + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.dataset.temporal.rst b/docs/source/generated/stgraph.dataset.temporal.rst new file mode 100644 index 0000000..930201d --- /dev/null +++ b/docs/source/generated/stgraph.dataset.temporal.rst @@ -0,0 +1,69 @@ +stgraph.dataset.temporal package +================================ + +Submodules +---------- + +stgraph.dataset.temporal.hungarycp\_dataloader module +----------------------------------------------------- + +.. automodule:: stgraph.dataset.temporal.hungarycp_dataloader + :members: + :undoc-members: + :show-inheritance: + +stgraph.dataset.temporal.metrla\_dataloader module +-------------------------------------------------- + +.. automodule:: stgraph.dataset.temporal.metrla_dataloader + :members: + :undoc-members: + :show-inheritance: + +stgraph.dataset.temporal.montevideobus\_dataloader module +--------------------------------------------------------- + +.. automodule:: stgraph.dataset.temporal.montevideobus_dataloader + :members: + :undoc-members: + :show-inheritance: + +stgraph.dataset.temporal.pedalme\_dataloader module +--------------------------------------------------- + +.. automodule:: stgraph.dataset.temporal.pedalme_dataloader + :members: + :undoc-members: + :show-inheritance: + +stgraph.dataset.temporal.stgraph\_temporal\_dataset module +---------------------------------------------------------- + +.. automodule:: stgraph.dataset.temporal.stgraph_temporal_dataset + :members: + :undoc-members: + :show-inheritance: + +stgraph.dataset.temporal.wikimath\_dataloader module +---------------------------------------------------- + +.. automodule:: stgraph.dataset.temporal.wikimath_dataloader + :members: + :undoc-members: + :show-inheritance: + +stgraph.dataset.temporal.windmilloutput\_dataloader module +---------------------------------------------------------- + +.. automodule:: stgraph.dataset.temporal.windmilloutput_dataloader + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.dataset.temporal + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.graph.dynamic.gpma.rst b/docs/source/generated/stgraph.graph.dynamic.gpma.rst new file mode 100644 index 0000000..44dcae0 --- /dev/null +++ b/docs/source/generated/stgraph.graph.dynamic.gpma.rst @@ -0,0 +1,29 @@ +stgraph.graph.dynamic.gpma package +================================== + +Submodules +---------- + +stgraph.graph.dynamic.gpma.gpma module +-------------------------------------- + +.. automodule:: stgraph.graph.dynamic.gpma.gpma + :members: + :undoc-members: + :show-inheritance: + +stgraph.graph.dynamic.gpma.gpma\_graph module +--------------------------------------------- + +.. automodule:: stgraph.graph.dynamic.gpma.gpma_graph + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.graph.dynamic.gpma + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.graph.dynamic.naive.rst b/docs/source/generated/stgraph.graph.dynamic.naive.rst new file mode 100644 index 0000000..6a42edc --- /dev/null +++ b/docs/source/generated/stgraph.graph.dynamic.naive.rst @@ -0,0 +1,21 @@ +stgraph.graph.dynamic.naive package +=================================== + +Submodules +---------- + +stgraph.graph.dynamic.naive.naive\_graph module +----------------------------------------------- + +.. automodule:: stgraph.graph.dynamic.naive.naive_graph + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.graph.dynamic.naive + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.graph.dynamic.pcsr.rst b/docs/source/generated/stgraph.graph.dynamic.pcsr.rst new file mode 100644 index 0000000..a0eb935 --- /dev/null +++ b/docs/source/generated/stgraph.graph.dynamic.pcsr.rst @@ -0,0 +1,29 @@ +stgraph.graph.dynamic.pcsr package +================================== + +Submodules +---------- + +stgraph.graph.dynamic.pcsr.pcsr module +-------------------------------------- + +.. automodule:: stgraph.graph.dynamic.pcsr.pcsr + :members: + :undoc-members: + :show-inheritance: + +stgraph.graph.dynamic.pcsr.pcsr\_graph module +--------------------------------------------- + +.. automodule:: stgraph.graph.dynamic.pcsr.pcsr_graph + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.graph.dynamic.pcsr + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.graph.dynamic.rst b/docs/source/generated/stgraph.graph.dynamic.rst new file mode 100644 index 0000000..67a88f5 --- /dev/null +++ b/docs/source/generated/stgraph.graph.dynamic.rst @@ -0,0 +1,31 @@ +stgraph.graph.dynamic package +============================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + stgraph.graph.dynamic.gpma + stgraph.graph.dynamic.naive + stgraph.graph.dynamic.pcsr + +Submodules +---------- + +stgraph.graph.dynamic.dynamic\_graph module +------------------------------------------- + +.. automodule:: stgraph.graph.dynamic.dynamic_graph + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.graph.dynamic + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.graph.rst b/docs/source/generated/stgraph.graph.rst new file mode 100644 index 0000000..6b6c229 --- /dev/null +++ b/docs/source/generated/stgraph.graph.rst @@ -0,0 +1,30 @@ +stgraph.graph package +===================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + stgraph.graph.dynamic + stgraph.graph.static + +Submodules +---------- + +stgraph.graph.stgraph\_base module +---------------------------------- + +.. automodule:: stgraph.graph.stgraph_base + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.graph + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.graph.static.rst b/docs/source/generated/stgraph.graph.static.rst new file mode 100644 index 0000000..b748e9f --- /dev/null +++ b/docs/source/generated/stgraph.graph.static.rst @@ -0,0 +1,29 @@ +stgraph.graph.static package +============================ + +Submodules +---------- + +stgraph.graph.static.csr module +------------------------------- + +.. automodule:: stgraph.graph.static.csr + :members: + :undoc-members: + :show-inheritance: + +stgraph.graph.static.static\_graph module +----------------------------------------- + +.. automodule:: stgraph.graph.static.static_graph + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.graph.static + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.nn.GCNConv.rst b/docs/source/generated/stgraph.nn.GCNConv.rst new file mode 100644 index 0000000..4c24f95 --- /dev/null +++ b/docs/source/generated/stgraph.nn.GCNConv.rst @@ -0,0 +1,11 @@ +.. role:: hidden + :class: hidden-section +.. currentmodule:: stgraph.nn + + +GCNConv +======= + +.. autoclass:: GCNConv + :show-inheritance: + :members: \ No newline at end of file diff --git a/docs/source/generated/stgraph.nn.pytorch.rst b/docs/source/generated/stgraph.nn.pytorch.rst new file mode 100644 index 0000000..ca26df7 --- /dev/null +++ b/docs/source/generated/stgraph.nn.pytorch.rst @@ -0,0 +1,19 @@ +stgraph.nn.pytorch package +========================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + stgraph.nn.pytorch.static + stgraph.nn.pytorch.temporal + +Module contents +--------------- + +.. automodule:: stgraph.nn.pytorch + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.nn.pytorch.static.rst b/docs/source/generated/stgraph.nn.pytorch.static.rst new file mode 100644 index 0000000..a8646e1 --- /dev/null +++ b/docs/source/generated/stgraph.nn.pytorch.static.rst @@ -0,0 +1,29 @@ +stgraph.nn.pytorch.static package +================================= + +Submodules +---------- + +stgraph.nn.pytorch.static.gat\_conv module +------------------------------------------ + +.. automodule:: stgraph.nn.pytorch.static.gat_conv + :members: + :undoc-members: + :show-inheritance: + +stgraph.nn.pytorch.static.gcn\_conv module +------------------------------------------ + +.. automodule:: stgraph.nn.pytorch.static.gcn_conv + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.nn.pytorch.static + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.nn.pytorch.temporal.rst b/docs/source/generated/stgraph.nn.pytorch.temporal.rst new file mode 100644 index 0000000..a2c2d44 --- /dev/null +++ b/docs/source/generated/stgraph.nn.pytorch.temporal.rst @@ -0,0 +1,21 @@ +stgraph.nn.pytorch.temporal package +=================================== + +Submodules +---------- + +stgraph.nn.pytorch.temporal.tgcn module +--------------------------------------- + +.. automodule:: stgraph.nn.pytorch.temporal.tgcn + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.nn.pytorch.temporal + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.nn.rst b/docs/source/generated/stgraph.nn.rst new file mode 100644 index 0000000..885737f --- /dev/null +++ b/docs/source/generated/stgraph.nn.rst @@ -0,0 +1,18 @@ +stgraph.nn package +================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + stgraph.nn.pytorch + +Module contents +--------------- + +.. automodule:: stgraph.nn + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.rst b/docs/source/generated/stgraph.rst new file mode 100644 index 0000000..ef83e5b --- /dev/null +++ b/docs/source/generated/stgraph.rst @@ -0,0 +1,22 @@ +stgraph package +=============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + stgraph.compiler + stgraph.dataset + stgraph.graph + stgraph.nn + stgraph.utils + +Module contents +--------------- + +.. automodule:: stgraph + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/generated/stgraph.utils.DataTable.rst b/docs/source/generated/stgraph.utils.DataTable.rst new file mode 100644 index 0000000..53564bc --- /dev/null +++ b/docs/source/generated/stgraph.utils.DataTable.rst @@ -0,0 +1,11 @@ +.. role:: hidden + :class: hidden-section +.. currentmodule:: stgraph.utils + + +DataTable +========= + +.. autoclass:: DataTable + :show-inheritance: + :members: \ No newline at end of file diff --git a/docs/source/generated/stgraph.utils.SizeConstants.rst b/docs/source/generated/stgraph.utils.SizeConstants.rst new file mode 100644 index 0000000..74eacb0 --- /dev/null +++ b/docs/source/generated/stgraph.utils.SizeConstants.rst @@ -0,0 +1,11 @@ +.. role:: hidden + :class: hidden-section +.. currentmodule:: stgraph.utils + + +SizeConstants +============= + +.. autoclass:: SizeConstants + :show-inheritance: + :members: \ No newline at end of file diff --git a/docs/source/generated/stgraph.utils.rst b/docs/source/generated/stgraph.utils.rst new file mode 100644 index 0000000..5598e54 --- /dev/null +++ b/docs/source/generated/stgraph.utils.rst @@ -0,0 +1,29 @@ +stgraph.utils package +===================== + +Submodules +---------- + +stgraph.utils.constants module +------------------------------ + +.. automodule:: stgraph.utils.constants + :members: + :undoc-members: + :show-inheritance: + +stgraph.utils.data\_table module +-------------------------------- + +.. automodule:: stgraph.utils.data_table + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: stgraph.utils + :members: + :undoc-members: + :show-inheritance: