From 0917c5694d2697a8e0f5f47ebafc3da3c7bdef2d Mon Sep 17 00:00:00 2001 From: Xuehai Pan Date: Thu, 17 Nov 2022 13:36:51 +0800 Subject: [PATCH] docs: update screenshot and badges Signed-off-by: Xuehai Pan --- README.md | 52 ++++++++++++++++++++++++------------------- docs/source/index.rst | 14 ++++++------ 2 files changed, 36 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index b782bb8b..7e2b1820 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,21 @@ ![Python 3.5+](https://img.shields.io/badge/Python-3.5%2B-brightgreen) -[![PyPI](https://img.shields.io/pypi/v/nvitop?label=PyPI&logo=pypi)](https://pypi.org/project/nvitop) -![Status](https://img.shields.io/pypi/status/nvitop?label=Status) -[![conda-forge](https://img.shields.io/conda/vn/conda-forge/nvitop?label=Conda&logo=condaforge)](https://anaconda.org/conda-forge/nvitop) -[![Documentation Status](https://img.shields.io/readthedocs/nvitop?label=Docs&logo=readthedocs)](https://nvitop.readthedocs.io) -[![Downloads](https://static.pepy.tech/personalized-badge/nvitop?period=total&left_color=grey&right_color=blue&left_text=Downloads)](https://pepy.tech/project/nvitop) -[![GitHub Repo Stars](https://img.shields.io/github/stars/XuehaiPan/nvitop?label=Stars&logo=github&color=brightgreen)](https://github.com/XuehaiPan/nvitop/stargazers) -[![License](https://img.shields.io/github/license/XuehaiPan/nvitop?label=License)](#license) +[![PyPI](https://img.shields.io/pypi/v/nvitop?label=pypi&logo=pypi)](https://pypi.org/project/nvitop) +![Status](https://img.shields.io/pypi/status/nvitop?label=status) +[![conda-forge](https://img.shields.io/conda/vn/conda-forge/nvitop?label=conda&logo=condaforge)](https://anaconda.org/conda-forge/nvitop) +[![Documentation Status](https://img.shields.io/readthedocs/nvitop?label=docs&logo=readthedocs)](https://nvitop.readthedocs.io) +[![Downloads](https://static.pepy.tech/personalized-badge/nvitop?period=total&left_color=grey&right_color=blue&left_text=downloads)](https://pepy.tech/project/nvitop) +[![GitHub Repo Stars](https://img.shields.io/github/stars/XuehaiPan/nvitop?label=stars&logo=github&color=brightgreen)](https://github.com/XuehaiPan/nvitop/stargazers) +[![License](https://img.shields.io/github/license/XuehaiPan/nvitop?label=license)](#license) An interactive NVIDIA-GPU process viewer, the one-stop solution for GPU process management. The full API references host at .

Monitor -
+
Monitor mode of nvitop. -
+
(TERM: GNOME Terminal / OS: Ubuntu 16.04 LTS (over SSH) / Locale: en_US.UTF-8)

@@ -55,14 +55,20 @@ This project is inspired by [nvidia-htop](https://github.com/peci1/nvidia-htop) [nvidia-htop](https://github.com/peci1/nvidia-htop) is a tool for enriching the output of `nvidia-smi`. It uses regular expressions to read the output of `nvidia-smi` from a subprocess, which is inefficient. In the meanwhile, there is a powerful interactive GPU monitoring tool called [nvtop](https://github.com/Syllo/nvtop). But [nvtop](https://github.com/Syllo/nvtop) is written in *C*, which makes it lack of portability. And what is really inconvenient is that you should compile it yourself during the installation. Therefore, I made this repo. I got a lot help when reading the source code of [ranger](https://github.com/ranger/ranger), the console file manager. Some files in this repo are modified from [ranger](https://github.com/ranger/ranger) under the **GPLv3 License**. -If this repo is useful to you, please star ⭐️ it to let more people know 🤗. [![GitHub Repo Stars](https://img.shields.io/github/stars/XuehaiPan/nvitop?label=Stars&logo=github&color=brightgreen)](https://github.com/XuehaiPan/nvitop) +If this repo is useful to you, please star ⭐️ it to let more people know 🤗. [![GitHub Repo Stars](https://img.shields.io/github/stars/XuehaiPan/nvitop?label=stars&logo=github&color=brightgreen)](https://github.com/XuehaiPan/nvitop)

- Comparison -
+ Comparison +
Compare to nvidia-smi.

+

+ Filter +
+ Process filtering and more colorful interface. +

+ ------ ## Features @@ -90,9 +96,9 @@ If this repo is useful to you, please star ⭐️ it to let more people know

Windows -
+
nvitop supports Windows! -
+
(SHELL: PowerShell / TERM: Windows Terminal / OS: Windows 10 / Locale: en-US)

@@ -125,7 +131,7 @@ bash install-nvidia-driver.sh --latest # install the latest

install-nvidia-driver -
+
NVIDIA driver installer for Ubuntu Linux.

@@ -143,7 +149,7 @@ Run `bash install-nvidia-driver.sh --help` for more information. pipx run nvitop ``` -Install from PyPI ([![PyPI](https://img.shields.io/pypi/v/nvitop?label=PyPI)](https://pypi.org/project/nvitop) / ![Status](https://img.shields.io/pypi/status/nvitop?label=Status)): +Install from PyPI ([![PyPI](https://img.shields.io/pypi/v/nvitop?label=pypi&logo=pypi)](https://pypi.org/project/nvitop) / ![Status](https://img.shields.io/pypi/status/nvitop?label=status)): ```bash pip3 install --upgrade nvitop @@ -173,9 +179,9 @@ pip3 install .

MIG Device Support -
+
MIG Device Support. -
+

------ @@ -248,7 +254,7 @@ Also, to enter the process metrics screen, select a process and then press the <

Process Metrics Screen -
+
Watch metrics for a specific process (shortcut: Enter / Return).

@@ -256,7 +262,7 @@ Press h for help or q to return to the terminal. See [Keyb

Help Screen -
+
nvitop comes with a help screen (shortcut: h).

@@ -346,7 +352,7 @@ process filtering:

Spectrum-like Bar Charts -
+
Spectrum-like bar charts (with option --colorful).

@@ -400,7 +406,7 @@ echo 'set -gx NVITOP_MONITOR_MODE "full"' >> ~/.config/fish/config.fish | `` | Select the last process. | | ``
`^` | Scroll left to the beginning of the process entry (i.e. beginning of line). | | ``
`$` | Scroll right to the end of the process entry (i.e. end of line). | -| `` / ``
`` / ``
`[` / `]` | scroll entire screen (for large amounts of processes). | +| `` / ``
`` / ``
`[` / `]` | scroll entire screen (for large amounts of processes). | | | | | `` | Tag/untag current process. | | `` | Clear process selection. | @@ -675,7 +681,7 @@ for device in devices:

Demo -
+
An example monitoring script built with APIs from nvitop.

diff --git a/docs/source/index.rst b/docs/source/index.rst index 8e602174..c3787d2c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,7 +1,7 @@ Welcome to nvitop's documentation! ================================== -|GitHub|_ |Python Version|_ |PyPI Package|_ |Package Status|_ |Documentation Status|_ |Downloads|_ |GitHub Repo Stars|_ |License|_ |Tweet|_ +|GitHub|_ |Python Version|_ |PyPI Package|_ |Package Status|_ |Conda Package|_ |Documentation Status|_ |Downloads|_ |GitHub Repo Stars|_ |License|_ |Tweet|_ An interactive NVIDIA-GPU process viewer, the one-stop solution for GPU process management. @@ -16,25 +16,25 @@ An interactive NVIDIA-GPU process viewer, the one-stop solution for GPU process .. |Python Version| image:: https://img.shields.io/badge/Python-3.5%2B-brightgreen .. _Python Version: https://pypi.org/project/nvitop -.. |PyPI Package| image:: https://img.shields.io/pypi/v/nvitop?label=PyPI&logo=pypi +.. |PyPI Package| image:: https://img.shields.io/pypi/v/nvitop?label=pypi&logo=pypi .. _PyPI Package: https://pypi.org/project/nvitop .. |Conda Package| image:: https://img.shields.io/conda/v/conda-forge/nvitop?logo=condaforge .. _Conda Package: https://anaconda.org/conda-forge/nvitop -.. |Package Status| image:: https://img.shields.io/pypi/status/nvitop?label=Status +.. |Package Status| image:: https://img.shields.io/pypi/status/nvitop?label=status .. _Package Status: https://pypi.org/project/nvitop -.. |Documentation Status| image:: https://img.shields.io/readthedocs/nvitop?label=Docs&logo=readthedocs +.. |Documentation Status| image:: https://img.shields.io/readthedocs/nvitop?label=docs&logo=readthedocs .. _Documentation Status: https://nvitop.readthedocs.io -.. |Downloads| image:: https://static.pepy.tech/personalized-badge/nvitop?period=total&left_color=grey&right_color=blue&left_text=Downloads +.. |Downloads| image:: https://static.pepy.tech/personalized-badge/nvitop?period=total&left_color=grey&right_color=blue&left_text=downloads .. _Downloads: https://pepy.tech/project/nvitop -.. |GitHub Repo Stars| image:: https://img.shields.io/github/stars/XuehaiPan/nvitop?label=Stars&logo=github&color=brightgreen +.. |GitHub Repo Stars| image:: https://img.shields.io/github/stars/XuehaiPan/nvitop?label=stars&logo=github&color=brightgreen .. _GitHub Repo Stars: https://github.com/XuehaiPan/nvitop -.. |License| image:: https://img.shields.io/github/license/XuehaiPan/nvitop?label=License +.. |License| image:: https://img.shields.io/github/license/XuehaiPan/nvitop?label=license .. _License: https://github.com/XuehaiPan/nvitop#license .. |Tweet| image:: https://img.shields.io/twitter/url?url=https%3A%2F%2Fgithub.com%2FXuehaiPan%2Fnvitop