microsoft / microsoft/onnxruntime

[Documentation] How to profile the GPU memory info for a onnxruntime session?

Open
#24,993 3 comments 0 reactions 0 assignees 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

How to profile the GPU memory info for a onnxruntime session?
e.g.
```
onnx_session = onnxruntime.InferenceSession(detect_model,sess_options,providers=exec_providers)
print(onnx_session.memory_consumption())
```
Is there a python API to show the GPU memory consumption?

### Page / URL

_No response_

Contributor guide

Open the contributing guide

Research direction

Start by checking the ONNX Runtime Python InferenceSession APIs and existing profiling documentation for GPU memory support. Document the supported way to inspect GPU memory for a session, or clearly state that no Python API exists and identify the available profiling alternative.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, machine-learning
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.