Move from Sphinx Autodoc to sphinx-autoapi#92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ksivaman merged 7 commits into from
Mar 11, 2023
Merged

Move from Sphinx Autodoc to sphinx-autoapi #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
010c363
Change from AutoDoc to AutoAPI
ptrendx Mar 10, 2023
191afc8
Fixes
ptrendx Mar 10, 2023
264de00
WAR for the wrong autosummary generation
ptrendx Mar 10, 2023
ee1326a
Change common to be in line with pytorch API docs
ptrendx Mar 10, 2023
ae42a42
Add GitHub Action to build docs
ptrendx Mar 10, 2023
260cd3e
Fix
ptrendx Mar 10, 2023
6037e25
Trying to fix the versions
ptrendx Mar 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/workflows/build_docs.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright (c) 2022-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# See LICENSE for license information.

# A workflow to trigger the build of TE documentation on GitHub
name: 'Build documentation'
on:
pull_request:
workflow_dispatch:
jobs:
build_docs:
runs-on: ubuntu-latest
steps:
- name: 'Checkout'
uses: actions/checkout@v3
- name: 'Install dependencies'
run: |
pip install sphinx==5.1.1 sphinx_rtd_theme==1.0.0 nbsphinx==0.8.10 IPython ipython_genutils==0.2.0 ipywidgets==8.0.2
pip install breathe==4.34.0 sphinx-autoapi==2.0.1
sudo apt-get install -y pandoc graphviz doxygen
export GIT_SHA=$(git show-ref --hash HEAD)
- name: 'Build docs'
run: |
doxygen docs/Doxyfile
cd docs
make html
- name: 'Upload docs'
uses: actions/upload-artifact@v3
with:
name: te_docs
path: docs/_build/html
retention-days: 7
7 changes: 2 additions & 5 deletions docs/api/common.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,10 +6,7 @@
Common API
==========

Classes
-------
.. autoapiclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))
.. autoapiclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))

22 changes: 8 additions & 14 deletions docs/api/pytorch.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,29 +6,23 @@
pyTorch
=======

Modules
-------

.. autoclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
:members: forward

.. autoclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)

.. autoclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
:members: forward

.. autoclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
:members: forward

.. autoclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
:members: forward

.. autoclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
:members: forward

Functions
---------

.. autofunction:: transformer_engine.pytorch.fp8_autocast
.. autoapifunction:: transformer_engine.pytorch.fp8_autocast

.. autofunction:: transformer_engine.pytorch.checkpoint
.. autoapifunction:: transformer_engine.pytorch.checkpoint
6 changes: 5 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,8 @@
'sphinx.ext.mathjax',
'sphinx.ext.napoleon',
'nbsphinx',
'breathe']
'breathe',
'autoapi.extension']

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
Expand DownExpand Up@@ -97,3 +98,6 @@

breathe_projects = {"TransformerEngine": os.path.abspath("doxygen/xml/")}
breathe_default_project = "TransformerEngine"

autoapi_generate_api_docs = False
autoapi_dirs = ["../transformer_engine"]
2 changes: 1 addition & 1 deletion transformer_engine/pytorch/transformer.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

from flash_attn.flash_attn_interface import flash_attn_unpadded_func

