AddisuSeteye commited on
Commit
7b6fbec
·
verified ·
1 Parent(s): e0d5c65

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +4 -3
README.md CHANGED
@@ -1,11 +1,11 @@
1
  ---
2
  license: mit
3
  ---
4
- # Model card - Ikimina Reliability Index
5
 
6
- **Artifacts:** On the Hugging Face repo, open the **Files** tab. You should see **`calibrated_model.joblib`** and **`model_meta.json`** (required), and optionally **`month_imputes.json`**, **`group_reliability.json`**.
7
 
8
- **Reproducibility:** Full pipeline code is in your submitted project (`generate_data.py`, `features.py`, `train_model.py`, `scorer.py`, `train.ipynb`). If the brief requires a public Git URL, paste it on this line: _[repository URL]_.
9
 
10
  **What this is:** CPU **XGBoost** (`tree_method="hist"`) + **`CalibratedClassifierCV`** (sigmoid, `cv=4`), saved as **`calibrated_model.joblib`** (scikit-learn / **joblib** — not Transformers). Load in Python with **`joblib.load`**. Use **`model_meta.json`** with it: **14** feature names in order (`feature_columns`), score formula, holdout **metrics**, tier labels.
11
 
@@ -20,3 +20,4 @@ license: mit
20
  **Use / limits:** Prioritization / exploration only — **not** an automatic lending decision. Simulated labels; **no** fairness audit on protected attributes (not in schema). Hyperparameters **hand-tuned**, not full HPO.
21
 
22
  **Privacy:** Scores only with **member consent** and **minimum necessary** identifiers.
 
 
1
  ---
2
  license: mit
3
  ---
4
+ # Model card Ikimina Reliability Index
5
 
6
+ **Artifacts:** Use the **Files** tab on this repository. Required: **`calibrated_model.joblib`**, **`model_meta.json`**. Optional: **`month_imputes.json`**, **`group_reliability.json`**.
7
 
8
+ **Source code:** This repository stores checkpoints only. The training and scoring pipeline is implemented in **`generate_data.py`**, **`features.py`**, **`train_model.py`**, **`scorer.py`**, and **`train.ipynb`**, supplied alongside this model as part of the same deliverable.
9
 
10
  **What this is:** CPU **XGBoost** (`tree_method="hist"`) + **`CalibratedClassifierCV`** (sigmoid, `cv=4`), saved as **`calibrated_model.joblib`** (scikit-learn / **joblib** — not Transformers). Load in Python with **`joblib.load`**. Use **`model_meta.json`** with it: **14** feature names in order (`feature_columns`), score formula, holdout **metrics**, tier labels.
11
 
 
20
  **Use / limits:** Prioritization / exploration only — **not** an automatic lending decision. Simulated labels; **no** fairness audit on protected attributes (not in schema). Hyperparameters **hand-tuned**, not full HPO.
21
 
22
  **Privacy:** Scores only with **member consent** and **minimum necessary** identifiers.
23
+