Skip to content

Commit c6a61d7

Browse files
Mark Fowdengeorgepaw
authored andcommitted
Documentation for TF2.4
Summary: Documentation for TF2.4 TF2.4 Only Fix T43245, T40858, T36134, T43241 Reviewers: #tensorflow, #framework_ip_review_-_any_oss_or_third-party_code_use_has_been_approved, georgep Reviewed By: #tensorflow, #framework_ip_review_-_any_oss_or_third-party_code_use_has_been_approved, georgep Subscribers: hakons, markf, jackh, alfiee, jamiep, grahamh Maniphest Tasks: T43245, T43241, T40858, T36134 Differential Revision: https://phabricator.sourcevertex.net/D49535
1 parent bafaf3c commit c6a61d7

26 files changed

+1269
-943
lines changed

tensorflow/compiler/plugin/poplar/BUILD

Lines changed: 156 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4995,17 +4995,6 @@ tf_xla_py_test(
49954995
],
49964996
)
49974997

4998-
tf_xla_py_test(
4999-
name = "logging_example_1",
5000-
size = "large",
5001-
srcs = ["docs/logging_example_1.py"],
5002-
enabled_backends = ["poplar"],
5003-
deps = [
5004-
"//tensorflow:tensorflow_py",
5005-
"//tensorflow/python/ipu:ipu_lib",
5006-
],
5007-
)
5008-
50094998
tf_xla_py_test(
50104999
name = "perf_training_example",
50115000
size = "large",
@@ -5425,6 +5414,149 @@ tf_xla_py_test(
54255414
],
54265415
)
54275416

