LearningModel.LoadFromStorageFileAsync Method

  • Reference

Definition

Namespace:
Windows.AI.MachineLearning

Overloads

LoadFromStorageFileAsync(IStorageFile, ILearningModelOperatorProvider)

Loads an ONNX model from an IStorageFile asynchronously.
LoadFromStorageFileAsync(IStorageFile)

Loads an ONNX model from an IStorageFile asynchronously.

LoadFromStorageFileAsync(IStorageFile, ILearningModelOperatorProvider)

Edit

Loads an ONNX model from an IStorageFile asynchronously.

public:
 static IAsyncOperation<LearningModel ^> ^ LoadFromStorageFileAsync(IStorageFile ^ modelFile, ILearningModelOperatorProvider ^ operatorProvider);
/// [Windows.Foundation.Metadata.Overload("LoadFromStorageFileWithOperatorProviderAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
 static IAsyncOperation<LearningModel> LoadFromStorageFileAsync(IStorageFile const& modelFile, ILearningModelOperatorProvider const& operatorProvider);
[Windows.Foundation.Metadata.Overload("LoadFromStorageFileWithOperatorProviderAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public static IAsyncOperation<LearningModel> LoadFromStorageFileAsync(IStorageFile modelFile, ILearningModelOperatorProvider operatorProvider);
function loadFromStorageFileAsync(modelFile, operatorProvider)
Public Shared Function LoadFromStorageFileAsync (modelFile As IStorageFile, operatorProvider As ILearningModelOperatorProvider) As IAsyncOperation(Of LearningModel)

Parameters

modelFile
IStorageFile

The location of the model file.

operatorProvider
ILearningModelOperatorProvider

Returns

IAsyncOperation<LearningModel>

A LearningModel based on the model file.

Attributes
OverloadAttribute RemoteAsyncAttribute

Remarks

Windows Server

To use this API on Windows Server, you must use Windows Server 2019 with Desktop Experience.

Thread safety

This API is thread-safe.

Applies to

LoadFromStorageFileAsync(IStorageFile)

Edit

Loads an ONNX model from an IStorageFile asynchronously.

public:
 static IAsyncOperation<LearningModel ^> ^ LoadFromStorageFileAsync(IStorageFile ^ modelFile);
/// [Windows.Foundation.Metadata.Overload("LoadFromStorageFileAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
 static IAsyncOperation<LearningModel> LoadFromStorageFileAsync(IStorageFile const& modelFile);
[Windows.Foundation.Metadata.Overload("LoadFromStorageFileAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public static IAsyncOperation<LearningModel> LoadFromStorageFileAsync(IStorageFile modelFile);
function loadFromStorageFileAsync(modelFile)
Public Shared Function LoadFromStorageFileAsync (modelFile As IStorageFile) As IAsyncOperation(Of LearningModel)

Parameters

modelFile
IStorageFile

The location of the model file.

Returns

IAsyncOperation<LearningModel>

A LearningModel based on the model file.

Attributes
OverloadAttribute RemoteAsyncAttribute

Examples

The following example loads the model and creates an evaulation session with it.

private async Task LoadModelAsync(string _modelFileName)
{
    LearningModel _model;
    LearningModelSession _session;

    try
    {
        // Load and create the model
        var modelFile = 
            await StorageFile.GetFileFromApplicationUriAsync(new Uri($"ms-appx:///Assets/{_modelFileName}"));
        _model = await LearningModel.LoadFromStorageFileAsync(modelFile);

        // Create the evaluation session with the model
        _session = new LearningModelSession(_model);

    }
    catch (Exception ex)
    {
        StatusBlock.Text = $"error: {ex.Message}";
        _model = null;
    }
}

Remarks

Windows Server

To use this API on Windows Server, you must use Windows Server 2019 with Desktop Experience.

Thread safety

This API is thread-safe.

Applies to