Skip to content

[SC-11665] Remove scorecard with GLM notebook#408

Merged
juanmleng merged 2 commits intomainfrom
juan/sc-11665/remove-application-scorecard-with-glm-notebook
Aug 7, 2025
Merged

[SC-11665] Remove scorecard with GLM notebook#408
juanmleng merged 2 commits intomainfrom
juan/sc-11665/remove-application-scorecard-with-glm-notebook

Conversation

@juanmleng
Copy link
Contributor

@juanmleng juanmleng commented Aug 6, 2025

Pull Request Description

What and why?

What

We removed the application_scorecard_demo.ipynb notebook, which used GLM as its modeling approach. This notebook was the first scorecard notebook we created, but it has since been superseded by the following notebooks, which use more relevant models—XGBoost and RandomClassifier—for benchmarking purposes:

  • application_scorecard_executive.ipynb
  • application_scorecard_full_suite.ipynb
  • application_scorecard_with_ml.ipynb

Why

We confirmed with SA that the application_scorecard_demo.ipynb notebook is no longer used. It also relies on a different template than the currently adopted credit scorecard notebooks. Keeping this obsolete notebook may cause confusion about which templates should be used and whether this is an active notebook suitable for demos. Removing it helps prevent misunderstandings and ensures consistency across the asset materials.

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

The template in the backend corresponding to the application scorecard should be replaced by the one currently used by the active application scorecard demo notebooks. See corresponding backend PR:
https://github.com/validmind/backend/pull/1795

Release notes

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)

@juanmleng juanmleng self-assigned this Aug 6, 2025
@juanmleng juanmleng added chore Chore tasks that aren't bugs or new features deprecation Feature to be removed for the release notes labels Aug 6, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Aug 6, 2025

PR Summary

This PR removes the long-standing credit risk application scorecard demo notebook from the project, likely because it was either deprecated or redundant. Additionally, it extends the testing framework by adding several new test types in the tests types file. In particular, new plot tests (BoxPlot, CorrelationHeatmap, HistogramPlot, ViolinPlot) and statistical tests (CorrelationAnalysis, DescriptiveStats, NormalityTests, OutlierDetection) have been added to enhance the library's capabilities in model documentation validation and data analysis. Note that while version bumps are present in the configuration files, the primary functional changes focus on test coverage improvements and the removal of the notebook file.

Test Suggestions

  • Run the full test suite to verify that the new test modules for plots and statistical analyses execute correctly.
  • Create sample datasets to verify that the newly added test types (e.g., BoxPlot, CorrelationHeatmap) generate the expected output.
  • Ensure that the removal of the notebook does not break any external references or integrations.
  • Perform regression tests to confirm that the updated test definitions do not introduce conflicts with existing tests.

@juanmleng juanmleng merged commit fd29386 into main Aug 7, 2025
7 checks passed
@juanmleng juanmleng deleted the juan/sc-11665/remove-application-scorecard-with-glm-notebook branch August 7, 2025 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Chore tasks that aren't bugs or new features deprecation Feature to be removed for the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants