microsoft / microsoft/onnxruntime

[Documentation] run_async missing documention for user_data parameter

Open
#20,367 5 comments 1 reaction 1 assignee Claimed by @justinchuby View on GitHub
documentation
Dominant language
C++
Stars
21.9k
Forks
4.2k
Avg merge
4d 11h
Merged PRs (30d)
184

Description

### Describe the documentation issue

The run_async function takes a user_data parameter but there is nothing in the docs saying what that is:

```md
Compute the predictions asynchronously in a separate cxx thread from ort intra-op threadpool.

:param output_names: name of the outputs
:param input_feed: dictionary ``{ input_name: input_value }``
:param callback: python function that accept array of results, and a status string on error.
The callback will be invoked by a cxx thread from ort intra-op threadpool.
:param run_options: See :class:`onnxruntime.RunOptions`.
```

### Page / URL

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.