Skip to content

Commit 0addcb3

Browse files
author
Ruban Hussain
committed
feature: SDK Defaults Config - Session Default S3 Bucket and Prefix - Rename sagemaker_config keys
1 parent 4d97794 commit 0addcb3

File tree

10 files changed

+25
-27
lines changed

10 files changed

+25
-27
lines changed

src/sagemaker/config/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@
135135
SCHEMA_VERSION,
136136
PYTHON_SDK,
137137
MODULES,
138-
SESSION_DEFAULT_S3_BUCKET,
139-
SESSION_DEFAULT_S3_OBJECT_KEY_PREFIX,
138+
DEFAULT_S3_BUCKET,
139+
DEFAULT_S3_OBJECT_KEY_PREFIX,
140140
SESSION,
141141
)

src/sagemaker/config/config_schema.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@
9090
ADDITIONAL_PROPERTIES = "additionalProperties"
9191
ENABLE_INTER_CONTAINER_TRAFFIC_ENCRYPTION = "EnableInterContainerTrafficEncryption"
9292
SESSION = "Session"
93-
SESSION_DEFAULT_S3_BUCKET = "SessionDefaultS3Bucket"
94-
SESSION_DEFAULT_S3_OBJECT_KEY_PREFIX = "SessionDefaultS3ObjectKeyPrefix"
93+
DEFAULT_S3_BUCKET = "DefaultS3Bucket"
94+
DEFAULT_S3_OBJECT_KEY_PREFIX = "DefaultS3ObjectKeyPrefix"
9595

9696

9797
def _simple_path(*args: str):
@@ -299,10 +299,10 @@ def _simple_path(*args: str):
299299
SAGEMAKER, TRAINING_JOB, ENABLE_INTER_CONTAINER_TRAFFIC_ENCRYPTION
300300
)
301301
SESSION_DEFAULT_S3_BUCKET_PATH = _simple_path(
302-
SAGEMAKER, PYTHON_SDK, MODULES, SESSION, SESSION_DEFAULT_S3_BUCKET
302+
SAGEMAKER, PYTHON_SDK, MODULES, SESSION, DEFAULT_S3_BUCKET
303303
)
304304
SESSION_DEFAULT_S3_OBJECT_KEY_PREFIX_PATH = _simple_path(
305-
SAGEMAKER, PYTHON_SDK, MODULES, SESSION, SESSION_DEFAULT_S3_OBJECT_KEY_PREFIX
305+
SAGEMAKER, PYTHON_SDK, MODULES, SESSION, DEFAULT_S3_OBJECT_KEY_PREFIX
306306
)
307307

308308

