Skip to main content

A small program that uses the NVIDIA Management Library to control the GPU independent of OS or display server. This project is not provided or endorsed by NVIDIA

Project description

CaioH NVML GPU Control

This is a small program that uses the NVIDIA Management Library (NVML) to monitor GPU temperature and set fan speed. NVML is being used, because it is OS and display sever agnostic (that means it doesn't depend on X11 or Windows). Another important reason is that the official NVIDIA tool (NVIDIA smi) does not currently support fan control.

Disclaimer

  • This project is NOT endorsed or sponsored by NVIDIA
  • This project is independent and not affiliated to NVIDIA

Supported hardware

  • Any NVIDIA CUDA supported card with a driver higher or equal to version 520

Dependencies

To use it, you must have installed:

  • NVIDIA's proprietary drivers (>= v520)
  • Python 3
  • nvidia-ml-py (NVIDIA's official python bindings)

You will also need admin/root privileges to be able to set anything. Query can be done by unprivileged users however.

Installation

Windows

Install the package with pip running as admin to make it system wide (needed for startup services)

pip install caioh-nvml-gpu-control

Linux

Install the package with pipx running as root, so it can be installed system-wide (needed for startup services).

sudo pipx install --global caioh-nvml-gpu-control

[!WARNING] Files must be writable only to admin/root, otherwise unprivileged programs may escalate provileges with the startup services. If you followed the steps, this should be done already

Uninstall

Windows

Uninstall the package by running pip as admin

pip uninstall caioh-nvml-gpu-control

Linux

Uninstall the package by running pipx command as root

sudo pipx uninstall --global caioh-nvml-gpu-control

How to use

[!NOTE] The python command on Windows may require the .exe at the end (like this "python.exe")

[!TIP] You can start the program with chnvml if the Scripts directory is in the PATH or use python -m caioh_nvml_gpu_control.

  • You must first list all cards that are connected, so you can get the name or UUID
chnvml list
  • Then you can select a target by name
chnvml fan-control -n 'NVIDIA GeForce RTX 4080'
  • Or by UUID
chnvml fan-control -id GPU-00000000-0000-0000-0000-000000000000
  • And the fan speed for each temperature level (requires admin)
sudo chnvml fan-control -n 'NVIDIA GeForce RTX 4080' -sp '10:35,20:50,30:50,35:100'
  • You could also use the --dry-run for testing! (no admin or root)
chnvml fan-control -n 'NVIDIA GeForce RTX 4080' -sp '10:35,20:50,30:50,35:100' --dry-run
  • You can also revert to the original fan state by runnig the following command or rebooting the machine
chnvml fan-policy --auto -n 'NVIDIA GeForce RTX 4080'

Note that it does not current support fan curve (or linear progression), so it works on levels. Each level the temperature is verified against the configuration (higher or equal) and then set properly. Also, each temperature associated with speed is ordered automatically. (think of it as a staircase graph)

Temp : speed(%)

1. 40 : 100 (>=40°C - 100%)

2. 30 : 50 (>=30°C - 50%)

3. 20 : 30 (>=20°C - 30%)

4. Default speed (DS)

___________________________

41°C - 100%

21°C - 30%

19°C - Default speed

Usage actions and options

python ./nvml_gpu_control.py <ACTION> <OPTIONS>

ACTIONS
    help
          Display help text

    list
          List all available GPUs connected to the system by printing its name and UUID

    fan-control
          Monitor and controls the fan speed of the selected card (you must select a target card)

    fan-info
          Shows information about fan speed

    fan-policy <--auto|--manual>
          Changes the fan control policy to automatic (vBIOS controlled) or manual. Note that when the fan speed is changed, the NVML library automatically changes this setting to manual. This setting is useful to change the GPU back to its original state

    fan-policy-info
          Shows information about the current fan policy

    power-limit-info
          Shows information about the power limit of the selected GPU

    power-control
          Controls the power limit of the selected GPU. It runs in a loop by default, but can run once using the --single-use option

    thresholds-info
          Shows information about temperature thresholds in dregrees Celsius of the selected GPU.

    temp-control
          Controls the temperature thresholds configuration of the selected GPU. It runs in a loop by default, but can run once using the --single-use option

    control-all
         Allows the use of all controls in a single command/loop


OPTIONS

    --name OR -n <GPU_NAME>
          Select a target GPU by its name. Example: --name "NVIDIA GeForce RTX 4080". Note: UUID has preference over name

    --uuid OR -id <GPU_UUID>
          Select a target GPU by its Universally Unique IDentifier (UUID). Example: --uuid "GPU-00000000-0000-0000-0000-000000000000". Note: UUID has preference over name

    --time-interval OR -ti <TIME_SECONDS>
          Time period to wait before probing the GPU again. Works for all actions that run in a loop

    --retry-interval OR -ri <TIME_SECONDS>
          Time period in seconds to wait before trying to issue commands to the GPU again. Works for all actions that run in a loop

    --dry-run OR -dr
          Run the program, but don't change/set anything. Useful for testing the behavior of the program

    --speed-pair OR -sp <TEMP_CELSIUS:SPEED_PERCENTAGE,TEMP_CELSIUS:SPEED_PERCENTAGE...>
          A comma separated list of pairs of temperature in celsius and the fan speed in % (temp:speed) defining basic settings for a fan curve

    --default-speed OR -ds <FAN_SPEED_PERCENTAGE>
          Set a default speed for when there is no match for the fan curve settings

    --manual
          Sets the fan policy to manual

    --auto
          Sets the fan policy to automatic (vBIOS controlled)

    --power-limit OR -pl <POWER_LIMIT_WATTS>
          Sets the power limit of the GPU in watts

    --acoustic-temp-limit OR -tl <TEMPERATURE_CELSIUS>
          Sets the acoustic threshold in celsious (note that this is the same temperature limit used by GeForce Experience)

    --single-use OR -su
          Makes some actions work only once insted of in a loop. This option is valid for: temp-control and power-control

    --verbose OR -V
          When there are no settings changes, leg messages are omitted by default. This option enables them back (good for debugging)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

caioh_nvml_gpu_control-1.1.0.0.tar.gz (25.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

caioh_nvml_gpu_control-1.1.0.0-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file caioh_nvml_gpu_control-1.1.0.0.tar.gz.

File metadata

  • Download URL: caioh_nvml_gpu_control-1.1.0.0.tar.gz
  • Upload date:
  • Size: 25.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for caioh_nvml_gpu_control-1.1.0.0.tar.gz
Algorithm Hash digest
SHA256 7f78e1953b2763b3db0ce854e0f9902875c5f887d100457b7b55be010d083f18
MD5 c4a9771817aa32ddf059001b62c547ad
BLAKE2b-256 2279f9d5a04e710091a137a47f28b5563665118240342092bea0a47e858cccd6

See more details on using hashes here.

File details

Details for the file caioh_nvml_gpu_control-1.1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for caioh_nvml_gpu_control-1.1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aa5843c921d43fc174c475eb6e6b76899dfd1dc5ffbebfaee4f2615ab561f3ef
MD5 6d8a4f89ade1ec1a2b71eb6ab38352a7
BLAKE2b-256 c03e7d1516f8a178ef78b71f36b2dbaa09953453879af63dc44874e3944144ab

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page