simplify probatus: remove 'old' code, update mkdocs config (#237)

Remove a lot of the extra packages which makes maintaining MKDOCS easier.
ing-bank · Mar 17, 2024 · cbd0d34 · cbd0d34
1 parent a5088ef
commit cbd0d34
Show file tree

Hide file tree

Showing 51 changed files with 54 additions and 7,645 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -33,17 +33,16 @@ repos:
       types: [python]
   - repo: local
     hooks:
-    - id: ruff
-      name: 'ruff: Check for errors, styling issues and complexity'
+    - id: ruff-check
+      name: 'Ruff: Check for errors, styling issues and complexity, and fixes issues if possible (including import order)'
       entry: ruff
       language: system
-  - repo: local
-    hooks:
-    - id: isort
-      name: 'isort: Sort file imports'
-      entry: isort
+      args: [ --fix, --no-cache ]
+    - id: ruff-format
+      name: 'Ruff: format code in line with PEP8'
+      entry: ruff format
       language: system
-      types: [python]
+      args: [ --no-cache ]
   - repo: local
     hooks:
     - id: codespell
@@ -57,12 +56,4 @@ repos:
     hooks:
     - id: pyupgrade
       name: 'pyupgrade: Updates code to Python 3.8+ code convention'
-      args: [*py_version]
-  - repo: local
-    hooks:
-    - id: black
-      name: 'black: PEP8 compliant code formatter'
-      entry: black
-      language: python
-      types: [python]
-      language_version: python3
+      args: [*py_version]
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -13,10 +13,8 @@
 **Probatus** is a python package that helps validate binary classification models and the data used to develop them. Main features:
 
 - [probatus.interpret](https://ing-bank.github.io/probatus/api/model_interpret.html) provides shap-based model interpretation tools
-- [probatus.metric_volatility](https://ing-bank.github.io/probatus/api/metric_volatility.html) provides tools using bootstrapping and/or different random seeds to assess metric volatility/stability.
 - [probatus.sample_similarity](https://ing-bank.github.io/probatus/api/sample_similarity.html) to compare two datasets using resemblance modelling, f.e. `train` with out-of-time `test`.
 - [probatus.feature_elimination.ShapRFECV](https://ing-bank.github.io/probatus/api/feature_elimination.html) provides cross-validated Recursive Feature Elimination using shap feature importance.
-- [probatus.missing_values](https://ing-bank.github.io/probatus/api/imputation_selector.html) compares performance gains of different missing values imputation strategies for a given model.
 
 ## Installation
 

diff --git a/VISION.md b/VISION.md
@@ -28,5 +28,4 @@ The main principles that drive development of `Probatus` are the following
 
 ## The Roadmap
 
-The following [issue](https://github.com/ing-bank/Probatus/issues/93) keeps track of the features coming to Probatus.
 We are open to new ideas, so if you can think of a feature that fits the vision, make an [issue](https://github.com/ing-bank/Probatus/issues) and help us further develop this package.
diff --git a/docs/api/imputation_selector.md b/docs/api/imputation_selector.md
diff --git a/docs/api/metric_volatility.md b/docs/api/metric_volatility.md
diff --git a/docs/api/stat_tests.md b/docs/api/stat_tests.md
diff --git a/docs/img/KS2_Example.png b/docs/img/KS2_Example.png
diff --git a/docs/img/autodist.png b/docs/img/autodist.png
diff --git a/docs/img/imputation_comparison.png b/docs/img/imputation_comparison.png
diff --git a/docs/img/metric_volatility_bootstrapped.png b/docs/img/metric_volatility_bootstrapped.png
diff --git a/docs/img/metric_volatility_split_seed.png b/docs/img/metric_volatility_split_seed.png
diff --git a/docs/img/metric_volatility_train_test.png b/docs/img/metric_volatility_train_test.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,5 +1,3 @@
-# Welcome to probatus documentation!
-
 <img src="img/logo_large.png" width=190 align="right">
 
 **Probatus** is a Python library that allows to analyse binary classification models as well as the data used to develop them.