End-to-end notebook template generation script

[validbeck]

Internal Notes for Reviewers

sc-7899

Migrated Jupyter Notebook templates

I moved the templates that used to live in documentation/internal/templates/jupyter-notebooks to validmind-library/notebooks/templates:

New templates folder	Updated notebooks README

Interactive end-to-end notebook template generation

There is now a fancy new Python script and an accompanying notebook:

• notebooks/templates/e2e_template.py
• notebooks/templates/e2e-notebook.ipynb

You can either run the notebook, or call make notebook from the root of the validmind-library repo:

validmind-library/Makefile

Line 83 in 17bc771

notebook:

The functionality of the script and the notebook is the same:

• It asks the user for the filename of the new Jupyter Notebook, and creates a the file in notebooks/code_sharing
• It asks the user for the title of the notebook and creates a markdown cell at the top of the notebook, applying the input as an h1 header
• It asks the user whether or not they want to append the following mini-templates to the notebook:
  • notebooks/templates/about-validmind.ipynb
  • notebooks/templates/install-initialize-validmind.ipynb
  • notebooks/templates/next-steps.ipynb
  • notebooks/templates/upgrade-validmind.ipynb
• Shows you the changed files you need to commit outside of notebooks/templates

Install & initialize ValidMind

If the user chooses to append the contents of this template to the notebook, they will also be prompted to enter:

• A {template} name
• A {use-case}

Default	Example generated notebook

Cell IDs

The templates have been broken down into individual cells with cell IDs, in preparation for maybe being able to bulk-edit notebooks in sc-4132. There are some other considerations, like how all pre-existing notebooks will need to be recreated with this templating script/notebook, and how we can work around injected table-of-contents anchors, but, hey, it's a head start.

Template cell ID	Generated cell ID

[cachafla]

This is very fancy 😄 great job!

One minor suggestion for the future (no need to make any changes now) is to leverage @click for building the CLI:

• https://click.palletsprojects.com/en/stable/
• Some examples in our code: https://github.com/validmind/validmind-library/blob/main/scripts/extract_descriptions.py

[github-actions]

PR Summary

This pull request introduces several enhancements to the ValidMind project:

1. Makefile Update: A new notebook command has been added to the Makefile. This command runs a Python script located at notebooks/templates/e2e_template.py and filters the output of git status to exclude changes in the notebooks/templates directory.

2. Notebook Templates: Several Jupyter notebook templates have been added under the notebooks/templates directory. These templates include:

   • about-validmind.ipynb: Provides an overview of ValidMind, its key concepts, and prerequisites.
   • e2e-notebook.ipynb: A template for generating end-to-end notebooks for ValidMind.
   • install-initialize-validmind.ipynb: Instructions for installing and initializing the ValidMind Library.
   • next-steps.ipynb: Guidance on next steps after using the ValidMind Library.
   • upgrade-validmind.ipynb: Instructions for upgrading the ValidMind Library.

3. Template README: A new README file has been added to the notebooks/templates directory, providing a quick start guide for creating code samples using the provided templates.

4. Python Script for Notebook Generation: A Python script e2e_template.py has been added to facilitate the creation of new Jupyter notebooks by combining various mini-templates. This script includes functions for creating notebooks, setting titles, and appending content from mini-templates.

5. Documentation Update: The notebooks/README.md file has been updated to remove the deprecated notebooks/archive section and add a new section on contributing code samples.

Test Suggestions

• Test the new make notebook command to ensure it correctly runs the Python script and filters the git status output.
• Verify that each Jupyter notebook template can be opened and executed without errors.
• Check that the Python script e2e_template.py correctly creates a new notebook and appends content from mini-templates.
• Ensure that the README files provide accurate and clear instructions for using the templates and contributing code samples.
• Test the integration of the new templates with the ValidMind Library to ensure they function as expected.