models.ready

  • Updated on Nov 11, 2020
  • Published on Oct 24, 2020
  • 1 minute(s) read
  • Ben Callister
 Prev Next

Description

Returns whether or not a machine learning (ML) model is installed and ready for use. When ready, run your model using ai.models.run.

Input Parameters

Name Type Required Description
key Text Yes Unique model identifier used during ai.models.install

Returns

Type: Boolean

Returns true if model is installed and ready for use. Otherwise, false is returned.

Examples

// check if model is installed and ready for use
if (ai.models.ready("riskModel") === true)
    debug.log("Model is ready.");
JavaScript

Remarks

Use this function to check if a machine learning (ML) model is installed and ready for use. For this to return true, you must have previously installed the model using ai.models.install.