Skip to content

Commit 6c4c288

Browse files
committed
fix to pass unit test
1 parent b89d853 commit 6c4c288

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

src/sagemaker/debugger.py

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ def get_rule_container_image_uri(region):
3030
"""
3131
Returns the Debugger rule image URI for the given AWS region.
3232
For a full list of rule image URIs,
33-
see `Use Debugger Docker Images for Built-in or Custom Rules <https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-docker-images-rules.html>`_.
33+
see `Use Debugger Docker Images for Built-in or Custom Rules
34+
<https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-docker-images-rules.html>`_.
3435
3536
Args:
3637
region (str): A string of AWS Region. For example, ``'us-east-1'``.
@@ -89,10 +90,11 @@ def sagemaker(
8990
9091
Args:
9192
base_config (dict): Required. This is the base rule config dictionary returned from the
92-
``rule_configs`` method. For example, 'rule_configs.dead_relu()'.
93+
``rule_configs`` method. For example, ``rule_configs.dead_relu()``.
9394
name (str): Optional. The name of the debugger rule. If one is not provided,
9495
the name of the base_config will be used.
95-
container_local_output_path (str): Optional. The local path in the rule processing container.
96+
container_local_output_path (str): Optional. The local path in the rule processing
97+
container.
9698
s3_output_path (str): Optional. The location in S3 to store the output tensors.
9799
The default Debugger output path is created under the
98100
default output path of the :class:`~sagemaker.estimator.Estimator` class.
@@ -212,7 +214,9 @@ def custom(
212214
"""Initialize a ``Rule`` processing job for a *custom* SageMaker Debugging
213215
Rule. The custom rule analyzes tensors emitted during the training of a model
214216
and monitors conditions that are critical for the success of a training
215-
job. For more information, see `Create Debugger Custom Rules for Training Job Analysis <https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-custom-rules.html>`_
217+
job. For more information, see `Create Debugger Custom Rules for Training Job
218+
Analysis
219+
<https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-custom-rules.html>`_
216220
217221
Args:
218222
name (str): Required. The name of the debugger rule.
@@ -300,6 +304,15 @@ def to_debugger_rule_config_dict(self):
300304

301305

302306
class DebuggerHookConfig(object):
307+
"""
308+
Initialize an instance of ``DebuggerHookConfig``.
309+
DebuggerHookConfig provides options to customize how debugging
310+
information is emitted and saved. This high-level DebuggerHookConfig class
311+
runs based on the `smdebug.SaveConfig
312+
<https://github.com/awslabs/sagemaker-debugger/blob/master/docs/
313+
api.md#saveconfig>`_
314+
class.
315+
"""
303316

304317
def __init__(
305318
self,
@@ -308,12 +321,7 @@ def __init__(
308321
hook_parameters=None,
309322
collection_configs=None,
310323
):
311-
"""Initialize an instance of ``DebuggerHookConfig``.
312-
DebuggerHookConfig provides options to customize how debugging
313-
information is emitted and saved. This high-level DebuggerHookConfig class
314-
runs based on the `smdebug.SaveConfig <https://github.com/awslabs/sagemaker-debugger/blob/master/docs/api.md#saveconfig>`_
315-
class.
316-
324+
"""
317325
Args:
318326
s3_output_path (str): Optional. The location in S3 to store the output tensors.
319327
The default Debugger output path is created under the
@@ -425,7 +433,9 @@ def __init__(self, name, parameters=None):
425433
]
426434
427435
For a full list of Debugger built-in collection, see
428-
`Debugger Built in Collections <https://github.com/awslabs/sagemaker-debugger/blob/master/docs/api.md#built-in-collections>`_.
436+
`Debugger Built in Collections
437+
<https://github.com/awslabs/sagemaker-debugger/blob/master
438+
/docs/api.md#built-in-collections>`_.
429439
430440
**Example of creating a CollectionConfig object with parameter adjustment:**
431441

0 commit comments

Comments
 (0)