Skip to content
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.

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

python session.run() fallback to CPU/CUDA provider for EP failures. #1960

Merged
merged 7 commits into from
Oct 2, 2019

Conversation

jywu-msft
Copy link
Member

python api session.run() fallback mechanism.

Problem Statement: Execution Provider internal failures cause session.run() to fail.
An execution provider's GetCapability() implementation is supposed to accurately return what subgraphs on an ONNX model the EP can execute. However, for 3rd party EP's, sometimes the response is not accurate, leading to Onnxruntime assigning a subgraph to an EP, but the EP fails during runtime.

To satisfy ORT's requirement to be able to execute all valid ONNX models, we introduce a fallback/retry mechanism for the session.Run() api, which is enabled by default.

If Run() fails due to internal EP failure, it will recreate a new session and retry using default execution providers ['CPUExecutionProvider'] or ['CUDAExecutionProvider, 'CPUExecutionProvider'] (if gpu capable)

For example, if session.run() is invoked and the subgraph is assigned to TensorrtExecutionProvider but fails during execution, the session will be recreated and retried using CUDAExecutionProvider.
Similarly, if NGRAPHExecutionProvider fails, a new session is recreated and the session.run() retried using CPUExecutionProvider.

The session is recreated at most once. The retry only happens when EPFail exception is thrown by session.Run(). Thus, other exceptions thrown by ORT will not trigger the retry.
Once the session is recreated and set to default providers, subsequent run() invocations will use the default provider settings. (to prevent the same failure from happening again)

For this PR, NGRAPHExecution provider was updated to return the proper EPFail status code.
Other EP's will be updated in subsequent PRs.

Tested against previously failing onnx backend tests (e.g. test_hardmax_negative_axis) which fails using NGraph. with this PR, it fallsback and retries on CPU and succeeds.

@jywu-msft jywu-msft requested a review from a team as a code owner September 30, 2019 21:22
@jywu-msft jywu-msft requested a review from HectorSVC October 1, 2019 16:24
try:
return self._sess.run(output_names, input_feed, run_options)
except C.EPFail as err:
if self._enable_fallback:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if self._enable_fallback: [](start = 12, length = 25)

Is it possible that for CPUProvider only, if failed, it will try CPU one more time?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, the intent is to retry only for EPFail status, which should only get returned from EP's Compile() or EP's compute_func

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants