Skip to content

Commit b2127bb

Browse files
authored
TensorFlow 2 User Guide: improve intro (#3)
General improvements to the introduction including adding links to documents, and tutorials.
1 parent 21d2d42 commit b2127bb

File tree

1 file changed

+13
-6
lines changed
  • tensorflow/compiler/plugin/poplar/docs

1 file changed

+13
-6
lines changed

tensorflow/compiler/plugin/poplar/docs/intro.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,14 @@ The purpose of this document is to introduce the TensorFlow framework from the
55
perspective of developing and training models for the IPU. It assumes you have
66
some knowledge of machine learning and TensorFlow.
77

8-
For more information about the IPU architecture, abstract programming model and tools, as well as algorithmic techniques, refer to the :external+ipu-programmers-guide:doc:`index`. The :external+memory-performan-optimisation:doc:`index` contains guidelines for optimising performance in machine learning models running on the IPU.
9-
10-
118
.. note:: This document is for TensorFlow 2. For information on TensorFlow 1
129
please refer to `Targeting the IPU from TensorFlow 1
1310
<https://docs.graphcore.ai/projects/tensorflow1-user-guide/>`_.
1411

15-
See the `Getting Started" guide for your IPU system <https://docs.graphcore.ai/en/latest/getting-started.html>`__ in the
16-
`Graphcore documentation <https://docs.graphcore.ai>`_
17-
for information on installing the Poplar SDK and refer to the :external+tensorflow1-quick-start:doc:`index` for installing TensorFlow 1 and running a simple application.
12+
13+
For more information about the IPU architecture, abstract programming model and tools, as well as algorithmic techniques, refer to the :external+ipu-programmers-guide:doc:`index`.
14+
15+
The Graphcore implementation of TensorFlow 2 is included in the :doc:`Poplar SDK <sdk-overview:index>`. See the `Getting Started guide <https://docs.graphcore.ai/en/latest/getting-started.html#getting-started>`_ for your system for how to install the Poplar SDK. Refer to the :external+tensorflow2-quick-start:doc:`index` for installing the TensorFlow 2 for IPU wheel. The quick start guide also shows how to run a simple TensorFlow 2 application on the IPU.
1816

1917
TensorFlow is a powerful graph-modelling framework that can be used for the
2018
development, training and deployment of deep learning models. In the Graphcore
@@ -71,6 +69,15 @@ Document overview
7169
* The next few sections provide information on IPU-specific features.
7270
* Finally, there are reference chapters describing the API and supported operators.
7371

72+
Other resources
73+
~~~~~~~~~~~~~~~
74+
7475
You can find further information on porting a TensorFlow program to the IPU and
7576
parallelising it, in our `TensorFlow technical notes
7677
<https://docs.graphcore.ai/en/latest/#tensorflow>`_.
78+
79+
:doc:`differences-ipu-gpu:index` provides a high-level overview of the programming changes required when switching from GPUs to IPUs and :doc:`memory-performance-optimisation` presents guidelines to help you develop high-performance machine learning models running on the IPU.
80+
81+
The Graphcore `Examples GitHub repository <https://github.com/graphcore/examples>`_ contains TensorFlow 2 applications, :tutorials-repo:`feature examples <feature_examples/tensorflow2>`,
82+
:tutorials-repo:`tutorials <tutorials/tensorflow2>` and :tutorials-repo:`simple applications <simple_applications/tensorflow2>`.
83+
Further developer resources can be found on `Graphcore's developer portal <https://www.graphcore.ai/developer>`_.

0 commit comments

Comments
 (0)