Adding latest RawData notebook to docs

[validbeck]

Internal Notes for Reviewers

sc-8282

Follow up to validmind/validmind-library#309.

Pulled in the latest RawData notebook and added mentions it to on the following pages:

Testing overview

LIVE PREVIEW

FAQ - Testing

LIVE PREVIEW

[validbeck]

@johnwalz97 Just pullin' in the notebook you spun up into the docs. Let me know if anything else needs to be added or if it's g2g! 🙏🏻

[github-actions]

PR Summary

This pull request introduces enhancements to the testing documentation by adding a new feature, RawData, to the ValidMind tests. The RawData feature allows users to access intermediate or unprocessed data generated during test execution, enabling customization of test outputs. The changes include:

• Documentation Updates:

  • Added a new entry in the testing-overview.qmd file to include a new notebook understand_utilize_rawdata.ipynb.
  • Updated the FAQ section in faq-testing.qmd to include information about the RawData feature and its benefits for customizing test outputs.

• New Notebook:

  • Introduced a new Jupyter notebook understand_utilize_rawdata.ipynb that provides a comprehensive guide on how to use the RawData feature in ValidMind tests. This notebook includes examples of using RawData for ROC Curve, Pearson Correlation Matrix, and Precision-Recall Curve tests, as well as creating custom tests that utilize RawData.

These changes aim to enhance the flexibility and usability of the ValidMind testing framework by allowing users to tailor test outputs to their specific needs.

Test Suggestions

• Verify that the new notebook understand_utilize_rawdata.ipynb runs without errors and produces the expected outputs.
• Test the integration of the RawData feature with existing ValidMind tests to ensure compatibility.
• Check the documentation links and references in the updated FAQ and testing overview files for accuracy.
• Ensure that the examples provided in the new notebook are clear and reproducible.
• Test the custom test creation process using RawData as described in the notebook.

[github-actions]

PR Summary

This pull request introduces enhancements to the testing documentation by adding a new feature called RawData in the ValidMind tests. The changes include:

1. Documentation Updates:

   • Updated the testing-overview.qmd file to include a new grid column and an additional content entry for understanding and utilizing RawData.
   • Enhanced the FAQ section in faq-testing.qmd to include information about personalizing tests using the RawData feature.

2. New Notebook:

   • Added a new Jupyter notebook understand_utilize_rawdata.ipynb that provides a comprehensive guide on how to access, inspect, and utilize RawData in ValidMind tests. This notebook includes setup instructions, usage examples, and custom test creation using RawData.

These changes aim to improve the flexibility and customization of test outputs by leveraging the RawData feature, allowing users to create custom visualizations and post-processing functions.

Test Suggestions

• Verify that the new grid column in testing-overview.qmd displays correctly.
• Check that the new content entry in testing-overview.qmd links to the correct notebook.
• Ensure that the FAQ section in faq-testing.qmd correctly describes the RawData feature.
• Run the new Jupyter notebook understand_utilize_rawdata.ipynb to ensure all code cells execute without errors.
• Test the examples in the notebook to confirm that RawData is being utilized as described.
• Validate that custom tests using RawData can be created and executed successfully.

[johnwalz97]

lgtm @validbeck