Docs changes

Summary: Ref T57087

Reviewers: dionysiaa, #tensorflow, #framework_ip_review_-_any_oss_or_third-party_code_use_has_been_approved, alfiee

Reviewed By: #tensorflow, #framework_ip_review_-_any_oss_or_third-party_code_use_has_been_approved, alfiee

Maniphest Tasks: T57087

Differential Revision: https://phabricator.sourcevertex.net/D62603

Author: georgepaw

tensorflow/compiler/plugin/poplar/docs/api-changes.rst

@@ -1,12 +1,52 @@
-API changes
------------
+TensorFlow API changes
+----------------------
 
 Release 2.5
 ~~~~~~~~~~~
 
 The following changes have been made to the TensorFlow API in the Poplar SDK version 2.5.
 This may require you to change your code.
 
+Breaking changes
+________________
+
+.. warning::
+
+  These will require changes to any code that uses them.
+
+Removal of deprecated APIs
+''''''''''''''''''''''''''
+
+  - `IpuConfig.floating_point_behaviour.esr` may no longer be assigned a boolean
+    value (deprecated in Poplar SDK version 2.4). Doing so will now raise a
+    `ValueError`. From Poplar SDK version 2.5 onwards,
+    :py:class:`~tensorflow.python.ipu.config.StochasticRoundingBehaviour`
+    must be used. Note that serialized IpuConfig instances from an earlier
+    Poplar SDK version will not be deserializable from Poplar SDK version 2.5
+    onwards.
+  - `extract_all_events`, `extract_all_strings_from_event_trace` and
+    `extract_all_types_from_event_trace` have been removed from
+    `tensorflow.python.ipu.utils`. These items were deprecated in Poplar SDK
+    version 2.4.
+  - `IPUMultiReplicaStrategy` (deprecated in Poplar SDK version 2.4) has been
+    removed. From Poplar SDK version 2.5 onwards use
+    :py:class:`~tensorflow.python.ipu.horovod.popdist_strategy.PopDistStrategy`.
+  - The `save_interval_report` flag provided to `TF_POPLAR_FLAGS` has been
+    removed following deprecation in Poplar SDK version 2.4. From Poplar SDK
+    version 2.5, LIBPVA should be used.
+  - `tensorflow.python.ipu.ops.summary_ops` has been removed as both
+    `ipu_compile_summary` and `get_ipu_reports` were deprecated in Poplar
+    SDK version 2.4. From Poplar SDK 2.5 onwards, the
+    [PopVision] (https://docs.graphcore.ai/projects/tf-model-parallelism/en/latest/profiler.html)
+    suite of tools should be used instead. Additionally, the `compile_summary`
+    parameter of `IPURunConfig` has been removed.
+
+Other
+'''''
+
+  - The flag ``save_vertex_graph`` from ``TF_POPLAR_FLAGS`` is now non-functional.
+    Please use the ``target.saveOutputVertexGraph`` Poplar engine option instead.
+
 Non-breaking changes
 ____________________
 
@@ -75,7 +115,7 @@ Deprecated pipeline and gradient_accumulation options
 
 The `experimental_normalize_gradients` parameter when setting gradient accumulation options
 (`Model.set_gradient_accumulation_options()`) and pipeline options (`Model.set_pipelining_options()`)
-is being deprecated and will be removed in future. This feature will be provided by new mean reduction
+has been deprecated and will be removed in future. This feature will be provided by new mean reduction
 methods being added via the `reduction_method` parameter
 (`tensorflow.python.ipu.optimizers.GradientAccumulationReductionMethod`).
 
@@ -92,49 +132,6 @@ The ``available_memory_proportion_fwd`` and ``available_memory_proportion_bwd``
 
 These values are now set using the ``'availableMemoryProportion'`` key of the ``options`` and ``options_bwd`` arguments correspondingly.
 
-Breaking changes
-________________
-
-.. warning::
-
-  These will require changes to any code that uses them.
-
-Removal of deprecated APIs
-''''''''''''''''''''''''''
-  - `IpuConfig.floating_point_behaviour.esr` may no longer be assigned a boolean
-  value (deprecated in Poplar SDK version 2.4). Doing so will now raise a
-  `ValueError`. From Poplar SDK version 2.5 onwards,
-  :py:class:`~tensorflow.python.ipu.config.StochasticRoundingBehaviour`
-  must be used. Note that serialized IpuConfig instances from an earlier
-  Poplar SDK version will not be deserializable from Poplar SDK version 2.5
-  onwards.
-
-  - `extract_all_events`, `extract_all_strings_from_event_trace` and
-  `extract_all_types_from_event_trace` have been removed from
-  `tensorflow.python.ipu.utils`. These items were deprecated in Poplar SDK
-  version 2.4.
-
-  - `IPUMultiReplicaStrategy` (deprecated in Poplar SDK version 2.4) has been
-  removed. From Poplar SDK version 2.5 onwards use
-  :py:class:`~tensorflow.python.ipu.horovod.popdist_strategy.PopDistStrategy`.
-
-  - The `save_interval_report` flag provided to `TF_POPLAR_FLAGS` has been
-  removed following deprecation in Poplar SDK version 2.4. From Poplar SDK
-  version 2.5, LIBPVA should be used.
-
-  - `tensorflow.python.ipu.ops.summary_ops` has been removed as both
-  `ipu_compile_summary` and `get_ipu_reports` were deprecated in Poplar
-  SDK version 2.4. From Poplar SDK 2.5 onwards, the 
-  [PopVision](https://docs.graphcore.ai/projects/tf-model-parallelism/en/latest/profiler.html)
-  suite of tools should be used instead. Additionally, the `compile_summary`
-  parameter of `IPURunConfig` has been removed.
-
-Other
-'''''
-
-  - The flag ``save_vertex_graph`` from ``TF_POPLAR_FLAGS`` is now non-functional.
-  Please use the ``target.saveOutputVertexGraph`` Poplar engine option instead.
-
 Release 2.4
 ~~~~~~~~~~~
 

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

@@ -1,7 +1,7 @@
 .. _api-section:
 
-Python API
-----------
+TensorFlow Python API
+---------------------
 
 Remember to import the IPU API using: