oracle.epm.api.model

Class MlModel

java.lang.Object

oracle.epm.api.model.MlModel

public class MlModel
extends java.lang.Object

This object represents a ML Model.

By default, parameters are case insensitive and may not be null or empty unless otherwise specified.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object arg0)
java.lang.String	getName() Returns the name of this ML model.
java.lang.String	getPath() Returns the path of this ML model from the root.
int	hashCode()
MlPredictionStatus[]	predict(java.lang.Object... input) Returns the predicted values for the set of inputs.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Returns the name of this ML model.

Returns:

the name of this ML model

getPath

public java.lang.String getPath()

Returns the path of this ML model from the root.

Returns:

the path of this ML model from the root

predict

public MlPredictionStatus[] predict(java.lang.Object... input)

Returns the predicted values for the set of inputs.

Parameters:

input - a list of input value arrays

Example call from Groovy to predict one value:

 if (operation.application.hasMlModel("/Library", "Model 1")) {
     MlModel model = operation.application.getMlModel("/Library", "Model 1")
     println model.predict("1","2","3","4","5")[0].PredictedValue
 }
 

The predicted output value will be printed to the job console as follows: 512.4775380929867

Example call from Groovy to predict multiple values:

 def inputs = [["1","2","3","4","5"] as String[], ["6","8","9","10"] as String[]]
 if (operation.application.hasMlModel("/Library", "Model 1")) {
     MlModel model = operation.application.getMlModel("/Library", "Model 1")
     MlPredictionStatus[] predictedValue = model.predict(inputs)
     predictedValue.each() { MlPredictionStatus status ->
         println status.success ? status.predictedValue : status.errorMessage
     }
 }
 

The prediction output values or error messages will be printed to the job console as follows: 512.4775380929867 The number of inputs provided do not match the expected inputs by the ML model.

Returns:

the predicted values for the set of inputs.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object

equals

public boolean equals(java.lang.Object arg0)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object