Closed
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
12 changes: 9 additions & 3 deletions sagemaker-core/src/sagemaker/core/modules/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@

from sagemaker.core.shapes import Unassigned
from sagemaker.core.modules import logger
from sagemaker.core.helper.pipeline_variable import PipelineVariable


def _is_valid_s3_uri(path: str, path_type: Literal["File", "Directory", "Any"] = "Any") -> bool:
Expand DownExpand Up@@ -129,19 +130,24 @@ def safe_serialize(data):

This function handles the following cases:
1. If `data` is a string, it returns the string as-is without wrapping in quotes.
2. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
2. If `data` is of type `PipelineVariable`, it returns the PipelineVariable object
as-is for pipeline serialization.
3. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
the JSON-encoded string using `json.dumps()`.
3. If `data` cannot be serialized (e.g., a custom object), it returns the string
4. If `data` cannot be serialized (e.g., a custom object), it returns the string
representation of the data using `str(data)`.

Args:
data (Any): The data to serialize.

Returns:
str: The serialized JSON-compatible string or the string representation of the input.
str | PipelineVariable: The serialized JSON-compatible string, the string
representation of the input, or the PipelineVariable object as-is.
"""
if isinstance(data, str):
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.
return data
elif isinstance(data, PipelineVariable):
return data
try:
return json.dumps(data)
except TypeError:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize in sagemaker.core.modules.utils with PipelineVariable support.

Verifies that safe_serialize correctly handles PipelineVariable objects
(e.g., ParameterInteger, ParameterString) by returning them as-is rather
than attempting str() conversion which would raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.core.modules.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Comment thread
aviruthen marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@

from sagemaker.core.helper.session_helper import Session
from sagemaker.core.helper.pipeline_variable import PipelineVariable, StrPipeVar
from sagemaker.core.workflow.parameters import ParameterString
from sagemaker.core.workflow.parameters import ParameterString, ParameterInteger
from sagemaker.train.model_trainer import ModelTrainer, Mode
from sagemaker.train.configs import (
Compute,
Expand DownExpand Up@@ -176,3 +176,68 @@ def test_training_image_rejects_invalid_type(self):
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
)


class TestModelTrainerPipelineVariableHyperparameters:
"""Test that PipelineVariable objects work correctly in ModelTrainer hyperparameters."""

def test_hyperparameters_with_parameter_integer(self):
"""ParameterInteger in hyperparameters should be preserved through _create_training_job_args.

This test documents the exact bug scenario from GH#5504: safe_serialize
would fall back to str(data) for PipelineVariable objects, but
PipelineVariable.__str__ intentionally raises TypeError.
Before the fix, this call would have raised TypeError.
"""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
Comment thread
aviruthen marked this conversation as resolved.
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"max_depth": max_depth},
)
# This call would have raised TypeError before the fix (GH#5504)
args = trainer._create_training_job_args()
# PipelineVariable should be preserved as-is, not stringified
Comment thread
aviruthen marked this conversation as resolved.
assert args["hyper_parameters"]["max_depth"] is max_depth

def test_hyperparameters_with_parameter_string(self):
Comment thread
aviruthen marked this conversation as resolved.
"""ParameterString in hyperparameters should be preserved."""
algo = ParameterString(name="Algorithm", default_value="xgboost")
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"algorithm": algo},
)
args = trainer._create_training_job_args()
assert args["hyper_parameters"]["algorithm"] is algo

def test_hyperparameters_with_mixed_pipeline_and_static_values(self):
"""Mixed PipelineVariable and static values should both be handled correctly."""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={
"max_depth": max_depth,
"eta": 0.1,
"objective": "binary:logistic",
"num_round": 100,
},
)
args = trainer._create_training_job_args()
hp = args["hyper_parameters"]
# PipelineVariable preserved as-is
assert hp["max_depth"] is max_depth
# Static values serialized to strings
assert hp["eta"] == "0.1"
assert hp["objective"] == "binary:logistic"
assert hp["num_round"] == "100"
92 changes: 92 additions & 0 deletions sagemaker-train/tests/unit/train/test_safe_serialize.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize with PipelineVariable support.

Verifies that safe_serialize in sagemaker.train.utils correctly handles
PipelineVariable objects (e.g., ParameterInteger, ParameterString) by
returning them as-is rather than attempting str() conversion which would
raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.train.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
Comment thread
aviruthen marked this conversation as resolved.
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"
assert safe_serialize("12345") == "12345"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_float(self):
"""Floats should be JSON-serialized to string."""
assert safe_serialize(3.14) == "3.14"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_list(self):
"""Lists should be JSON-serialized."""
assert safe_serialize([1, 2, 3]) == "[1, 2, 3]"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Closed
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
12 changes: 9 additions & 3 deletions sagemaker-core/src/sagemaker/core/modules/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@

from sagemaker.core.shapes import Unassigned
from sagemaker.core.modules import logger
from sagemaker.core.helper.pipeline_variable import PipelineVariable


def _is_valid_s3_uri(path: str, path_type: Literal["File", "Directory", "Any"] = "Any") -> bool:
Expand DownExpand Up@@ -129,19 +130,24 @@ def safe_serialize(data):

This function handles the following cases:
1. If `data` is a string, it returns the string as-is without wrapping in quotes.
2. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
2. If `data` is of type `PipelineVariable`, it returns the PipelineVariable object
as-is for pipeline serialization.
3. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
the JSON-encoded string using `json.dumps()`.
3. If `data` cannot be serialized (e.g., a custom object), it returns the string
4. If `data` cannot be serialized (e.g., a custom object), it returns the string
representation of the data using `str(data)`.

Args:
data (Any): The data to serialize.

Returns:
str: The serialized JSON-compatible string or the string representation of the input.
str | PipelineVariable: The serialized JSON-compatible string, the string
representation of the input, or the PipelineVariable object as-is.
"""
if isinstance(data, str):
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.
return data
elif isinstance(data, PipelineVariable):
return data
try:
return json.dumps(data)
except TypeError:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize in sagemaker.core.modules.utils with PipelineVariable support.

