score_direction

Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

score_direction(method: str) → str[source]

Return the selection rule for a validation score.

Parameters:: method – Validation score name, e.g. "silhouette" or "elbow".
Returns:: One of MAXIMIZE, MINIMIZE, KNEE or BIC_GRADIENT. Unknown names fall back to MAXIMIZE, matching the v0.1 default.