microsoft / microsoft/onnxruntime
Documentation and examples for onnxruntime_perf_test
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 21.9k
- Forks
- 4.2k
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 184
Description
Is your feature request related to a problem? Please describe.
Need to do some perf tests and following instructions here
System information
- ONNX Runtime version (you are using): 1.4 (master) from source
Describe the solution you'd like
This is the current line:
Model path and input data dependency: Performance test uses the same input structure as onnx_test_runner tool. It requrires the directory trees as below
It assumes the reader knows onnx_test_runner or its data structure
Describe alternatives you've considered
Documentation, with examples and hyperlinks. Even links to the appropriate part of a code is more useful.
Additional context
Also, more documentation about the utility, how it works, warm-up strategy, ...
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the instructions in onnxruntime/test/perftest and compare them with the referenced onnx_test_runner data structure. Document the directory layout, usage examples, relevant hyperlinks, utility behavior, and warm-up strategy so readers can run performance tests without prior knowledge of onnx_test_runner.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100