Skip to content

Commit 1c8fc7e

Browse files
authored
doc: add documentation for EstimatorBase parameters missing from docstring (#1445)
1 parent 64ccf20 commit 1c8fc7e

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

src/sagemaker/estimator.py

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,23 @@ def __init__(
198198
started. If the path is unset then SageMaker assumes the
199199
checkpoints will be provided under `/opt/ml/checkpoints/`.
200200
(default: ``None``).
201-
enable_sagemaker_metrics (bool): enable SageMaker Metrics Time
201+
rules (list[:class:`~sagemaker.debugger.Rule`]): A list of
202+
:class:`~sagemaker.debugger.Rule` objects used to define
203+
rules for continuous analysis with SageMaker Debugger
204+
(default: ``None``). For more, see
205+
https://sagemaker.readthedocs.io/en/stable/amazon_sagemaker_debugger.html#continuous-analyses-through-rules
206+
debugger_hook_config (:class:`~sagemaker.debugger.DebuggerHookConfig` or bool):
207+
Configuration for how debugging information is emitted with
208+
SageMaker Debugger. If not specified, a default one is created using
209+
the estimator's ``output_path``, unless the region does not
210+
support SageMaker Debugger. To disable SageMaker Debugger,
211+
set this parameter to ``False``. For more, see
212+
https://sagemaker.readthedocs.io/en/stable/amazon_sagemaker_debugger.html
213+
tensorboard_output_config (:class:`~sagemaker.debugger.TensorBoardOutputConfig`):
214+
Configuration for customizing debugging visualization using TensorBoard
215+
(default: ``None``). For more, see
216+
https://sagemaker.readthedocs.io/en/stable/amazon_sagemaker_debugger.html#capture-real-time-tensorboard-data-from-the-debugging-hook
217+
enable_sagemaker_metrics (bool): Enables SageMaker Metrics Time
202218
Series. For more information see:
203219
https://docs.aws.amazon.com/sagemaker/latest/dg/API_AlgorithmSpecification.html#SageMaker-Type-AlgorithmSpecification-EnableSageMakerMetricsTimeSeries
204220
(default: ``None``).

0 commit comments

Comments
 (0)