from transformer_engine.pytorch import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
from transformer_engine.pytorch.module import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
Comment thread
ksivaman marked this conversation as resolved.
from transformer_engine.pytorch.jit import (
set_jit_fusion_options,
warmup_jit_bias_dropout_add_all_dtypes,
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Move from Sphinx Autodoc to sphinx-autoapi#92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ksivaman
merged 7 commits into

from

Mar 11, 2023
 Merged


Move from Sphinx Autodoc to sphinx-autoapi
#92
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
010c363

Change from AutoDoc to AutoAPI


ptrendx Mar 10, 2023
191afc8

Fixes


ptrendx Mar 10, 2023
264de00

WAR for the wrong autosummary generation


ptrendx Mar 10, 2023
ee1326a

Change common to be in line with pytorch API docs


ptrendx Mar 10, 2023
ae42a42

Add GitHub Action to build docs


ptrendx Mar 10, 2023
260cd3e

Fix


ptrendx Mar 10, 2023
6037e25

Trying to fix the versions


ptrendx Mar 10, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


32 changes: 32 additions & 0 deletions
.github/workflows/build_docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright (c) 2022-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# See LICENSE for license information.

# A workflow to trigger the build of TE documentation on GitHub
name: 'Build documentation'
on:
 pull_request:
 workflow_dispatch:
jobs:
 build_docs:
 runs-on: ubuntu-latest
 steps:
 - name: 'Checkout'
 uses: actions/checkout@v3
 - name: 'Install dependencies'
 run: |
 pip install sphinx==5.1.1 sphinx_rtd_theme==1.0.0 nbsphinx==0.8.10 IPython ipython_genutils==0.2.0 ipywidgets==8.0.2
 pip install breathe==4.34.0 sphinx-autoapi==2.0.1
 sudo apt-get install -y pandoc graphviz doxygen
 export GIT_SHA=$(git show-ref --hash HEAD)
 - name: 'Build docs'
 run: |
 doxygen docs/Doxyfile
 cd docs
 make html
 - name: 'Upload docs'
 uses: actions/upload-artifact@v3
 with:
 name: te_docs
 path: docs/_build/html
 retention-days: 7

7 changes: 2 additions & 5 deletions
docs/api/common.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,10 +6,7 @@
Common API
==========

Classes
-------
.. autoapiclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))
.. autoapiclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))


22 changes: 8 additions & 14 deletions
docs/api/pytorch.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,29 +6,23 @@
pyTorch
=======

Modules
-------

.. autoclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)

.. autoclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
 :members: forward

Functions
---------

.. autofunction:: transformer_engine.pytorch.fp8_autocast
.. autoapifunction:: transformer_engine.pytorch.fp8_autocast

.. autofunction:: transformer_engine.pytorch.checkpoint
.. autoapifunction:: transformer_engine.pytorch.checkpoint

6 changes: 5 additions & 1 deletion
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,8 @@
 'sphinx.ext.mathjax',
 'sphinx.ext.napoleon',
 'nbsphinx',
 'breathe']
 'breathe',
 'autoapi.extension']

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
Expand DownExpand Up@@ -97,3 +98,6 @@

breathe_projects = {"TransformerEngine": os.path.abspath("doxygen/xml/")}
breathe_default_project = "TransformerEngine"

autoapi_generate_api_docs = False
autoapi_dirs = ["../transformer_engine"]

2 changes: 1 addition & 1 deletion
transformer_engine/pytorch/transformer.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

from flash_attn.flash_attn_interface import flash_attn_unpadded_func

from transformer_engine.pytorch import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
from transformer_engine.pytorch.module import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
Comment thread
ksivaman marked this conversation as resolved.

from transformer_engine.pytorch.jit import (
 set_jit_fusion_options,
 warmup_jit_bias_dropout_add_all_dtypes,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Move from Sphinx Autodoc to sphinx-autoapi#92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ksivaman
merged 7 commits into

from

Mar 11, 2023
 Merged


Move from Sphinx Autodoc to sphinx-autoapi
#92
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
010c363

Change from AutoDoc to AutoAPI


ptrendx Mar 10, 2023
191afc8

Fixes


ptrendx Mar 10, 2023
264de00

WAR for the wrong autosummary generation


ptrendx Mar 10, 2023
ee1326a

Change common to be in line with pytorch API docs


ptrendx Mar 10, 2023
ae42a42

Add GitHub Action to build docs


ptrendx Mar 10, 2023
260cd3e

Fix


ptrendx Mar 10, 2023
6037e25

Trying to fix the versions


ptrendx Mar 10, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


32 changes: 32 additions & 0 deletions
.github/workflows/build_docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright (c) 2022-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# See LICENSE for license information.

# A workflow to trigger the build of TE documentation on GitHub
name: 'Build documentation'
on:
 pull_request:
 workflow_dispatch:
jobs:
 build_docs:
 runs-on: ubuntu-latest
 steps:
 - name: 'Checkout'
 uses: actions/checkout@v3
 - name: 'Install dependencies'
 run: |
 pip install sphinx==5.1.1 sphinx_rtd_theme==1.0.0 nbsphinx==0.8.10 IPython ipython_genutils==0.2.0 ipywidgets==8.0.2
 pip install breathe==4.34.0 sphinx-autoapi==2.0.1
 sudo apt-get install -y pandoc graphviz doxygen
 export GIT_SHA=$(git show-ref --hash HEAD)
 - name: 'Build docs'
 run: |
 doxygen docs/Doxyfile
 cd docs
 make html
 - name: 'Upload docs'
 uses: actions/upload-artifact@v3
 with:
 name: te_docs
 path: docs/_build/html
 retention-days: 7

7 changes: 2 additions & 5 deletions
docs/api/common.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,10 +6,7 @@
Common API
==========

Classes
-------
.. autoapiclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))
.. autoapiclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))


