Interface FindMatchesMetrics.Builder

All Superinterfaces:
Buildable, CopyableBuilder<FindMatchesMetrics.Builder,FindMatchesMetrics>, SdkBuilder<FindMatchesMetrics.Builder,FindMatchesMetrics>, SdkPojo
Enclosing class:
FindMatchesMetrics

public static interface FindMatchesMetrics.Builder extends SdkPojo, CopyableBuilder<FindMatchesMetrics.Builder,FindMatchesMetrics>
  • Method Details

    • areaUnderPRCurve

      FindMatchesMetrics.Builder areaUnderPRCurve(Double areaUnderPRCurve)

      The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.

      For more information, see Precision and recall in Wikipedia.

      Parameters:
      areaUnderPRCurve - The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.

      For more information, see Precision and recall in Wikipedia.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • precision

      FindMatchesMetrics.Builder precision(Double precision)

      The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.

      For more information, see Precision and recall in Wikipedia.

      Parameters:
      precision - The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.

      For more information, see Precision and recall in Wikipedia.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • recall

      The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.

      For more information, see Precision and recall in Wikipedia.

      Parameters:
      recall - The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.

      For more information, see Precision and recall in Wikipedia.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • f1

      The maximum F1 metric indicates the transform's accuracy between 0 and 1, where 1 is the best accuracy.

      For more information, see F1 score in Wikipedia.

      Parameters:
      f1 - The maximum F1 metric indicates the transform's accuracy between 0 and 1, where 1 is the best accuracy.

      For more information, see F1 score in Wikipedia.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • confusionMatrix

      FindMatchesMetrics.Builder confusionMatrix(ConfusionMatrix confusionMatrix)

      The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.

      For more information, see Confusion matrix in Wikipedia.

      Parameters:
      confusionMatrix - The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.

      For more information, see Confusion matrix in Wikipedia.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • confusionMatrix

      default FindMatchesMetrics.Builder confusionMatrix(Consumer<ConfusionMatrix.Builder> confusionMatrix)

      The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.

      For more information, see Confusion matrix in Wikipedia.

      This is a convenience method that creates an instance of the ConfusionMatrix.Builder avoiding the need to create one manually via ConfusionMatrix.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to confusionMatrix(ConfusionMatrix).

      Parameters:
      confusionMatrix - a consumer that will call methods on ConfusionMatrix.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • columnImportances

      FindMatchesMetrics.Builder columnImportances(Collection<ColumnImportance> columnImportances)

      A list of ColumnImportance structures containing column importance metrics, sorted in order of descending importance.

      Parameters:
      columnImportances - A list of ColumnImportance structures containing column importance metrics, sorted in order of descending importance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • columnImportances

      FindMatchesMetrics.Builder columnImportances(ColumnImportance... columnImportances)

      A list of ColumnImportance structures containing column importance metrics, sorted in order of descending importance.

      Parameters:
      columnImportances - A list of ColumnImportance structures containing column importance metrics, sorted in order of descending importance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • columnImportances

      FindMatchesMetrics.Builder columnImportances(Consumer<ColumnImportance.Builder>... columnImportances)

      A list of ColumnImportance structures containing column importance metrics, sorted in order of descending importance.

      This is a convenience method that creates an instance of the ColumnImportance.Builder avoiding the need to create one manually via ColumnImportance.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to columnImportances(List<ColumnImportance>).

      Parameters:
      columnImportances - a consumer that will call methods on ColumnImportance.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: