Skip to content

Quick fixes for ongoing monitoring#204

Merged
validbeck merged 8 commits intomainfrom
beck/sc-5862/notebook-fixes-for-ongoing-monitoring
Oct 8, 2024
Merged

Quick fixes for ongoing monitoring#204
validbeck merged 8 commits intomainfrom
beck/sc-5862/notebook-fixes-for-ongoing-monitoring

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

Internal Notes for Reviewers

sc-5862

  • Cleaned up the "Initialize the client library" section
  • Quick edits for style guide adherence
  • Added a ToC (removed old artifacts from the template this notebook was based on)

@validbeck validbeck added the internal Not to be externalized in the release notes label Oct 8, 2024
@validbeck validbeck self-assigned this Oct 8, 2024
@validbeck validbeck requested review from cachafla and nrichers October 8, 2024 20:12
Copy link
Copy Markdown
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.

Awesome 🙌

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 8, 2024

PR Summary

This pull request introduces several enhancements to the documentation and code structure within Jupyter notebooks used for ongoing monitoring and model development tutorials. The key changes include:

  1. Table of Contents (TOC) Enhancement: A comprehensive table of contents has been added to the quickstart_customer_churn_ongoing_monitoring.ipynb notebook. This TOC includes links to various sections such as 'About ValidMind', 'Install the client library', 'Initialize the client library', and more, providing a structured navigation experience.

  2. Improved Markdown Formatting: The markdown cells have been updated to improve readability and consistency. This includes adding section anchors, improving the layout of instructions, and ensuring consistent use of headings and subheadings.

  3. Code Consistency: Minor adjustments have been made to the code snippets to ensure consistency in style, such as spacing around assignment operators.

  4. Removal of Empty Cells: An empty markdown cell was removed from the intro_for_model_developers.ipynb notebook, streamlining the document.

These changes aim to enhance the usability and clarity of the notebooks, making it easier for users to follow the instructions and understand the content.

Test Suggestions

  • Verify that the table of contents links navigate to the correct sections within the notebook.
  • Check that all markdown formatting changes render correctly in Jupyter Notebook.
  • Ensure that the code snippets execute without errors and produce the expected results.
  • Review the notebook for any remaining empty or unnecessary cells.

@validbeck validbeck merged commit f8426c0 into main Oct 8, 2024
@validbeck validbeck deleted the beck/sc-5862/notebook-fixes-for-ongoing-monitoring branch October 8, 2024 21:34
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.

2 participants