Tutorials

This document contains a list of all tutorials from the Graphcore GitHub Tutorials repository.

The document is generated by the gen_docs.py script.

Updates for SDK releases

Update the SDK version number in .gitmodules. This value is used to update the script.

You must also manually update the tutorials submodule as follows:

# cd into the tutorials submodule directory
cd tutorials
git checkout sdk-release-x.y
cd ..
git add tutorials
git commit -m "updated tutorials submodule to branck sdk-release-x.y"
git push

Hereafter, anyone pulling from the gc-docs/tutorials GitHub repo will get the sdk-release-x.y branch.

Troubleshooting the build on ReadTheDocs

For the gen_docs.py script to run on ReadTheDocs, the readthedocs.yaml file must contain the jobs field in the build section (the code shows the entry for the full build section):

build:
  os: ubuntu-20.04
  tools:
    python: "3.6"
  jobs:
    pre_build:
      - "python3 gen_docs.py"

Building locally

In order to build this doc locally, you have to run git submodule update --init after the document repo is cloned from gc-docs. This updates the tutorials submodule. Thereafter, run git pull --recurse-submodules to pull the tutorials repo.

Then, run python gen_docs.py.

You should get an output similar to the following:

Found the following tutorial tutorials:
  tutorials/tutorials/poplar/tut1_variables/README.rst
  tutorials/tutorials/poplar/tut2_operations/README.rst
  tutorials/tutorials/poplar/tut3_vertices/README.rst
  tutorials/tutorials/poplar/tut4_profiling/README.rst
  tutorials/tutorials/poplar/tut5_matrix_vector/README.rst
  tutorials/tutorials/poplar/tut6_matrix_vector_opt/README.rst
  tutorials/tutorials/popvision/libpva/README.md
  tutorials/tutorials/popvision/lightweight_profiling/README.md
  tutorials/tutorials/popvision/system_analyser_instrumentation/README.md
  tutorials/tutorials/popxl/1_basic_concepts/README.md
  tutorials/tutorials/popxl/2_custom_optimiser/README.md
  tutorials/tutorials/popxl/3_data_parallelism/README.md
  tutorials/tutorials/popxl/4_pipelining/README.md
  tutorials/tutorials/popxl/5_remote_variables_and_rts/README.md
  tutorials/tutorials/popxl/6_phased_execution/README.md
  tutorials/tutorials/pytorch/basics/README.md
  tutorials/tutorials/pytorch/efficient_data_loading/README.md
  tutorials/tutorials/pytorch/finetuning_bert/README.md
  tutorials/tutorials/pytorch/mixed_precision/README.md
  tutorials/tutorials/pytorch/observing_tensors/README.md
  tutorials/tutorials/pytorch/pipelining/README.md
  tutorials/tutorials/pytorch/vit_model_training/README.md
  tutorials/tutorials/standard_tools/using_jupyter/README.md
  tutorials/tutorials/tensorflow1/basics/README.md
  tutorials/tutorials/tensorflow1/half_precision_training/README.md
  tutorials/tutorials/tensorflow1/pipelining/README.md
  tutorials/tutorials/tensorflow2/infeed_outfeed/README.md
  tutorials/tutorials/tensorflow2/keras/README.md
  tutorials/tutorials/tensorflow2/tensorboard/README.md
Building PyTorch Section
  tutorials/tutorials/pytorch/basics/README.md
  tutorials/tutorials/pytorch/efficient_data_loading/README.md
  tutorials/tutorials/pytorch/finetuning_bert/README.md
  tutorials/tutorials/pytorch/mixed_precision/README.md
  tutorials/tutorials/pytorch/observing_tensors/README.md
  tutorials/tutorials/pytorch/pipelining/README.md
  tutorials/tutorials/pytorch/vit_model_training/README.md
Building PopXL Section
  tutorials/tutorials/popxl/1_basic_concepts/README.md
  tutorials/tutorials/popxl/2_custom_optimiser/README.md
  tutorials/tutorials/popxl/3_data_parallelism/README.md
  tutorials/tutorials/popxl/4_pipelining/README.md
  tutorials/tutorials/popxl/5_remote_variables_and_rts/README.md
  tutorials/tutorials/popxl/6_phased_execution/README.md
Building PopART Section
  No tutorials selected
Building Poplar Section
  tutorials/tutorials/poplar/tut1_variables/README.rst
  tutorials/tutorials/poplar/tut2_operations/README.rst
  tutorials/tutorials/poplar/tut3_vertices/README.rst
  tutorials/tutorials/poplar/tut4_profiling/README.rst
  tutorials/tutorials/poplar/tut5_matrix_vector/README.rst
  tutorials/tutorials/poplar/tut6_matrix_vector_opt/README.rst
Building TensorFlow 1 Section
  tutorials/tutorials/tensorflow1/basics/README.md
  tutorials/tutorials/tensorflow1/half_precision_training/README.md
  tutorials/tutorials/tensorflow1/pipelining/README.md
Building TensorFlow 2 Section
  tutorials/tutorials/tensorflow2/infeed_outfeed/README.md
  tutorials/tutorials/tensorflow2/keras/README.md
  tutorials/tutorials/tensorflow2/tensorboard/README.md
Building PopVision Section
  tutorials/tutorials/popvision/libpva/README.md
  tutorials/tutorials/popvision/lightweight_profiling/README.md
  tutorials/tutorials/popvision/system_analyser_instrumentation/README.md
Building Standard Tools Section
  tutorials/tutorials/standard_tools/using_jupyter/README.md
Not included anywhere:
Generated files:
  index.rst
  legal.rst