pynvml


Namepynvml JSON
Version 12.0.0 PyPI version JSON
download
home_pageNone
SummaryPython utilities for the NVIDIA Management Library
upload_time2024-12-02 15:04:36
maintainerNone
docs_urlNone
authorNVIDIA Corporation
requires_python>=3.9
licenseBSD-3-Clause
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            > [!WARNING]
> 
> **The `pynvml` module is NOT developed or maintained in this project!**
> 
> This project provides unofficial NVML Python utilities (i.e. the `pynvml_utils` module).
> The `pynvml_utils` module is intended for demonstration purposes only.
> There is no guarantee for long-term maintenence or support.
>
> The `pynvml_utils` module depends on the official NVML bindings
> published by NVIDIA under a different `nvidia-ml-py` project
> (see: https://pypi.org/project/nvidia-ml-py/).
>


Python utilities for the NVIDIA Management Library
===============================================================

This project provides unofficial Python utilities for the
NVIDIA Management Library (NVML).

For information about the NVML library, see the NVML developer page
http://developer.nvidia.com/nvidia-management-library-nvml


Requires
--------
`nvidia-ml-py`.


Installation
------------

    pip install .

Usage
-----

Bindings for the high-level `nvidia-smi` API are available
in `pynvml_utils.nvidia_smi`:

> [!WARNING]
> The `nvidia_smi` module is intended for demonstration purposes only.
> There is no guarantee for long-term maintenence or support.

```python
from pynvml_utils import nvidia_smi
nvsmi = nvidia_smi.getInstance()
nvsmi.DeviceQuery('memory.free, memory.total')
```

```python
from pynvml_utils import nvidia_smi
nvsmi = nvidia_smi.getInstance()
print(nvsmi.DeviceQuery('--help-query-gpu'), end='\n')
```

Release Notes
-------------

-   Version 12.0.0
    - Remove pynvml module and depend on nvidia-ml-py instead
    - Pin to nvidia-ml-py>=12.0.0,<13.0.0a0


Old Releases
------------

-   Version 2.285.0
    - Added new functions for NVML 2.285.  See NVML documentation for more information.
    - Ported to support Python 3.0 and Python 2.0 syntax.
    - Added nvidia_smi.py tool as a sample app.
-   Version 3.295.0
    - Added new functions for NVML 3.295.  See NVML documentation for more information.
    - Updated nvidia_smi.py tool
      - Includes additional error handling
-   Version 4.304.0
    - Added new functions for NVML 4.304.  See NVML documentation for more information.
    - Updated nvidia_smi.py tool
-   Version 4.304.3
    - Fixing nvmlUnitGetDeviceCount bug
-   Version 5.319.0
    - Added new functions for NVML 5.319.  See NVML documentation for more information.
-   Version 6.340.0
    - Added new functions for NVML 6.340.  See NVML documentation for more information.
-   Version 7.346.0
    - Added new functions for NVML 7.346.  See NVML documentation for more information.
-   Version 7.352.0
    - Added new functions for NVML 7.352.  See NVML documentation for more information.
-   Version 8.0.0
    - Refactor code to a nvidia_smi singleton class
    - Added DeviceQuery that returns a dictionary of (name, value).
    - Added filter parameters on DeviceQuery to match query api in nvidia-smi
    - Added filter parameters on XmlDeviceQuery to match query api in nvidia-smi
    - Added integer enumeration for filter strings to reduce overhead for performance monitoring.
    - Added loop(filter) method with async and callback support
-   Version 8.0.1
    - Restructuring directories into two packages (pynvml and nvidia_smi)
    - Adding initial tests for both packages
    - Some name-convention cleanup in pynvml
-   Version 8.0.2
    - Added NVLink function wrappers for pynvml module
-   Version 8.0.3
    - Added versioneer
    - Fixed nvmlDeviceGetNvLinkUtilizationCounter bug
-   Version 8.0.4
    - Added nvmlDeviceGetTotalEnergyConsumption
    - Added notes about NVML permissions
    - Fixed version-check testing
-   Version 11.0.0
    - Updated nvml.py to CUDA 11
    - Updated smi.py DeviceQuery to R460
    - Aligned nvml.py with latest nvidia-ml-py deployment
-   Version 11.4.0
    - Updated nvml.py to CUDA 11.4
    - Updated smi.py NVML_BRAND_NAMES
    - Aligned nvml.py with latest nvidia-ml-py deployment (11.495.46)
-   Version 11.4.1
    - Fix comma bugs in nvml.py
-   Version 11.5.0
    - Updated nvml.py to support CUDA 11.5 and CUDA 12
    - Aligned with latest nvidia-ml-py deployment (11.525.84)
-   Version 11.5.2
    - Relocated smi bindings to new pynvml_utils module
    - Updated README to encourage migration to nvidia-ml-py
-   Version 11.5.3
    - Update versioneer

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pynvml",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "NVIDIA Corporation",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/26/6f/6b5880ed0239e85b9a39aed103b65b2ef81425beef9f45e5c035bf008330/pynvml-12.0.0.tar.gz",
    "platform": null,
    "description": "> [!WARNING]\n> \n> **The `pynvml` module is NOT developed or maintained in this project!**\n> \n> This project provides unofficial NVML Python utilities (i.e. the `pynvml_utils` module).\n> The `pynvml_utils` module is intended for demonstration purposes only.\n> There is no guarantee for long-term maintenence or support.\n>\n> The `pynvml_utils` module depends on the official NVML bindings\n> published by NVIDIA under a different `nvidia-ml-py` project\n> (see: https://pypi.org/project/nvidia-ml-py/).\n>\n\n\nPython utilities for the NVIDIA Management Library\n===============================================================\n\nThis project provides unofficial Python utilities for the\nNVIDIA Management Library (NVML).\n\nFor information about the NVML library, see the NVML developer page\nhttp://developer.nvidia.com/nvidia-management-library-nvml\n\n\nRequires\n--------\n`nvidia-ml-py`.\n\n\nInstallation\n------------\n\n    pip install .\n\nUsage\n-----\n\nBindings for the high-level `nvidia-smi` API are available\nin `pynvml_utils.nvidia_smi`:\n\n> [!WARNING]\n> The `nvidia_smi` module is intended for demonstration purposes only.\n> There is no guarantee for long-term maintenence or support.\n\n```python\nfrom pynvml_utils import nvidia_smi\nnvsmi = nvidia_smi.getInstance()\nnvsmi.DeviceQuery('memory.free, memory.total')\n```\n\n```python\nfrom pynvml_utils import nvidia_smi\nnvsmi = nvidia_smi.getInstance()\nprint(nvsmi.DeviceQuery('--help-query-gpu'), end='\\n')\n```\n\nRelease Notes\n-------------\n\n-   Version 12.0.0\n    - Remove pynvml module and depend on nvidia-ml-py instead\n    - Pin to nvidia-ml-py>=12.0.0,<13.0.0a0\n\n\nOld Releases\n------------\n\n-   Version 2.285.0\n    - Added new functions for NVML 2.285.  See NVML documentation for more information.\n    - Ported to support Python 3.0 and Python 2.0 syntax.\n    - Added nvidia_smi.py tool as a sample app.\n-   Version 3.295.0\n    - Added new functions for NVML 3.295.  See NVML documentation for more information.\n    - Updated nvidia_smi.py tool\n      - Includes additional error handling\n-   Version 4.304.0\n    - Added new functions for NVML 4.304.  See NVML documentation for more information.\n    - Updated nvidia_smi.py tool\n-   Version 4.304.3\n    - Fixing nvmlUnitGetDeviceCount bug\n-   Version 5.319.0\n    - Added new functions for NVML 5.319.  See NVML documentation for more information.\n-   Version 6.340.0\n    - Added new functions for NVML 6.340.  See NVML documentation for more information.\n-   Version 7.346.0\n    - Added new functions for NVML 7.346.  See NVML documentation for more information.\n-   Version 7.352.0\n    - Added new functions for NVML 7.352.  See NVML documentation for more information.\n-   Version 8.0.0\n    - Refactor code to a nvidia_smi singleton class\n    - Added DeviceQuery that returns a dictionary of (name, value).\n    - Added filter parameters on DeviceQuery to match query api in nvidia-smi\n    - Added filter parameters on XmlDeviceQuery to match query api in nvidia-smi\n    - Added integer enumeration for filter strings to reduce overhead for performance monitoring.\n    - Added loop(filter) method with async and callback support\n-   Version 8.0.1\n    - Restructuring directories into two packages (pynvml and nvidia_smi)\n    - Adding initial tests for both packages\n    - Some name-convention cleanup in pynvml\n-   Version 8.0.2\n    - Added NVLink function wrappers for pynvml module\n-   Version 8.0.3\n    - Added versioneer\n    - Fixed nvmlDeviceGetNvLinkUtilizationCounter bug\n-   Version 8.0.4\n    - Added nvmlDeviceGetTotalEnergyConsumption\n    - Added notes about NVML permissions\n    - Fixed version-check testing\n-   Version 11.0.0\n    - Updated nvml.py to CUDA 11\n    - Updated smi.py DeviceQuery to R460\n    - Aligned nvml.py with latest nvidia-ml-py deployment\n-   Version 11.4.0\n    - Updated nvml.py to CUDA 11.4\n    - Updated smi.py NVML_BRAND_NAMES\n    - Aligned nvml.py with latest nvidia-ml-py deployment (11.495.46)\n-   Version 11.4.1\n    - Fix comma bugs in nvml.py\n-   Version 11.5.0\n    - Updated nvml.py to support CUDA 11.5 and CUDA 12\n    - Aligned with latest nvidia-ml-py deployment (11.525.84)\n-   Version 11.5.2\n    - Relocated smi bindings to new pynvml_utils module\n    - Updated README to encourage migration to nvidia-ml-py\n-   Version 11.5.3\n    - Update versioneer\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Python utilities for the NVIDIA Management Library",
    "version": "12.0.0",
    "project_urls": {
        "Homepage": "https://github.com/gpuopenanalytics/pynvml",
        "Source": "https://github.com/gpuopenanalytics/pynvml"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eddff7cf07a65a96dd11d71f346f9c2863accdd4784da83af7181b067d556cbc",
                "md5": "50265abb8037bdee4c66df893c9fb703",
                "sha256": "fdff84b62a27dbe98e08e1a647eb77342bef1aebe0878bcd15e99a83fcbecb9e"
            },
            "downloads": -1,
            "filename": "pynvml-12.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "50265abb8037bdee4c66df893c9fb703",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 26560,
            "upload_time": "2024-12-02T15:04:35",
            "upload_time_iso_8601": "2024-12-02T15:04:35.047709Z",
            "url": "https://files.pythonhosted.org/packages/ed/df/f7cf07a65a96dd11d71f346f9c2863accdd4784da83af7181b067d556cbc/pynvml-12.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "266f6b5880ed0239e85b9a39aed103b65b2ef81425beef9f45e5c035bf008330",
                "md5": "2bca3198a8036106ad726ab6625f9a9c",
                "sha256": "299ce2451a6a17e6822d6faee750103e25b415f06f59abb8db65d30f794166f5"
            },
            "downloads": -1,
            "filename": "pynvml-12.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2bca3198a8036106ad726ab6625f9a9c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 33636,
            "upload_time": "2024-12-02T15:04:36",
            "upload_time_iso_8601": "2024-12-02T15:04:36.631572Z",
            "url": "https://files.pythonhosted.org/packages/26/6f/6b5880ed0239e85b9a39aed103b65b2ef81425beef9f45e5c035bf008330/pynvml-12.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-02 15:04:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "gpuopenanalytics",
    "github_project": "pynvml",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pynvml"
}
        
Elapsed time: 0.45617s