Verifies that safe_serialize correctly handles PipelineVariable objects
(e.g., ParameterInteger, ParameterString) by returning them as-is rather
than attempting str() conversion which would raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.core.modules.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Comment thread
aviruthen marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@

from sagemaker.core.helper.session_helper import Session
from sagemaker.core.helper.pipeline_variable import PipelineVariable, StrPipeVar
from sagemaker.core.workflow.parameters import ParameterString
from sagemaker.core.workflow.parameters import ParameterString, ParameterInteger
from sagemaker.train.model_trainer import ModelTrainer, Mode
from sagemaker.train.configs import (
Compute,
Expand DownExpand Up@@ -176,3 +176,68 @@ def test_training_image_rejects_invalid_type(self):
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
)


class TestModelTrainerPipelineVariableHyperparameters:
"""Test that PipelineVariable objects work correctly in ModelTrainer hyperparameters."""

def test_hyperparameters_with_parameter_integer(self):
"""ParameterInteger in hyperparameters should be preserved through _create_training_job_args.

This test documents the exact bug scenario from GH#5504: safe_serialize
would fall back to str(data) for PipelineVariable objects, but
PipelineVariable.__str__ intentionally raises TypeError.
Before the fix, this call would have raised TypeError.
"""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
Comment thread
aviruthen marked this conversation as resolved.
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"max_depth": max_depth},
)
# This call would have raised TypeError before the fix (GH#5504)
args = trainer._create_training_job_args()
# PipelineVariable should be preserved as-is, not stringified
Comment thread
aviruthen marked this conversation as resolved.
assert args["hyper_parameters"]["max_depth"] is max_depth

def test_hyperparameters_with_parameter_string(self):
Comment thread
aviruthen marked this conversation as resolved.
"""ParameterString in hyperparameters should be preserved."""
algo = ParameterString(name="Algorithm", default_value="xgboost")
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"algorithm": algo},
)
args = trainer._create_training_job_args()
assert args["hyper_parameters"]["algorithm"] is algo

def test_hyperparameters_with_mixed_pipeline_and_static_values(self):
"""Mixed PipelineVariable and static values should both be handled correctly."""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={
"max_depth": max_depth,
"eta": 0.1,
"objective": "binary:logistic",
"num_round": 100,
},
)
args = trainer._create_training_job_args()
hp = args["hyper_parameters"]
# PipelineVariable preserved as-is
assert hp["max_depth"] is max_depth
# Static values serialized to strings
assert hp["eta"] == "0.1"
assert hp["objective"] == "binary:logistic"
assert hp["num_round"] == "100"
92 changes: 92 additions & 0 deletions sagemaker-train/tests/unit/train/test_safe_serialize.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize with PipelineVariable support.

Verifies that safe_serialize in sagemaker.train.utils correctly handles
PipelineVariable objects (e.g., ParameterInteger, ParameterString) by
returning them as-is rather than attempting str() conversion which would
raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.train.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
Comment thread
aviruthen marked this conversation as resolved.
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"
assert safe_serialize("12345") == "12345"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_float(self):
"""Floats should be JSON-serialized to string."""
assert safe_serialize(3.14) == "3.14"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_list(self):
"""Lists should be JSON-serialized."""
assert safe_serialize([1, 2, 3]) == "[1, 2, 3]"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
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
12 changes: 9 additions & 3 deletions sagemaker-core/src/sagemaker/core/modules/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@

from sagemaker.core.shapes import Unassigned
from sagemaker.core.modules import logger
from sagemaker.core.helper.pipeline_variable import PipelineVariable


def _is_valid_s3_uri(path: str, path_type: Literal["File", "Directory", "Any"] = "Any") -> bool:
Expand DownExpand Up@@ -129,19 +130,24 @@ def safe_serialize(data):

