microsoft / microsoft/onnxruntime

[Documentation] [Python API] Add documentation for onnxruntime module level functions

Open
#18,625 1 comment 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

These module level functions don't seem to be [documented](https://onnxruntime.ai/docs/api/python/api_summary.html#api-details).
https://github.com/microsoft/onnxruntime/blob/d2dfbf41795e72911643e2ffcadac069b72580bd/onnxruntime/__init__.py#L36-L48

Some are quite useful - e.g., `set_default_logger_severity` for setting the default log level.

### Page / URL

https://onnxruntime.ai/docs/api/python/api_summary.html

Contributor guide

Open the contributing guide

Research direction

Start with onnxruntime/__init__.py lines 36-48 and compare those module-level functions with the Python API summary at https://onnxruntime.ai/docs/api/python/api_summary.html. Document the functions that are missing from the API details, including their useful behavior, and verify that the page exposes them clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.