Skip to content

Commit 87da5bc

Browse files
evakravievakravi
committed
fix: docstring
1 parent 5ce011b commit 87da5bc

16 files changed

+30
-30
lines changed

‎src/sagemaker/image_uris.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ def retrieve(
114114
sagemaker_session (sagemaker.session.Session): A SageMaker Session
115115
object, used for SageMaker interactions. If not
116116
specified, one is created using the default AWS configuration
117-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
117+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
118118
119119
Returns:
120120
str: The ECR URI for the corresponding SageMaker Docker image.

‎src/sagemaker/jumpstart/artifacts/environment_variables.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def _retrieve_default_environment_variables(
5858
sagemaker_session (sagemaker.session.Session): A SageMaker Session
5959
object, used for SageMaker interactions. If not
6060
specified, one is created using the default AWS configuration
61-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
61+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
6262
Returns:
6363
dict: the inference environment variables to use for the model.
6464
"""

‎src/sagemaker/jumpstart/artifacts/hyperparameters.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def _retrieve_default_hyperparameters(
6262
sagemaker_session (sagemaker.session.Session): A SageMaker Session
6363
object, used for SageMaker interactions. If not
6464
specified, one is created using the default AWS configuration
65-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
65+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
6666
Returns:
6767
dict: the hyperparameters to use for the model.
6868
"""

‎src/sagemaker/jumpstart/artifacts/image_uris.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ def _retrieve_image_uri(
9494
sagemaker_session (sagemaker.session.Session): A SageMaker Session
9595
object, used for SageMaker interactions. If not
9696
specified, one is created using the default AWS configuration
97-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
97+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
9898
Returns:
9999
str: the ECR URI for the corresponding SageMaker Docker image.
100100

‎src/sagemaker/jumpstart/artifacts/incremental_training.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def _model_supports_incremental_training(
5353
sagemaker_session (sagemaker.session.Session): A SageMaker Session
5454
object, used for SageMaker interactions. If not
5555
specified, one is created using the default AWS configuration
56-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
56+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
5757
Returns:
5858
bool: the support status for incremental training.
5959
"""

‎src/sagemaker/jumpstart/artifacts/instance_types.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ def _retrieve_default_instance_type(
5959
sagemaker_session (sagemaker.session.Session): A SageMaker Session
6060
object, used for SageMaker interactions. If not
6161
specified, one is created using the default AWS configuration
62-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
62+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
6363
Returns:
6464
str: the default instance type to use for the model or None.
6565
@@ -125,7 +125,7 @@ def _retrieve_instance_types(
125125
sagemaker_session (sagemaker.session.Session): A SageMaker Session
126126
object, used for SageMaker interactions. If not
127127
specified, one is created using the default AWS configuration
128-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
128+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
129129
Returns:
130130
list: the supported instance types to use for the model or None.
131131

‎src/sagemaker/jumpstart/artifacts/kwargs.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def _retrieve_model_init_kwargs(
5555
sagemaker_session (sagemaker.session.Session): A SageMaker Session
5656
object, used for SageMaker interactions. If not
5757
specified, one is created using the default AWS configuration
58-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
58+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
5959
Returns:
6060
dict: the kwargs to use for the use case.
6161
"""
@@ -111,7 +111,7 @@ def _retrieve_model_deploy_kwargs(
111111
sagemaker_session (sagemaker.session.Session): A SageMaker Session
112112
object, used for SageMaker interactions. If not
113113
specified, one is created using the default AWS configuration
114-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
114+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
115115
116116
Returns:
117117
dict: the kwargs to use for the use case.
@@ -166,7 +166,7 @@ def _retrieve_estimator_init_kwargs(
166166
sagemaker_session (sagemaker.session.Session): A SageMaker Session
167167
object, used for SageMaker interactions. If not
168168
specified, one is created using the default AWS configuration
169-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
169+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
170170
Returns:
171171
dict: the kwargs to use for the use case.
172172
"""
@@ -222,7 +222,7 @@ def _retrieve_estimator_fit_kwargs(
222222
sagemaker_session (sagemaker.session.Session): A SageMaker Session
223223
object, used for SageMaker interactions. If not
224224
specified, one is created using the default AWS configuration
225-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
225+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
226226
227227
Returns:
228228
dict: the kwargs to use for the use case.

‎src/sagemaker/jumpstart/artifacts/metric_definitions.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ def _retrieve_default_training_metric_definitions(
5454
sagemaker_session (sagemaker.session.Session): A SageMaker Session
5555
object, used for SageMaker interactions. If not
5656
specified, one is created using the default AWS configuration
57-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
57+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
5858
Returns:
5959
list: the default training metric definitions to use for the model or None.
6060
"""

‎src/sagemaker/jumpstart/artifacts/model_packages.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ def _retrieve_model_package_arn(
5454
sagemaker_session (sagemaker.session.Session): A SageMaker Session
5555
object, used for SageMaker interactions. If not
5656
specified, one is created using the default AWS configuration
57-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
57+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
5858
5959
Returns:
6060
str: the model package arn to use for the model or None.
@@ -115,7 +115,7 @@ def _retrieve_model_package_model_artifact_s3_uri(
115115
sagemaker_session (sagemaker.session.Session): A SageMaker Session
116116
object, used for SageMaker interactions. If not
117117
specified, one is created using the default AWS configuration
118-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
118+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
119119
Returns:
120120
str: the model package artifact uri to use for the model or None.
121121

‎src/sagemaker/jumpstart/artifacts/model_uris.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ def _retrieve_model_uri(
6161
sagemaker_session (sagemaker.session.Session): A SageMaker Session
6262
object, used for SageMaker interactions. If not
6363
specified, one is created using the default AWS configuration
64-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
64+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
6565
Returns:
6666
str: the model artifact S3 URI for the corresponding model.
6767
@@ -129,7 +129,7 @@ def _model_supports_training_model_uri(
129129
sagemaker_session (sagemaker.session.Session): A SageMaker Session
130130
object, used for SageMaker interactions. If not
131131
specified, one is created using the default AWS configuration
132-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
132+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
133133
Returns:
134134
bool: the support status for model uri with training.
135135
"""

‎src/sagemaker/jumpstart/artifacts/predictors.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ def _retrieve_default_deserializer(
9595
sagemaker_session (sagemaker.session.Session): A SageMaker Session
9696
object, used for SageMaker interactions. If not
9797
specified, one is created using the default AWS configuration
98-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
98+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
9999
100100
Returns:
101101
BaseDeserializer: the default deserializer to use for the model.
@@ -139,7 +139,7 @@ def _retrieve_default_serializer(
139139
sagemaker_session (sagemaker.session.Session): A SageMaker Session
140140
object, used for SageMaker interactions. If not
141141
specified, one is created using the default AWS configuration
142-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
142+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
143143
Returns:
144144
BaseSerializer: the default serializer to use for the model.
145145
"""
@@ -182,7 +182,7 @@ def _retrieve_deserializer_options(
182182
sagemaker_session (sagemaker.session.Session): A SageMaker Session
183183
object, used for SageMaker interactions. If not
184184
specified, one is created using the default AWS configuration
185-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
185+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
186186
Returns:
187187
List[BaseDeserializer]: the supported deserializers to use for the model.
188188
"""
@@ -239,7 +239,7 @@ def _retrieve_serializer_options(
239239
sagemaker_session (sagemaker.session.Session): A SageMaker Session
240240
object, used for SageMaker interactions. If not
241241
specified, one is created using the default AWS configuration
242-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
242+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
243243
Returns:
244244
List[BaseSerializer]: the supported serializers to use for the model.
245245
"""
@@ -296,7 +296,7 @@ def _retrieve_default_content_type(
296296
sagemaker_session (sagemaker.session.Session): A SageMaker Session
297297
object, used for SageMaker interactions. If not
298298
specified, one is created using the default AWS configuration
299-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
299+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
300300
Returns:
301301
str: the default content type to use for the model.
302302
"""
@@ -344,7 +344,7 @@ def _retrieve_default_accept_type(
344344
sagemaker_session (sagemaker.session.Session): A SageMaker Session
345345
object, used for SageMaker interactions. If not
346346
specified, one is created using the default AWS configuration
347-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
347+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
348348
Returns:
349349
str: the default accept type to use for the model.
350350
"""
@@ -393,7 +393,7 @@ def _retrieve_supported_accept_types(
393393
sagemaker_session (sagemaker.session.Session): A SageMaker Session
394394
object, used for SageMaker interactions. If not
395395
specified, one is created using the default AWS configuration
396-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
396+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
397397
Returns:
398398
list: the supported accept types to use for the model.
399399
"""
@@ -442,7 +442,7 @@ def _retrieve_supported_content_types(
442442
sagemaker_session (sagemaker.session.Session): A SageMaker Session
443443
object, used for SageMaker interactions. If not
444444
specified, one is created using the default AWS configuration
445-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
445+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
446446
Returns:
447447
list: the supported content types to use for the model.
448448
"""

‎src/sagemaker/jumpstart/artifacts/resource_names.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def _retrieve_resource_name_base(
5353
sagemaker_session (sagemaker.session.Session): A SageMaker Session
5454
object, used for SageMaker interactions. If not
5555
specified, one is created using the default AWS configuration
56-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
56+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
5757
Returns:
5858
str: the default resource name.
5959
"""

‎src/sagemaker/jumpstart/artifacts/script_uris.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ def _retrieve_script_uri(
6161
sagemaker_session (sagemaker.session.Session): A SageMaker Session
6262
object, used for SageMaker interactions. If not
6363
specified, one is created using the default AWS configuration
64-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
64+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
6565
Returns:
6666
str: the model script URI for the corresponding model.
6767
@@ -127,7 +127,7 @@ def _model_supports_inference_script_uri(
127127
sagemaker_session (sagemaker.session.Session): A SageMaker Session
128128
object, used for SageMaker interactions. If not
129129
specified, one is created using the default AWS configuration
130-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
130+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
131131
Returns:
132132
bool: the support status for script uri with inference.
133133
"""

‎src/sagemaker/jumpstart/utils.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ def verify_model_region_and_return_specs(
403403
sagemaker_session (sagemaker.session.Session): A SageMaker Session
404404
object, used for SageMaker interactions. If not
405405
specified, one is created using the default AWS configuration
406-
chain. (Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
406+
chain. (Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
407407
408408
Raises:
409409
NotImplementedError: If the scope is not supported.

‎src/sagemaker/jumpstart/validators.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ def validate_hyperparameters(
187187
region (str): Region for which to validate hyperparameters. (Default: JumpStart
188188
default region).
189189
sagemaker_session (Optional[Session]): Custom SageMaker Session to use.
190-
(Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
190+
(Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
191191
tolerate_vulnerable_model (bool): True if vulnerable versions of model
192192
specifications should be tolerated (exception not raised). If False, raises an
193193
exception if the script used by this version of the model has dependencies with known

‎src/sagemaker/predictor.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ def retrieve_default(
4545
Args:
4646
endpoint_name (str): Endpoint name for which to create a predictor.
4747
sagemaker_session (Session): The SageMaker Session to attach to the Predictor.
48-
(Default: DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
48+
(Default: sagemaker.jumpstart.constants.DEFAULT_JUMPSTART_SAGEMAKER_SESSION).
4949
region (str): The AWS Region for which to retrieve the default predictor.
5050
(Default: None).
5151
model_id (str): The model ID of the model for which to

0 commit comments

Comments
 (0)