This function handles the following cases:
1. If `data` is a string, it returns the string as-is without wrapping in quotes.
2. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
2. If `data` is of type `PipelineVariable`, it returns the PipelineVariable object
as-is for pipeline serialization.
3. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
the JSON-encoded string using `json.dumps()`.
3. If `data` cannot be serialized (e.g., a custom object), it returns the string
4. If `data` cannot be serialized (e.g., a custom object), it returns the string
representation of the data using `str(data)`.

Args:
data (Any): The data to serialize.

Returns:
str: The serialized JSON-compatible string or the string representation of the input.
str | PipelineVariable: The serialized JSON-compatible string, the string
representation of the input, or the PipelineVariable object as-is.
"""
if isinstance(data, str):
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.
return data
elif isinstance(data, PipelineVariable):
return data
try:
return json.dumps(data)
except TypeError:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize in sagemaker.core.modules.utils with PipelineVariable support.

Verifies that safe_serialize correctly handles PipelineVariable objects
(e.g., ParameterInteger, ParameterString) by returning them as-is rather
than attempting str() conversion which would raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.core.modules.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Comment thread
aviruthen marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@

from sagemaker.core.helper.session_helper import Session
from sagemaker.core.helper.pipeline_variable import PipelineVariable, StrPipeVar
from sagemaker.core.workflow.parameters import ParameterString
from sagemaker.core.workflow.parameters import ParameterString, ParameterInteger
from sagemaker.train.model_trainer import ModelTrainer, Mode
from sagemaker.train.configs import (
Compute,
Expand DownExpand Up@@ -176,3 +176,68 @@ def test_training_image_rejects_invalid_type(self):
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
)


class TestModelTrainerPipelineVariableHyperparameters:
"""Test that PipelineVariable objects work correctly in ModelTrainer hyperparameters."""

def test_hyperparameters_with_parameter_integer(self):
"""ParameterInteger in hyperparameters should be preserved through _create_training_job_args.

This test documents the exact bug scenario from GH#5504: safe_serialize
would fall back to str(data) for PipelineVariable objects, but
PipelineVariable.__str__ intentionally raises TypeError.
Before the fix, this call would have raised TypeError.
"""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
Comment thread
aviruthen marked this conversation as resolved.
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"max_depth": max_depth},
)
# This call would have raised TypeError before the fix (GH#5504)
args = trainer._create_training_job_args()
# PipelineVariable should be preserved as-is, not stringified
Comment thread
aviruthen marked this conversation as resolved.
assert args["hyper_parameters"]["max_depth"] is max_depth

def test_hyperparameters_with_parameter_string(self):
Comment thread
aviruthen marked this conversation as resolved.
"""ParameterString in hyperparameters should be preserved."""
algo = ParameterString(name="Algorithm", default_value="xgboost")
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"algorithm": algo},
)
args = trainer._create_training_job_args()
assert args["hyper_parameters"]["algorithm"] is algo

def test_hyperparameters_with_mixed_pipeline_and_static_values(self):
"""Mixed PipelineVariable and static values should both be handled correctly."""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={
"max_depth": max_depth,
"eta": 0.1,
"objective": "binary:logistic",
"num_round": 100,
},
)
args = trainer._create_training_job_args()
hp = args["hyper_parameters"]
# PipelineVariable preserved as-is
assert hp["max_depth"] is max_depth
# Static values serialized to strings
assert hp["eta"] == "0.1"
assert hp["objective"] == "binary:logistic"
assert hp["num_round"] == "100"
92 changes: 92 additions & 0 deletions sagemaker-train/tests/unit/train/test_safe_serialize.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize with PipelineVariable support.

Verifies that safe_serialize in sagemaker.train.utils correctly handles
PipelineVariable objects (e.g., ParameterInteger, ParameterString) by
returning them as-is rather than attempting str() conversion which would
raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.train.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
Comment thread
aviruthen marked this conversation as resolved.
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"
assert safe_serialize("12345") == "12345"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_float(self):
"""Floats should be JSON-serialized to string."""
assert safe_serialize(3.14) == "3.14"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_list(self):
"""Lists should be JSON-serialized."""
assert safe_serialize([1, 2, 3]) == "[1, 2, 3]"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
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
12 changes: 9 additions & 3 deletions sagemaker-core/src/sagemaker/core/modules/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@

from sagemaker.core.shapes import Unassigned
from sagemaker.core.modules import logger
from sagemaker.core.helper.pipeline_variable import PipelineVariable


def _is_valid_s3_uri(path: str, path_type: Literal["File", "Directory", "Any"] = "Any") -> bool:
Expand DownExpand Up@@ -129,19 +130,24 @@ def safe_serialize(data):

This function handles the following cases:
1. If `data` is a string, it returns the string as-is without wrapping in quotes.
2. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
2. If `data` is of type `PipelineVariable`, it returns the PipelineVariable object
as-is for pipeline serialization.
3. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
the JSON-encoded string using `json.dumps()`.
3. If `data` cannot be serialized (e.g., a custom object), it returns the string
4. If `data` cannot be serialized (e.g., a custom object), it returns the string
representation of the data using `str(data)`.

Args:
data (Any): The data to serialize.

Returns:
str: The serialized JSON-compatible string or the string representation of the input.
str | PipelineVariable: The serialized JSON-compatible string, the string
representation of the input, or the PipelineVariable object as-is.
"""
if isinstance(data, str):
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.
return data
elif isinstance(data, PipelineVariable):
return data
try:
return json.dumps(data)
except TypeError:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize in sagemaker.core.modules.utils with PipelineVariable support.