@@ -497,11 +497,11 @@ def _simple_path(*args: str):
497497
TYPE: OBJECT,
498498
ADDITIONAL_PROPERTIES: False,
499499
PROPERTIES: {
500-
SESSION_DEFAULT_S3_BUCKET: {
500+
DEFAULT_S3_BUCKET: {
501501
"description": "sets `default_bucket` of Session",
502502
"$ref": "#/definitions/s3Bucket",
503503
},
504-
SESSION_DEFAULT_S3_OBJECT_KEY_PREFIX: {
504+
DEFAULT_S3_OBJECT_KEY_PREFIX: {
505505
"description": (
506506
"sets `default_bucket_prefix` of Session"
507507
),

tests/data/config/config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ SageMaker:
33
PythonSDK:
44
Modules:
55
Session:
6-
SessionDefaultS3Bucket: 'sagemaker-python-sdk-test-bucket'
7-
SessionDefaultS3ObjectKeyPrefix: 'test-prefix'
6+
DefaultS3Bucket: 'sagemaker-python-sdk-test-bucket'
7+
DefaultS3ObjectKeyPrefix: 'test-prefix'
88
RemoteFunction:
99
Dependencies: "./requirements.txt"
1010
EnvironmentVariables:

tests/integ/test_sagemaker_config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ def sagemaker_session_with_dynamically_generated_sagemaker_config(
9999
"PythonSDK": {
100100
"Modules": {
101101
"Session": {
102-
"SessionDefaultS3ObjectKeyPrefix": S3_KEY_PREFIX,
102+
"DefaultS3ObjectKeyPrefix": S3_KEY_PREFIX,
103103
# S3Bucket is omitted for now, because the tests support one S3 bucket at
104104
# the moment and it would be hard to validate injection of this parameter
105105
# if we use the same bucket that the rest of the tests are.

tests/unit/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@
7474
SCHEMA_VERSION,
7575
PYTHON_SDK,
7676
MODULES,
77-
SESSION_DEFAULT_S3_BUCKET,
78-
SESSION_DEFAULT_S3_OBJECT_KEY_PREFIX,
77+
DEFAULT_S3_BUCKET,
78+
DEFAULT_S3_OBJECT_KEY_PREFIX,
7979
SESSION,
8080
)
8181

@@ -90,8 +90,8 @@
9090
PYTHON_SDK: {
9191
MODULES: {
9292
SESSION: {
93-
SESSION_DEFAULT_S3_BUCKET: "sagemaker-config-session-s3-bucket",
94-
SESSION_DEFAULT_S3_OBJECT_KEY_PREFIX: "test-prefix",
93+
DEFAULT_S3_BUCKET: "sagemaker-config-session-s3-bucket",
94+
DEFAULT_S3_OBJECT_KEY_PREFIX: "test-prefix",
9595
},
9696
},
9797
},

tests/unit/sagemaker/config/conftest.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ def valid_tags():
4040
@pytest.fixture()
4141
def valid_session_config():
4242
return {
43-
"SessionDefaultS3Bucket": "sagemaker-python-sdk-test-bucket",
44-
"SessionDefaultS3ObjectKeyPrefix": "test-prefix",
43+
"DefaultS3Bucket": "sagemaker-python-sdk-test-bucket",
44+
"DefaultS3ObjectKeyPrefix": "test-prefix",
4545
}
4646

4747

tests/unit/sagemaker/config/test_config_schema.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ def test_invalid_s3uri_schema(base_config_with_schema):
214214
],
215215
)
216216
def test_session_s3_bucket_schema(base_config_with_schema, bucket_name):
217-
config = {"PythonSDK": {"Modules": {"Session": {"SessionDefaultS3Bucket": bucket_name}}}}
217+
config = {"PythonSDK": {"Modules": {"Session": {"DefaultS3Bucket": bucket_name}}}}
218218
_validate_config(base_config_with_schema, config)
219219

220220

@@ -256,9 +256,7 @@ def test_invalid_session_s3_bucket_schema(base_config_with_schema, invalid_bucke
256256
],
257257
)
258258
def test_session_s3_object_key_prefix_schema(base_config_with_schema, prefix_name):
259-
config = {
260-
"PythonSDK": {"Modules": {"Session": {"SessionDefaultS3ObjectKeyPrefix": prefix_name}}}
261-
}
259+
config = {"PythonSDK": {"Modules": {"Session": {"DefaultS3ObjectKeyPrefix": prefix_name}}}}
262260
_validate_config(base_config_with_schema, config)
263261

264262

tests/unit/sagemaker/local/test_local_session.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -973,7 +973,7 @@ def test_default_bucket_with_sagemaker_config(boto_session, client):
973973
assert (
974974
session_with_config_bucket.default_bucket()
975975
== SAGEMAKER_CONFIG_SESSION["SageMaker"]["PythonSDK"]["Modules"]["Session"][
976-
"SessionDefaultS3Bucket"
976+
"DefaultS3Bucket"
977977
]
978978
)
979979

@@ -1012,7 +1012,7 @@ def test_default_bucket_prefix_with_sagemaker_config(boto_session, client):
10121012
assert (
10131013
session_with_config_prefix.default_bucket_prefix
10141014
== SAGEMAKER_CONFIG_SESSION["SageMaker"]["PythonSDK"]["Modules"]["Session"][
1015-
"SessionDefaultS3ObjectKeyPrefix"
1015+
"DefaultS3ObjectKeyPrefix"
10161016
]
10171017
)
10181018

tests/unit/sagemaker/workflow/test_pipeline_session.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ def test_default_bucket_with_sagemaker_config(boto_session, client):
342342
assert (
343343
session_with_config_bucket.default_bucket()
344344
== SAGEMAKER_CONFIG_SESSION["SageMaker"]["PythonSDK"]["Modules"]["Session"][
345-
"SessionDefaultS3Bucket"
345+
"DefaultS3Bucket"
346346
]
347347
)
348348

@@ -381,7 +381,7 @@ def test_default_bucket_prefix_with_sagemaker_config(boto_session, client):
381381
assert (
382382
session_with_config_prefix.default_bucket_prefix
383383
== SAGEMAKER_CONFIG_SESSION["SageMaker"]["PythonSDK"]["Modules"]["Session"][
384-
"SessionDefaultS3ObjectKeyPrefix"
384+
"DefaultS3ObjectKeyPrefix"
385385
]
386386
)
387387

tests/unit/test_session.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ def test_default_bucket_with_sagemaker_config(boto_session, client):
396396
assert (
397397
session_with_config_bucket.default_bucket()
398398
== SAGEMAKER_CONFIG_SESSION["SageMaker"]["PythonSDK"]["Modules"]["Session"][
399-
"SessionDefaultS3Bucket"
399+
"DefaultS3Bucket"
400400
]
401401
)
402402

@@ -438,7 +438,7 @@ def test_default_bucket_prefix_with_sagemaker_config(boto_session, client):
438438
assert (
439439
session_with_config_prefix.default_bucket_prefix
440440
== SAGEMAKER_CONFIG_SESSION["SageMaker"]["PythonSDK"]["Modules"]["Session"][
441-
"SessionDefaultS3ObjectKeyPrefix"
441+
"DefaultS3ObjectKeyPrefix"
442442
]
443443
)
444444

0 commit comments

Comments
 (0)