22 changes: 8 additions & 14 deletions
docs/api/pytorch.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,29 +6,23 @@
pyTorch
=======

Modules
-------

.. autoclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)

.. autoclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
 :members: forward

Functions
---------

.. autofunction:: transformer_engine.pytorch.fp8_autocast
.. autoapifunction:: transformer_engine.pytorch.fp8_autocast

.. autofunction:: transformer_engine.pytorch.checkpoint
.. autoapifunction:: transformer_engine.pytorch.checkpoint

6 changes: 5 additions & 1 deletion
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,8 @@
 'sphinx.ext.mathjax',
 'sphinx.ext.napoleon',
 'nbsphinx',
 'breathe']
 'breathe',
 'autoapi.extension']

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
Expand DownExpand Up@@ -97,3 +98,6 @@

breathe_projects = {"TransformerEngine": os.path.abspath("doxygen/xml/")}
breathe_default_project = "TransformerEngine"

autoapi_generate_api_docs = False
autoapi_dirs = ["../transformer_engine"]

2 changes: 1 addition & 1 deletion
transformer_engine/pytorch/transformer.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

from flash_attn.flash_attn_interface import flash_attn_unpadded_func

from transformer_engine.pytorch import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
from transformer_engine.pytorch.module import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
Comment thread
ksivaman marked this conversation as resolved.

from transformer_engine.pytorch.jit import (
 set_jit_fusion_options,
 warmup_jit_bias_dropout_add_all_dtypes,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Move from Sphinx Autodoc to sphinx-autoapi#92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ksivaman
merged 7 commits into

from

Mar 11, 2023
 Merged


Move from Sphinx Autodoc to sphinx-autoapi
#92
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
010c363

Change from AutoDoc to AutoAPI


ptrendx Mar 10, 2023
191afc8

Fixes


ptrendx Mar 10, 2023
264de00

WAR for the wrong autosummary generation


ptrendx Mar 10, 2023
ee1326a

Change common to be in line with pytorch API docs


ptrendx Mar 10, 2023
ae42a42

Add GitHub Action to build docs


ptrendx Mar 10, 2023
260cd3e

Fix


ptrendx Mar 10, 2023
6037e25

Trying to fix the versions


ptrendx Mar 10, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


32 changes: 32 additions & 0 deletions
.github/workflows/build_docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright (c) 2022-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# See LICENSE for license information.

# A workflow to trigger the build of TE documentation on GitHub
name: 'Build documentation'
on:
 pull_request:
 workflow_dispatch:
jobs:
 build_docs:
 runs-on: ubuntu-latest
 steps:
 - name: 'Checkout'
 uses: actions/checkout@v3
 - name: 'Install dependencies'
 run: |
 pip install sphinx==5.1.1 sphinx_rtd_theme==1.0.0 nbsphinx==0.8.10 IPython ipython_genutils==0.2.0 ipywidgets==8.0.2
 pip install breathe==4.34.0 sphinx-autoapi==2.0.1
 sudo apt-get install -y pandoc graphviz doxygen
 export GIT_SHA=$(git show-ref --hash HEAD)
 - name: 'Build docs'
 run: |
 doxygen docs/Doxyfile
 cd docs
 make html
 - name: 'Upload docs'
 uses: actions/upload-artifact@v3
 with:
 name: te_docs
 path: docs/_build/html
 retention-days: 7

7 changes: 2 additions & 5 deletions
docs/api/common.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,10 +6,7 @@
Common API
==========

Classes
-------
.. autoapiclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))
.. autoapiclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))


