Metadata-Version: 2.1
Name: gpumonitor
Version: 0.1.0
Summary: GPU Monitoring Callbacks for TensorFlow and PyTorch Lightning
Home-page: https://github.com/sicara/gpumonitor
Author: Raphael Meudec
Author-email: raphael.meudec@gmail.com
License: MIT
Description: # gpumonitor
        
        `gpumonitor` gives you **stats about GPU** usage during execution of your scripts and trainings,
        as [TensorFlow](https://www.github.com/tensorflow/tensorflow) or 
        [Pytorch Lightning](https://github.com/PyTorchLightning/pytorch-lightning) callbacks.
        
        <p align="center">
            <img src="./assets/callbacks.png" width="800" />
        </p>
        
        
        ## Installation
        
        Installation can be done directly from this repository:
        
        ```
        pip install https://github.com/sicara/gpumonitor/archive/master.zip
        ```
        
        ## Getting started
        
        
        <p align="center">
            <img src="./assets/gpumonitor.gif" width="1000" />
        </p>
        
        ### Option 1: In your scripts
        
        ```python
        monitor = gpumonitor.GPUStatMonitor(delay=1)
        
        # Your instructions here
        # [...]
        
        monitor.stop()
        monitor.display_average_stats_per_gpu()
        ```
        
        ### Option 2: Callbacks
        
        Add the following callback to your training loop:
        
        For [TensorFlow](https://www.github.com/tensorflow/tensorflow),
        
        ```python
        from gpumonitor.callbacks.tf import TFGpuMonitorCallback
        
        model.fit(x, y, callbacks=[TFGpuMonitorCallback(delay=0.5)])
        ```
        
        For [PyTorch Lightning](https://github.com/PyTorchLightning/pytorch-lightning),
        
        ```python
        from gpumonitor.callbacks.lightning import PyTorchGpuMonitorCallback
        
        trainer = pl.Trainer(callbacks=[PyTorchGpuMonitorCallback(delay=0.5)])
        trainer.fit(model)
        ```
        
        
        ## Sources
        
        - Built on top of [GPUStat](https://github.com/wookayin/gpustat)
        - Separate thread loop coming from [gputil](https://github.com/anderskm/gputil)
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: publish