Verifies that safe_serialize correctly handles PipelineVariable objects
(e.g., ParameterInteger, ParameterString) by returning them as-is rather
than attempting str() conversion which would raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.core.modules.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Comment thread
aviruthen marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@

from sagemaker.core.helper.session_helper import Session
from sagemaker.core.helper.pipeline_variable import PipelineVariable, StrPipeVar
from sagemaker.core.workflow.parameters import ParameterString
from sagemaker.core.workflow.parameters import ParameterString, ParameterInteger
from sagemaker.train.model_trainer import ModelTrainer, Mode
from sagemaker.train.configs import (
Compute,
Expand DownExpand Up@@ -176,3 +176,68 @@ def test_training_image_rejects_invalid_type(self):
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
)


class TestModelTrainerPipelineVariableHyperparameters:
"""Test that PipelineVariable objects work correctly in ModelTrainer hyperparameters."""

def test_hyperparameters_with_parameter_integer(self):
"""ParameterInteger in hyperparameters should be preserved through _create_training_job_args.

This test documents the exact bug scenario from GH#5504: safe_serialize
would fall back to str(data) for PipelineVariable objects, but
PipelineVariable.__str__ intentionally raises TypeError.
Before the fix, this call would have raised TypeError.
"""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
Comment thread
aviruthen marked this conversation as resolved.
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"max_depth": max_depth},
)
# This call would have raised TypeError before the fix (GH#5504)
args = trainer._create_training_job_args()
# PipelineVariable should be preserved as-is, not stringified
Comment thread
aviruthen marked this conversation as resolved.
assert args["hyper_parameters"]["max_depth"] is max_depth

def test_hyperparameters_with_parameter_string(self):
Comment thread
aviruthen marked this conversation as resolved.
"""ParameterString in hyperparameters should be preserved."""
algo = ParameterString(name="Algorithm", default_value="xgboost")
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"algorithm": algo},
)
args = trainer._create_training_job_args()
assert args["hyper_parameters"]["algorithm"] is algo

def test_hyperparameters_with_mixed_pipeline_and_static_values(self):
"""Mixed PipelineVariable and static values should both be handled correctly."""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={
"max_depth": max_depth,
"eta": 0.1,
"objective": "binary:logistic",
"num_round": 100,
},
)
args = trainer._create_training_job_args()
hp = args["hyper_parameters"]
# PipelineVariable preserved as-is
assert hp["max_depth"] is max_depth
# Static values serialized to strings
assert hp["eta"] == "0.1"
assert hp["objective"] == "binary:logistic"
assert hp["num_round"] == "100"
92 changes: 92 additions & 0 deletions sagemaker-train/tests/unit/train/test_safe_serialize.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize with PipelineVariable support.

Verifies that safe_serialize in sagemaker.train.utils correctly handles
PipelineVariable objects (e.g., ParameterInteger, ParameterString) by
returning them as-is rather than attempting str() conversion which would
raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.train.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
Comment thread
aviruthen marked this conversation as resolved.
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"
assert safe_serialize("12345") == "12345"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_float(self):
"""Floats should be JSON-serialized to string."""
assert safe_serialize(3.14) == "3.14"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_list(self):
"""Lists should be JSON-serialized."""
assert safe_serialize([1, 2, 3]) == "[1, 2, 3]"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Closed
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
12 changes: 9 additions & 3 deletions sagemaker-core/src/sagemaker/core/modules/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@

from sagemaker.core.shapes import Unassigned
from sagemaker.core.modules import logger
from sagemaker.core.helper.pipeline_variable import PipelineVariable


def _is_valid_s3_uri(path: str, path_type: Literal["File", "Directory", "Any"] = "Any") -> bool:
Expand DownExpand Up@@ -129,19 +130,24 @@ def safe_serialize(data):

This function handles the following cases:
1. If `data` is a string, it returns the string as-is without wrapping in quotes.
2. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
2. If `data` is of type `PipelineVariable`, it returns the PipelineVariable object
as-is for pipeline serialization.
3. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
the JSON-encoded string using `json.dumps()`.
3. If `data` cannot be serialized (e.g., a custom object), it returns the string
4. If `data` cannot be serialized (e.g., a custom object), it returns the string
representation of the data using `str(data)`.

Args:
data (Any): The data to serialize.