22 changes: 8 additions & 14 deletions
docs/api/pytorch.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,29 +6,23 @@
pyTorch
=======

Modules
-------

.. autoclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)

.. autoclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
 :members: forward

Functions
---------

.. autofunction:: transformer_engine.pytorch.fp8_autocast
.. autoapifunction:: transformer_engine.pytorch.fp8_autocast

.. autofunction:: transformer_engine.pytorch.checkpoint
.. autoapifunction:: transformer_engine.pytorch.checkpoint

6 changes: 5 additions & 1 deletion
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,8 @@
 'sphinx.ext.mathjax',
 'sphinx.ext.napoleon',
 'nbsphinx',
 'breathe']
 'breathe',
 'autoapi.extension']

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
Expand DownExpand Up@@ -97,3 +98,6 @@

breathe_projects = {"TransformerEngine": os.path.abspath("doxygen/xml/")}
breathe_default_project = "TransformerEngine"

autoapi_generate_api_docs = False
autoapi_dirs = ["../transformer_engine"]

2 changes: 1 addition & 1 deletion
transformer_engine/pytorch/transformer.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

from flash_attn.flash_attn_interface import flash_attn_unpadded_func

from transformer_engine.pytorch import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
from transformer_engine.pytorch.module import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
Comment thread
ksivaman marked this conversation as resolved.

from transformer_engine.pytorch.jit import (
 set_jit_fusion_options,
 warmup_jit_bias_dropout_add_all_dtypes,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Move from Sphinx Autodoc to sphinx-autoapi#92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ksivaman
merged 7 commits into

from

Mar 11, 2023
 Merged


Move from Sphinx Autodoc to sphinx-autoapi
#92
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
010c363

Change from AutoDoc to AutoAPI


ptrendx Mar 10, 2023
191afc8

Fixes


ptrendx Mar 10, 2023
264de00

WAR for the wrong autosummary generation


ptrendx Mar 10, 2023
ee1326a

Change common to be in line with pytorch API docs


ptrendx Mar 10, 2023
ae42a42

Add GitHub Action to build docs


ptrendx Mar 10, 2023
260cd3e

Fix


ptrendx Mar 10, 2023
6037e25

Trying to fix the versions


ptrendx Mar 10, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


32 changes: 32 additions & 0 deletions
.github/workflows/build_docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright (c) 2022-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# See LICENSE for license information.

# A workflow to trigger the build of TE documentation on GitHub
name: 'Build documentation'
on:
 pull_request:
 workflow_dispatch:
jobs:
 build_docs:
 runs-on: ubuntu-latest
 steps:
 - name: 'Checkout'
 uses: actions/checkout@v3
 - name: 'Install dependencies'
 run: |
 pip install sphinx==5.1.1 sphinx_rtd_theme==1.0.0 nbsphinx==0.8.10 IPython ipython_genutils==0.2.0 ipywidgets==8.0.2
 pip install breathe==4.34.0 sphinx-autoapi==2.0.1
 sudo apt-get install -y pandoc graphviz doxygen
 export GIT_SHA=$(git show-ref --hash HEAD)
 - name: 'Build docs'
 run: |
 doxygen docs/Doxyfile
 cd docs
 make html
 - name: 'Upload docs'
 uses: actions/upload-artifact@v3
 with:
 name: te_docs
 path: docs/_build/html
 retention-days: 7

7 changes: 2 additions & 5 deletions
docs/api/common.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,10 +6,7 @@
Common API
==========

Classes
-------
.. autoapiclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))
.. autoapiclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))


22 changes: 8 additions & 14 deletions
docs/api/pytorch.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,29 +6,23 @@
pyTorch
=======

Modules
-------

.. autoclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)

.. autoclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
 :members: forward

Functions
---------

.. autofunction:: transformer_engine.pytorch.fp8_autocast
.. autoapifunction:: transformer_engine.pytorch.fp8_autocast

.. autofunction:: transformer_engine.pytorch.checkpoint
.. autoapifunction:: transformer_engine.pytorch.checkpoint

