[PR #22] [MERGED] Add detailed documentation for API references #122

New issue

Closed

opened 2026-05-05 03:26:17 -06:00 by gitea-mirror · 0 comments

gitea-mirror commented

2026-05-05 03:26:17 -06:00

Owner

📋 Pull Request Information

Original PR: https://github.com/XuehaiPan/nvitop/pull/22
Author: @XuehaiPan
Created: 6/29/2022
Status: ✅ Merged
Merged: 7/1/2022
Merged by: @XuehaiPan

Base: dev ← Head: docs

📝 Commits (9)

209ec7f docs(core/device): add detailed documentation for device classes
74b6bab docs(core/libnvml): add detailed documentation for NVML bindings
db29062 docs(core/host): add detailed documentation for psutil shortcuts
06c5443 docs(core/process): add detailed documentation for process classes
fab7cf8 docs(core/utils): add detailed documentation for utilities
3bb17f6 docs: remove todo list in README.md
102ee45 docs: add Sphinx-based documents
eff645d style: resolve pylint warnings
7512bad docs: update link URLs

📊 Changes

26 files changed (+1855 additions, -114 deletions)

View changed files

📝 README.md (+7 -22)
➕ docs/Makefile (+20 -0)
➕ docs/make.bat (+35 -0)
➕ docs/requirements.txt (+6 -0)
➕ docs/source/_static/.gitkeep (+0 -0)
➕ docs/source/_static/style.css (+3 -0)
➕ docs/source/_templates/.gitkeep (+0 -0)
➕ docs/source/apis/callbacks.rst (+45 -0)
➕ docs/source/apis/core/collector.rst (+8 -0)
➕ docs/source/apis/core/device.rst (+8 -0)
➕ docs/source/apis/core/host.rst (+8 -0)
➕ docs/source/apis/core/libnvml.rst (+8 -0)
➕ docs/source/apis/core/process.rst (+8 -0)
➕ docs/source/apis/core/utils.rst (+8 -0)
➕ docs/source/apis/index.rst (+24 -0)
➕ docs/source/conf.py (+136 -0)
➕ docs/source/index.rst (+18 -0)
📝 nvitop/callbacks/keras.py (+13 -7)
📝 nvitop/callbacks/pytorch_lightning.py (+19 -15)
📝 nvitop/core/__init__.py (+2 -5)

...and 6 more files

📄 Description

Issue Type

Improvement

Runtime Environment

Operating system and version: Ubuntu 20.04 LTS
Terminal emulator and version: GNOME Terminal 3.36.2
Python version: 3.9.13
NVML version (driver version): 470.129.06
nvitop version or commit: N/A
python-ml-py version: 11.450.51
Locale: en_US.UTF-8

Description

Add docstrings and examples for module/class/function.

Motivation and Context

Add detailed documentation for API references.

Testing

N/A

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/XuehaiPan/nvitop/pull/22 **Author:** [@XuehaiPan](https://github.com/XuehaiPan) **Created:** 6/29/2022 **Status:** ✅ Merged **Merged:** 7/1/2022 **Merged by:** [@XuehaiPan](https://github.com/XuehaiPan) **Base:** `dev` ← **Head:** `docs` --- ### 📝 Commits (9) - [`209ec7f`](https://github.com/XuehaiPan/nvitop/commit/209ec7faef25135c65ca6655b61cb753501cd80b) docs(core/device): add detailed documentation for device classes - [`74b6bab`](https://github.com/XuehaiPan/nvitop/commit/74b6bab3ca8734c3a9f50572326bd6ccc7cb8104) docs(core/libnvml): add detailed documentation for NVML bindings - [`db29062`](https://github.com/XuehaiPan/nvitop/commit/db29062e4c883fc2b91b94b2f6f77120afeb8a82) docs(core/host): add detailed documentation for `psutil` shortcuts - [`06c5443`](https://github.com/XuehaiPan/nvitop/commit/06c5443a7580aa5f1f813375265a7119aff73a3b) docs(core/process): add detailed documentation for process classes - [`fab7cf8`](https://github.com/XuehaiPan/nvitop/commit/fab7cf85481b64abeb8942b0aa2c2feb69b5a904) docs(core/utils): add detailed documentation for utilities - [`3bb17f6`](https://github.com/XuehaiPan/nvitop/commit/3bb17f6cc9afb246462ee7010d719cf175b5aae9) docs: remove todo list in README.md - [`102ee45`](https://github.com/XuehaiPan/nvitop/commit/102ee45960fb9746334c858a59bae84cd3363828) docs: add Sphinx-based documents - [`eff645d`](https://github.com/XuehaiPan/nvitop/commit/eff645db1aa598151ece43e1ac01fcb908a3c8be) style: resolve pylint warnings - [`7512bad`](https://github.com/XuehaiPan/nvitop/commit/7512badf82c85dcf56f6df609616812e6e925e40) docs: update link URLs ### 📊 Changes **26 files changed** (+1855 additions, -114 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+7 -22) ➕ `docs/Makefile` (+20 -0) ➕ `docs/make.bat` (+35 -0) ➕ `docs/requirements.txt` (+6 -0) ➕ `docs/source/_static/.gitkeep` (+0 -0) ➕ `docs/source/_static/style.css` (+3 -0) ➕ `docs/source/_templates/.gitkeep` (+0 -0) ➕ `docs/source/apis/callbacks.rst` (+45 -0) ➕ `docs/source/apis/core/collector.rst` (+8 -0) ➕ `docs/source/apis/core/device.rst` (+8 -0) ➕ `docs/source/apis/core/host.rst` (+8 -0) ➕ `docs/source/apis/core/libnvml.rst` (+8 -0) ➕ `docs/source/apis/core/process.rst` (+8 -0) ➕ `docs/source/apis/core/utils.rst` (+8 -0) ➕ `docs/source/apis/index.rst` (+24 -0) ➕ `docs/source/conf.py` (+136 -0) ➕ `docs/source/index.rst` (+18 -0) 📝 `nvitop/callbacks/keras.py` (+13 -7) 📝 `nvitop/callbacks/pytorch_lightning.py` (+19 -15) 📝 `nvitop/core/__init__.py` (+2 -5) _...and 6 more files_ </details> ### 📄 Description #### Issue Type  - Improvement #### Runtime Environment  - Operating system and version: Ubuntu 20.04 LTS - Terminal emulator and version: GNOME Terminal 3.36.2 - Python version: `3.9.13` - NVML version (driver version): `470.129.06` - `nvitop` version or commit: N/A - `python-ml-py` version: `11.450.51` - Locale: `en_US.UTF-8` #### Description  Add docstrings and examples for module/class/function. #### Motivation and Context    Add detailed documentation for API references. #### Testing   N/A --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>