Returns:
str: The serialized JSON-compatible string or the string representation of the input.
str | PipelineVariable: The serialized JSON-compatible string, the string
representation of the input, or the PipelineVariable object as-is.
"""
if isinstance(data, str):
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.
return data
elif isinstance(data, PipelineVariable):
return data
try:
return json.dumps(data)
except TypeError:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize in sagemaker.core.modules.utils with PipelineVariable support.

Verifies that safe_serialize correctly handles PipelineVariable objects
(e.g., ParameterInteger, ParameterString) by returning them as-is rather
than attempting str() conversion which would raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.core.modules.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Comment thread
aviruthen marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@

from sagemaker.core.helper.session_helper import Session
from sagemaker.core.helper.pipeline_variable import PipelineVariable, StrPipeVar
from sagemaker.core.workflow.parameters import ParameterString
from sagemaker.core.workflow.parameters import ParameterString, ParameterInteger
from sagemaker.train.model_trainer import ModelTrainer, Mode
from sagemaker.train.configs import (
Compute,
Expand DownExpand Up@@ -176,3 +176,68 @@ def test_training_image_rejects_invalid_type(self):
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
)


class TestModelTrainerPipelineVariableHyperparameters:
"""Test that PipelineVariable objects work correctly in ModelTrainer hyperparameters."""

def test_hyperparameters_with_parameter_integer(self):
"""ParameterInteger in hyperparameters should be preserved through _create_training_job_args.

This test documents the exact bug scenario from GH#5504: safe_serialize
would fall back to str(data) for PipelineVariable objects, but
PipelineVariable.__str__ intentionally raises TypeError.
Before the fix, this call would have raised TypeError.
"""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
Comment thread
aviruthen marked this conversation as resolved.
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"max_depth": max_depth},
)
# This call would have raised TypeError before the fix (GH#5504)
args = trainer._create_training_job_args()
# PipelineVariable should be preserved as-is, not stringified
Comment thread
aviruthen marked this conversation as resolved.
assert args["hyper_parameters"]["max_depth"] is max_depth

def test_hyperparameters_with_parameter_string(self):
Comment thread
aviruthen marked this conversation as resolved.
"""ParameterString in hyperparameters should be preserved."""
algo = ParameterString(name="Algorithm", default_value="xgboost")
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"algorithm": algo},
)
args = trainer._create_training_job_args()
assert args["hyper_parameters"]["algorithm"] is algo

def test_hyperparameters_with_mixed_pipeline_and_static_values(self):
"""Mixed PipelineVariable and static values should both be handled correctly."""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={
"max_depth": max_depth,
"eta": 0.1,
"objective": "binary:logistic",
"num_round": 100,
},
)
args = trainer._create_training_job_args()
hp = args["hyper_parameters"]
# PipelineVariable preserved as-is
assert hp["max_depth"] is max_depth
# Static values serialized to strings
assert hp["eta"] == "0.1"
assert hp["objective"] == "binary:logistic"
assert hp["num_round"] == "100"
92 changes: 92 additions & 0 deletions sagemaker-train/tests/unit/train/test_safe_serialize.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize with PipelineVariable support.

Verifies that safe_serialize in sagemaker.train.utils correctly handles
PipelineVariable objects (e.g., ParameterInteger, ParameterString) by
returning them as-is rather than attempting str() conversion which would
raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.train.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
Comment thread
aviruthen marked this conversation as resolved.
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"
assert safe_serialize("12345") == "12345"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_float(self):
"""Floats should be JSON-serialized to string."""
assert safe_serialize(3.14) == "3.14"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_list(self):
"""Lists should be JSON-serialized."""
assert safe_serialize([1, 2, 3]) == "[1, 2, 3]"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
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
12 changes: 9 additions & 3 deletions sagemaker-core/src/sagemaker/core/modules/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@

from sagemaker.core.shapes import Unassigned
from sagemaker.core.modules import logger
from sagemaker.core.helper.pipeline_variable import PipelineVariable


def _is_valid_s3_uri(path: str, path_type: Literal["File", "Directory", "Any"] = "Any") -> bool:
Expand DownExpand Up@@ -129,19 +130,24 @@ def safe_serialize(data):

This function handles the following cases:
1. If `data` is a string, it returns the string as-is without wrapping in quotes.
2. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
2. If `data` is of type `PipelineVariable`, it returns the PipelineVariable object
as-is for pipeline serialization.
3. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
the JSON-encoded string using `json.dumps()`.
3. If `data` cannot be serialized (e.g., a custom object), it returns the string
4. If `data` cannot be serialized (e.g., a custom object), it returns the string
representation of the data using `str(data)`.

Args:
data (Any): The data to serialize.

Returns:
str: The serialized JSON-compatible string or the string representation of the input.
str | PipelineVariable: The serialized JSON-compatible string, the string
representation of the input, or the PipelineVariable object as-is.
"""
if isinstance(data, str):
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.
return data
elif isinstance(data, PipelineVariable):
return data
try:
return json.dumps(data)
except TypeError:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize in sagemaker.core.modules.utils with PipelineVariable support.

Verifies that safe_serialize correctly handles PipelineVariable objects
(e.g., ParameterInteger, ParameterString) by returning them as-is rather
than attempting str() conversion which would raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.core.modules.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Comment thread
aviruthen marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@