6 changes: 5 additions & 1 deletion
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,8 @@
 'sphinx.ext.mathjax',
 'sphinx.ext.napoleon',
 'nbsphinx',
 'breathe']
 'breathe',
 'autoapi.extension']

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
Expand DownExpand Up@@ -97,3 +98,6 @@

breathe_projects = {"TransformerEngine": os.path.abspath("doxygen/xml/")}
breathe_default_project = "TransformerEngine"

autoapi_generate_api_docs = False
autoapi_dirs = ["../transformer_engine"]

2 changes: 1 addition & 1 deletion
transformer_engine/pytorch/transformer.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

from flash_attn.flash_attn_interface import flash_attn_unpadded_func

from transformer_engine.pytorch import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
from transformer_engine.pytorch.module import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
Comment thread
ksivaman marked this conversation as resolved.

from transformer_engine.pytorch.jit import (
 set_jit_fusion_options,
 warmup_jit_bias_dropout_add_all_dtypes,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Move from Sphinx Autodoc to sphinx-autoapi#92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ksivaman
merged 7 commits into

from

Mar 11, 2023
 Merged


Move from Sphinx Autodoc to sphinx-autoapi
#92
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
010c363

Change from AutoDoc to AutoAPI


ptrendx Mar 10, 2023
191afc8

Fixes


ptrendx Mar 10, 2023
264de00

WAR for the wrong autosummary generation


ptrendx Mar 10, 2023
ee1326a

Change common to be in line with pytorch API docs


ptrendx Mar 10, 2023
ae42a42

Add GitHub Action to build docs


ptrendx Mar 10, 2023
260cd3e

Fix


ptrendx Mar 10, 2023
6037e25

Trying to fix the versions


ptrendx Mar 10, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


32 changes: 32 additions & 0 deletions
.github/workflows/build_docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright (c) 2022-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# See LICENSE for license information.

# A workflow to trigger the build of TE documentation on GitHub
name: 'Build documentation'
on:
 pull_request:
 workflow_dispatch:
jobs:
 build_docs:
 runs-on: ubuntu-latest
 steps:
 - name: 'Checkout'
 uses: actions/checkout@v3
 - name: 'Install dependencies'
 run: |
 pip install sphinx==5.1.1 sphinx_rtd_theme==1.0.0 nbsphinx==0.8.10 IPython ipython_genutils==0.2.0 ipywidgets==8.0.2
 pip install breathe==4.34.0 sphinx-autoapi==2.0.1
 sudo apt-get install -y pandoc graphviz doxygen
 export GIT_SHA=$(git show-ref --hash HEAD)
 - name: 'Build docs'
 run: |
 doxygen docs/Doxyfile
 cd docs
 make html
 - name: 'Upload docs'
 uses: actions/upload-artifact@v3
 with:
 name: te_docs
 path: docs/_build/html
 retention-days: 7

7 changes: 2 additions & 5 deletions
docs/api/common.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,10 +6,7 @@
Common API
==========

Classes
-------
.. autoapiclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))
.. autoapiclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))


22 changes: 8 additions & 14 deletions
docs/api/pytorch.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,29 +6,23 @@
pyTorch
=======

Modules
-------

.. autoclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)

.. autoclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
 :members: forward

Functions
---------

.. autofunction:: transformer_engine.pytorch.fp8_autocast
.. autoapifunction:: transformer_engine.pytorch.fp8_autocast

.. autofunction:: transformer_engine.pytorch.checkpoint
.. autoapifunction:: transformer_engine.pytorch.checkpoint

6 changes: 5 additions & 1 deletion
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,8 @@
 'sphinx.ext.mathjax',
 'sphinx.ext.napoleon',
 'nbsphinx',
 'breathe']
 'breathe',
 'autoapi.extension']

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
Expand DownExpand Up@@ -97,3 +98,6 @@

breathe_projects = {"TransformerEngine": os.path.abspath("doxygen/xml/")}
breathe_default_project = "TransformerEngine"

autoapi_generate_api_docs = False
autoapi_dirs = ["../transformer_engine"]

2 changes: 1 addition & 1 deletion
transformer_engine/pytorch/transformer.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

