Skip to content

[Doc] Add error code reference for EP registration results #260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yeelam-gordon wants to merge 1 commit into
base: docs
Choose a base branch
from
+9 −0
Open

[Doc] Add error code reference for EP registration results #260

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/new-windows-ml/initialize-execution-providers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,15 @@ installed = result.status == winml.ExecutionProviderReadyResultState.SUCCESS

---

### Handling installation results

The [ExecutionProviderReadyResult](/windows/windows-app-sdk/api/winrt/microsoft.windows.ai.machinelearning.executionproviderreadyresult) returned by `EnsureReadyAsync()` includes a [Status](/windows/windows-app-sdk/api/winrt/microsoft.windows.ai.machinelearning.executionproviderreadyresult.status) property of type [ExecutionProviderReadyResultState](/windows/windows-app-sdk/api/winrt/microsoft.windows.ai.machinelearning.executionproviderreadyresultstate). When `Status` is not `Success`, use the `ExtendedError` and `DiagnosticText` properties to diagnose the failure.

> [!TIP]
> Always check the `Status` before proceeding with session creation. If a provider fails, consider falling back to a different execution provider, such as the CPU execution provider. For common download and installation issues, see [Troubleshoot execution provider download issues](./execution-provider-errors.md).

---

## Installing with progress

The APIs for downloading and installing EPs include callbacks that provide progress updates, so that you can display progress indicators to keep your users informed.
Expand Down