from sagemaker.core.helper.session_helper import Session
from sagemaker.core.helper.pipeline_variable import PipelineVariable, StrPipeVar
from sagemaker.core.workflow.parameters import ParameterString
from sagemaker.core.workflow.parameters import ParameterString, ParameterInteger
from sagemaker.train.model_trainer import ModelTrainer, Mode
from sagemaker.train.configs import (
Compute,
Expand DownExpand Up@@ -176,3 +176,68 @@ def test_training_image_rejects_invalid_type(self):
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
)


class TestModelTrainerPipelineVariableHyperparameters:
"""Test that PipelineVariable objects work correctly in ModelTrainer hyperparameters."""

def test_hyperparameters_with_parameter_integer(self):
"""ParameterInteger in hyperparameters should be preserved through _create_training_job_args.

This test documents the exact bug scenario from GH#5504: safe_serialize
would fall back to str(data) for PipelineVariable objects, but
PipelineVariable.__str__ intentionally raises TypeError.
Before the fix, this call would have raised TypeError.
"""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
Comment thread
aviruthen marked this conversation as resolved.
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"max_depth": max_depth},
)
# This call would have raised TypeError before the fix (GH#5504)
args = trainer._create_training_job_args()
# PipelineVariable should be preserved as-is, not stringified
Comment thread
aviruthen marked this conversation as resolved.
assert args["hyper_parameters"]["max_depth"] is max_depth

def test_hyperparameters_with_parameter_string(self):
Comment thread
aviruthen marked this conversation as resolved.
"""ParameterString in hyperparameters should be preserved."""
algo = ParameterString(name="Algorithm", default_value="xgboost")
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"algorithm": algo},
)
args = trainer._create_training_job_args()
assert args["hyper_parameters"]["algorithm"] is algo

def test_hyperparameters_with_mixed_pipeline_and_static_values(self):
"""Mixed PipelineVariable and static values should both be handled correctly."""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={
"max_depth": max_depth,
"eta": 0.1,
"objective": "binary:logistic",
"num_round": 100,
},
)
args = trainer._create_training_job_args()
hp = args["hyper_parameters"]
# PipelineVariable preserved as-is
assert hp["max_depth"] is max_depth
# Static values serialized to strings
assert hp["eta"] == "0.1"
assert hp["objective"] == "binary:logistic"
assert hp["num_round"] == "100"
92 changes: 92 additions & 0 deletions sagemaker-train/tests/unit/train/test_safe_serialize.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize with PipelineVariable support.

Verifies that safe_serialize in sagemaker.train.utils correctly handles
PipelineVariable objects (e.g., ParameterInteger, ParameterString) by
returning them as-is rather than attempting str() conversion which would
raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.train.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
Comment thread
aviruthen marked this conversation as resolved.
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"
assert safe_serialize("12345") == "12345"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_float(self):
"""Floats should be JSON-serialized to string."""
assert safe_serialize(3.14) == "3.14"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_list(self):
"""Lists should be JSON-serialized."""
assert safe_serialize([1, 2, 3]) == "[1, 2, 3]"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
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
12 changes: 9 additions & 3 deletions sagemaker-core/src/sagemaker/core/modules/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@

from sagemaker.core.shapes import Unassigned
from sagemaker.core.modules import logger
from sagemaker.core.helper.pipeline_variable import PipelineVariable


def _is_valid_s3_uri(path: str, path_type: Literal["File", "Directory", "Any"] = "Any") -> bool:
Expand DownExpand Up@@ -129,19 +130,24 @@ def safe_serialize(data):

This function handles the following cases:
1. If `data` is a string, it returns the string as-is without wrapping in quotes.
2. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
2. If `data` is of type `PipelineVariable`, it returns the PipelineVariable object
as-is for pipeline serialization.
3. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
the JSON-encoded string using `json.dumps()`.
3. If `data` cannot be serialized (e.g., a custom object), it returns the string
4. If `data` cannot be serialized (e.g., a custom object), it returns the string
representation of the data using `str(data)`.

Args:
data (Any): The data to serialize.

Returns:
str: The serialized JSON-compatible string or the string representation of the input.
str | PipelineVariable: The serialized JSON-compatible string, the string
representation of the input, or the PipelineVariable object as-is.
"""
if isinstance(data, str):
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.
return data
elif isinstance(data, PipelineVariable):
return data
try:
return json.dumps(data)
except TypeError:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize in sagemaker.core.modules.utils with PipelineVariable support.

Verifies that safe_serialize correctly handles PipelineVariable objects
(e.g., ParameterInteger, ParameterString) by returning them as-is rather
than attempting str() conversion which would raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.core.modules.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Comment thread
aviruthen marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@

from sagemaker.core.helper.session_helper import Session
from sagemaker.core.helper.pipeline_variable import PipelineVariable, StrPipeVar
from sagemaker.core.workflow.parameters import ParameterString
from sagemaker.core.workflow.parameters import ParameterString, ParameterInteger
from sagemaker.train.model_trainer import ModelTrainer, Mode
from sagemaker.train.configs import (
Compute,
Expand DownExpand Up@@ -176,3 +176,68 @@ def test_training_image_rejects_invalid_type(self):
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
)


class TestModelTrainerPipelineVariableHyperparameters:
"""Test that PipelineVariable objects work correctly in ModelTrainer hyperparameters."""

def test_hyperparameters_with_parameter_integer(self):
"""ParameterInteger in hyperparameters should be preserved through _create_training_job_args.

