You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Glue::Types::FindMatchesParameters

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

Note:

When making an API call, you may pass FindMatchesParameters data as a hash:

{
  primary_key_column_name: "ColumnNameString",
  precision_recall_tradeoff: 1.0,
  accuracy_cost_tradeoff: 1.0,
  enforce_provided_labels: false,
}

The parameters to configure the find matches transform.

Instance Attribute Summary collapse

Instance Attribute Details

#accuracy_cost_tradeoffFloat

The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate FindMatches transform, sometimes with unacceptable accuracy.

Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.

Cost measures how many compute resources, and thus money, are consumed to run the transform.

Returns:

  • (Float)


4668
4669
4670
4671
4672
4673
4674
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4668

class FindMatchesParameters < Struct.new(
  :primary_key_column_name,
  :precision_recall_tradeoff,
  :accuracy_cost_tradeoff,
  :enforce_provided_labels)
  include Aws::Structure
end

#enforce_provided_labelsBoolean

The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model.

Note that setting this value to true may increase the conflation execution time.

Returns:

  • (Boolean)


4668
4669
4670
4671
4672
4673
4674
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4668

class FindMatchesParameters < Struct.new(
  :primary_key_column_name,
  :precision_recall_tradeoff,
  :accuracy_cost_tradeoff,
  :enforce_provided_labels)
  include Aws::Structure
end

#precision_recall_tradeoffFloat

The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.

The precision metric indicates how often your model is correct when it predicts a match.

The recall metric indicates that for an actual match, how often your model predicts the match.

Returns:

  • (Float)


4668
4669
4670
4671
4672
4673
4674
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4668

class FindMatchesParameters < Struct.new(
  :primary_key_column_name,
  :precision_recall_tradeoff,
  :accuracy_cost_tradeoff,
  :enforce_provided_labels)
  include Aws::Structure
end

#primary_key_column_nameString

The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

Returns:

  • (String)


4668
4669
4670
4671
4672
4673
4674
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4668

class FindMatchesParameters < Struct.new(
  :primary_key_column_name,
  :precision_recall_tradeoff,
  :accuracy_cost_tradeoff,
  :enforce_provided_labels)
  include Aws::Structure
end