snowflake-ml-python 1.1.1__py3-none-any.whl → 1.1.2__py3-none-any.whl

snowflake/ml/modeling/metrics/classification.py

@@ -5,7 +5,6 @@ import warnings
 from typing import Any, Dict, Iterable, List, Optional, Set, Tuple, Union
 
 import cloudpickle
-import numpy
 import numpy as np
 import numpy.typing as npt
 from sklearn import exceptions, metrics
@@ -43,12 +42,17 @@ def accuracy_score(
     corresponding set of labels in the y true columns.
 
     Args:
-        df: Input dataframe.
-        y_true_col_names: Column name(s) representing actual values.
-        y_pred_col_names: Column name(s) representing predicted values.
-        normalize: If ``False``, return the number of correctly classified samples.
+        df: snowpark.DataFrame
+            Input dataframe.
+        y_true_col_names: string or list of strings
+            Column name(s) representing actual values.
+        y_pred_col_names: string or list of strings
+            Column name(s) representing predicted values.
+        normalize: boolean, default=True
+            If ``False``, return the number of correctly classified samples.
             Otherwise, return the fraction of correctly classified samples.
-        sample_weight_col_name: Column name representing sample weights.
+        sample_weight_col_name: string, default=None
+            Column name representing sample weights.
 
     Returns:
         If ``normalize == True``, return the fraction of correctly
@@ -102,14 +106,19 @@ def confusion_matrix(
     :math:`C_{1,1}` and false positives is :math:`C_{0,1}`.
 
     Args:
-        df: Input dataframe.
-        y_true_col_name: Column name representing actual values.
-        y_pred_col_name: Column name representing predicted values.
-        labels: List of labels to index the matrix. This may be used to
+        df: snowpark.DataFrame
+            Input dataframe.
+        y_true_col_name: string or list of strings
+            Column name representing actual values.
+        y_pred_col_name: string or list of strings
+            Column name representing predicted values.
+        labels: list of labels, default=None
+            List of labels to index the matrix. This may be used to
             reorder or select a subset of labels.
             If ``None`` is given, those that appear at least once in the
             y true or y pred column are used in sorted order.
-        sample_weight_col_name: Column name representing sample weights.
+        sample_weight_col_name: string, default=None
+            Column name representing sample weights.
         normalize: {'true', 'pred', 'all'}, default=None
             Normalizes confusion matrix over the true (rows), predicted (columns)
             conditions or all the population. If None, confusion matrix will not be
@@ -124,7 +133,9 @@ def confusion_matrix(
 
     Raises:
         ValueError: The given ``labels`` is empty.
+
         ValueError: No label specified in the given ``labels`` is in the y true column.
+
         ValueError: ``normalize`` is not one of {'true', 'pred', 'all', None}.
     """
     assert df._session is not None
@@ -323,17 +334,22 @@ def f1_score(
     parameter.
 
     Args:
-        df: Input dataframe.
-        y_true_col_names: Column name(s) representing actual values.
-        y_pred_col_names: Column name(s) representing predicted values.
-        labels: The set of labels to include when ``average != 'binary'``, and
+        df: snowpark.DataFrame
+            Input dataframe.
+        y_true_col_names: string or list of strings
+            Column name(s) representing actual values.
+        y_pred_col_names: string or list of strings
+            Column name(s) representing predicted values.
+        labels: list of labels, default=None
+            The set of labels to include when ``average != 'binary'``, and
             their order if ``average is None``. Labels present in the data can be
             excluded, for example to calculate a multiclass average ignoring a
             majority negative class, while labels not present in the data will
             result in 0 components in a macro average. For multilabel targets,
             labels are column indices. By default, all labels in the y true and
             y pred columns are used in sorted order.
-        pos_label: The class to report if ``average='binary'`` and the data is
+        pos_label:  string or integer, default=1
+            The class to report if ``average='binary'`` and the data is
             binary. If the data are multiclass or multilabel, this will be ignored;
             setting ``labels=[pos_label]`` and ``average != 'binary'`` will report
             scores for that label only.
@@ -359,7 +375,8 @@ def f1_score(
                 Calculate metrics for each instance, and find their average (only
                 meaningful for multilabel classification where this differs from
                 func`accuracy_score`).
-        sample_weight_col_name: Column name representing sample weights.
+        sample_weight_col_name: string, default=None
+            Column name representing sample weights.
         zero_division: "warn", 0 or 1, default="warn"
             Sets the value to return when there is a zero division, i.e. when all
             predictions and labels are negative. If set to "warn", this acts as 0,
@@ -408,18 +425,24 @@ def fbeta_score(
     only recall).
 
     Args:
-        df: Input dataframe.
-        y_true_col_names: Column name(s) representing actual values.
-        y_pred_col_names: Column name(s) representing predicted values.
-        beta: Determines the weight of recall in the combined score.
-        labels: The set of labels to include when ``average != 'binary'``, and
+        df: snowpark.DataFrame
+            Input dataframe.
+        y_true_col_names: string or list of strings
+            Column name(s) representing actual values.
+        y_pred_col_names: string or list of strings
+            Column name(s) representing predicted values.
+        beta: float
+            Determines the weight of recall in the combined score.
+        labels: list of labels, default=None
+            The set of labels to include when ``average != 'binary'``, and
             their order if ``average is None``. Labels present in the data can be
             excluded, for example to calculate a multiclass average ignoring a
             majority negative class, while labels not present in the data will
             result in 0 components in a macro average. For multilabel targets,
             labels are column indices. By default, all labels in the y true and
             y pred columns are used in sorted order.
-        pos_label: The class to report if ``average='binary'`` and the data is
+        pos_label: string or integer, default=1
+            The class to report if ``average='binary'`` and the data is
             binary. If the data are multiclass or multilabel, this will be ignored;
             setting ``labels=[pos_label]`` and ``average != 'binary'`` will report
             scores for that label only.
@@ -445,7 +468,8 @@ def fbeta_score(
                 Calculate metrics for each instance, and find their average (only
                 meaningful for multilabel classification where this differs from
                 func`accuracy_score`).
-        sample_weight_col_name: Column name representing sample weights.
+        sample_weight_col_name: string, default=None
+            Column name representing sample weights.
         zero_division: "warn", 0 or 1, default="warn"
             Sets the value to return when there is a zero division, i.e. when all
             predictions and labels are negative. If set to "warn", this acts as 0,
@@ -498,9 +522,12 @@ def log_loss(
         L_{\log}(y, p) = -(y \log (p) + (1 - y) \log (1 - p))
 
     Args:
-        df: Input dataframe.
-        y_true_col_names: Column name(s) representing actual values.
-        y_pred_col_names: Column name(s) representing predicted probabilities,
+        df: snowpark.DataFrame
+            Input dataframe.
+        y_true_col_names: string or list of strings
+            Column name(s) representing actual values.
+        y_pred_col_names: string or list of strings
+            Column name(s) representing predicted probabilities,
             as returned by a classifier's predict_proba method.
             If ``y_pred.shape = (n_samples,)`` the probabilities provided are
             assumed to be that of the positive class. The labels in ``y_pred``
@@ -509,10 +536,13 @@ def log_loss(
             Log loss is undefined for p=0 or p=1, so probabilities are
             clipped to `max(eps, min(1 - eps, p))`. The default will depend on the
             data type of `y_pred` and is set to `np.finfo(y_pred.dtype).eps`.
-        normalize: If true, return the mean loss per sample.
+        normalize: boolean, default=True
+            If true, return the mean loss per sample.
             Otherwise, return the sum of the per-sample losses.
-        sample_weight_col_name: Column name representing sample weights.
-        labels: If not provided, labels will be inferred from y_true. If ``labels``
+        sample_weight_col_name: string, default=None
+            Column name representing sample weights.
+        labels: list of labels, default=None
+            If not provided, labels will be inferred from y_true. If ``labels``
             is ``None`` and ``y_pred`` has shape (n_samples,) the labels are
             assumed to be binary and are inferred from ``y_true``.
 
@@ -697,18 +727,24 @@ def precision_recall_fscore_support(
     is one of ``'micro'``, ``'macro'``, ``'weighted'`` or ``'samples'``.
 
     Args:
-        df: Input dataframe.
-        y_true_col_names: Column name(s) representing actual values.
-        y_pred_col_names: Column name(s) representing predicted values.
-        beta: The strength of recall versus precision in the F-score.
-        labels: The set of labels to include when ``average != 'binary'``, and
+        df: snowpark.DataFrame
+            Input dataframe.
+        y_true_col_names: string or list of strings
+            Column name(s) representing actual values.
+        y_pred_col_names: string or list of strings
+            Column name(s) representing predicted values.
+        beta: float, default=1.0
+            The strength of recall versus precision in the F-score.
+        labels: list of labels, default=None
+            The set of labels to include when ``average != 'binary'``, and
             their order if ``average is None``. Labels present in the data can be
             excluded, for example to calculate a multiclass average ignoring a
             majority negative class, while labels not present in the data will
             result in 0 components in a macro average. For multilabel targets,
             labels are column indices. By default, all labels in the y true and
             y pred columns are used in sorted order.
-        pos_label: The class to report if ``average='binary'`` and the data is
+        pos_label: string or integer, default=1
+            The class to report if ``average='binary'`` and the data is
             binary. If the data are multiclass or multilabel, this will be ignored;
             setting ``labels=[pos_label]`` and ``average != 'binary'`` will report
             scores for that label only.
@@ -733,9 +769,11 @@ def precision_recall_fscore_support(
                 Calculate metrics for each instance, and find their average (only
                 meaningful for multilabel classification where this differs from
                 :func:`accuracy_score`).
-        warn_for: This determines which warnings will be made in the case that this
+        warn_for: tuple or set containing "precision", "recall", or "f-score"
+            This determines which warnings will be made in the case that this
             function is being used to return only one of its metrics.
-        sample_weight_col_name: Column name representing sample weights.
+        sample_weight_col_name: string, default=None
+            Column name representing sample weights.
         zero_division: "warn", 0 or 1, default="warn"
             Sets the value to return when there is a zero division:
                * recall - when there are no positive labels
@@ -980,6 +1018,78 @@ def _register_multilabel_confusion_matrix_computer(
     return multilabel_confusion_matrix_computer
 
 
+def _binary_precision_score(
+    *,
+    df: snowpark.DataFrame,
+    y_true_col_names: Union[str, List[str]],
+    y_pred_col_names: Union[str, List[str]],
+    pos_label: Union[str, int] = 1,
+    sample_weight_col_name: Optional[str] = None,
+    zero_division: Union[str, int] = "warn",
+) -> Union[float, npt.NDArray[np.float_]]:
+
+    statement_params = telemetry.get_statement_params(_PROJECT, _SUBPROJECT)
+
+    if isinstance(y_true_col_names, str):
+        y_true_col_names = [y_true_col_names]
+    if isinstance(y_pred_col_names, str):
+        y_pred_col_names = [y_pred_col_names]
+
+    if len(y_pred_col_names) != len(y_true_col_names):
+        raise ValueError(
+            "precision_score: `y_true_col_names` and `y_pred_column_names` must be lists of the same length "
+            "or both strings."
+        )
+
+    # Confirm that the data is binary.
+    labels_set = set()
+    columns = y_true_col_names + y_pred_col_names
+    column_labels_lists = df.select(*[F.array_unique_agg(col) for col in columns]).collect(
+        statement_params=statement_params
+    )[0]
+    for column_labels_list in column_labels_lists:
+        for column_label in json.loads(column_labels_list):
+            labels_set.add(column_label)
+    labels = sorted(list(labels_set))
+    _ = _check_binary_labels(labels, pos_label=pos_label)
+
+    sample_weight_column = df[sample_weight_col_name] if sample_weight_col_name else None
+
+    scores = []
+    for y_true, y_pred in zip(y_true_col_names, y_pred_col_names):
+        tp_col = F.iff((F.col(y_true) == pos_label) & (F.col(y_pred) == pos_label), 1, 0)
+        fp_col = F.iff((F.col(y_true) != pos_label) & (F.col(y_pred) == pos_label), 1, 0)
+        tp = metrics_utils.weighted_sum(
+            df=df,
+            sample_score_column=tp_col,
+            sample_weight_column=sample_weight_column,
+            statement_params=statement_params,
+        )
+        fp = metrics_utils.weighted_sum(
+            df=df,
+            sample_score_column=fp_col,
+            sample_weight_column=sample_weight_column,
+            statement_params=statement_params,
+        )
+
+        try:
+            score = tp / (tp + fp)
+        except ZeroDivisionError:
+            if zero_division == "warn":
+                msg = "precision_score: division by zero: score value will be 0."
+                warnings.warn(msg, exceptions.UndefinedMetricWarning, stacklevel=2)
+                score = 0.0
+            else:
+                score = float(zero_division)
+
+        scores.append(score)
+
+    if len(scores) == 1:
+        return scores[0]
+
+    return np.array(scores)
+
+
 @telemetry.send_api_usage_telemetry(project=_PROJECT, subproject=_SUBPROJECT)
 def precision_score(
     *,
@@ -1003,17 +1113,22 @@ def precision_score(
     The best value is 1 and the worst value is 0.
 
     Args:
-        df: Input dataframe.
-        y_true_col_names: Column name(s) representing actual values.
-        y_pred_col_names: Column name(s) representing predicted values.
-        labels: The set of labels to include when ``average != 'binary'``, and
+        df: snowpark.DataFrame
+            Input dataframe.
+        y_true_col_names: string or list of strings
+            Column name(s) representing actual values.
+        y_pred_col_names: string or list of strings
+            Column name(s) representing predicted values.
+        labels: list of labels, default=None
+            The set of labels to include when ``average != 'binary'``, and
             their order if ``average is None``. Labels present in the data can be
             excluded, for example to calculate a multiclass average ignoring a
             majority negative class, while labels not present in the data will
             result in 0 components in a macro average. For multilabel targets,
             labels are column indices. By default, all labels in the y true and
             y pred columns are used in sorted order.
-        pos_label: The class to report if ``average='binary'`` and the data is
+        pos_label: string or integer, default=1
+            The class to report if ``average='binary'`` and the data is
             binary. If the data are multiclass or multilabel, this will be ignored;
             setting ``labels=[pos_label]`` and ``average != 'binary'`` will report
             scores for that label only.
@@ -1038,7 +1153,8 @@ def precision_score(
                 Calculate metrics for each instance, and find their average (only
                 meaningful for multilabel classification where this differs from
                 func`accuracy_score`).
-        sample_weight_col_name: Column name representing sample weights.
+        sample_weight_col_name: string, default=None
+            Column name representing sample weights.
         zero_division: "warn", 0 or 1, default="warn"
             Sets the value to return when there is a zero division. If set to
             "warn", this acts as 0, but warnings are also raised.
@@ -1048,6 +1164,16 @@ def precision_score(
             Precision of the positive class in binary classification or weighted
             average of the precision of each class for the multiclass task.
     """
+    if average == "binary":
+        return _binary_precision_score(
+            df=df,
+            y_true_col_names=y_true_col_names,
+            y_pred_col_names=y_pred_col_names,
+            pos_label=pos_label,
+            sample_weight_col_name=sample_weight_col_name,
+            zero_division=zero_division,
+        )
+
     p, _, _, _ = precision_recall_fscore_support(
         df=df,
         y_true_col_names=y_true_col_names,
@@ -1084,17 +1210,22 @@ def recall_score(
     The best value is 1 and the worst value is 0.
 
     Args:
-        df: Input dataframe.
-        y_true_col_names: Column name(s) representing actual values.
-        y_pred_col_names: Column name(s) representing predicted values.
-        labels: The set of labels to include when ``average != 'binary'``, and
+        df: snowpark.DataFrame
+            Input dataframe.
+        y_true_col_names: string or list of strings
+            Column name(s) representing actual values.
+        y_pred_col_names: string or list of strings
+            Column name(s) representing predicted values.
+        labels: list of labels, default=None
+            The set of labels to include when ``average != 'binary'``, and
             their order if ``average is None``. Labels present in the data can be
             excluded, for example to calculate a multiclass average ignoring a
             majority negative class, while labels not present in the data will
             result in 0 components in a macro average. For multilabel targets,
             labels are column indices. By default, all labels in the y true and
             y pred columns are used in sorted order.
-        pos_label: The class to report if ``average='binary'`` and the data is
+        pos_label: string or integer, default=1
+            The class to report if ``average='binary'`` and the data is
             binary. If the data are multiclass or multilabel, this will be ignored;
             setting ``labels=[pos_label]`` and ``average != 'binary'`` will report
             scores for that label only.
@@ -1121,7 +1252,8 @@ def recall_score(
                 Calculate metrics for each instance, and find their average (only
                 meaningful for multilabel classification where this differs from
                 func`accuracy_score`).
-        sample_weight_col_name: Column name representing sample weights.
+        sample_weight_col_name: string, default=None
+            Column name representing sample weights.
         zero_division: "warn", 0 or 1, default="warn"
             Sets the value to return when there is a zero division. If set to
             "warn", this acts as 0, but warnings are also raised.
@@ -1190,10 +1322,13 @@ def _check_binary_labels(
     """
     if len(labels) <= 2:
         if len(labels) == 2 and pos_label not in labels:
-            raise ValueError(f"pos_label={pos_label} is not a valid label. It should be one of {labels}")
+            raise ValueError(f"pos_label={pos_label} is not a valid label. It must be one of {labels}")
         labels = [pos_label]
     else:
-        raise ValueError("Please choose another average setting.")
+        raise ValueError(
+            "Cannot compute precision score with binary average: there are more than two labels present."
+            "Please choose another average setting."
+        )
 
     return labels
 

snowflake/ml/modeling/metrics/correlation.py

@@ -36,8 +36,10 @@ def correlation(*, df: snowpark.DataFrame, columns: Optional[Collection[str]] =
     as a post-processing step.
 
     Args:
-        df (snowpark.DataFrame): Snowpark Dataframe for which correlation matrix has to be computed.
-        columns (Optional[Collection[str]]): List of column names for which the correlation matrix has to be computed.
+        df: snowpark.DataFrame
+            Snowpark Dataframe for which correlation matrix has to be computed.
+        columns: List of strings
+            List of column names for which the correlation matrix has to be computed.
             If None, correlation matrix is computed for all numeric columns in the snowpark dataframe.
 
     Returns:

snowflake/ml/modeling/metrics/covariance.py

@@ -36,11 +36,14 @@ def covariance(*, df: DataFrame, columns: Optional[Collection[str]] = None, ddof
     as a post-processing step.
 
     Args:
-        df (DataFrame): Snowpark Dataframe for which covariance matrix has to be computed.
-        columns (Optional[Collection[str]]): List of column names for which the covariance matrix has to be computed.
+        df: snowpark.DataFrame
+            Snowpark Dataframe for which covariance matrix has to be computed.
+        columns: list of strings, default=None
+            List of column names for which the covariance matrix has to be computed.
             If None, covariance matrix is computed for all numeric columns in the snowpark dataframe.
-        ddof (int): default 1. Delta degrees of freedom.
-            The divisor used in calculations is N - ddof, where N represents the number of rows.
+        ddof: int, default=1
+            Delta degrees of freedom. The divisor used in calculations is N - ddof, where N represents the
+            number of rows.
 
     Returns:
         Covariance matrix in pandas.DataFrame format.

snowflake/ml/modeling/metrics/ranking.py

@@ -49,18 +49,23 @@ def precision_recall_curve(
     which corresponds to a classifier that always predicts the positive class.
 
     Args:
-        df: Input dataframe.
-        y_true_col_name: Column name representing true binary labels.
+        df: snowpark.DataFrame
+            Input dataframe.
+        y_true_col_name: string
+            Column name representing true binary labels.
             If labels are not either {-1, 1} or {0, 1}, then pos_label should be
             explicitly given.
-        probas_pred_col_name: Column name representing target scores.
+        probas_pred_col_name: string
+            Column name representing target scores.
             Can either be probability estimates of the positive
             class, or non-thresholded measure of decisions (as returned by
             `decision_function` on some classifiers).
-        pos_label: The label of the positive class.
+        pos_label: string or int, default=None
+            The label of the positive class.
             When ``pos_label=None``, if y_true is in {-1, 1} or {0, 1},
             ``pos_label`` is set to 1, otherwise an error will be raised.
-        sample_weight_col_name: Column name representing sample weights.
+        sample_weight_col_name: string, default=None
+            Column name representing sample weights.
 
     Returns:
         Tuple containing following items
@@ -142,12 +147,15 @@ def roc_auc_score(
     multilabel classification, but some restrictions apply.
 
     Args:
-        df: Input dataframe.
-        y_true_col_names: Column name(s) representing true labels or binary label indicators.
+        df: snowpark.DataFrame
+            Input dataframe.
+        y_true_col_names: string or list of strings
+            Column name(s) representing true labels or binary label indicators.
             The binary and multiclass cases expect labels with shape (n_samples,)
             while the multilabel case expects binary label indicators with shape
             (n_samples, n_classes).
-        y_score_col_names: Column name(s) representing target scores.
+        y_score_col_names: string or list of strings
+            Column name(s) representing target scores.
             * In the binary case, it corresponds to an array of shape
               `(n_samples,)`. Both probability estimates and non-thresholded
               decision values can be provided. The probability estimates correspond
@@ -186,7 +194,8 @@ def roc_auc_score(
             ``'samples'``
                 Calculate metrics for each instance, and find their average.
             Will be ignored when ``y_true`` is binary.
-        sample_weight_col_name: Column name representing sample weights.
+        sample_weight_col_name: string, default=None
+            Column name representing sample weights.
         max_fpr: float > 0 and <= 1, default=None
             If not ``None``, the standardized partial AUC [2]_ over the range
             [0, max_fpr] is returned. For the multiclass case, ``max_fpr``,
@@ -208,7 +217,8 @@ def roc_auc_score(
                 possible pairwise combinations of classes [5]_.
                 Insensitive to class imbalance when
                 ``average == 'macro'``.
-        labels: Only used for multiclass targets. List of labels that index the
+        labels: list of labels, default=None
+            Only used for multiclass targets. List of labels that index the
             classes in ``y_score``. If ``None``, the numerical or lexicographical
             order of the labels in ``y_true`` is used.
 
@@ -282,19 +292,25 @@ def roc_curve(
     Note: this implementation is restricted to the binary classification task.
 
     Args:
-        df: Input dataframe.
-        y_true_col_name: Column name representing true binary labels.
+        df: snowpark.DataFrame
+            Input dataframe.
+        y_true_col_name: string
+            Column name representing true binary labels.
             If labels are not either {-1, 1} or {0, 1}, then pos_label should be
             explicitly given.
-        y_score_col_name: Column name representing target scores, can either
+        y_score_col_name: string
+            Column name representing target scores, can either
             be probability estimates of the positive class, confidence values,
             or non-thresholded measure of decisions (as returned by
             "decision_function" on some classifiers).
-        pos_label: The label of the positive class.
+        pos_label: string, default=None
+            The label of the positive class.
             When ``pos_label=None``, if `y_true` is in {-1, 1} or {0, 1},
             ``pos_label`` is set to 1, otherwise an error will be raised.
-        sample_weight_col_name: Column name representing sample weights.
-        drop_intermediate: Whether to drop some suboptimal thresholds which would
+        sample_weight_col_name: string, default=None
+            Column name representing sample weights.
+        drop_intermediate: boolean, default=True
+            Whether to drop some suboptimal thresholds which would
             not appear on a plotted ROC curve. This is useful in order to create
             lighter ROC curves.