This test documents the exact bug scenario from GH#5504: safe_serialize
would fall back to str(data) for PipelineVariable objects, but
PipelineVariable.__str__ intentionally raises TypeError.
Before the fix, this call would have raised TypeError.
"""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
Comment thread
aviruthen marked this conversation as resolved.
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"max_depth": max_depth},
)
# This call would have raised TypeError before the fix (GH#5504)
args = trainer._create_training_job_args()
# PipelineVariable should be preserved as-is, not stringified
Comment thread
aviruthen marked this conversation as resolved.
assert args["hyper_parameters"]["max_depth"] is max_depth

def test_hyperparameters_with_parameter_string(self):
Comment thread
aviruthen marked this conversation as resolved.
"""ParameterString in hyperparameters should be preserved."""
algo = ParameterString(name="Algorithm", default_value="xgboost")
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"algorithm": algo},
)
args = trainer._create_training_job_args()
assert args["hyper_parameters"]["algorithm"] is algo

def test_hyperparameters_with_mixed_pipeline_and_static_values(self):
"""Mixed PipelineVariable and static values should both be handled correctly."""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={
"max_depth": max_depth,
"eta": 0.1,
"objective": "binary:logistic",
"num_round": 100,
},
)
args = trainer._create_training_job_args()
hp = args["hyper_parameters"]
# PipelineVariable preserved as-is
assert hp["max_depth"] is max_depth
# Static values serialized to strings
assert hp["eta"] == "0.1"
assert hp["objective"] == "binary:logistic"
assert hp["num_round"] == "100"
92 changes: 92 additions & 0 deletions sagemaker-train/tests/unit/train/test_safe_serialize.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize with PipelineVariable support.

Verifies that safe_serialize in sagemaker.train.utils correctly handles
PipelineVariable objects (e.g., ParameterInteger, ParameterString) by
returning them as-is rather than attempting str() conversion which would
raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.train.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
Comment thread
aviruthen marked this conversation as resolved.
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"
assert safe_serialize("12345") == "12345"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_float(self):
"""Floats should be JSON-serialized to string."""
assert safe_serialize(3.14) == "3.14"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_list(self):
"""Lists should be JSON-serialized."""
assert safe_serialize([1, 2, 3]) == "[1, 2, 3]"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Closed
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
12 changes: 9 additions & 3 deletions sagemaker-core/src/sagemaker/core/modules/utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@

from sagemaker.core.shapes import Unassigned
from sagemaker.core.modules import logger
from sagemaker.core.helper.pipeline_variable import PipelineVariable


def _is_valid_s3_uri(path: str, path_type: Literal["File", "Directory", "Any"] = "Any") -> bool:
Expand DownExpand Up@@ -129,19 +130,24 @@ def safe_serialize(data):

This function handles the following cases:
1. If `data` is a string, it returns the string as-is without wrapping in quotes.
2. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
2. If `data` is of type `PipelineVariable`, it returns the PipelineVariable object
as-is for pipeline serialization.
3. If `data` is serializable (e.g., a dictionary, list, int, float), it returns
the JSON-encoded string using `json.dumps()`.
3. If `data` cannot be serialized (e.g., a custom object), it returns the string
4. If `data` cannot be serialized (e.g., a custom object), it returns the string
representation of the data using `str(data)`.

Args:
data (Any): The data to serialize.

Returns:
str: The serialized JSON-compatible string or the string representation of the input.
str | PipelineVariable: The serialized JSON-compatible string, the string
representation of the input, or the PipelineVariable object as-is.
"""
if isinstance(data, str):
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.
return data
elif isinstance(data, PipelineVariable):
return data
try:
return json.dumps(data)
except TypeError:
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize in sagemaker.core.modules.utils with PipelineVariable support.

Verifies that safe_serialize correctly handles PipelineVariable objects
(e.g., ParameterInteger, ParameterString) by returning them as-is rather
than attempting str() conversion which would raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.core.modules.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString
Comment thread
aviruthen marked this conversation as resolved.
Comment thread
aviruthen marked this conversation as resolved.


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Comment thread
aviruthen marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@

from sagemaker.core.helper.session_helper import Session
from sagemaker.core.helper.pipeline_variable import PipelineVariable, StrPipeVar
from sagemaker.core.workflow.parameters import ParameterString
from sagemaker.core.workflow.parameters import ParameterString, ParameterInteger
from sagemaker.train.model_trainer import ModelTrainer, Mode
from sagemaker.train.configs import (
Compute,
Expand DownExpand Up@@ -176,3 +176,68 @@ def test_training_image_rejects_invalid_type(self):
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
)


class TestModelTrainerPipelineVariableHyperparameters:
"""Test that PipelineVariable objects work correctly in ModelTrainer hyperparameters."""

