Skip to content

Fix sourcedir.tar.gz filenames in docstrings #5019

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 10, 2025
Merged
Show file tree
Hide file tree
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
8 changes: 4 additions & 4 deletions src/sagemaker/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -387,8 +387,8 @@ def __init__(
source_dir (str or PipelineVariable): The absolute, relative, or S3 URI Path to
a directory with any other training source code dependencies aside from the entry
point file (default: None). If ``source_dir`` is an S3 URI, it must
point to a tar.gz file. The structure within this directory is preserved
when training on Amazon SageMaker. If 'git_config' is provided,
point to a file with name ``sourcedir.tar.gz``. The structure within this directory
is preserved when training on Amazon SageMaker. If 'git_config' is provided,
'source_dir' should be a relative location to a directory in the Git
repo.
With the following GitHub repo directory structure:
Expand Down Expand Up @@ -3421,8 +3421,8 @@ def __init__(
source_dir (str or PipelineVariable): Path (absolute, relative or an S3 URI)
to a directory with any other training source code dependencies aside from
the entry point file (default: None). If ``source_dir`` is an S3 URI, it must
point to a tar.gz file. Structure within this directory are preserved
when training on Amazon SageMaker. If 'git_config' is provided,
point to a file with name ``sourcedir.tar.gz``. Structure within this directory
are preserved when training on Amazon SageMaker. If 'git_config' is provided,
'source_dir' should be a relative location to a directory in the Git
repo.

Expand Down
2 changes: 1 addition & 1 deletion src/sagemaker/fw_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ def validate_source_code_input_against_pipeline_variables(
logger.warning(
"The source_dir is a pipeline variable: %s. During pipeline execution, "
"the interpreted value of source_dir has to be an S3 URI and "
"must point to a tar.gz file",
"must point to a file with name ``sourcedir.tar.gz``",
type(source_dir),
)

Expand Down
4 changes: 2 additions & 2 deletions src/sagemaker/huggingface/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ def __init__(
source_dir (str or PipelineVariable): Path (absolute, relative or an S3 URI) to a
directory with any other training source code dependencies aside from the entry
point file (default: None). If ``source_dir`` is an S3 URI, it must
point to a tar.gz file. Structure within this directory are preserved
when training on Amazon SageMaker.
point to a file with name ``sourcedir.tar.gz``. Structure within this directory are
preserved when training on Amazon SageMaker.
hyperparameters (dict[str, str] or dict[str, PipelineVariable]): Hyperparameters
that will be used for training (default: None). The hyperparameters are made
accessible as a dict[str, str] to the training code on
Expand Down
8 changes: 4 additions & 4 deletions src/sagemaker/jumpstart/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -350,8 +350,8 @@ def __init__(
source_dir (Optional[Union[str, PipelineVariable]]): The absolute, relative, or
S3 URI Path to a directory with any other training source code dependencies
aside from the entry point file. If ``source_dir`` is an S3 URI, it must
point to a tar.gz file. Structure within this directory is preserved
when training on Amazon SageMaker. If 'git_config' is provided,
point to a file with name ``sourcedir.tar.gz``. Structure within this directory
is preserved when training on Amazon SageMaker. If 'git_config' is provided,
'source_dir' should be a relative location to a directory in the Git
repo.
(Default: None).
Expand Down Expand Up @@ -947,8 +947,8 @@ def deploy(
source_dir (Optional[str]): The absolute, relative, or S3 URI Path to a directory
with any other training source code dependencies aside from the entry
point file (Default: None). If ``source_dir`` is an S3 URI, it must
point to a tar.gz file. Structure within this directory is preserved
when training on Amazon SageMaker. If 'git_config' is provided,
point to a file with name ``sourcedir.tar.gz``. Structure within this directory is
preserved when training on Amazon SageMaker. If 'git_config' is provided,
'source_dir' should be a relative location to a directory in the Git repo.
If the directory points to S3, no code is uploaded and the S3 location
is used instead. (Default: None).
Expand Down
4 changes: 2 additions & 2 deletions src/sagemaker/jumpstart/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,8 @@ def __init__(
source_dir (Optional[str]): The absolute, relative, or S3 URI Path to a directory
with any other training source code dependencies aside from the entry
point file (Default: None). If ``source_dir`` is an S3 URI, it must
point to a tar.gz file. Structure within this directory is preserved
when training on Amazon SageMaker. If 'git_config' is provided,
point to a file with name ``sourcedir.tar.gz``. Structure within this directory is
preserved when training on Amazon SageMaker. If 'git_config' is provided,
'source_dir' should be a relative location to a directory in the Git repo.
If the directory points to S3, no code is uploaded and the S3 location
is used instead. (Default: None).
Expand Down
14 changes: 7 additions & 7 deletions src/sagemaker/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,8 @@ def __init__(
source_dir (str): The absolute, relative, or S3 URI Path to a directory
with any other training source code dependencies aside from the entry
point file (default: None). If ``source_dir`` is an S3 URI, it must
point to a tar.gz file. Structure within this directory is preserved
when training on Amazon SageMaker. If 'git_config' is provided,
point to a file with name ``sourcedir.tar.gz``. Structure within this directory
is preserved when training on Amazon SageMaker. If 'git_config' is provided,
'source_dir' should be a relative location to a directory in the Git repo.
If the directory points to S3, no code is uploaded and the S3 location
is used instead.
Expand Down Expand Up @@ -1996,11 +1996,11 @@ def __init__(
source_dir (str): Path (absolute, relative or an S3 URI) to a directory
with any other training source code dependencies aside from the entry
point file (default: None). If ``source_dir`` is an S3 URI, it must
point to a tar.gz file. Structure within this directory are preserved
when training on Amazon SageMaker. If 'git_config' is provided,
'source_dir' should be a relative location to a directory in the Git repo.
If the directory points to S3, no code will be uploaded and the S3 location
will be used instead.
point to a file with name ``sourcedir.tar.gz``. Structure within this
directory are preserved when training on Amazon SageMaker. If 'git_config'
is provided, 'source_dir' should be a relative location to a directory in the
Git repo. If the directory points to S3, no code will be uploaded and the S3
location will be used instead.

.. admonition:: Example

Expand Down
4 changes: 2 additions & 2 deletions src/sagemaker/mxnet/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ def __init__(
source_dir (str or PipelineVariable): Path (absolute, relative or an S3 URI) to
a directory with any other training source code dependencies aside from the entry
point file (default: None). If ``source_dir`` is an S3 URI, it must
point to a tar.gz file. Structure within this directory are preserved
when training on Amazon SageMaker.
point to a file with name ``sourcedir.tar.gz``. Structure within this directory
are preserved when training on Amazon SageMaker.
hyperparameters (dict[str, str] or dict[str, PipelineVariable]): Hyperparameters
that will be used for training (default: None). The hyperparameters are made
accessible as a dict[str, str] to the training code on
Expand Down
4 changes: 2 additions & 2 deletions src/sagemaker/pytorch/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,8 @@ def __init__(
unless ``image_uri`` is provided.
source_dir (str or PipelineVariable): Path (absolute, relative or an S3 URI) to
a directory with any other training source code dependencies aside from the entry
point file (default: None). If ``source_dir`` is an S3 URI, it must
point to a tar.gz file. Structure within this directory are preserved
point file (default: None). If ``source_dir`` is an S3 URI, it must point to a
file with name ``sourcedir.tar.gz``. Structure within this directory are preserved
when training on Amazon SageMaker. Must be a local path when using training_recipe.
hyperparameters (dict[str, str] or dict[str, PipelineVariable]): Hyperparameters
that will be used for training (default: None). The hyperparameters are made
Expand Down
4 changes: 2 additions & 2 deletions src/sagemaker/rl/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@ def __init__(
source_dir (str or PipelineVariable): Path (absolute, relative or an S3 URI)
to a directory with any other training source code dependencies aside from
the entry point file (default: None). If ``source_dir`` is an S3 URI, it must
point to a tar.gz file. Structure within this directory are preserved
when training on Amazon SageMaker.
point to a file with name ``sourcedir.tar.gz``. Structure within this directory
are preserved when training on Amazon SageMaker.
hyperparameters (dict[str, str] or dict[str, PipelineVariable]): Hyperparameters
that will be used for training (default: None). The hyperparameters are made
accessible as a dict[str, str] to the training code on
Expand Down
4 changes: 2 additions & 2 deletions src/sagemaker/sklearn/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ def __init__(
source_dir (str or PipelineVariable): Path (absolute, relative or an S3 URI) to
a directory with any other training source code dependencies aside from the entry
point file (default: None). If ``source_dir`` is an S3 URI, it must
point to a tar.gz file. Structure within this directory are preserved
when training on Amazon SageMaker.
point to a file with name ``sourcedir.tar.gz``. Structure within this directory
are preserved when training on Amazon SageMaker.
hyperparameters (dict[str, str] or dict[str, PipelineVariable]): Hyperparameters
that will be used for training (default: None). The hyperparameters are made
accessible as a dict[str, str] to the training code on
Expand Down
4 changes: 2 additions & 2 deletions src/sagemaker/xgboost/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ def __init__(
source_dir (str or PipelineVariable): Path (absolute, relative or an S3 URI) to
a directory with any other training source code dependencies aside from the entry
point file (default: None). If ``source_dir`` is an S3 URI, it must
point to a tar.gz file. Structure within this directory are preserved
when training on Amazon SageMaker.
point to a file with name ``sourcedir.tar.gz``. Structure within this directory
are preserved when training on Amazon SageMaker.
hyperparameters (dict[str, str] or dict[str, PipelineVariable]): Hyperparameters
that will be used for training (default: None).
The hyperparameters are made accessible as a dict[str, str] to the training code
Expand Down
Loading