Skip to content

Commit

Permalink
Update readme and project metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
sasha0552 committed Mar 5, 2024
1 parent e917e01 commit b47205c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A library and CLI utilities for managing performance states of NVIDIA GPUs.
pip3 install nvidia_pstate
```

## Usage
## Usage (CLI)
```sh
# List available performance states (TODO: does not work right now, use nvidia-smi -q and count memory clocks)
nvidia-pstate list-pstates
Expand All @@ -20,3 +20,13 @@ nvidia-pstate set-pstate -i 0 -ps 16
# Set performance state for all GPUs
nvidia-pstate set-pstate -ps 0
```

## Usage (API)
```python
from nvidia_pstate import set_pstate_low, set_pstate_high

set_pstate_low() # set pstate to "low" level (8 by default)
set_pstate_high() # set pstate to "high" level (16 by default)

# default values can be overrided using NVIDIA_PSTATE_LOW and NVIDIA_PSTATE_HIGH environment variables.
```
8 changes: 7 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,16 @@ requires = [
[project]
description = "A library and CLI utilities for managing performance states of NVIDIA GPUs."
name = "nvidia_pstate"
version = "1.0.0"
version = "1.0.1"
readme = "README.md"

authors = [
{ name = "sasha0552", email = "admin@sasha0552.org" },
]

classifiers = [
"License :: OSI Approved :: MIT License",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
]

Expand All @@ -25,3 +27,7 @@ license = { text = "MIT" }

[project.scripts]
nvidia-pstate = "nvidia_pstate.scripts.nvidia_pstate:main"


[project.urls]
Homepage = "https://github.com/sasha0552/nvidia-pstate"

0 comments on commit b47205c

Please sign in to comment.