Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add custom logging to SynapseMLLogger #1

Merged
merged 6 commits into from
Aug 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions core/src/main/python/synapse/ml/core/logging/SynapseMLLogger.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,14 @@ def _log_base(
num_cols: int,
execution_sec: float,
feature_name: Optional[str] = None,
custom_log_dict: Optional[Dict[str, str]] = None,
):
payload_dict = self._get_payload(class_name, method_name, num_cols, execution_sec, None)
if custom_log_dict:
if shared_keys := set(custom_log_dict.keys()) & set(payload_dict.keys()):
raise ValueError(f"Shared keys found in custom logger dictionary: {shared_keys}")
self._log_base_dict(
self._get_payload(class_name, method_name, num_cols, execution_sec, None),
payload_dict | (custom_log_dict if custom_log_dict else {}),
feature_name=feature_name,
)

Expand Down Expand Up @@ -214,26 +219,41 @@ def log_decorator_wrapper(self, *args, **kwargs):
return get_wrapper

@staticmethod
def log_verb_static(method_name: Optional[str] = None):
def log_verb_static(method_name: Optional[str] = None, feature_name: Optional[str] = None, custom_log_function = None):
def get_wrapper(func):
@functools.wraps(func)
def log_decorator_wrapper(self, *args, **kwargs):
# Validate that self.logger is set
if not hasattr(self, 'logger'):
raise AttributeError(f"{self.__class__.__name__} does not have a 'logger' attribute. "
"Ensure a logger instance is initialized in the constructor.")

# Validate custom_log_function for proper definition
if custom_log_function:
if not callable(custom_log_function):
raise ValueError("custom_log_function must be callable")

logger = self.logger
start_time = time.perf_counter()
try:
result = func(self, *args, **kwargs)
execution_time = logger._round_significant(
time.perf_counter() - start_time, 3
)
# Create custom logs if necessary
custom_log_dict = None
if custom_log_function:
custom_log_dict = custom_log_function(self, result, *args, **kwargs)
if not isinstance(custom_log_dict, dict):
raise TypeError("custom_log_function must return a Dict[str, str]")

logger._log_base(
func.__module__,
method_name if method_name else func.__name__,
logger.get_column_number(args, kwargs),
execution_time,
None,
feature_name,
custom_log_dict
)
return result
except Exception as e:
Expand Down
29 changes: 28 additions & 1 deletion core/src/test/python/synapsemltest/core/test_logging.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,27 @@ def fit(self, df):
def test_throw(self):
raise Exception("test exception")

@SynapseMLLogger.log_verb_static(feature_name="test_logging")
def test_feature_name(self):
return 0

def custom_logging_function(self, results, *args, **kwargs):
return {"args": f"Arguments: {args}",
"result": str(results)}

@SynapseMLLogger.log_verb_static(custom_log_function=custom_logging_function)
def test_custom_function(self, df):
return 0

def custom_logging_function_w_collision(self, results, *args, **kwargs):
return {"args": f"Arguments: {args}",
"result": str(results),
"className": "this is the collision key"}

@SynapseMLLogger.log_verb_static(custom_log_function=custom_logging_function_w_collision)
def test_custom_function_w_collision(self, df):
return 0


class LoggingTest(unittest.TestCase):
def test_logging_smoke(self):
Expand All @@ -65,17 +86,23 @@ def test_logging_smoke(self):
assert f"{e}" == "test exception"
t.test_feature_name()

def test_logging_smoke_no_inheritance(self):
def test_log_verb_static(self):
t = NoInheritTransformer()
data = [("Alice", 25), ("Bob", 30), ("Charlie", 35)]
columns = ["name", "age"]
df = sc.createDataFrame(data, columns)
t.transform(df)
t.fit(df)
t.test_feature_name()
t.test_custom_function(df)
try:
t.test_throw()
except Exception as e:
assert f"{e}" == "test exception"
try:
t.test_custom_function_w_collision(df)
except Exception as e:
assert f"{e}" == "Shared keys found in custom logger dictionary: {'className'}"


if __name__ == "__main__":
Expand Down