Skip to content

Notebooks: Fixing wrong images & typos in validation series#367

Merged
validbeck merged 4 commits intomainfrom
beck/validation-notebook-patch
May 8, 2025
Merged

Notebooks: Fixing wrong images & typos in validation series#367
validbeck merged 4 commits intomainfrom
beck/validation-notebook-patch

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented May 8, 2025

Pull Request Description

What

I found some typoes and incorrect images in the validation notebook series I didn't catch the first few rounds

Why

typoes and incorrect images misleading

How to Test

You can just review the changed files on GitHub!

diff

Pull Request Dependencies

This PR affects a WIP PR (not yet on remote) in the documentation repo that requires these updated fixes.

Checklist

  • PR body describes what, why, and how to test
  • Release notes written — N/A
  • Deployment notes written — N/A
  • Breaking changes identified — N/A
  • Labels applied
  • PR linked to Shortcut — N/A
  • Screenshots/videos added (Frontend) — N/A
  • Unit tests added (Backend) — N/A
  • Tested locally
  • Documentation updated (if required) — Will pull these changes into my working documentation PR.

Additional Notes

new PR template slaps thanks @nibalizer!

@validbeck validbeck self-assigned this May 8, 2025
@validbeck validbeck added the internal Not to be externalized in the release notes label May 8, 2025
@validbeck validbeck requested a review from cachafla May 8, 2025 19:26
@validbeck validbeck requested a review from nrichers May 8, 2025 19:26
@validbeck validbeck requested a review from juanmleng May 8, 2025 19:26
Copy link

@gtagle gtagle left a comment

Choose a reason for hiding this comment

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

moar bettar

@github-actions
Copy link
Contributor

github-actions bot commented May 8, 2025

PR Summary

This pull request updates the documentation in the Jupyter notebooks related to model validation and evaluation processes. The changes primarily involve correcting and clarifying section titles to better reflect the content and purpose of the sections.

  1. In the 2-start_validation_process.ipynb notebook, the section title "Log tests with a unique identifiers" was corrected to "Log tests with unique identifiers" to improve grammatical accuracy.

  2. In the 3-developing_challenger_model.ipynb notebook, the section title "Running model validation tests" was updated to "Running model evaluation tests" to more accurately describe the focus of the section, which is on evaluating model performance rather than just validation.

These changes aim to enhance the clarity and readability of the documentation for users following the tutorials.

Test Suggestions

  • Verify that the updated section titles in the Jupyter notebooks render correctly and are linked properly in the table of contents.
  • Ensure that the changes do not affect the execution of the notebooks and that all cells run without errors.
  • Check that the documentation changes are consistent with the actual content and purpose of the sections.

@validbeck validbeck merged commit 0324718 into main May 8, 2025
7 checks passed
@validbeck validbeck deleted the beck/validation-notebook-patch branch May 8, 2025 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants