Skip to content

Pulling in latest from developer-framework PR#195 #438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 25, 2024
Merged

Pulling in latest from developer-framework PR#195 #438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f6324a
Pulling in latest from developer-framework
validbeck Sep 23, 2024
5f75a58
Added .screenshot class to model inventory fields
validbeck Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions site/guide/model-inventory/manage-model-inventory-fields.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@ Number

::: {.w-50-ns}

![Simple number field type](number-simple.png){fig-alt="A screenshot showing a simple number field type"}
![Simple number field type](number-simple.png){fig-alt="A screenshot showing a simple number field type" class="screenshot"}

:::

::: {.w-40-ns}

![Currency number field type](number-currency.png){fig-alt="A screenshot showing a currency number field type"}
![Currency number field type](number-currency.png){fig-alt="A screenshot showing a currency number field type" class="screenshot"}

:::

Expand Down
Binary file modified site/notebooks.zip
View file
Open in desktop
Binary file not shown.
152 changes: 60 additions & 92 deletions site/notebooks/code_samples/credit_risk/application_scorecard_demo.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@
"### New to ValidMind?\n",
"If you haven't already seen our [Get started with the ValidMind Developer Framework](https://docs.validmind.ai/developer/get-started-developer-framework.html), we recommend you begin by exploring the available resources in this section. There, you can learn more about documenting models, find code samples, or read our developer reference.\n",
"\n",
"<div class=\"alert alert-block alert-info\" style=\"background-color: #f7e4ee; color: #222425; border: 1px solid #222425;\">For access to all features available in this notebook, create a free ValidMind account.\n",
"\n",
"Signing up is FREE — <a href=\"https://app.prod.validmind.ai\"><b>Sign up now</b></a></div>"
"<div class=\"alert alert-block alert-info\" style=\"background-color: #f7e4ee; color: black; border: 1px solid black;\"><b>For access to all features available in this notebook, create a free ValidMind account.</b>\n",
"<br></br>\n",
"Signing up is FREE — <a href=\"https://docs.validmind.ai/guide/configuration/register-with-validmind.html\"><b>Register with ValidMind</b></a></div>\n"
]
},
{
Expand Down Expand Up @@ -155,7 +155,7 @@
"\n",
"Get your code snippet:\n",
"\n",
"1. In a browser, log into the [Platform UI](https://app.prod.validmind.ai).\n",
"1. In a browser, [log in to ValidMind](https://docs.validmind.ai/guide/configuration/log-in-to-validmind.html).\n",
"\n",
"2. In the left sidebar, navigate to **Model Inventory** and click **+ Register new model**.\n",
"\n",
Expand Down Expand Up @@ -595,8 +595,8 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.data_validation.TabularDescriptionTables:raw_dataset\",\n",
" inputs={\n",
" \"dataset\": vm_raw_dataset,\n",
" input_grid={\n",
" \"dataset\": [vm_raw_dataset],\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -610,8 +610,8 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.data_validation.MissingValuesBarPlot:raw_dataset\",\n",
" inputs={\n",
" \"dataset\": vm_raw_dataset,\n",
" input_grid={\n",
" \"dataset\": [vm_raw_dataset]\n",
" },\n",
")\n",
"test.log()"
Expand Down Expand Up @@ -646,8 +646,8 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.data_validation.TabularDescriptionTables:preprocess_dataset\",\n",
" inputs={\n",
" \"dataset\": vm_preprocess_dataset,\n",
" input_grid={\n",
" \"dataset\": [vm_preprocess_dataset]\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -661,8 +661,8 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.data_validation.IQROutliersTable\",\n",
" inputs={\n",
" \"dataset\": vm_preprocess_dataset,\n",
" input_grid={\n",
" \"dataset\": [vm_preprocess_dataset]\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -676,8 +676,8 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.data_validation.ClassImbalance\",\n",
" inputs={\n",
" \"dataset\": vm_preprocess_dataset,\n",
" input_grid={\n",
" \"dataset\": [vm_preprocess_dataset]\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -691,8 +691,8 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.data_validation.TabularNumericalHistograms\",\n",
" inputs={\n",
" \"dataset\": vm_preprocess_dataset,\n",
" input_grid={\n",
" \"dataset\": [vm_preprocess_dataset]\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -706,8 +706,8 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.data_validation.TabularCategoricalBarPlots\",\n",
" inputs={\n",
" \"dataset\": vm_preprocess_dataset,\n",
" input_grid={\n",
" \"dataset\": [vm_preprocess_dataset]\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -721,8 +721,8 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.data_validation.TargetRateBarPlots\",\n",
" inputs={\n",
" \"dataset\": vm_preprocess_dataset,\n",
" input_grid={\n",
" \"dataset\": [vm_preprocess_dataset]\n",
" },\n",
" params={\n",
" \"default_column\": lending_club.target_column,\n",
Expand All @@ -740,8 +740,8 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.data_validation.PearsonCorrelationMatrix\",\n",
" inputs={\n",
" \"dataset\": vm_preprocess_dataset,\n",
" input_grid={\n",
" \"dataset\": [vm_preprocess_dataset]\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -755,8 +755,8 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.data_validation.HighPearsonCorrelation\",\n",
" inputs={\n",
" \"dataset\": vm_preprocess_dataset,\n",
" input_grid={\n",
" \"dataset\": [vm_preprocess_dataset]\n",
" },\n",
")\n",
"test.log()"
Expand Down Expand Up @@ -784,8 +784,8 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.data_validation.WOEBinTable\",\n",
" inputs={\n",
" \"dataset\": vm_preprocess_dataset,\n",
" input_grid={\n",
" \"dataset\": [vm_preprocess_dataset]\n",
" },\n",
" params={\n",
" \"breaks_adj\": lending_club.breaks_adj,\n",
Expand All @@ -802,8 +802,8 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.data_validation.WOEBinPlots\",\n",
" inputs={\n",
" \"dataset\": vm_preprocess_dataset,\n",
" input_grid={\n",
" \"dataset\": [vm_preprocess_dataset]\n",
" },\n",
" params={\n",
" \"breaks_adj\": lending_club.breaks_adj,\n",
Expand Down Expand Up @@ -866,24 +866,9 @@
"outputs": [],
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.model_validation.statsmodels.RegressionCoeffsPlot\",\n",
" inputs={\n",
" \"models\": [vm_model],\n",
" },\n",
")\n",
"test.log()"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.model_validation.statsmodels.RegressionModelsCoeffs\",\n",
" inputs={\n",
" \"models\": [vm_model],\n",
" \"validmind.model_validation.statsmodels.RegressionCoeffs\",\n",
" input_grid={\n",
" \"model\": [vm_model]\n",
" },\n",
")\n",
"test.log()"
Expand Down Expand Up @@ -917,26 +902,10 @@
"outputs": [],
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.model_validation.sklearn.ClassifierPerformance:train_dataset\",\n",
" inputs={\n",
" \"dataset\": vm_train_ds,\n",
" \"model\": vm_model,\n",
" },\n",
")\n",
"test.log()"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.model_validation.sklearn.ClassifierPerformance:test_dataset\",\n",
" inputs={\n",
" \"dataset\": vm_test_ds,\n",
" \"model\": vm_model,\n",
" \"validmind.model_validation.sklearn.ClassifierPerformance\",\n",
" input_grid={\n",
" \"dataset\": [vm_train_ds, vm_test_ds],\n",
" \"model\": [vm_model],\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -950,9 +919,9 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.model_validation.statsmodels.GINITable\",\n",
" inputs={\n",
" \"datasets\": [vm_train_ds, vm_test_ds],\n",
" \"model\": vm_model,\n",
" input_grid={\n",
" \"dataset\": [vm_train_ds, vm_test_ds],\n",
" \"model\": [vm_model],\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -966,9 +935,9 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.model_validation.sklearn.ConfusionMatrix\",\n",
" inputs={\n",
" \"dataset\": vm_test_ds,\n",
" \"model\": vm_model,\n",
" input_grid={\n",
" \"dataset\": [vm_train_ds, vm_test_ds],\n",
" \"model\": [vm_model],\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -982,9 +951,9 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.model_validation.sklearn.ROCCurve\",\n",
" inputs={\n",
" \"model\": vm_model,\n",
" \"dataset\": vm_test_ds,\n",
" input_grid={\n",
" \"dataset\": [vm_train_ds, vm_test_ds],\n",
" \"model\": [vm_model],\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -998,9 +967,9 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.model_validation.statsmodels.PredictionProbabilitiesHistogram\",\n",
" inputs={\n",
" \"model\": vm_model,\n",
" \"datasets\": [vm_train_ds, vm_test_ds],\n",
" input_grid={\n",
" \"dataset\": [vm_train_ds, vm_test_ds],\n",
" \"model\": [vm_model],\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -1014,9 +983,9 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.model_validation.statsmodels.CumulativePredictionProbabilities\",\n",
" inputs={\n",
" \"model\": vm_model,\n",
" \"datasets\": [vm_train_ds, vm_test_ds],\n",
" input_grid={\n",
" \"model\": [vm_model],\n",
" \"dataset\": [vm_train_ds, vm_test_ds],\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -1030,9 +999,8 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.model_validation.statsmodels.ScorecardHistogram\",\n",
" inputs={\n",
" \"model\": vm_model,\n",
" \"datasets\": [vm_train_ds, vm_test_ds],\n",
" input_grid={\n",
" \"dataset\": [vm_train_ds, vm_test_ds],\n",
" },\n",
" params={\n",
" \"score_column\": \"glm_scores\",\n",
Expand Down Expand Up @@ -1066,9 +1034,9 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.model_validation.statsmodels.RegressionPermutationFeatureImportance\",\n",
" inputs={\n",
" \"model\": vm_model,\n",
" \"dataset\": vm_test_ds,\n",
" input_grid={\n",
" \"model\": [vm_model],\n",
" \"dataset\": [vm_train_ds, vm_test_ds],\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -1082,9 +1050,9 @@
"source": [
"test = vm.tests.run_test(\n",
" \"validmind.model_validation.FeaturesAUC\",\n",
" inputs={\n",
" \"model\": vm_model,\n",
" \"dataset\": vm_test_ds,\n",
" input_grid={\n",
" \"model\": [vm_model],\n",
" \"dataset\": [vm_train_ds, vm_test_ds],\n",
" },\n",
")\n",
"test.log()"
Expand All @@ -1104,7 +1072,7 @@
"\n",
"### Work with your model documentation\n",
"\n",
"1. In the [Platform UI](https://app.prod.validmind.ai), go to the **Documentation** page for the model you registered earlier.\n",
"1. In the ValidMind Platform UI, go to the **Documentation** page for the model you registered earlier. ([Need more help?](https://docs.validmind.ai/guide/model-documentation/working-with-model-documentation.html))\n",
"\n",
"2. Expand the following sections and take a look around:\n",
"\n",
Expand Down Expand Up @@ -1142,7 +1110,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.13"
"version": "3.10.14"
}
},
"nbformat": 4,
Expand Down
Loading
Loading