from flash_attn.flash_attn_interface import flash_attn_unpadded_func

from transformer_engine.pytorch import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
from transformer_engine.pytorch.module import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
Comment thread
ksivaman marked this conversation as resolved.

from transformer_engine.pytorch.jit import (
 set_jit_fusion_options,
 warmup_jit_bias_dropout_add_all_dtypes,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Move from Sphinx Autodoc to sphinx-autoapi#92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ksivaman
merged 7 commits into

from

Mar 11, 2023
 Merged


Move from Sphinx Autodoc to sphinx-autoapi
#92
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
010c363

Change from AutoDoc to AutoAPI


ptrendx Mar 10, 2023
191afc8

Fixes


ptrendx Mar 10, 2023
264de00

WAR for the wrong autosummary generation


ptrendx Mar 10, 2023
ee1326a

Change common to be in line with pytorch API docs


ptrendx Mar 10, 2023
ae42a42

Add GitHub Action to build docs


ptrendx Mar 10, 2023
260cd3e

Fix


ptrendx Mar 10, 2023
6037e25

Trying to fix the versions


ptrendx Mar 10, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


32 changes: 32 additions & 0 deletions
.github/workflows/build_docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright (c) 2022-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# See LICENSE for license information.

# A workflow to trigger the build of TE documentation on GitHub
name: 'Build documentation'
on:
 pull_request:
 workflow_dispatch:
jobs:
 build_docs:
 runs-on: ubuntu-latest
 steps:
 - name: 'Checkout'
 uses: actions/checkout@v3
 - name: 'Install dependencies'
 run: |
 pip install sphinx==5.1.1 sphinx_rtd_theme==1.0.0 nbsphinx==0.8.10 IPython ipython_genutils==0.2.0 ipywidgets==8.0.2
 pip install breathe==4.34.0 sphinx-autoapi==2.0.1
 sudo apt-get install -y pandoc graphviz doxygen
 export GIT_SHA=$(git show-ref --hash HEAD)
 - name: 'Build docs'
 run: |
 doxygen docs/Doxyfile
 cd docs
 make html
 - name: 'Upload docs'
 uses: actions/upload-artifact@v3
 with:
 name: te_docs
 path: docs/_build/html
 retention-days: 7

7 changes: 2 additions & 5 deletions
docs/api/common.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,10 +6,7 @@
Common API
==========

Classes
-------
.. autoapiclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))
.. autoapiclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))


22 changes: 8 additions & 14 deletions
docs/api/pytorch.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,29 +6,23 @@
pyTorch
=======

Modules
-------

.. autoclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)

.. autoclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
 :members: forward

Functions
---------

.. autofunction:: transformer_engine.pytorch.fp8_autocast
.. autoapifunction:: transformer_engine.pytorch.fp8_autocast

.. autofunction:: transformer_engine.pytorch.checkpoint
.. autoapifunction:: transformer_engine.pytorch.checkpoint

6 changes: 5 additions & 1 deletion
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,8 @@
 'sphinx.ext.mathjax',
 'sphinx.ext.napoleon',
 'nbsphinx',
 'breathe']
 'breathe',
 'autoapi.extension']

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
Expand DownExpand Up@@ -97,3 +98,6 @@

breathe_projects = {"TransformerEngine": os.path.abspath("doxygen/xml/")}
breathe_default_project = "TransformerEngine"

autoapi_generate_api_docs = False
autoapi_dirs = ["../transformer_engine"]

2 changes: 1 addition & 1 deletion
transformer_engine/pytorch/transformer.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

from flash_attn.flash_attn_interface import flash_attn_unpadded_func

from transformer_engine.pytorch import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
from transformer_engine.pytorch.module import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
Comment thread
ksivaman marked this conversation as resolved.

