PredictabilityEstimate - Global
-
- UpdatedAug 3, 2023
- 5 minutes to read
- Vancouver
- API reference
The PredictabilityEstimate API is a scriptable object used in Predictive Intelligence stores. This object provides estimation of how predictable fields of a dataset can be, and which features can be useful for predicting those fields.
This API requires the Predictive Intelligence plugin (com.glide.platform_ml) and is provided
within the sn_ml
namespace.
- Create a dataset using the DatasetDefinition API.
- Use the constructor to create a predictability estimate object.
- Add the predictability estimate object to the predictability estimate store using the PredictabilityEstimateStore - add() method.
- Train the predictability estimate using the submitTrainingJob() method. This creates a version of the object that you can manage using the PredictabilityEstimateVersion API.
- Get estimated predictive values using the PredictabilityEstimateVersion – getResults() method.
For usage guidelines, refer to Using ML APIs.
PredictabilityEstimate - PredictabilityEstimate(Object config)
Creates a predictability estimate.
To get new predictability estimates on the same dataset, use this constructor to create a new PredictabilityEstimate object with a unique name.
Example
The following example shows how to create an estimation job and add it to the PredictabilityEstimate store.
PredictabilityEstimate - cancelTrainingJob()
Cancels a job for a predictability estimate object that has been submitted for training.
Name | Type | Description |
---|---|---|
None |
Type | Description |
---|---|
None |
Example
The following example shows how to cancel an existing training job.
PredictabilityEstimate - getActiveVersion()
Gets the active PredictabilityEstimateVersion object.
Name | Type | Description |
---|---|---|
None |
Type | Description |
---|---|
Object | Active PredictabilityEstimateVersion object. |
Example
The following example shows how to get an active PredictabilityEstimate version from the store and return its training status.
Output:
PredictabilityEstimate - getAllVersions()
Gets all versions of a predictability estimate.
Name | Type | Description |
---|---|---|
None |
Type | Description |
---|---|
Array | Existing versions of a solution object. See also PredictabilityEstimateVersion API. |
Example
The following example shows how to get all PredictabilityEstimate version objects and call the getVersionNumber() and getStatus() estimate version methods on them.
Output:
PredictabilityEstimate - getLatestVersion()
Gets the latest version of a predictability estimate.
Name | Type | Description |
---|---|---|
None |
Type | Description |
---|---|
Object | PredictabilityEstimateVersion object corresponding to the latest version of a PredictabilityEstimate(). |
Example
The following example shows how to get the latest version of a predictability estimate and return its training status.
Output:
PredictabilityEstimate - getName()
Gets the name of the object to use for interaction with the store.
Name | Type | Description |
---|---|---|
None |
Type | Description |
---|---|
String | Name of the estimate object. |
Example
The following example shows how to update PredictabilityEstimate dataset information and print the name of the object.
Output:
PredictabilityEstimate - getProperties()
Gets predictability estimate object properties.
Name | Type | Description |
---|---|---|
None |
Example
The following example gets properties of a predictability estimate object in the store.
PredictabilityEstimate - getVersion(String version)
Gets a predictability estimate by provided version number.
Name | Type | Description |
---|---|---|
version | String | Existing version number of a predictability estimate. |
Type | Description |
---|---|
Object | Specified version of the PredictabilityEstimate() object on which you can call PredictabilityEstimateVersion API methods. |
Example
The following example shows how to get the training status of a predictability estimate by version number.
Output:
PredictabilityEstimate - setActiveVersion(String version)
Activates a specified version of a predictability estimate in the store.
Name | Type | Description |
---|---|---|
version | String | Name of the PredictabilityEstimate() object version to
activate. Activating this version deactivates any other version. |
Type | Description |
---|---|
None |
Example
The following example shows how to activate a predictability estimate version in the store.
PredictabilityEstimate - submitTrainingJob()
Submits a training job.
Name | Type | Description |
---|---|---|
None |
Type | Description |
---|---|
Object | PredictabilityEstimateVersion object corresponding to the PredictabilityEstimate being trained. |
Example
The following example shows how to create a dataset, apply it to a predictability estimate, add it to a store, and submit the training job.
On this page
- PredictabilityEstimate - PredictabilityEstimate(Object config)
- PredictabilityEstimate - cancelTrainingJob()
- PredictabilityEstimate - getActiveVersion()
- PredictabilityEstimate - getAllVersions()
- PredictabilityEstimate - getLatestVersion()
- PredictabilityEstimate - getName()
- PredictabilityEstimate - getProperties()
- PredictabilityEstimate - getVersion(String version)
- PredictabilityEstimate - setActiveVersion(String version)
- PredictabilityEstimate - submitTrainingJob()