PR Summary

This pull request introduces several enhancements and bug fixes to the ValidMind project, focusing on documentation, code samples, and testing capabilities. Key changes include:

1. Documentation Updates:

   • Added detailed markdown files for various tests, including MutualInformation, ScoreBandDefaultRates, CalibrationCurve, ClassifierThresholdOptimization, HyperParametersTuning, ModelParameters, ScoreProbabilityAlignment, CumulativePredictionProbabilities, and PredictionProbabilitiesHistogram. These documents provide insights into the purpose, mechanism, strengths, and limitations of each test.

2. Code Samples:

   • Introduced new Jupyter notebooks for application scorecard models, including application_scorecard_full_suite.ipynb and application_scorecard_with_ml.ipynb. These notebooks guide users through building and documenting application scorecard models using the ValidMind Library.
   • Updated the hugging_face_summarization_demo.ipynb to include the validmind[huggingface] installation.

3. Template Enhancements:

   • Added a new Jupyter Notebook template QuickStart guide and mini-templates for creating ValidMind code samples.
   • Introduced an end-to-end notebook template generation script (e2e_template.py) to streamline the creation of new code samples.

4. Testing Enhancements:

   • Updated the quickstart_option_pricing_models.ipynb and quickstart_option_pricing_models_quantlib.ipynb notebooks with additional data quality checks and model evaluation tests.

5. Miscellaneous:

   • Removed deprecated notebooks and updated README files to reflect the latest changes.
   • Added a new site/python-docs.zip file for documentation purposes.

Test Suggestions

• Run all Jupyter notebooks to ensure they execute without errors.
• Verify that the new markdown documentation files are correctly formatted and provide accurate information.
• Test the new end-to-end notebook template generation script to ensure it creates notebooks as expected.
• Check the installation of validmind[huggingface] in the hugging_face_summarization_demo.ipynb notebook.
• Validate the new data quality and model evaluation tests in the updated notebooks.

A PR preview is available: Preview URL