File size: 9,035 Bytes
75b9644
 
 
 
 
 
 
 
 
 
 
 
 
 
e04d581
3c9829c
75b9644
3c9829c
 
 
 
 
 
 
 
 
75b9644
 
 
 
 
 
 
 
 
 
e04d581
75b9644
 
 
 
 
 
 
 
3c9829c
 
 
 
75b9644
 
3c9829c
 
 
 
 
75b9644
3c9829c
 
 
 
 
 
 
 
 
 
 
 
 
 
75b9644
 
3c9829c
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
75b9644
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
e04d581
 
 
 
 
 
 
 
75b9644
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
e04d581
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
75b9644
 
 
 
 
 
9c69672
9e60540
 
 
 
 
9c69672
9e60540
 
 
 
 
9c69672
9e60540
 
 
 
 
9c69672
9e60540
 
 
 
 
9c69672
9e60540
 
 
 
 
75b9644
 
 
 
 
 
 
 
e04d581
75b9644
 
 
 
 
 
e04d581
75b9644
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
"""App-side helpers to load artifacts and build visual outputs."""

from __future__ import annotations

import json
import pickle
from dataclasses import dataclass
from pathlib import Path
from typing import Any

import joblib
import pandas as pd
import plotly.express as px
import plotly.graph_objects as go
from sklearn.metrics import auc, confusion_matrix, roc_curve
from sklearn.model_selection import train_test_split

from credit_risk.config import (
    DATA_PROCESSED_DIR,
    DATA_RAW_PATH,
    MODEL_DIR,
    REPORTS_DIR,
    SELECTED_FEATURES,
)
from credit_risk.features import build_training_frame
from credit_risk.modeling import evaluate_model, save_metrics, save_model, train_model


@dataclass
class AppArtifacts:
    """Objects loaded once at startup to keep app latency low."""

    model: Any
    metrics: dict[str, float]
    feature_importance_plot: go.Figure
    confusion_matrix_plot: go.Figure
    roc_curve_plot: go.Figure


def _load_model() -> Any:
    """Load the most recent model artifact with backward-compatible fallback."""
    joblib_path = MODEL_DIR / "model.joblib"
    legacy_pickle_path = MODEL_DIR / "model.pickle"

    if joblib_path.exists():
        try:
            return joblib.load(joblib_path)
        except Exception:
            pass

    if legacy_pickle_path.exists():
        try:
            with legacy_pickle_path.open("rb") as file:
                return pickle.load(file)
        except Exception:
            pass

    return _retrain_and_persist_artifacts()


def _retrain_and_persist_artifacts() -> Any:
    """Rebuild model artifacts when serialized files are missing/incompatible."""
    raw_df = pd.read_csv(DATA_RAW_PATH)
    features, target = build_training_frame(raw_df)

    x_train, x_test, y_train, y_test = train_test_split(
        features,
        target,
        test_size=0.3,
        random_state=42,
        stratify=target,
    )

    model = train_model(x_train=x_train, y_train=y_train, random_state=42)
    metrics, y_hat = evaluate_model(model=model, x_test=x_test, y_test=y_test)

    DATA_PROCESSED_DIR.mkdir(parents=True, exist_ok=True)
    x_train.to_parquet(DATA_PROCESSED_DIR / "x_train.parquet", index=False)
    x_test.to_parquet(DATA_PROCESSED_DIR / "x_test.parquet", index=False)
    y_train.to_frame(name="target").to_parquet(DATA_PROCESSED_DIR / "y_train.parquet", index=False)
    y_test.to_frame(name="target").to_parquet(DATA_PROCESSED_DIR / "y_test.parquet", index=False)
    y_hat.to_frame(name="prediction").to_parquet(DATA_PROCESSED_DIR / "yhat.parquet", index=False)

    save_model(model=model, model_path=MODEL_DIR / "model.joblib")
    with (MODEL_DIR / "model.pickle").open("wb") as file:
        pickle.dump(model, file)
    save_metrics(metrics=metrics, path=REPORTS_DIR / "metrics.json")
    return model


def _load_metrics() -> dict[str, float]:
    """Load cached metrics, or return an empty dict when not available."""
    metrics_path = REPORTS_DIR / "metrics.json"
    if not metrics_path.exists():
        return {}
    return json.loads(metrics_path.read_text(encoding="utf-8"))


def _load_test_outputs() -> tuple[pd.Series | None, pd.Series | None]:
    """Load y_test and yhat predictions used to generate confusion matrix."""
    y_test_path = Path("data") / "processed" / "y_test.parquet"
    y_hat_path = Path("data") / "processed" / "yhat.parquet"

    if not y_test_path.exists() or not y_hat_path.exists():
        return None, None

    y_test = pd.read_parquet(y_test_path).squeeze()
    y_hat = pd.read_parquet(y_hat_path).squeeze()
    return y_test, y_hat


def _load_x_test() -> pd.DataFrame | None:
    """Load x_test features used to compute ROC curve from model probabilities."""
    x_test_path = Path("data") / "processed" / "x_test.parquet"
    if not x_test_path.exists():
        return None
    return pd.read_parquet(x_test_path)


