Skip to content

documentation: add security note for the estimator hyperparameter arg #3622

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.

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 2 commits into from
Feb 2, 2023
Merged
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions src/sagemaker/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,13 @@ def __init__(
hyperparameters (dict[str, str] or dict[str, PipelineVariable]):
A dictionary containing the hyperparameters to
initialize this estimator with. (Default: None).

.. caution::
You must not include any security-sensitive information, such as
account access IDs, secrets, and tokens, in the dictionary for configuring
hyperparameters. SageMaker rejects the training job request and returns an
validation error for detected credentials, if such user input is found.

container_log_level (int or PipelineVariable): The log level to use within the container
(default: logging.INFO). Valid values are defined in the Python
logging module.
Expand Down Expand Up @@ -2462,6 +2469,13 @@ def __init__(
using the default AWS configuration chain.
hyperparameters (dict[str, str] or dict[str, PipelineVariable]):
Dictionary containing the hyperparameters to initialize this estimator with.

.. caution::
You must not include any security-sensitive information, such as
account access IDs, secrets, and tokens, in the dictionary for configuring
hyperparameters. SageMaker rejects the training job request and returns an
validation error for detected credentials, if such user input is found.

tags (list[dict[str, str] or list[dict[str, PipelineVariable]]): List of tags for
labeling a training job. For more, see
https://docs.aws.amazon.com/sagemaker/latest/dg/API_Tag.html.
Expand Down Expand Up @@ -2939,6 +2953,13 @@ def __init__(
SageMaker. For convenience, this accepts other types for keys
and values, but ``str()`` will be called to convert them before
training.

.. caution::
You must not include any security-sensitive information, such as
account access IDs, secrets, and tokens, in the dictionary for configuring
hyperparameters. SageMaker rejects the training job request and returns an
validation error for detected credentials, if such user input is found.

container_log_level (int or PipelineVariable): Log level to use within the container
(default: logging.INFO). Valid values are defined in the Python
logging module.
Expand Down