CoreML.Description
------------------

Queries the description of the model.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [CoreML](component_CoreML.md) | [7.4](newinversion74.md) | ✅ Yes | ❌ No | ❌ No | ✅ Yes, on macOS | ✅ Yes |

MBS( "CoreML.Description"; CoreMLRef ) 

**MBS**( **"CoreML.Description";** /\* Queries the description of the model. \*/  
**$CoreMLRef**) /\* The reference number to the model.e.g. $Model \*/ 

### Parameters

| Parameter | Description | Example |
|---|---|---|
| CoreMLRef | The reference number to the model. | $Model |

### Result

Returns JSON or error.

### Description

Queries the description of the model.  
This is returned as a JSON block.  
Common keys include predictedFeatureName, predictedProbabilitiesName, metadata, inputDescriptionsByName and outputDescriptionsByName.  
  
Added isUpdatable key in v10.0 to indicate whether model can be updated.  
Includes trainingInputDescriptionsByName and parameterDescriptionsByKey For MacOS 10.15 to provide details on training input and parameters.  
### Examples

Query description:

 Set Field \[ CoreML::Model Description ; MBS ("CoreML.Description"; $$ML ) \]  
<small>  
Example result:   
{ "predictedProbabilitiesName" : "classLabelProbs" , "predictedFeatureName" : "classLabel" , "inputDescriptionsByName" : { "image" : { "optional" : false, "type" : "Image" , "imageConstraint" : { "pixelsWide" : 224 , "pixelFormatTypeName" : "32BGRA" , "pixelFormatType" : 1111970369 , "pixelFormatTypeDescription" : "32 bit BGRA" , "pixelsHigh" : 224 }, "name" : "image" } }, "outputDescriptionsByName" : { "classLabel" : { "optional" : false, "type" : "String" , "name" : "classLabel" }, "classLabelProbs" : { "optional" : false, "dictionaryConstraint" : { "keyType" : "String" }, "type" : "Dictionary" , "name" : "classLabelProbs" } }, "metadata" : { "MLModelVersionStringKey" : "" , "MLModelDescriptionKey" : "Detects the dominant objects present in an image from a set of 1000 categories such as trees, animals, food, vehicles, person etc. The top-5 error from the original publication is 7.8%." , "MLModelCreatorDefinedKey" : { }, "MLModelAuthorKey" : "Original Paper: Kaiming He and Xiangyu Zhang and Shaoqing Ren and Jian Sun. Keras Implementation: François Chollet" , "MLModelLicenseKey" : "MIT License. More information available at https:\\/\\/github.com\\/fchollet\\/keras\\/blob\\/master\\/LICENSE" } } </small>Load model to get description:

 Set Variable \[ $model ; Value: MBS ( "[CoreML.OpenModel](CoreMLOpenModel.md)"; "/Users/cs/Desktop/UpdatableDrawingClassifier.mlmodelc" ) \]   
Set Field \[ test::ModelDescription ; MBS ( "CoreML.Description"; $model ) \]   
Set Variable \[ $r ; Value: MBS ( "[CoreML.Release](CoreMLRelease.md)"; $model ) \]  
### See also

- [CoreML.OpenModel](CoreMLOpenModel.md)
- [CoreML.Release](CoreMLRelease.md)
- [CoreML.Update](CoreMLUpdate.md)
- [ECKey.Description](ECKeyDescription.md)

### Release notes

- **Version 10.0**
    - Improved [CoreML.Description](https://www.mbsplugins.eu/CoreMLDescription.shtml) to include newer attributes for MacOS 10.15.

### Example Databases

- [Mac and iOS/Machine Learning/Core ML Photos](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Mac%20and%20iOS/Machine%20Learning/Core%20ML%20Photos.shtml#6ScriptAnchor_)
- [Mac and iOS/Machine Learning/CoreML](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Mac%20and%20iOS/Machine%20Learning/CoreML.shtml#1ScriptAnchor_)

### Blog Entries

- [Train machine learning models on device](https://www.mbsplugins.de/archive/2019-12-17/Train_machine_learning_models_/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin, version 9.6pr3](https://www.mbsplugins.de/archive/2019-12-17/MBS_FileMaker_Plugin_version_9/monkeybreadsoftware_blog_filemaker)

### FileMaker Magazin

- [Ausgabe 5/2022, Seite 26](https://filemaker-magazin.de/neuigkeit/4196-Appetithappen-FMM_202205)

This function checks for a license.

Created 16th September 2017 , last changed 16th December 2019

  
[CoreML.CompileModel](CoreMLCompileModel.md) - [CoreML.GetUsesCPUOnly](CoreMLGetUsesCPUOnly.md)

[HTML Version](CoreMLDescription.shtml)