Software Documents

Licensed Software

This software is made available under the terms of the Graphcore End User License Agreement (EULA). Please ensure you have read and accept the terms of the license before using the software.

Release notes for each software release can be found on the Graphcore software download site.

Getting Started

• Getting Started with an IPU-Server

• Getting Started with IPU-POD Systems

• Getting Started with Direct Attach IPU-M2000

• Getting Started with Graphcloud Preview

  Information on how to install the drivers and other essential software for your IPU hardware, how to run your first IPU program and get started with frameworks such as TensorFlow or PyTorch.

• IPU Programmer’s Guide

  An introduction to the IPU architecture, programming model and tools available.

• SDK Overview

  A description of the components of the Poplar SDK. Download and install instructions

• Using IPUs from Docker

  A set of pre-built Docker packages containing components of the Poplar SDK.

• Graphcore Glossary

  A dictionary of specialised terms related to Graphcore technology.

TensorFlow

• TensorFlow 1 User Guide

• TensorFlow 2 User Guide

• Keras for the IPU

  User guides and API reference for the IPU implementation of TensorFlow and Keras.

• Porting TensorFlow models to the IPU

  Explains the process of porting your TensorFlow application to the IPU.

• Model parallelism with TensorFlow: sharding and pipelining

  Exploiting the parallelism of the IPUs for your TensorFlow application.

• Optimising for the IPU: Computational Graph Recompilation and Executable Switching in TensorFlow

  Tips for managing graph compilation.

PyTorch

Support for PyTorch on the IPU.

• PyTorch for the IPU: User Guide

PopART

The Poplar Advanced Runtime (PopART) for importing and executing models from industry standard ML frameworks, using the ONNX format.

• PopART User Guide

• PopART Python API Reference

• PopART C++ API Reference

Profiling and Debugging

• PopVision User Guide

• Poplar Profiling File Formats

  Describes the contents of the files created by the Poplar tools with static and runtime profiling information. These files are mainly intended for use by the PopVision Graph Analyser but this may be useful to people wanting to use the data for their own purposes.

Poplar Graph Programming Framework

• Poplar and PopLibs User Guide

  Information on how to use the Poplar graph programming tools to write code for the IPU.

• Poplar and PopLibs API Reference

  Details of the functions in the Poplar and PopLibs libraries provided in the Poplar SDK.

• Poplar Assembly Programming Guide

  An introduction to programming in assembly language on the IPU. This also includes some useful detail about memory layout and usage by the Poplar tools.

Open Source Software

The following software is available as open source:

• TensorFlow for the IPU

  • Source repository

• PopTorch

  • Source repository

  • Build instructions

• PopART

  • Source repository

  • Build instructions

• PopLibs libraries

  • Source repository

  • Build instructions

• Poprithms: a library of graph algorithms used by the ML frameworks.

  • Source repository

  • Build instructions

License agreements

• Graphcore End User License Agreement (EULA)

• PopLibs, PopTorch, PopART and Poprithms are licensed under the terms of the MIT license.

• TensorFlow for the IPU is licensed under the Apache License 2.0.

• Open source Contribution License Agreement (CLA)