def test_hyperparameters_with_parameter_integer(self):
"""ParameterInteger in hyperparameters should be preserved through _create_training_job_args.

This test documents the exact bug scenario from GH#5504: safe_serialize
would fall back to str(data) for PipelineVariable objects, but
PipelineVariable.__str__ intentionally raises TypeError.
Before the fix, this call would have raised TypeError.
"""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
Comment thread
aviruthen marked this conversation as resolved.
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"max_depth": max_depth},
)
# This call would have raised TypeError before the fix (GH#5504)
args = trainer._create_training_job_args()
# PipelineVariable should be preserved as-is, not stringified
Comment thread
aviruthen marked this conversation as resolved.
assert args["hyper_parameters"]["max_depth"] is max_depth

def test_hyperparameters_with_parameter_string(self):
Comment thread
aviruthen marked this conversation as resolved.
"""ParameterString in hyperparameters should be preserved."""
algo = ParameterString(name="Algorithm", default_value="xgboost")
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={"algorithm": algo},
)
args = trainer._create_training_job_args()
assert args["hyper_parameters"]["algorithm"] is algo

def test_hyperparameters_with_mixed_pipeline_and_static_values(self):
"""Mixed PipelineVariable and static values should both be handled correctly."""
max_depth = ParameterInteger(name="MaxDepth", default_value=5)
trainer = ModelTrainer(
training_image=DEFAULT_IMAGE,
role=DEFAULT_ROLE,
compute=DEFAULT_COMPUTE,
stopping_condition=DEFAULT_STOPPING,
output_data_config=DEFAULT_OUTPUT,
hyperparameters={
"max_depth": max_depth,
"eta": 0.1,
"objective": "binary:logistic",
"num_round": 100,
},
)
args = trainer._create_training_job_args()
hp = args["hyper_parameters"]
# PipelineVariable preserved as-is
assert hp["max_depth"] is max_depth
# Static values serialized to strings
assert hp["eta"] == "0.1"
assert hp["objective"] == "binary:logistic"
assert hp["num_round"] == "100"
92 changes: 92 additions & 0 deletions sagemaker-train/tests/unit/train/test_safe_serialize.py
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
"""Tests for safe_serialize with PipelineVariable support.

Verifies that safe_serialize in sagemaker.train.utils correctly handles
PipelineVariable objects (e.g., ParameterInteger, ParameterString) by
returning them as-is rather than attempting str() conversion which would
raise TypeError.

See: https://github.com/aws/sagemaker-python-sdk/issues/5504
"""
from __future__ import annotations

import pytest

Comment thread
aviruthen marked this conversation as resolved.
from sagemaker.train.utils import safe_serialize
from sagemaker.core.helper.pipeline_variable import PipelineVariable
from sagemaker.core.workflow.parameters import ParameterInteger, ParameterString


class TestSafeSerializeWithPipelineVariables:
"""Test safe_serialize handles PipelineVariable objects correctly."""

@pytest.mark.parametrize("param", [
Comment thread
aviruthen marked this conversation as resolved.
ParameterInteger(name="MaxDepth", default_value=5),
ParameterString(name="Algorithm", default_value="xgboost"),
])
def test_safe_serialize_returns_pipeline_variable_as_is(self, param):
"""PipelineVariable objects should be returned as-is (identity preserved)."""
result = safe_serialize(param)
assert result is param
assert isinstance(result, PipelineVariable)

def test_pipeline_variable_str_raises_type_error(self):
"""Confirm PipelineVariable.__str__ raises TypeError (the root cause of the bug)."""
param = ParameterInteger(name="TestParam", default_value=10)
with pytest.raises(TypeError):
str(param)


class TestSafeSerializeBasicTypes:
"""Regression tests: verify basic types still work after PipelineVariable support."""

def test_safe_serialize_with_string(self):
"""Strings should be returned as-is without JSON wrapping."""
assert safe_serialize("hello") == "hello"
assert safe_serialize("12345") == "12345"

def test_safe_serialize_with_int(self):
"""Integers should be JSON-serialized to string."""
assert safe_serialize(42) == "42"

def test_safe_serialize_with_float(self):
"""Floats should be JSON-serialized to string."""
assert safe_serialize(3.14) == "3.14"

def test_safe_serialize_with_dict(self):
"""Dicts should be JSON-serialized."""
result = safe_serialize({"key": "val"})
assert result == '{"key": "val"}'

def test_safe_serialize_with_bool(self):
"""Booleans should be JSON-serialized."""
assert safe_serialize(True) == "true"
assert safe_serialize(False) == "false"

def test_safe_serialize_with_none(self):
"""None should be JSON-serialized to 'null'."""
assert safe_serialize(None) == "null"

def test_safe_serialize_with_list(self):
"""Lists should be JSON-serialized."""
assert safe_serialize([1, 2, 3]) == "[1, 2, 3]"

def test_safe_serialize_with_custom_object(self):
"""Custom objects should fall back to str()."""

class CustomObj:
def __str__(self):
return "custom"

assert safe_serialize(CustomObj()) == "custom"
Loading