From 3abd2904fb4ae34b3221c4b41acf98d8df63f324 Mon Sep 17 00:00:00 2001 From: Swati Gupta Date: Thu, 31 May 2018 20:18:42 -0700 Subject: [PATCH] Add README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a6f5dba --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# NVIDIA GPU Monitoring Tools + +## NVML Go Bindings + +[NVIDIA Management Library (NVML)](https://developer.nvidia.com/nvidia-management-library-nvml) is a C-based API for monitoring and managing NVIDIA GPU devices. +NVML go bindings are taken from [nvidia-docker 1.0](https://github.com/NVIDIA/nvidia-docker/tree/1.0) with some improvements and additions. NVML headers are also added to the package to make it easy to use and build. + +### NVML Samples +Three [samples](https://github.com/NVIDIA/gpu-monitoring-tools/blob/master/bindings/go/samples/nvml/README.md) are included to demonstrate how to use the NVML API. + +## DCGM exporter + +GPU metrics exporter for [Prometheus](https://prometheus.io/) leveraging [NVIDIA Data Center GPU Manager (DCGM)](https://developer.nvidia.com/data-center-gpu-manager-dcgm) is a simple shell script that starts nv-hostengine, reads GPU metrics every 1 second and converts it to a standard Prometheus format. + +Find the installation and run instructions [here](https://github.com/NVIDIA/gpu-monitoring-tools/blob/master/exporters/prometheus-dcgm/README.md). + +## Issues and Contributing + +A signed copy of the [Contributor License Agreement](https://github.com/NVIDIA/gpu-monitoring-tools/blob/master/CLA) needs to be provided to digits@nvidia.com before any change can be accepted. + +* Please let us know by [filing a new issue](https://github.com/NVIDIA/gpu-monitoring-tools/issues/new) +* You can contribute by opening a [pull request](https://help.github.com/articles/using-pull-requests/)