Skip to content

doc: Add a deprecation note for DetailedProfileConfig #3583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 31, 2023
Merged

doc: Add a deprecation note for DetailedProfileConfig #3583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
335f08a
little rephrasing
mchoi8739 Jan 10, 2023
619bbef
change to warning
mchoi8739 Jan 10, 2023
2ab9d0e
minor fix
mchoi8739 Jan 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/sagemaker/debugger/framework_profile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,12 @@ def __init__(
profiling. Configure it using the
:class:`~sagemaker.debugger.metrics_config.DetailedProfilingConfig` class.
Pass ``DetailedProfilingConfig()`` to use the default configuration.

.. warning::
This detailed framework profiling feature discontinues support for TensorFlow v2.11
and later. To use the detailed profiling feature, use previous versions of
TensorFlow between v2.3.1 and v2.10.0.

dataloader_profiling_config (DataloaderProfilingConfig): The configuration for
dataloader metrics profiling. Configure it using the
:class:`~sagemaker.debugger.metrics_config.DataloaderProfilingConfig` class.
Expand Down
8 changes: 6 additions & 2 deletions src/sagemaker/debugger/metrics_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,8 +203,7 @@ def __init__(
):
"""Specify target steps or a target duration to profile.

By default, it profiles step 5
of training.
By default, it profiles step 5 of the training job.

If **profile_default_steps** is set to `True` and none of the other
range parameters is specified,
Expand All @@ -224,6 +223,11 @@ def __init__(
if one of the two pairs is used. If both pairs are specified, a
conflict error occurs.

.. warning::
This detailed framework profiling feature discontinues support for TensorFlow v2.11
and later. To use the detailed profiling feature, use previous versions of
TensorFlow between v2.3.1 and v2.10.0.

"""
assert isinstance(
profile_default_steps, bool
Expand Down