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 explanation option to Chex shape asserts so that error messages can bring in lots of contextual information and make failures much more actionable. #198

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

copybara-service[bot]
Copy link

Add explanation option to Chex shape asserts so that error messages can bring in lots of contextual information and make failures much more actionable.

Example usage:

def _assert_explanation() -> str:
      return (f"{targets.shape=} {encoded.shape=} {_shape(decoder_mask)=} "
              f"{_shape(encoder_decoder_mask)=} {_shape(logit_mask)} "
              f"{enable_dropout=} {decode=} {max_decode_length=} {prefill=} "
              f"{prefill_lengths=}")

chex.assert_shape(x, init_targets.shape, _assert_explanation)

This allows a couple of nice usages, especially in complicated functions/classes:

  • Define an informative error message once (e.g. just below the function entry point)
  • Use repeatedly throughout the function with convenient syntax.

… can bring in lots of contextual information and make failures much more actionable.

Example usage:

```
def _assert_explanation() -> str:
      return (f"{targets.shape=} {encoded.shape=} {_shape(decoder_mask)=} "
              f"{_shape(encoder_decoder_mask)=} {_shape(logit_mask)} "
              f"{enable_dropout=} {decode=} {max_decode_length=} {prefill=} "
              f"{prefill_lengths=}")

chex.assert_shape(x, init_targets.shape, _assert_explanation)
```

This allows a couple of nice usages, especially in complicated functions/classes:
* Define an informative error message once (e.g. just below the function entry point)
* Use repeatedly throughout the function with convenient syntax.

PiperOrigin-RevId: 482900885
@google-cla
Copy link

google-cla bot commented Oct 22, 2022

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants