Skip to content

[SC-7587] Add logging image example to implement_custom_tests.ipynb notebook #254

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

Conversation

juanmleng
Copy link
Contributor

Internal Notes for Reviewers

Added example on logging images as vm tests in implement_custom_tests.ipynb.

External Release Notes

The vm-library allows users to wrap images into VM tests, enabling them to log these images into the UI and benefit from test interpretations. This is as a good example to showcase in the existing notebook implement_custom_tests.ipynb.

@juanmleng juanmleng added documentation Improvements or additions to documentation internal Not to be externalized in the release notes labels Nov 29, 2024
@juanmleng juanmleng self-assigned this Nov 29, 2024
Copy link
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

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

Nice 👌

Copy link
Contributor

@johnwalz97 johnwalz97 left a comment

Choose a reason for hiding this comment

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

very nice 👌

Copy link
Contributor

PR Summary

This pull request introduces a new feature in the Jupyter notebook located at notebooks/code_samples/custom_tests/implement_custom_tests.ipynb. The enhancement allows users to log images as test results within custom tests. A new code cell demonstrates how to implement a custom test that accepts a file path to a PNG image, verifies the file type, and logs the image as a test result using the ValidMind library. This feature is exemplified by logging a Pearson correlation matrix image. Additionally, the notebook's Python version metadata has been updated from 3.8.13 to 3.10.13, and the project version has been incremented from 2.6.3 to 2.6.4 in pyproject.toml and validmind/__version__.py.

Test Suggestions

  • Test the new image logging feature with a valid PNG file to ensure it logs correctly.
  • Test the custom test with a non-PNG file to verify that it raises a ValueError.
  • Check the notebook execution to ensure all cells run without errors, especially the new image logging cell.
  • Verify that the logged image appears correctly in the test results output.

@juanmleng juanmleng merged commit d0ef9e9 into main Nov 29, 2024
6 checks passed
@johnwalz97 johnwalz97 deleted the juan5508/sc-7587/add-logging-image-example-to-implement_custom_tests-notebook branch December 5, 2024 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants