Score Tool

The Score tool requires two inputs:

• The model object produced in an R-based predictive tool.
• A data stream that contains the predictor fields selected in the model configuration. This can be a standard Alteryx data stream or an XDF metadata stream.

Connect these inputs to the Score tool input to begin configuration.

Supported models

The Score tool can use a data stream from a predictive model, even if it was estimated using a RevoScaleR function. The Score tool can only use an XDF metadata stream if the input to the modeling tool was from either an XDF Output Tool or XDF Input Tool and the model was estimated using a RevoScaleR function.

Models estimated by Oracle R Enterprise using an In-DB predictive tool connected to an Oracle data source cannot be used to score a standard Alteryx data stream, although models estimated with a standard Alteryx data stream can be used to score Oracle data sources.

• The new field name (continuous target) or prefix (categorical target): The field name or prefix must start with a letter and may contain letters, numbers, and the special characters period (".") and underscore ("_"). R is case sensitive.
• The target field has an oversampled value: Select to provide:
  • The value of the target field that was oversampled: The name of the oversampled field.
  • The percentage of the oversampled value in the original data prior to oversampling: The percentage of values that were repeated during oversampling.
  These fields are used to adjust the fitted probabilities to match the true sample percentages.

  The adjustments made through this option are only valid if the target is a binary categorical variable.

• Non-regularized linear regression only options:
  • The target field has been natural log transformed: Select to apply a transformation that fits the values back to the original scale and to use a Smearing estimator to account for the subsequent transformation bias.
  • Include a prediction confidence interval: Select to specify the value used to calculate confidence intervals.

    If using an ORE-created model, the original estimation table must exist in the database to calculate confidence intervals.

• XDF input specific options:
• Append scores to the input XDF file: Select to append scores to the input XDF file instead of placing them into an Alteryx data stream.
• The number of records to score at a time: Select the number of records in a group. Input data is scored one group at a time to avoid the in-memory processing limitation of R.

The Score tool requires two inputs:

• The model object produced in an R-based predictive tool.
• A data stream that contains the predictor fields selected in the model configuration. This can be a standard Alteryx data stream or an XDF metadata stream.

Connect these inputs to the Score tool input to begin configuration.

Supported models

The Score tool can use a data stream from a predictive model, even if it was estimated using a RevoScaleR function. The Score tool can only use an XDF metadata stream if the input to the modeling tool was from either an XDF Output Tool or XDF Input Tool and the model was estimated using a RevoScaleR function.

Models estimated by ORE using an In-DB predictive tool connected to an Oracle data source cannot be used to score a standard Alteryx data stream, although models estimated with a standard Alteryx data stream can be used to score Oracle data sources.

• Output table name: Type the name of the table that the results are saved to in the database.
• The new field name (continuous target) or prefix (categorical target): The field name or prefix must start with a letter and may contain letters, numbers, and the special characters period (".") and underscore ("_").

  No other special characters are allowed, and R is case sensitive.

• The target field has an oversampled value: Select to provide:
  • The value of the target field that was oversampled: The name of the oversampled field.
  • The percentage of the oversampled value in the original data prior to oversampling: The percentage of values that were repeated during oversampling.
  These fields are used to adjust the fitted probabilities to match the true sample percentages.

  The adjustments made through this option are only valid if the target is a binary categorical variable.

• Linear regression only options:
  • The target field has been natural log transformed: Select to apply a transformation that fits the values back to the original scale and to use a Smearing estimator to account for the subsequent transformation bias.
  • Include a prediction confidence interval: Select to specify the value used to calculate confidence intervals.

    If using an ORE-created model, the original estimation table must exist in the database to calculate confidence intervals.

• Teradata specific configuration: Microsoft R Server needs additional configuration information about the specific Teradata platform to be used:
  • The Teradata server paths to R's binary executables
  • The temporary file write location that is used by Microsoft R Server.
  This information is typically provided by a local Teradata administrator.

• Model Source: Select the source of the model object that is passed into the (M) input of the Score tool. This can be either:
  • In the database, identified by the value in the "Name" field of the data stream.
  • Contained in the "Object" field of the data stream.

The output includes the original data streams with the predicted values of the model.

In the case of a model that uses a categorical target, a predicted probability for each level of the target variable is provided in a field name comprised of the user-provided prefix and the suffix of the field that corresponds to the possible level of the target variable.

1. Click Add Connection.
2. In the Add Connection window, enter an Alteryx Promote URL, a URL that points to the location where your model is stored.
3. Click Next.
4. In the Alteryx Promote Credentials window, type your Username and API Key.
5. Click Connect.
6. If successful, in the Connection Established window, select Finish. The new connection is selected and visible in the drop-down.

1. Select an available connection.
2. Click Remove Connection.
3. In the Confirmation window, verify the URL and Username are associated with the connection you want to remove.
4. Click OK. The connection is no longer available in the drop-down.