notebooks & notebook templating: Removed references to selecting use cases & added missing templates

[validbeck]

Pull Request Description

What and why?

sc-14229

• I removed the prompt for inserting a sample use case from the notebook generation template and any references to use cases from notebooks as this isn't necessarily a required field on registration depending on organization settings

• I added some YAML uploads for templates referenced in notebooks that aren't by default part of organizations and instructions on how to ask customer admins to include these templates for use. For example:

  

How to test

• Run the commandmake notebook and the end-to-end notebook (notebooks/templates/e2e-notebook.ipynb) to make sure it doesn't insert empty use cases
• Review the git diff for removed references to use cases: https://github.com/validmind/validmind-library/pull/474/changes?file-filters%5B%5D=.ipynb
• Review that the added document YAML templates look accurate: https://github.com/validmind/validmind-library/pull/474/changes?file-filters%5B%5D=.yaml

What needs special review?

Please make sure that the templates I added look accurate.

Dependencies, breaking changes, and deployment notes

n/a

Release notes

n/a

Checklist

• What and why
• Screenshots or videos (Frontend)
• How to test
• What needs special review
• Dependencies, breaking changes, and deployment notes
• Labels applied
• PR linked to Shortcut
• Unit tests added (Backend)
• Tested locally
• Documentation updated (if required)
• Environment variable additions/changes documented (if required)

[AnilSorathiya]

thanks @validbeck!

[juanmleng]

I received an error about nbformat not being installed. The issue was that Makefile target make notebook was running python, not the Poetry environment (so nbformat wasn’t available).

Replace this:

@python notebooks/templates/e2e_template.py

by this:

poetry run python notebooks/templates/e2e_template.py

[juanmleng]

Also I noticed that make notebook currently breaks if the notebook name contains spaces (e.g., test juan.ipynb). The editor CLI interprets the path as multiple args and ends up creating extra files like test and juan.ipynb in addition to the intended notebook. Perhaps, we should either normalize spaces to underscores or ensure the open/create step passes a properly quoted single filepath.

[juanmleng]

This look awesome @validbeck ! I just a couple of minor comments.

[github-actions]

PR Summary

This PR introduces several improvements across the project. First, the Makefile now executes the notebook template generation script via Poetry instead of a direct Python call, standardizing the environment for running scripts.

New and updated YAML templates have been added for various documentation aspects such as Capital Markets, Code Explainer, and Gen AI RAG. These templates provide detailed sections covering metadata, model design, testing, data preparation, model evaluation, and monitoring/governance, which will help ensure consistency across documentation notebooks.

Multiple notebooks, across areas like credit risk, NLP/LLM, time series, and more, have been updated to remove redundant example texts for model registration. These changes streamline the instructions by removing hard-coded use case examples and improving template name consistency.

Additionally, the e2e_template.py script has been enhanced by adding filename normalization—replacing spaces with underscores and converting names to lowercase—which improves usability and consistency when creating new notebooks. A block of code handling the '{use-case}' replacement was also simplified and removed, reducing complexity without affecting the core functionality.

Test Suggestions

• Run the Makefile target to confirm that 'poetry run python' executes the e2e_template.py as expected.
• Test the notebook creation process by entering a name with spaces and uppercase letters, and verify that the resulting file name is normalized.
• Load and preview the new YAML templates (for Capital Markets, Code Explainer, Gen AI RAG) in the documentation system to ensure proper formatting and valid YAML structure.
• Open several updated notebooks to verify that the instructional text has been correctly updated (e.g., removal of outdated example use cases) and that all links work as expected.

[validbeck]

I received an error about nbformat not being installed. The issue was that Makefile target make notebook was running python, not the Poetry environment (so nbformat wasn’t available).

Replace this:

@python notebooks/templates/e2e_template.py

by this:

poetry run python notebooks/templates/e2e_template.py

Done in 37f071e!

Also I noticed that make notebook currently breaks if the notebook name contains spaces (e.g., test juan.ipynb). The editor CLI interprets the path as multiple args and ends up creating extra files like test and juan.ipynb in addition to the intended notebook. Perhaps, we should either normalize spaces to underscores or ensure the open/create step passes a properly quoted single filepath.

Spaces are turned into underscores in c265e6f. It now also normalises any capitals if entered, and removes any spaces from the end of the filename if entered as well.