Improve error reporting for pre-allocated outputs with a wrong shape (#28481)
This pull request improves the handling of pre-allocated output buffers
in ONNX Runtime, especially for models with dynamic output shapes. The
changes ensure that when a user provides an output buffer whose shape
does not match the computed output shape, the library returns a clear
error message. Additionally, the error handling and testing around this
scenario are strengthened.
The most important changes are:
**Pre-allocated Output Buffer Shape Validation:**
* Enhanced the logic in `IExecutionFrame::GetOrCreateNodeOutputMLValue`
to check if the shape of a pre-allocated output OrtValue matches the
computed output shape. If there is a mismatch (typically due to dynamic
shapes), the code now returns an explicit `INVALID_ARGUMENT` error with
a detailed message, guiding the user to fix their usage.
**API and Error Handling Improvements:**
* Updated `OpKernelContext::OutputMLValue` to throw an exception with
the detailed error message if output OrtValue allocation fails, ensuring
that shape mismatches are surfaced clearly to the caller.
* Added a catch block for `OnnxRuntimeException` in
`sequential_executor.cc` to convert exceptions into proper `Status`
objects, improving robustness and error propagation.
**Testing and Regression Coverage:**
* Added a comprehensive regression test
(`ExecutionFrameTestInit.FetchWithMismatchedDynamicShapes`) to verify
correct handling of pre-allocated outputs with mismatched shapes,
including both error and success cases. This test covers scenarios where
output buffers are reused across runs with different dynamic shapes,
ensuring the new logic works as intended.
onnxruntime
70dcc0e2 - Improve error reporting for pre-allocated outputs with a wrong shape (#28481)
