Skip to content

Commit

Permalink
Fixes #8 and fixes #7
Browse files Browse the repository at this point in the history
  • Loading branch information
dimitri-tenstorrent committed Aug 12, 2024
1 parent c0a9ecf commit 1e63c2f
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 7 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/pages_deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,17 @@ jobs:
pip install -r requirements.txt
wget https://github.com/tenstorrent/tt-metal/releases/download/v0.49.0/metal_libs-0.49.0+wormhole.b0-cp38-cp38-linux_x86_64.whl
pip install --extra-index-url https://download.pytorch.org/whl/cpu metal_libs-0.49.0+wormhole.b0-cp38-cp38-linux_x86_64.whl
- name: Convert Installation.md to .rst in ttnn and tt-metallium docs
run: |
pandoc --from=markdown --to=rst --output=ttnn/ttnn/installing.rst ttnn/ttnn/installing.md
pandoc --from=markdown --to=rst --output=tt-metalium/installing.rst tt-metalium/installing.md
- name: Build documentation
run: |
python build_docs.py
- name: Make root index.html
run: |
touch output/index.html
echo -n "docs.tenstorrent.com" > output/CNAME
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
Expand Down
2 changes: 1 addition & 1 deletion tt-metalium/get_started/get_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Where to go from here
^^^^^^^^^^^^^^^^^^^^^

If you're an ML developer and looking for a simpler Python API to build models,
take a look at our higher-level API `TT-NN <../../ttnn>`_.
take a look at our higher-level API `TT-NN <../../../ttnn/latest/index.html>`_.

If you're an internal TT-Metalium developer, please now read and review the
`contribution standards
Expand Down
2 changes: 2 additions & 0 deletions ttnn/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@
"breathe",
]

source_suffix = ['.rst', '.md']

# Napoleon settings
napoleon_google_docstring = False
napoleon_numpy_docstring = True
Expand Down
8 changes: 4 additions & 4 deletions ttnn/ttnn/get_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ The GitHub page for the project is located here:
https://github.com/tenstorrent/tt-metal

Installation and environment setup instructions are in the
`installation guide <../ttnn/installing.html>`_.
`installation guide <./installing.html>`_.

1. Install and Build
^^^^^^^^^^^^^^^^^^^^

Install and build the project by following the instructions in the
`installation guide
<../ttnn/installing.html>`_.
<./installing.html>`_.

2. Explore our model demos
^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -39,7 +39,7 @@ and
This tutorial currently works on Grayskull only.

Learn the basics of multi-head attention operations with TT-NN
with a simple example: `TT-NN simple module <../../ttnn/ttnn/tutorials/ttnn_tutorials/003.html#Write-Multi-Head-Attention-using-ttnn>`_.
with a simple example: `TT-NN simple module <./tutorials/ttnn_tutorials/003.html#Write-Multi-Head-Attention-using-ttnn>`_.

4. TT-NN Tutorial: Multi-Head Attention (Optimized)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -48,7 +48,7 @@ with a simple example: `TT-NN simple module <../../ttnn/ttnn/tutorials/ttnn_tuto
This tutorial currently works on Grayskull only.

Dive deeper into multi-head attention operations in TT-NN, optimizing
performance: `optimizing performance <../../ttnn/ttnn/tutorials/ttnn_tutorials/003.html#Write-optimized-version-of-Multi-Head-Attention>`_.
performance: `optimizing performance <./tutorials/ttnn_tutorials/003.html#Write-optimized-version-of-Multi-Head-Attention>`_.

Where to go from here
^^^^^^^^^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion ttnn/ttnn/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Basic Examples

`tt_lib` operations are missing some of the features of ttnn operations such as graph tracing and in order to support these features, ttnn provides a different to call `tt_lib` operations that enabled the missing features.

.. literalinclude:: ../../../../ttnn/examples/usage/using_tt_lib.py
.. literalinclude:: examples/usage/using_tt_lib.py
:language: python


Expand Down

0 comments on commit 1e63c2f

Please sign in to comment.