On this Page
Overview
This is a Transform type Snap that enables you to predict the class (target/class) field for an unlabeled document. An unlabeled document is one that does not have a class field. So, the Snap reads this unlabeled document and predicts the class field. Predictions are made based on the classification model built by the Trainer (Classification) Snap.
You can configure the Snap to include the confidence level for the prediction. You can additionally specify if the Snap shows multiple predictions for a given input.
Input and Output
Expected input: An unlabeled document and the classification model.
Expected output: Predictions from the classification model based on the input document. Multiple predictions are displayed depending upon the configuration of the Max output property. Additionally, the confidence level for each prediction is displayed if the Confidence level property is selected.
Expected upstream Snaps:
- First input view: Any Snap that generates an unlabeled document. For example, JSON Parser, JSON Generator, CSV Parser, CSV Generator, Mapper, and so on.
- Second input view: Any Snap that reads and outputs the classification model. For example, a combination of File Reader, and JSON Parser.
Expected downstream Snaps: Any Snap that uses the predicted result. For example, Aggregate, or a combination of JSON Formatter and File Writer.
Prerequisites
The input document must be in tabular format (no nested structure).
Configuring Accounts
Accounts are not used with this Snap.
Configuring Views
Input | This Snap has exactly two document input views. The first input view is for the unlabeled document that requires prediction(s). The second input view is for the classification model. |
|---|---|
| Output | This Snap has exactly one document output view. |
| Error | This Snap has at most one document error view. |
Troubleshooting
None.
Limitations and Known Issues
None.
Modes
- Ultra Pipelines: Works in Ultra Pipelines.
Snap Settings
| Label | Required. The name for the Snap. Modify this to be more specific, especially if there are more than one of the same Snap in the pipeline. |
|---|---|
| Max output | Required. The maximum number of predictions for each row in the input document. The predictions are in descending order of their confidence level. Minimum value: 1 Default value: 1 |
| Confidence level | If selected, the Snap's output includes the confidence level for each prediction. The confidence level ranges from 0 to 1. The prediction with the confidence level that is closest to 1 is most likely to be the correct class field. Default value: Not selected |
Snap Execution | Select one of the following three modes in which the Snap executes:
Default Value: Execute only |
Examples
Weight Balance Classification – Testing
The model trained in the Weight Balance Classification – Model Training example pipeline is tested against an unlabeled dataset.
Download this pipeline.
To understand the dataset and the process prior to testing the model see the following examples:
Input
In this example, the unlabeled dataset is created using the CSV Generator Snap. This dataset is used as the data input for the Predictor (Classification) Snap. The classification field (Balance class) is to be predicted for this dataset.
The model trained in the Weight Balance Classification – Model Training example is used as the model input. The File Reader Snap is configured to read this model from the SLDB. The JSON Parser Snap is used to parse the output from the File Reader Snap. Below is a preview of the output from the JSON Parser Snap (the model):
Model Testing
To test a model trained on a classification dataset, the Predictor (Classification) Snap must be used.
The Predictor (Classification) Snap requires two inputs:
- An unlabeled dataset for the data input
- The ML model trained on the labeled dataset for the model input
The Predictor Snap is configured as shown below:
Based on its configuration, the output from the Snap includes one class prediction per document, and also includes the confidence level for the prediction. This output is as shown below:
Download this pipeline.
Additional Example
The following use case demonstrates a real-world scenario for using this Snap:
Downloads
Important steps to successfully reuse Pipelines
- Download and import the pipeline into the SnapLogic application.
- Configure Snap accounts as applicable.
- Provide pipeline parameters as applicable.