Merge pull request #69 from MoseleyBioinformaticsLab/granular

Granular

Author: erikhuck

.github/workflows/tests.yml

@@ -24,7 +24,7 @@ jobs:
     - name: Install testing environment
       run: |
         python3 -m pip install --upgrade pip
-        python3 -m pip install pytest pytest-mock pytest-cov
+        python3 -m pip install pytest pytest-mock pytest-cov deepdiff
     - name: Install package
       uses: Wandalen/wretry.action@master
       with:

README.rst

@@ -5,7 +5,7 @@ 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.
+The GPU tracking is for both Nvidia and AMD GPUs and respectively uses the nvidia-smi and amd-smi command-line tools to pull GPU usage information. Also, if neither the appropriate Nvidia nor AMD driver is installed, then the GPU-related metrics are not tracked and 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.
 

docs/conf.py

@@ -14,8 +14,8 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'gpu_tracker'
-copyright = '2024, Erik Huckvale, Hunter N. B. Moseley'
-author = 'Erik Huckvale, Hunter N. B. Moseley'
+copyright = '2024, Erik D. Huckvale, Hunter N. B. Moseley'
+author = 'Erik D. Huckvale, Hunter N. B. Moseley'
 version = __version__
 release = __version__
 

docs/notebook/combined-file.csv

@@ -0,0 +1,25 @@
+process_id,code_block_name,position,timestamp
+265016,my-code-block,0,1746129778.99568
+265016,my-code-block,1,1746129781.7855892
+265016,my-function,0,1746129781.7872624
+265016,my-function,1,1746129784.3252733
+265016,my-code-block,0,1746129784.3266726
+265016,my-code-block,1,1746129786.9071054
+265016,my-function,0,1746129786.9082048
+265016,my-function,1,1746129789.4858837
+265016,my-code-block,0,1746129789.486994
+265016,my-code-block,1,1746129792.0702057
+265016,my-function,0,1746129792.0713246
+265016,my-function,1,1746129794.6151624
+265016,my-code-block,0,1746129778.99568
+265016,my-code-block,1,1746129781.7855892
+265016,my-function,0,1746129781.7872624
+265016,my-function,1,1746129784.3252733
+265016,my-code-block,0,1746129784.3266726
+265016,my-code-block,1,1746129786.9071054
+265016,my-function,0,1746129786.9082048
+265016,my-function,1,1746129789.4858837
+265016,my-code-block,0,1746129789.486994
+265016,my-code-block,1,1746129792.0702057
+265016,my-function,0,1746129792.0713246
+265016,my-function,1,1746129794.6151624

docs/notebook/config.json

@@ -0,0 +1,6 @@
+{
+  "sleep_time": 0.5,
+  "ram_unit": "megabytes",
+  "gpu_ram_unit": "megabytes",
+  "time_unit": "seconds"
+}

docs/notebook/correct_nbconvert.py

@@ -5,6 +5,7 @@
 contents: str = contents.replace('python3\n\n    !', 'none\n\n    !')
 contents: str = contents.replace('parsed-literal::', 'code:: none')
 contents: str = contents.replace('!', '$ ')
+contents: str = contents.replace('os._exit(0)', '')
 contents = '.. _tutorial-label:\n\n' + contents
 
 with open('tutorial.rst', 'w') as file:

docs/notebook/my-results.pkl

@@ -0,0 +1,13 @@
+process_id,code_block_name,position,timestamp
+265016,my-code-block,0,1746129778.99568
+265016,my-code-block,1,1746129781.7855892
+265016,my-function,0,1746129781.7872624
+265016,my-function,1,1746129784.3252733
+265016,my-code-block,0,1746129784.3266726
+265016,my-code-block,1,1746129786.9071054
+265016,my-function,0,1746129786.9082048
+265016,my-function,1,1746129789.4858837
+265016,my-code-block,0,1746129789.486994
+265016,my-code-block,1,1746129792.0702055
+265016,my-function,0,1746129792.0713246
+265016,my-function,1,1746129794.6151624