| Name | gpu-tracker JSON |
| Version |
2.0.1
JSON |
| download |
| home_page | None |
| Summary | Tracks computational resources of a process and its child processes, most prominently GPU RAM, as well as RAM and compute time. |
| upload_time | 2024-04-01 02:40:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | The Clear BSD License Copyright (c) 2024, Erik D. Huckvale, and Hunter N.B. Moseley All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. * If the source code is used in a published work, then proper citation of the source code must be included with the published work. NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
gpu
ram
time
memory
profile
track
resource
usage
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
psutil
docopt
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
###########
gpu_tracker
###########
Description
-----------
The ``gpu_tracker`` package provides a ``Tracker`` class and a commandline-interface that tracks (profiles) the usage of compute time, maximum RAM, and maximum GPU RAM.
The compute time is a measurement of the real time taken by the task as opposed to the CPU-utilization time.
The GPU tracking is for Nvidia GPUs and uses the ``nvidia-smi`` command, assuming the Nvidia drivers have been installed.
Computational resources are tracked throughout the duration of a context manager or the duration of explicit calls to the ``start()`` and ``stop()`` methods of the ``Tracker`` class.
The ``gpu-tracker`` command-line interface alternatively tracks the computational-resource-usage of an arbitrary shell command.
Documentation
-------------
The complete documentation for the ``gpu_tracker`` package, including tutorials, can be found `here <https://moseleybioinformaticslab.github.io/gpu_tracker/>`__.
Installation
------------
Requires python 3.10 and above.
Install on Linux, Mac OS X
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. parsed-literal::
python3 -m pip install gpu-tracker
Install on Windows
~~~~~~~~~~~~~~~~~~
.. parsed-literal::
py -3 -m pip install gpu-tracker
PyPi
~~~~
See our PyPi page `here <https://pypi.org/project/gpu-tracker/>`__.
Questions, Feature Requests, and Bug Reports
--------------------------------------------
Please submit any questions or feature requests you may have and report any potential bugs/errors you observe on `our GitHub issues page <https://github.com/MoseleyBioinformaticsLab/gpu_tracker/issues>`__.
GitHub Repository
-------------------
Code is available on GitHub: https://github.com/MoseleyBioinformaticsLab/gpu_tracker.
Raw data
{
"_id": null,
"home_page": null,
"name": "gpu-tracker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "gpu, ram, time, memory, profile, track, resource, usage",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/dd/2e/c8b1d1cf943d7b853792bfa5b279a6c8f5c989d91c3a2d780b63f96df8b0/gpu-tracker-2.0.1.tar.gz",
"platform": null,
"description": "###########\ngpu_tracker\n###########\nDescription\n-----------\nThe ``gpu_tracker`` package provides a ``Tracker`` class and a commandline-interface that tracks (profiles) the usage of compute time, maximum RAM, and maximum GPU RAM.\nThe compute time is a measurement of the real time taken by the task as opposed to the CPU-utilization time.\nThe GPU tracking is for Nvidia GPUs and uses the ``nvidia-smi`` command, assuming the Nvidia drivers have been installed.\nComputational resources are tracked throughout the duration of a context manager or the duration of explicit calls to the ``start()`` and ``stop()`` methods of the ``Tracker`` class.\nThe ``gpu-tracker`` command-line interface alternatively tracks the computational-resource-usage of an arbitrary shell command.\n\nDocumentation\n-------------\nThe complete documentation for the ``gpu_tracker`` package, including tutorials, can be found `here <https://moseleybioinformaticslab.github.io/gpu_tracker/>`__.\n\nInstallation\n------------\nRequires python 3.10 and above.\n\nInstall on Linux, Mac OS X\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n.. parsed-literal::\n python3 -m pip install gpu-tracker\n\nInstall on Windows\n~~~~~~~~~~~~~~~~~~\n.. parsed-literal::\n py -3 -m pip install gpu-tracker\n\nPyPi\n~~~~\nSee our PyPi page `here <https://pypi.org/project/gpu-tracker/>`__.\n\nQuestions, Feature Requests, and Bug Reports\n--------------------------------------------\nPlease submit any questions or feature requests you may have and report any potential bugs/errors you observe on `our GitHub issues page <https://github.com/MoseleyBioinformaticsLab/gpu_tracker/issues>`__.\n\nGitHub Repository\n-------------------\nCode is available on GitHub: https://github.com/MoseleyBioinformaticsLab/gpu_tracker.\n",
"bugtrack_url": null,
"license": "The Clear BSD License Copyright (c) 2024, Erik D. Huckvale, and Hunter N.B. Moseley All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. * If the source code is used in a published work, then proper citation of the source code must be included with the published work. NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Tracks computational resources of a process and its child processes, most prominently GPU RAM, as well as RAM and compute time.",
"version": "2.0.1",
"project_urls": {
"Documentation": "https://moseleybioinformaticslab.github.io/gpu_tracker/",
"GitHub": "https://github.com/MoseleyBioinformaticsLab/gpu_tracker",
"Homepage": "https://github.com/MoseleyBioinformaticsLab/gpu_tracker",
"Issues": "https://github.com/MoseleyBioinformaticsLab/gpu_tracker/issues"
},
"split_keywords": [
"gpu",
" ram",
" time",
" memory",
" profile",
" track",
" resource",
" usage"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fda21a975552c899b175c93eab960418e625f5b65373a65fcdc1bfaf6f48525c",
"md5": "6f957bc5b75d61c83afa677258dd33a9",
"sha256": "f7c4e43ad85d522c0f56cd4e75dfc5d13b794de96af9b4a0b43b53814f902855"
},
"downloads": -1,
"filename": "gpu_tracker-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f957bc5b75d61c83afa677258dd33a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 10683,
"upload_time": "2024-04-01T02:40:01",
"upload_time_iso_8601": "2024-04-01T02:40:01.158177Z",
"url": "https://files.pythonhosted.org/packages/fd/a2/1a975552c899b175c93eab960418e625f5b65373a65fcdc1bfaf6f48525c/gpu_tracker-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dd2ec8b1d1cf943d7b853792bfa5b279a6c8f5c989d91c3a2d780b63f96df8b0",
"md5": "9f27c3ace7cbc54553cfda8d244d384f",
"sha256": "a4f6d815b25142843a9fecfb844be06e644adee659c69793bdca60e984012f23"
},
"downloads": -1,
"filename": "gpu-tracker-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9f27c3ace7cbc54553cfda8d244d384f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 26889,
"upload_time": "2024-04-01T02:40:03",
"upload_time_iso_8601": "2024-04-01T02:40:03.127380Z",
"url": "https://files.pythonhosted.org/packages/dd/2e/c8b1d1cf943d7b853792bfa5b279a6c8f5c989d91c3a2d780b63f96df8b0/gpu-tracker-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 02:40:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MoseleyBioinformaticsLab",
"github_project": "gpu_tracker",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "psutil",
"specs": []
},
{
"name": "docopt",
"specs": []
}
],
"lcname": "gpu-tracker"
}
