mltop 0.6.2

Resource monitor for ML engineers written in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

<div align="center">

# mltop

A resource monitoring tool designed for working with Machine Learning tasks  
**CPU & GPU at a glance**

![CI](https://github.com/kikefdezl/mltop/actions/workflows/ci.yml/badge.svg/?branch=main)
[![crates.io](https://img.shields.io/crates/v/mltop.svg)](https://crates.io/crates/mltop)

</div>

![demo](./assets/demo.png)

## Introduction

**mltop** is a resource monitoring tool designed specifically for Machine Learning Engineers and those working with ML tasks. It was a born as a hybrid of [nvtop](https://github.com/Syllo/nvtop) (for monitoring GPUs) and [htop](https://github.com/htop-dev/htop) (for monitoring CPU and memory), allowing users to see a comprehensive view of their system’s performance in a single interface.

### Key Features

- Dual Resource Monitoring: Overlays CPU and GPU usage for spotting bottlenecks in your dataloader pipelines.
- Simplified UI: Combines the key features of `htop` and `nvtop`, so you don't need to open multiple tools.

--- 

**mltop** requires NVIDIA drivers to monitor NVIDIA GPU information.

## Installation

You can install **mltop** using Cargo:

1. Make sure you have Rust (Cargo) installed.
2. Clone the repository:
```bash
git clone https://github.com/kikefdezl/mltop.git
```

3. Build & run the project:
```bash
cd mltop
cargo build --release
```

This will compile the binary into `target/release/mltop`.

Pre-built binaries to be added in the future. In the meantime, please build from source using Cargo.

## Dependencies

- **mltop** uses [nvml_wrapper](https://github.com/rust-nvml/nvml-wrapper) to fetch NVIDIA GPU information, which requires
interfacing with your NVIDIA Drivers. If those are not available, **mltop** won't be able to find your GPU.

Currently, only NVIDIA GPUs are supported, but support for different GPUs is in the roadmap.

## Usage

Once installed, run `mltop` in your terminal. The tool will run until you press `q` to quit.

## Customization

Customization is done via `~/.config/mltop/config.toml`. For theme customization, see [Theme Customization](docs/theme.md).

## Roadmap

- Pre-built binaries
- Support for multiple GPUs
- Support for other GPU vendors (AMD, Intel, etc.)

## Contributing

I welcome contributions to **mltop**! Especially those aimed towards supporting hardware I don't have access to. If you'd like to contribute, please follow these steps:

- Fork the repository.
- Clone your fork and create a new branch.
- Make your changes and add tests if applicable.
- Commit your changes with clear messages.
- Submit a pull request.

## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE.MD) file for details.

## Acknowledgments

- Thanks to the creators of [htop](https://github.com/htop-dev/htop), [nvtop](https://github.com/Syllo/nvtop), for for inspiring this project, and to the developers
of `crossterm`, `ratatui`, `sysinfo` & `nvml_wrapper` for providing the building blocks.

## Contact
For any questions or feedback, feel free to reach out via GitHub Issues.