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

Add environment variable to log cudf.pandas fallback calls #16161

Merged
merged 14 commits into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
Changes from 7 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: 26 additions & 0 deletions python/cudf/cudf/pandas/_logger.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# SPDX-FileCopyrightText: Copyright (c) 2023-2024, NVIDIA CORPORATION & AFFILIATES.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# SPDX-FileCopyrightText: Copyright (c) 2023-2024, NVIDIA CORPORATION & AFFILIATES.
# SPDX-FileCopyrightText: Copyright (c) 2024, NVIDIA CORPORATION & AFFILIATES.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. A copy-paste oversight

# All rights reserved.
# SPDX-License-Identifier: Apache-2.0

from __future__ import annotations

import json
import logging

# https://docs.python.org/3/howto/logging-cookbook.html#implementing-structured-logging


class StructuredMessage:
def __init__(self, debug_type: str, /, **kwargs):
self.debug_type = debug_type
self.kwargs = kwargs

def __str__(self):
log = {"debug_type": self.debug_type}
return json.dumps({**log, **self.kwargs})


logging.basicConfig(
filename="cudf_pandas_unit_tests_debug.log", level=logging.INFO
)
logger = logging.getLogger()
41 changes: 40 additions & 1 deletion python/cudf/cudf/pandas/fast_slow_proxy.py
Original file line number Diff line number Diff line change
Expand Up @@ -930,13 +930,52 @@ def _fast_slow_function_call(
"Pandas debugging mode failed. "
f"The exception was {e}."
)
except Exception:
except Exception as err:
with nvtx.annotate(
"EXECUTE_SLOW",
color=_CUDF_PANDAS_NVTX_COLORS["EXECUTE_SLOW"],
domain="cudf_pandas",
):
slow_args, slow_kwargs = _slow_arg(args), _slow_arg(kwargs)
if _env_get_bool("CUDF_PANDAS_SLOW_LOG", False):
from ._logger import StructuredMessage, logger

def reprify(arg) -> str:
try:
return repr(arg)
except Exception:
return "<REPR FAILED>"

module = getattr(slow_args[0], "__module__", "")
obj_name = getattr(
slow_args[0], "__name__", type(slow_args[0]).__name__
)
slow_object = f"{module}.{obj_name}"
# TODO: maybe use inspect.signature to map called args and kwargs
# to their keyword names
called_args = ",".join((reprify(val) for val in slow_args[1]))
if len(slow_args) == 3:
fmt_kwargs = ",".join(
f"{kwarg}={reprify(value)}"
for kwarg, value in slow_args[2].items()
)
called_args = ",".join((called_args, fmt_kwargs))
passed_kwargs = {
kwarg: reprify(value)
for kwarg, value in slow_args[2].items()
}
else:
passed_kwargs = {}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we never looking slow_kwargs?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think slow_kwargs is always empty. Because kwargs is getting subsumed by args in the _fast_slow_function_call calls. I opened #16266 to fix.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think slow_kwargs is always empty.

Correct. Seems like all calls to _fast_slow_function_call internally are of the form _fast_slow_function_call(something, object, args, kwargs) so kwargs are actually in slow_args instead of slow_kwargs

As commented in #16266 (comment) I am not sure this is exactly a bug

message = StructuredMessage(
"CUDF_PANDAS_SLOW_LOG",
failed_call=f"{slow_object}({called_args})",
exception=type(err).__name__,
exception_message=str(err),
pandas_object=slow_object,
passed_args=called_args,
passed_kwargs=passed_kwargs,
)
logger.info(message)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we pull all of this logic into the logger, so that we just do:

if should_log:
    from ._logger import log_fallback
    log_fallback(slow_args, slow_kwargs)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure thing. Done.

with disable_module_accelerator():
result = func(*slow_args, **slow_kwargs)
return _maybe_wrap_result(result, func, *args, **kwargs), fast
Expand Down
Loading