| Name | gpu-tracker JSON |
| Version |
3.0.2
JSON |
| download |
| home_page | None |
| Summary | Tracks computational resources of a process and its child processes, most prominently GPU RAM, as well as RAM, compute time, and CPU utilization. |
| upload_time | 2024-09-25 15:13:13 |
| 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 |
No requirements were recorded.
|
| 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, CPU utilization, maximum RAM, GPU utilization, 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. If the Nvidia drivers have not been installed, then the max GPU RAM is not tracked and measurements are reported as 0.
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.
**NOTE: The tracking occurs in a separate process. To maximize the accuracy of the reported resource usage, you may want to have a core available solely for the tracking process e.g. if your job uses 3 workers, you may want to allocate 4 cores.**
**NOTE: Since the tracking process is created using the Python multiprocessing library, if done so using the "spawn" start method (default on MacOS and Windows) or the "forkserver" method, you may get a runtime error after starting the tracking. To prevent this, you'll need to start the tracker after checking** ``if __name__ == '__main__'``. **See "Safe importing of main module" under** `The spawn and forkserver start methods <https://docs.python.org/3/library/multiprocessing.html#the-spawn-and-forkserver-start-methods>`__ **for more information.**
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/46/4a/d243f1b1305c3ca13547fcf51e0b54ddab140d9d4347c00d2691bd7f0d79/gpu_tracker-3.0.2.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, CPU utilization, maximum RAM, GPU utilization, 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. If the Nvidia drivers have not been installed, then the max GPU RAM is not tracked and measurements are reported as 0.\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\n**NOTE: The tracking occurs in a separate process. To maximize the accuracy of the reported resource usage, you may want to have a core available solely for the tracking process e.g. if your job uses 3 workers, you may want to allocate 4 cores.**\n\n**NOTE: Since the tracking process is created using the Python multiprocessing library, if done so using the \"spawn\" start method (default on MacOS and Windows) or the \"forkserver\" method, you may get a runtime error after starting the tracking. To prevent this, you'll need to start the tracker after checking** ``if __name__ == '__main__'``. **See \"Safe importing of main module\" under** `The spawn and forkserver start methods <https://docs.python.org/3/library/multiprocessing.html#the-spawn-and-forkserver-start-methods>`__ **for more information.**\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, compute time, and CPU utilization.",
"version": "3.0.2",
"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": "40539cdad022b2255f9013730296146b5a42ce2cbd0602f5374c6a5a05f06b00",
"md5": "1f2c56e7f98c805a4d96c82d3b3b0421",
"sha256": "efd7716e03f14b38d7ca2e5392ee92b086b2b01cbf1a2f296286e167660fefd7"
},
"downloads": -1,
"filename": "gpu_tracker-3.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f2c56e7f98c805a4d96c82d3b3b0421",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 15062,
"upload_time": "2024-09-25T15:13:12",
"upload_time_iso_8601": "2024-09-25T15:13:12.506822Z",
"url": "https://files.pythonhosted.org/packages/40/53/9cdad022b2255f9013730296146b5a42ce2cbd0602f5374c6a5a05f06b00/gpu_tracker-3.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "464ad243f1b1305c3ca13547fcf51e0b54ddab140d9d4347c00d2691bd7f0d79",
"md5": "fc805233afb1a34385882eb5514d5fcd",
"sha256": "20069e658a0e3e227ba793ce7b8a52ac200e8a1529addc45abf3985142478895"
},
"downloads": -1,
"filename": "gpu_tracker-3.0.2.tar.gz",
"has_sig": false,
"md5_digest": "fc805233afb1a34385882eb5514d5fcd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 43655,
"upload_time": "2024-09-25T15:13:13",
"upload_time_iso_8601": "2024-09-25T15:13:13.551347Z",
"url": "https://files.pythonhosted.org/packages/46/4a/d243f1b1305c3ca13547fcf51e0b54ddab140d9d4347c00d2691bd7f0d79/gpu_tracker-3.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-25 15:13:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MoseleyBioinformaticsLab",
"github_project": "gpu_tracker",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "gpu-tracker"
}
