Metadata-Version: 2.1
Name: fastgpu
Version: 0.0.1
Summary: A queue service for quickly developing scripts that use all your GPUs efficiently
Home-page: https://github.com/fastai/fastgpu
Author: Jeremy Howard and Alexis Gallagher
Author-email: info@fast.ai
License: Apache Software License 2.0
Description: <!--
        
        #################################################
        ### THIS FILE WAS AUTOGENERATED! DO NOT EDIT! ###
        #################################################
        # file to edit: 99_index.ipynb
        # command to build the docs after a change: nbdev_build_docs
        
        -->
        
        # fastgpu
        
        > A queue service for quickly developing scripts that use all your GPUs efficiently
        
        
        `fastgpu` provides a single command, `fastgpu_poll`, which polls a directory to check for scripts to run, and then runs them on the first available GPU. If no GPUs are available, it waits until one is. If more than one GPU is available, multiple scripts are run in parallel, one per GPU.
        
        An API is also provided for polling programmatically, which is extensible for assigning other resources to processes besides GPUs.
        
        ## Install
        
        `pip install fastgpu`
        
        ## How to use
        
        `--help` provides command help:
        
        ----
        
        ```
        $ fastgpu_poll --help
        usage: fastgpu_poll [-h] [--path PATH] [--exit EXIT]
        
        Poll `path` for scripts using `ResourcePoolGPU.poll_scripts`
        
        optional arguments:
          -h, --help   show this help message and exit
          --path PATH  Path containing `to_run` directory
          --exit EXIT  Exit when `to_run` is empty
        ```
        
        ----
        
        `path` defaults to the current directory. The path should contain a subdirectory `to_run` containing executable scripts you wish to run. It should not contain any other files, although it can contain subdirectories (which are ignored).
        
        `fastgpu_poll` will run each script in `to_run` in sorted order. Each script will be assigned to one GPU. The id of the GPU selected will be passed as the first argument to the script; it is the responsibility of your script to use this GPU.
        
        Once a script is selected to be run, it is moved into a directory called `running`. Once it's finished, it's moved into `complete` or `fail` as appropriate. stdout and stderr are captured to files with the same name as the script, plus `stdout` or `stderr` appended.
        
        If `exit` is `1` (which is the default), then once all scripts are run, `fastgpu_poll` will exit. If it is `0` then `fastgpu_poll` will continue running until it is killed; it will keep polling for any new scripts that are added to `to_run`.
        
Keywords: GPU fast.ai queue watchdog
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
