nafisatibrahim commited on
Commit
5c0514a
·
verified ·
1 Parent(s): 4ab85b8

Document feature_engineering_data_dictionary.xlsx, outputs/ folder, and default vs feature_engineered configs

Browse files
Files changed (1) hide show
  1. README.md +35 -1
README.md CHANGED
@@ -65,9 +65,29 @@ This dataset backs **Credit Risk Default**: an explainable credit-risk platform
65
  | Marienne Dosso | Data Scientist |
66
  | Bintou Ba | Data Scientist |
67
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
68
  ## Data Dictionary
69
 
70
- Reference files under `data_dictionary/`, produced while cleaning the raw LendingClub CSV (see [`notebooks/00_cleaning.ipynb`](https://github.com/BuildersLab/Credit-Risk-Default/blob/main/notebooks/00_cleaning.ipynb)), not Kaggle's raw column list. Each has a different schema, so each CSV is declared as its own config above (see `configs:` in the metadata) rather than being auto-merged.
71
 
72
  - **`data_dictionary_summary.csv`**: one row per column: `Variable`, `Description`
73
  (LendingClub's official column definition), `Missing Values` (count),
@@ -83,3 +103,17 @@ Reference files under `data_dictionary/`, produced while cleaning the raw Lendin
83
  columns that survive the leakage/keep review (median fill, median plus a
84
  missing-flag column, mode plus flag, or drop rows), with the mechanism and
85
  reasoning behind each call.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
65
  | Marienne Dosso | Data Scientist |
66
  | Bintou Ba | Data Scientist |
67
 
68
+ ## Dataset Splits
69
+
70
+ Two versions of the same train/validation/test splits are available as separate configs:
71
+
72
+ - **`default`** (used automatically if you don't pass a config name): the cleaned,
73
+ target-filtered, leakage-removed, imputed dataset from
74
+ [`notebooks/00_cleaning.ipynb`](https://github.com/BuildersLab/Credit-Risk-Default/blob/main/notebooks/00_cleaning.ipynb),
75
+ before feature engineering. Files under `data/before_feature_engineering/`.
76
+ - **`feature_engineered`**: the same splits after
77
+ [`notebooks/02_feature_engineering.ipynb`](https://github.com/BuildersLab/Credit-Risk-Default/blob/main/notebooks/02_feature_engineering.ipynb)
78
+ (engineered features added, several raw columns consolidated or dropped).
79
+ Files under `data/after_feature_engineering/`.
80
+
81
+ ```python
82
+ from datasets import load_dataset
83
+
84
+ before = load_dataset("BuildersLab/loan-application-dataset") # default config
85
+ after = load_dataset("BuildersLab/loan-application-dataset", "feature_engineered") # after feature engineering
86
+ ```
87
+
88
  ## Data Dictionary
89
 
90
+ Reference files under `data_dictionary/`, produced while cleaning and engineering the LendingClub data (see [`notebooks/00_cleaning.ipynb`](https://github.com/BuildersLab/Credit-Risk-Default/blob/main/notebooks/00_cleaning.ipynb) and [`notebooks/02_feature_engineering.ipynb`](https://github.com/BuildersLab/Credit-Risk-Default/blob/main/notebooks/02_feature_engineering.ipynb)), not Kaggle's raw column list. Each has a different schema, so each CSV is declared as its own config above (see `configs:` in the metadata) rather than being auto-merged.
91
 
92
  - **`data_dictionary_summary.csv`**: one row per column: `Variable`, `Description`
93
  (LendingClub's official column definition), `Missing Values` (count),
 
103
  columns that survive the leakage/keep review (median fill, median plus a
104
  missing-flag column, mode plus flag, or drop rows), with the mechanism and
105
  reasoning behind each call.
106
+ - **`feature_engineering_data_dictionary.xlsx`**: 4-sheet workbook covering the
107
+ `feature_engineered` split from `02_feature_engineering.ipynb`: a data
108
+ dictionary, dictionary plus per-column statistics (min/max/mean/std/percentiles
109
+ for numeric columns, unique/top/freq for categorical columns, missing value
110
+ count for all), a full feature x feature correlation matrix, and feature x
111
+ `default` target correlation.
112
+
113
+ ## Outputs
114
+
115
+ Analysis artifacts produced by the notebooks, not part of the model-ready dataset
116
+ itself, live under `outputs/`. Currently the feature x feature correlation matrix
117
+ (`feature_correlation_matrix.csv`) and its heatmap (`feature_correlation_matrix.png`)
118
+ from `02_feature_engineering.ipynb`; later notebooks will add artifacts like SHAP
119
+ plots and evaluation curves here too.