Skip to content

doc: Correct runtime param #3984

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 4 commits into from
Jul 12, 2023
Merged

doc: Correct runtime param #3984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
563d390
Update session.py
mingchun-liu Jul 7, 2023
3de2b58
Update tuner.py
mingchun-liu Jul 7, 2023
b0f4350
Merge pull request #1 from mlsquareup/documentation-correct-runtime-p…
mingchun-liu Jul 7, 2023
f277b70
Update tuner.py
mingchun-liu Jul 7, 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
4 changes: 2 additions & 2 deletions src/sagemaker/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2639,7 +2639,7 @@ def tune( # noqa: C901
warm_start_config (dict): Configuration defining the type of warm start and
other required configurations.
max_runtime_in_seconds (int or PipelineVariable): The maximum time in seconds
that a training job launched by a hyperparameter tuning job can run.
that a hyperparameter tuning job can run.
completion_criteria_config (sagemaker.tuner.TuningJobCompletionCriteriaConfig): A
configuration for the completion criteria.
early_stopping_type (str): Specifies whether early stopping is enabled for the job.
Expand Down Expand Up @@ -2894,7 +2894,7 @@ def _map_tuning_config(
tuning job.
max_parallel_jobs (int): Maximum number of parallel training jobs to start.
max_runtime_in_seconds (int or PipelineVariable): The maximum time in seconds
that a training job launched by a hyperparameter tuning job can run.
that a hyperparameter tuning job can run.
early_stopping_type (str): Specifies whether early stopping is enabled for the job.
Can be either 'Auto' or 'Off'. If set to 'Off', early stopping will not be
attempted. If set to 'Auto', early stopping of some training jobs may happen,
Expand Down
4 changes: 2 additions & 2 deletions src/sagemaker/tuner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -650,7 +650,7 @@ def __init__(
max_parallel_jobs (int or PipelineVariable): Maximum number of parallel training jobs to
start (default: 1).
max_runtime_in_seconds (int or PipelineVariable): The maximum time in seconds
that a training job launched by a hyperparameter tuning job can run.
that a hyperparameter tuning job can run.
tags (list[dict[str, str] or list[dict[str, PipelineVariable]]): List of tags for
labeling the tuning job (default: None). For more, see
https://docs.aws.amazon.com/sagemaker/latest/dg/API_Tag.html.
Expand Down Expand Up @@ -1922,7 +1922,7 @@ def create(
max_parallel_jobs (int): Maximum number of parallel training jobs to start
(default: 1).
max_runtime_in_seconds (int): The maximum time in seconds
that a training job launched by a hyperparameter tuning job can run.
that a hyperparameter tuning job can run.
tags (list[dict]): List of tags for labeling the tuning job (default: None). For more,
see https://docs.aws.amazon.com/sagemaker/latest/dg/API_Tag.html.
warm_start_config (sagemaker.tuner.WarmStartConfig): A ``WarmStartConfig`` object that
Expand Down