5417+
tf_xla_py_test(
5418+
name = "targeting_tf2_example1",
5419+
size = "large",
5420+
srcs = ["docs/targeting_tf2_example1.py"],
5421+
enabled_backends = ["poplar"],
5422+
deps = [
5423+
"//tensorflow:tensorflow_py",
5424+
"//tensorflow/python/ipu:ipu_lib",
5425+
],
5426+
)
5427+
5428+
tf_xla_py_test(
5429+
name = "targeting_tf2_example2",
5430+
size = "large",
5431+
srcs = ["docs/targeting_tf2_example2.py"],
5432+
enabled_backends = ["poplar"],
5433+
deps = [
5434+
"//tensorflow:tensorflow_py",
5435+
"//tensorflow/python/ipu:ipu_lib",
5436+
],
5437+
)
5438+
5439+
tf_xla_py_test(
5440+
name = "targeting_tf2_example3",
5441+
size = "large",
5442+
srcs = ["docs/targeting_tf2_example3.py"],
5443+
enabled_backends = ["poplar"],
5444+
deps = [
5445+
"//tensorflow:tensorflow_py",
5446+
"//tensorflow/python/ipu:ipu_lib",
5447+
],
5448+
)
5449+
5450+
tf_xla_py_test(
5451+
name = "keras_tf2_example1",
5452+
size = "large",
5453+
srcs = ["docs/keras_tf2_example1.py"],
5454+
enabled_backends = ["poplar"],
5455+
deps = [
5456+
"//tensorflow:tensorflow_py",
5457+
"//tensorflow/python/ipu:ipu_lib",
5458+
],
5459+
)
5460+
5461+
tf_xla_py_test(
5462+
name = "keras_tf2_example2",
5463+
size = "large",
5464+
srcs = ["docs/keras_tf2_example2.py"],
5465+
enabled_backends = ["poplar"],
5466+
deps = [
5467+
"//tensorflow:tensorflow_py",
5468+
"//tensorflow/python/ipu:ipu_lib",
5469+
],
5470+
)
5471+
5472+
tf_xla_py_test(
5473+
name = "keras_tf2_example3",
5474+
size = "large",
5475+
srcs = ["docs/keras_tf2_example3.py"],
5476+
enabled_backends = ["poplar"],
5477+
deps = [
5478+
"//tensorflow:tensorflow_py",
5479+
"//tensorflow/python/ipu:ipu_lib",
5480+
],
5481+
)
5482+
5483+
tf_xla_py_test(
5484+
name = "keras_tf2_example4",
5485+
size = "large",
5486+
srcs = ["docs/keras_tf2_example4.py"],
5487+
enabled_backends = ["poplar"],
5488+
deps = [
5489+
"//tensorflow:tensorflow_py",
5490+
"//tensorflow/python/ipu:ipu_lib",
5491+
],
5492+
)
5493+
5494+
tf_xla_py_test(
5495+
name = "keras_tf2_example5",
5496+
size = "large",
5497+
srcs = ["docs/keras_tf2_example5.py"],
5498+
enabled_backends = ["poplar"],
5499+
deps = [
5500+
"//tensorflow:tensorflow_py",
5501+
"//tensorflow/python/ipu:ipu_lib",
5502+
],
5503+
)
5504+
5505+
tf_xla_py_test(
5506+
name = "keras_tf2_example6",
5507+
size = "large",
5508+
srcs = ["docs/keras_tf2_example6.py"],
5509+
enabled_backends = ["poplar"],
5510+
deps = [
5511+
"//tensorflow:tensorflow_py",
5512+
"//tensorflow/python/ipu:ipu_lib",
5513+
],
5514+
)
5515+
5516+
tf_xla_py_test(
5517+
name = "keras_tf2_example7",
5518+
size = "large",
5519+
srcs = ["docs/keras_tf2_example7.py"],
5520+
enabled_backends = ["poplar"],
5521+
deps = [
5522+
"//tensorflow:tensorflow_py",
5523+
"//tensorflow/python/ipu:ipu_lib",
5524+
],
5525+
)
5526+
5527+
tf_xla_py_test(
5528+
name = "keras_tf2_example8",
5529+
size = "large",
5530+
srcs = ["docs/keras_tf2_example8.py"],
5531+
enabled_backends = ["poplar"],
5532+
deps = [
5533+
"//tensorflow:tensorflow_py",
5534+
"//tensorflow/python/ipu:ipu_lib",
5535+
],
5536+
)
5537+
5538+
tf_xla_py_test(
5539+
name = "keras_tf2_example9",
5540+
size = "large",
5541+
srcs = ["docs/keras_tf2_example9.py"],
5542+
enabled_backends = ["poplar"],
5543+
deps = [
5544+
"//tensorflow:tensorflow_py",
5545+
"//tensorflow/python/ipu:ipu_lib",
5546+
],
5547+
)
5548+
5549+
tf_xla_py_test(
5550+
name = "keras_porting_example",
5551+
size = "large",
5552+
srcs = ["docs/keras_porting_example.py"],
5553+
enabled_backends = ["poplar"],
5554+
deps = [
5555+
"//tensorflow:tensorflow_py",
5556+
"//tensorflow/python/ipu:ipu_lib",
5557+
],
5558+
)
5559+
54285560
tf_xla_py_test(
54295561
name = "compile_cache_test",
54305562
size = "large",
@@ -5697,10 +5829,22 @@ test_suite(
56975829
"function_example2",
56985830
"ipu_estimator_example",
56995831
"ipu_pipeline_estimator_example",
5700-
"logging_example_1",
5832+
"keras_tf2_example1",
5833+
"keras_tf2_example2",
5834+
"keras_tf2_example3",
5835+
"keras_tf2_example4",
5836+
"keras_tf2_example5",
5837+
"keras_tf2_example6",
5838+
"keras_tf2_example7",
5839+
"keras_tf2_example8",
5840+
"keras_tf2_example9",
5841+
"keras_porting_example",
57015842
"outfeed_example",
57025843
"perf_training_example",
57035844
"pre_compile_example_runner",
5845+
"targeting_tf2_example1",
5846+
"targeting_tf2_example2",
5847+
"targeting_tf2_example3",
57045848
"tutorial_attributes_example",
57055849
"tutorial_custom_codelet",
57065850
] + if_horovod(["distributed_training_horovod_example"]),

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

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,14 @@ For example, this will not work:
2323
:members:
2424
:imported-members:
2525

26+
.. note::
27+
28+
`tensorflow.python.ipu.ipu_strategy.IPUStrategy` is an alias of
29+
:py:class:`tensorflow.python.ipu.ipu_strategy.IPUStrategyV1`.
30+
2631
.. automodule:: tensorflow.python.ipu.ipu_strategy
2732
:members: IPUStrategyV1
33+
:special-members: __init__
2834

2935
.. Note: the headings of the following modules will be included
3036
as subsection headings. They need to be added before
@@ -137,20 +143,9 @@ Estimators
137143
Keras
138144
^^^^^
139145

140-
.. note::
141-
142-
`tensorflow.python.ipu.keras.SequentialPipelineModel` has been renamed to
143-
:py:class:`tensorflow.python.ipu.keras.PipelineSequential` and will be removed
144-
in a future version.
145-
146-
.. automodule:: tensorflow.python.ipu.keras
147-
:members: Model, Sequential, PipelineStage, PipelineModel, PipelineSequential
148-
:imported-members: Model, Sequential, PipelineModel, PipelineStage, PipelineSequential
149-
:special-members: __init__
150-
151-
.. automodule:: tensorflow.python.ipu.keras.model
152-
:members: IPUModel, IPUSequential
153-
:special-members: __init__
146+
.. automodule:: tensorflow.python.ipu.keras.extensions
147+
:members: FunctionalExtension, PipelineStage, FunctionalLayerPipelineStageAssignment, SequentialExtension, SequentialLayerPipelineStageAssignment
148+
:imported-members: FunctionalExtension, PipelineStage, FunctionalLayerPipelineStageAssignment, SequentialExtension, SequentialLayerPipelineStageAssignment
154149

155150
.. _keras-layers-api:
156151

0 commit comments

Comments
 (0)