ascend-nputop 0.0.4

An interactive Ascend-NPU process viewer.

nputop: Interactive Ascend-NPU Process Viewer 🚀

---

nputop is an interactive command-line tool designed specifically for monitoring and managing processes running on Ascend NPUs. Inspired by the popular nvitop project, nputop brings a similar, intuitive user experience to the Ascend NPU ecosystem, providing real-time insights into utilization, memory usage, temperature, power consumption, and more.

---

🌟 Key Features

• Real-time monitoring: Track NPU usage, memory status, temperature, and power draw.
• Interactive UI: Navigate with keyboard/mouse and manage processes effortlessly.
• Process management: View, select, and interact with running NPU processes directly.
• Multi-NPU Support: Efficiently manage multiple Ascend NPUs simultaneously.
• CLI convenience: Easy integration into terminal workflows with minimal setup.

---

📸 Screenshots

---

⚙️ Installation

Prerequisites:

• Python ≥ 3.10
• Ascend NPU Drivers and Runtime Environment (CANN)

pip install ascend-nputop

For development or editable installations:

git clone https://github.com/youyve/nputop.git
cd nputop
pip install -e .

---

🚀 Quick Start

Launch nputop directly from your terminal:

nputop

set environment variables (ASCEND_RT_VISIBLE_DEVICES) to restrict visible NPUs.

---

🔑 Usage & Shortcuts

• Navigate screens: ← → or TAB
• Sort columns: S
• Toggle compact mode: C
• Kill a process: select a process and press K
• Refresh manually: R
• Exit: Q or Ctrl+C

---

🛠️ Project Structure

nputop
├── assets/             # Images for documentation
├── nputop/
│   ├── api/            # Ascend NPU APIs & backend
│   ├── gui/            # Interactive UI (GPL-3.0-only)
│   ├── cli.py          # Command-line entry point
│   └── version.py      # Versioning and metadata
├── COPYING             # GPL-3.0 License file
├── LICENSE             # Apache 2.0 License file
├── NOTICE              # Acknowledgments and Notices
├── pyproject.toml      # Project configuration
├── setup.py            # Build script
└── README.md           # Documentation

---

📋 Known Issues & Roadmap

• 🚧 Metrics acquisition anomalies for single NPU displays.
• 🚧 Incomplete parameter display for some NPU metrics.
• 🚧 Real-time process tracking issues, such as abnormal process name display.

These performance issues and feature gaps are being actively addressed in ongoing development iterations. Contributions are highly encouraged to help us improve nputop.

---

🤝 Contributing

We warmly welcome contributions! Feel free to:

• Report bugs and request features via Issues.
• Fork the repository and submit pull requests.
• Improve documentation and examples.

---

📃 License

This project (nputop) is derived from the original project nvitop by Xuehai Pan.

The licenses applied are:

• API Modules: Apache License 2.0
• GUI Modules: GNU General Public License v3.0 only

Copyright (c) 2025 Xuehai Pan <[e-mail]>
Copyright (c) 2025 Lianzhong You <[e-mail]>

For full details, see LICENSE, COPYING, and NOTICE.

---

📧 Contact

• Maintainer: Lianzhong You

---

Enjoy monitoring your Ascend NPUs with nputop! 🎉