Skip to content

Commit ce118d2

Browse files
mohamedzeidan2021Mohamed Zeidan
andauthored
fix: allow Constraints.set_monitoring to disable monitoring for non-string features (#6325)
Per the constraints.json schema, monitoring_config_overrides is a feature-level key (a sibling of name, inferred_type, and the type-specific num_constraints/string_constraints blocks). set_monitoring previously read and wrote it inside feature["string_constraints"], which raised KeyError: 'string_constraints' for any non-string feature and, even for string features, nested the override one level too deep. Read/write the override directly on the feature dict so it works for any feature type and matches the documented schema. Adds tests/unit/sagemaker/monitor/test_monitoring_files.py. Fixes #2745 Co-authored-by: Mohamed Zeidan <zeidmo@amazon.com>
1 parent e22a54d commit ce118d2

2 files changed

Lines changed: 117 additions & 4 deletions

File tree

‎src/sagemaker/model_monitor/monitoring_files.py‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -362,10 +362,9 @@ def set_monitoring(self, enable_monitoring, feature_name=None):
362362
else:
363363
for feature in self.body_dict["features"]:
364364
if feature["name"] == feature_name:
365-
string_constraints = feature["string_constraints"]
366-
if string_constraints.get("monitoring_config_overrides") is None:
367-
string_constraints["monitoring_config_overrides"] = {}
368-
string_constraints["monitoring_config_overrides"]["evaluate_constraints"] = flag
365+
if feature.get("monitoring_config_overrides") is None:
366+
feature["monitoring_config_overrides"] = {}
367+
feature["monitoring_config_overrides"]["evaluate_constraints"] = flag
369368

370369

371370
class ConstraintViolations(ModelMonitoringFile):
Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License"). You
4+
# may not use this file except in compliance with the License. A copy of
5+
# the License is located at
6+
#
7+
# http://aws.amazon.com/apache2.0/
8+
#
9+
# or in the "license" file accompanying this file. This file is
10+
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11+
# ANY KIND, either express or implied. See the License for the specific
12+
# language governing permissions and limitations under the License.
13+
"""Unit tests for the Constraints.set_monitoring feature-level override."""
14+
from __future__ import absolute_import
15+
16+
import pytest
17+
18+
from sagemaker.model_monitor.monitoring_files import Constraints
19+
20+
CONSTRAINTS_S3_URI = "s3://bucket/constraints.json"
21+
22+
23+
def _body_dict():
24+
"""A constraints body with one non-string (binary/integral) and one string feature."""
25+
return {
26+
"version": 0.0,
27+
"features": [
28+
{
29+
"name": "Churn",
30+
"inferred_type": "Integral",
31+
"num_constraints": {"is_non_negative": True},
32+
},
33+
{
34+
"name": "State",
35+
"inferred_type": "String",
36+
"string_constraints": {"domains": ["OH", "NJ"]},
37+
},
38+
],
39+
"monitoring_config": {"evaluate_constraints": "Enabled"},
40+
}
41+
42+
43+
def _make_constraints():
44+
return Constraints(body_dict=_body_dict(), constraints_file_s3_uri=CONSTRAINTS_S3_URI)
45+
46+
47+
def _feature(constraints, name):
48+
return next(f for f in constraints.body_dict["features"] if f["name"] == name)
49+
50+
51+
def test_set_monitoring_disables_non_string_feature():
52+
# Regression test for GitHub issue #2745: set_monitoring must work for a
53+
# non-string (e.g. binary/integral) feature that has no string_constraints section.
54+
constraints = _make_constraints()
55+
56+
constraints.set_monitoring(False, feature_name="Churn")
57+
58+
churn = _feature(constraints, "Churn")
59+
assert churn["monitoring_config_overrides"] == {"evaluate_constraints": "Disabled"}
60+
# The override must live at the feature level, not nested inside num_constraints.
61+
assert "monitoring_config_overrides" not in churn["num_constraints"]
62+
63+
64+
def test_set_monitoring_override_is_feature_level_for_string_feature():
65+
# Even for a string feature, the override belongs at the feature level (per the
66+
# constraints.json schema), not inside the string_constraints section.
67+
constraints = _make_constraints()
68+
69+
constraints.set_monitoring(False, feature_name="State")
70+
71+
state = _feature(constraints, "State")
72+
assert state["monitoring_config_overrides"] == {"evaluate_constraints": "Disabled"}
73+
assert "monitoring_config_overrides" not in state["string_constraints"]
74+
75+
76+
def test_set_monitoring_enable_maps_to_enabled():
77+
constraints = _make_constraints()
78+
79+
constraints.set_monitoring(True, feature_name="Churn")
80+
81+
assert _feature(constraints, "Churn")["monitoring_config_overrides"] == {
82+
"evaluate_constraints": "Enabled"
83+
}
84+
85+
86+
def test_set_monitoring_preserves_existing_overrides():
87+
body = _body_dict()
88+
body["features"][0]["monitoring_config_overrides"] = {"some_other_flag": "keep"}
89+
constraints = Constraints(body_dict=body, constraints_file_s3_uri=CONSTRAINTS_S3_URI)
90+
91+
constraints.set_monitoring(False, feature_name="Churn")
92+
93+
overrides = _feature(constraints, "Churn")["monitoring_config_overrides"]
94+
assert overrides == {"some_other_flag": "keep", "evaluate_constraints": "Disabled"}
95+
96+
97+
def test_set_monitoring_without_feature_name_sets_top_level_flag():
98+
constraints = _make_constraints()
99+
100+
constraints.set_monitoring(False)
101+
102+
assert constraints.body_dict["monitoring_config"]["evaluate_constraints"] == "Disabled"
103+
104+
105+
@pytest.mark.parametrize("enable,expected", [(True, "Enabled"), (False, "Disabled")])
106+
def test_monitoring_api_map(enable, expected):
107+
constraints = _make_constraints()
108+
109+
constraints.set_monitoring(enable, feature_name="Churn")
110+
111+
assert (
112+
_feature(constraints, "Churn")["monitoring_config_overrides"]["evaluate_constraints"]
113+
== expected
114+
)

0 commit comments

Comments
 (0)