def _build_feature_importance_plot(model: Any) -> go.Figure:
    """Build a robust plot even when the estimator has no feature_importances_."""
    if hasattr(model, "feature_importances_"):
        importances = pd.Series(model.feature_importances_, index=SELECTED_FEATURES)
        data = (
            importances.sort_values(ascending=False)
            .rename_axis("feature")
            .reset_index(name="importance")
        )
        return px.bar(
            data,
            x="feature",
            y="importance",
            title="Feature Importance",
            labels={"feature": "Feature", "importance": "Importance"},
        )

    return go.Figure(
        layout={
            "title": "Feature importance is not available for this model type.",
            "xaxis_title": "Feature",
            "yaxis_title": "Importance",
        }
    )


def _build_confusion_matrix_plot(y_test: pd.Series | None, y_hat: pd.Series | None) -> go.Figure:
    """Build confusion matrix from cached test predictions."""
    if y_test is None or y_hat is None:
        return go.Figure(
            layout={
                "title": "Confusion matrix not available yet. Run training script first.",
                "xaxis_title": "Predicted",
                "yaxis_title": "Actual",
            }
        )

    matrix = confusion_matrix(y_test, y_hat)
    return px.imshow(
        matrix,
        x=["Predicted 0", "Predicted 1"],
        y=["Actual 0", "Actual 1"],
        color_continuous_scale="Blues",
        text_auto=True,
        labels={"x": "Predicted", "y": "Actual", "color": "Count"},
        title="Confusion Matrix",
    )


def _build_roc_curve_plot(model: Any, y_test: pd.Series | None, x_test: pd.DataFrame | None) -> go.Figure:
    """Build ROC curve when model probabilities and test data are available."""
    if y_test is None or x_test is None or not hasattr(model, "predict_proba"):
        return go.Figure(
            layout={
                "title": "ROC curve not available yet. Run training script first.",
                "xaxis_title": "False Positive Rate",
                "yaxis_title": "True Positive Rate",
            }
        )

    y_score = model.predict_proba(x_test)[:, 1]
    fpr, tpr, _ = roc_curve(y_test, y_score)
    roc_auc = auc(fpr, tpr)

    fig = go.Figure()
    fig.add_trace(
        go.Scatter(
            x=fpr,
            y=tpr,
            mode="lines",
            name=f"ROC Curve (AUC = {roc_auc:.4f})",
        )
    )
    fig.add_trace(
        go.Scatter(
            x=[0, 1],
            y=[0, 1],
            mode="lines",
            name="Baseline (AUC = 0.5)",
            line={"dash": "dash"},
        )
    )
    fig.update_layout(
        title=f"ROC Curve (AUC = {roc_auc:.4f})",
        xaxis_title="False Positive Rate",
        yaxis_title="True Positive Rate",
    )
    return fig


def format_metrics_markdown(metrics: dict[str, float]) -> str:
    """Render metrics consistently in the UI."""
    if not metrics:
        return "Metrics not available. Run `python scripts/train_model.py` first."

    lines = ["### Model Metrics"]
    if "accuracy" in metrics:
        lines.append(
            f"- **Accuracy (TP + TN) / (TP + TN + FP + FN):** {metrics['accuracy']:.4f}  \n"
            "  Proportion of correct predictions among all predictions. "
            "The closer to 1.0 (100%), the better."
        )
    if "precision" in metrics:
        lines.append(
            f"- **Precision TP / (TP + FP):** {metrics['precision']:.4f}  \n"
            "  Among predicted positives, how many are truly positive. "
            "The closer to 1.0 (100%), the better."
        )
    if "recall" in metrics:
        lines.append(
            f"- **Recall TP / (TP + FN):** {metrics['recall']:.4f}  \n"
            "  Among actual positives, how many the model correctly identifies. "
            "The closer to 1.0 (100%), the better."
        )
    if "f1_score" in metrics:
        lines.append(
            f"- **F1 Score 2 * (Precision * Recall) / (Precision + Recall):** {metrics['f1_score']:.4f}  \n"
            "  Harmonic mean of Precision and Recall, useful when you need balance between both. "
            "The closer to 1.0 (100%), the better."
        )
    if "roc_auc" in metrics:
        lines.append(
            f"- **ROC AUC (Area Under ROC Curve):** {metrics['roc_auc']:.4f}  \n"
            "  Measures how well the model separates positive and negative classes across thresholds. "
            "0.5 is random-like performance; the closer to 1.0, the better."
        )
    return "\n".join(lines)


def load_artifacts() -> AppArtifacts:
    """Entry point used by the app to pre-load model and visual assets once."""
    model = _load_model()
    metrics = _load_metrics()
    y_test, y_hat = _load_test_outputs()
    x_test = _load_x_test()

    return AppArtifacts(
        model=model,
        metrics=metrics,
        feature_importance_plot=_build_feature_importance_plot(model),
        confusion_matrix_plot=_build_confusion_matrix_plot(y_test, y_hat),
        roc_curve_plot=_build_roc_curve_plot(model, y_test, x_test),
    )