from transformer_engine.pytorch.jit import (
 set_jit_fusion_options,
 warmup_jit_bias_dropout_add_all_dtypes,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Move from Sphinx Autodoc to sphinx-autoapi#92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ksivaman
merged 7 commits into

from

Mar 11, 2023
 Merged


Move from Sphinx Autodoc to sphinx-autoapi
#92
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
010c363

Change from AutoDoc to AutoAPI


ptrendx Mar 10, 2023
191afc8

Fixes


ptrendx Mar 10, 2023
264de00

WAR for the wrong autosummary generation


ptrendx Mar 10, 2023
ee1326a

Change common to be in line with pytorch API docs


ptrendx Mar 10, 2023
ae42a42

Add GitHub Action to build docs


ptrendx Mar 10, 2023
260cd3e

Fix


ptrendx Mar 10, 2023
6037e25

Trying to fix the versions


ptrendx Mar 10, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


32 changes: 32 additions & 0 deletions
.github/workflows/build_docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright (c) 2022-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# See LICENSE for license information.

# A workflow to trigger the build of TE documentation on GitHub
name: 'Build documentation'
on:
 pull_request:
 workflow_dispatch:
jobs:
 build_docs:
 runs-on: ubuntu-latest
 steps:
 - name: 'Checkout'
 uses: actions/checkout@v3
 - name: 'Install dependencies'
 run: |
 pip install sphinx==5.1.1 sphinx_rtd_theme==1.0.0 nbsphinx==0.8.10 IPython ipython_genutils==0.2.0 ipywidgets==8.0.2
 pip install breathe==4.34.0 sphinx-autoapi==2.0.1
 sudo apt-get install -y pandoc graphviz doxygen
 export GIT_SHA=$(git show-ref --hash HEAD)
 - name: 'Build docs'
 run: |
 doxygen docs/Doxyfile
 cd docs
 make html
 - name: 'Upload docs'
 uses: actions/upload-artifact@v3
 with:
 name: te_docs
 path: docs/_build/html
 retention-days: 7

7 changes: 2 additions & 5 deletions
docs/api/common.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,10 +6,7 @@
Common API
==========

Classes
-------
.. autoapiclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.Format

.. autoclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))
.. autoapiclass:: transformer_engine.common.recipe.DelayedScaling(margin=0, interval=1, fp8_format=Format.E4M3, amax_history_len=1, amax_compute_algo="most_recent", scaling_factor_compute_algo=None, override_linear_precision=(False, False, False))


22 changes: 8 additions & 14 deletions
docs/api/pytorch.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,29 +6,23 @@
pyTorch
=======

Modules
-------

.. autoclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.Linear(in_features, out_features, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNorm(hidden_size, eps=1e-5, **kwargs)

.. autoclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormLinear(in_features, out_features, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.LayerNormMLP(hidden_size, ffn_hidden_size, eps=1e-5, bias=True, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.DotProductAttention(num_attention_heads, kv_channels, **kwargs)
 :members: forward

.. autoclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
.. autoapiclass:: transformer_engine.pytorch.TransformerLayer(hidden_size, ffn_hidden_size, num_attention_heads, **kwargs)
 :members: forward

Functions
---------

.. autofunction:: transformer_engine.pytorch.fp8_autocast
.. autoapifunction:: transformer_engine.pytorch.fp8_autocast

.. autofunction:: transformer_engine.pytorch.checkpoint
.. autoapifunction:: transformer_engine.pytorch.checkpoint

6 changes: 5 additions & 1 deletion
docs/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,8 @@
 'sphinx.ext.mathjax',
 'sphinx.ext.napoleon',
 'nbsphinx',
 'breathe']
 'breathe',
 'autoapi.extension']

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
Expand DownExpand Up@@ -97,3 +98,6 @@

breathe_projects = {"TransformerEngine": os.path.abspath("doxygen/xml/")}
breathe_default_project = "TransformerEngine"

autoapi_generate_api_docs = False
autoapi_dirs = ["../transformer_engine"]

2 changes: 1 addition & 1 deletion
transformer_engine/pytorch/transformer.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

from flash_attn.flash_attn_interface import flash_attn_unpadded_func

from transformer_engine.pytorch import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
from transformer_engine.pytorch.module import LayerNormLinear, Linear, LayerNormMLP, LayerNorm
Comment thread
ksivaman marked this conversation as resolved.

from transformer_engine.pytorch.jit import (
 set_jit_fusion_options,
 warmup_jit_bias_dropout_add_all_dtypes,
Expand Down