diff --git a/docs/axonn_style.py b/docs/axonn_style.py new file mode 100644 index 0000000..d6feab9 --- /dev/null +++ b/docs/axonn_style.py @@ -0,0 +1,16 @@ +# Copyright 2024 Parallel Software and Systems Group, University of Maryland. +# See the top-level LICENSE file for details. +# +# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + +# The name of the Pygments (syntax highlighting) style to use. +from pygments.styles.default import DefaultStyle +from pygments.token import Generic + + +# modifications to the default style +class AxonnStyle(DefaultStyle): + styles = DefaultStyle.styles.copy() + background_color = "#f4f4f8" + styles[Generic.Output] = "#355" + styles[Generic.Prompt] = "bold #346ec9" diff --git a/docs/conf.py b/docs/conf.py index 1f16863..2cfda6e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,15 +15,11 @@ # 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 os import sys # sys.path.insert(0, os.path.abspath('.')) -# The name of the Pygments (syntax highlighting) style to use. -from pygments.styles.default import DefaultStyle -from pygments.token import Generic - import pkg_resources @@ -60,21 +56,14 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] -# modifications to the default style -class AxonnStyle(DefaultStyle): - styles = DefaultStyle.styles.copy() - background_color = "#f4f4f8" - styles[Generic.Output] = "#355" - styles[Generic.Prompt] = "bold #346ec9" - - dist = pkg_resources.Distribution(__file__) sys.path.append(".") # make 'conf' module findable ep = pkg_resources.EntryPoint.parse("axonn = conf:AxonnStyle", dist=dist) dist._ep_map = {"pygments.styles": {"plugin1": ep}} pkg_resources.working_set.add(dist) -pygments_style = "axonn" +sys.path.insert(0, os.path.abspath(".")) +pygments_style = "axonn_style.AxonnStyle" # -- Options for HTML output ------------------------------------------------- diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..9a95852 --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,17 @@ + +******** +Examples +******** + +Training +============ + + + +Fine-tuning +=========== + + + +Inference +========= diff --git a/docs/index.rst b/docs/index.rst index 7bb76cd..5f80a27 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,6 +19,9 @@ AxoNN is a parallel framework for training deep neural networks. :caption: User Docs getting_started + user_guide + examples + ################## diff --git a/docs/user_guide.rst b/docs/user_guide.rst new file mode 100644 index 0000000..24bc0f0 --- /dev/null +++ b/docs/user_guide.rst @@ -0,0 +1,28 @@ +********** +User Guide +********** + +Initializing AxoNN +================== + +Tensor with Easy API +==================== + +Tensor using Advanced API +===================================== + +Combining Tensor in AxoNN with PyTorch DDP +========================================== + +Integration with other Parallel APIs +==================================== + +Huggingface +----------- + +Pipelining in AxoNN +=================== + +Combining Pipelining in AxoNN with Data Parallelism +=================================================== +