LearningModelDevice(LearningModelDeviceKind) Constructor

Definition

Namespace:

Windows.AI.MachineLearning

Create a LearningModelDevice from the specified LearningModelDeviceKind.

public:
 LearningModelDevice(LearningModelDeviceKind deviceKind);

 LearningModelDevice(LearningModelDeviceKind const& deviceKind);

public LearningModelDevice(LearningModelDeviceKind deviceKind);

function LearningModelDevice(deviceKind)

Public Sub New (deviceKind As LearningModelDeviceKind)

Parameters

deviceKind

LearningModelDeviceKind

The specified LearningModelDeviceKind to evaluate the model on.

Examples

The following example loads a model, selects the device on which to evaluate the model, and evaluates.

private async Task LoadModelAsync(string _modelFileName, bool _useGPU)
{
    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);

        // Select the device to evaluate on
        LearningModelDevice device = null;
        if (_useGPU)
        {
            // Use a GPU or other DirectX device to evaluate the model.
            device = new LearningModelDevice(LearningModelDeviceKind.DirectX);
        }
        else
        {
            // Use the CPU to evaluate the model.
            device = new LearningModelDevice(LearningModelDeviceKind.Cpu);
        }

        // Create the evaluation session with the model and device.
        _session = new LearningModelSession(_model, device);

    }
    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.

Using DirectX devices

If you pass in any of the DirectX options to this constructor, a hardware device must be found. If no hardware device exists, ERROR_NOT_FOUND is displayed. You can use this error code if you choose to fall back to the CPU. To do your own hardware detection before you call this constructor, use the DXGI APIs.

Note

Currently, this constructor succeeds and incorrectly returns the software adapter DXGI_ADAPTER_FLAG_SOFTWARE if no DirectX hardware device is found.