kgpu.py

GPU Overclocking Documentation

This documentation provides information on how to use the kgpu.py module for GPU overclocking.

Prerequisites

Before using the kgpu module, ensure that you have the following prerequisites installed:

• MSI Afterburner (for applying overclocking settings)

Module Usage

The kgpu module provides a function overclock_gpu() to apply overclocking settings to your GPU.

Importing the Module

To import the kgpu module, use the following import statement:

import subprocess
from kgpu import overclock_gpu

Applying Overclocking Settings

To apply overclocking settings to your GPU, call the overclock_gpu() function as follows:

overclock_gpu()

Overclocking Parameters

Before applying overclocking settings, you can modify the following parameters in the overclock_gpu() function according to your requirements:

• core_clock: Desired core clock frequency in MHz.
• memory_clock: Desired memory clock frequency in MHz.
• voltage: Desired voltage in volts.

For example, to set the core clock to 2000 MHz, memory clock to 4000 MHz, and voltage to 1.5 volts, modify the following lines of code:

core_clock = 2000
memory_clock = 4000
voltage = 1.5

Warning

Caution: Overclocking a GPU can cause instability, overheating, and potentially damage your hardware. Use it at your own risk.

Example

Here's an example usage of the kgpu module:

import subprocess
from kgpu import overclock_gpu

# Set the desired overclocking parameters
core_clock = 2000
memory_clock = 4000
voltage = 1.5

# Apply the overclocking settings
overclock_gpu()

Troubleshooting

If the msiafterburner.exe command is not found or the MSI Afterburner is not installed, the module will print the following message:

No Afterburner Installed

Make sure you have MSI Afterburner installed and its executable (msiafterburner.exe) is in your system's PATH.

Disclaimer

The authors of the kgpu module and this documentation are not responsible for any damage caused by overclocking your GPU. Use the module at your own risk and ensure that you understand the potential risks involved.