Skip to content

Commit 64a8630

Browse files
mchoi8739Namrata Madan
authored and
Namrata Madan
committed
doc: Add a deprecation note for DetailedProfileConfig (aws#3583)
1 parent c67970d commit 64a8630

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

src/sagemaker/debugger/framework_profile.py

+6
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,12 @@ def __init__(
143143
profiling. Configure it using the
144144
:class:`~sagemaker.debugger.metrics_config.DetailedProfilingConfig` class.
145145
Pass ``DetailedProfilingConfig()`` to use the default configuration.
146+
147+
.. warning::
148+
This detailed framework profiling feature discontinues support for TensorFlow v2.11
149+
and later. To use the detailed profiling feature, use previous versions of
150+
TensorFlow between v2.3.1 and v2.10.0.
151+
146152
dataloader_profiling_config (DataloaderProfilingConfig): The configuration for
147153
dataloader metrics profiling. Configure it using the
148154
:class:`~sagemaker.debugger.metrics_config.DataloaderProfilingConfig` class.

src/sagemaker/debugger/metrics_config.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -203,8 +203,7 @@ def __init__(
203203
):
204204
"""Specify target steps or a target duration to profile.
205205
206-
By default, it profiles step 5
207-
of training.
206+
By default, it profiles step 5 of the training job.
208207
209208
If **profile_default_steps** is set to `True` and none of the other
210209
range parameters is specified,
@@ -224,6 +223,11 @@ def __init__(
224223
if one of the two pairs is used. If both pairs are specified, a
225224
conflict error occurs.
226225
226+
.. warning::
227+
This detailed framework profiling feature discontinues support for TensorFlow v2.11
228+
and later. To use the detailed profiling feature, use previous versions of
229+
TensorFlow between v2.3.1 and v2.10.0.
230+
227231
"""
228232
assert isinstance(
229233
profile_default_steps, bool

0 commit comments

Comments
 (0)