Refactor benchmarking to kiosk_client (#46)

* refactor benchmarking to kiosk_client

.coveragerc

@@ -14,4 +14,4 @@ show_missing = True
 
 omit =
     **/*_test.py
-    benchmarking/__main__.py
+    kiosk_client/__main__.py

.travis.yml

@@ -20,7 +20,7 @@ install:
   - pip install -U pytest pytest-twisted pytest-cov pytest-pep8 coveralls attrs>=19.2.0
 
 script:
-  - pytest --cov=benchmarking --pep8 benchmarking
+  - pytest --cov=kiosk_client --pep8 kiosk_client
 
 jobs:
   include:

README.md

@@ -1,10 +1,10 @@
-# kiosk-benchmarking
+# kiosk-client
 
-[![Build Status](https://travis-ci.com/vanvalenlab/kiosk-benchmarking.svg?branch=master)](https://travis-ci.com/vanvalenlab/kiosk-benchmarking)
-[![Coverage Status](https://coveralls.io/repos/github/vanvalenlab/kiosk-benchmarking/badge.svg?branch=master)](https://coveralls.io/github/vanvalenlab/kiosk-benchmarking?branch=master)
+[![Build Status](https://travis-ci.com/vanvalenlab/kiosk-client.svg?branch=master)](https://travis-ci.com/vanvalenlab/kiosk-client)
+[![Coverage Status](https://coveralls.io/repos/github/vanvalenlab/kiosk-client/badge.svg?branch=master)](https://coveralls.io/github/vanvalenlab/kiosk-client?branch=master)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](/LICENSE)
 
-`kiosk-benchmarking` is tool for interacting with the [Kiosk](https://github.com/vanvalenlab/kiosk-console) in order to create and monitor deep learning image processing jobs. It uses the asynchronous HTTP client [treq](https://github.com/twisted/treq) and the [Kiosk-Frontend API](https://github.com/vanvalenlab/kiosk-frontend) to create and monitor many jobs at once. Once all jobs are completed, [costs are estimated](./docs/cost_computation_notes.md) by using the cluster's [Grafana API](https://grafana.com/docs/http_api/). An output file is then generated with statistics on each job's performance and resulting output files.
+`kiosk-client` is tool for interacting with the [DeepCell Kiosk](https://github.com/vanvalenlab/kiosk-console) in order to create and monitor deep learning image processing jobs. It uses the asynchronous HTTP client [treq](https://github.com/twisted/treq) and the [Kiosk-Frontend API](https://github.com/vanvalenlab/kiosk-frontend) to create and monitor many jobs at once. Once all jobs are completed, [costs are estimated](./docs/cost_computation_notes.md) by using the cluster's [Grafana API](https://grafana.com/docs/http_api/). An output file is then generated with statistics on each job's performance and resulting output files.
 
 This repository is part of the [DeepCell Kiosk](https://github.com/vanvalenlab/kiosk-console). More information about the Kiosk project is available through [Read the Docs](https://deepcell-kiosk.readthedocs.io/en/master) and our [FAQ](http://www.deepcell.org/faq) page.
 
@@ -14,10 +14,10 @@ First, clone the git repository and install the required dependencies.
 
 ```bash
 # clone the repository
-git clone https://github.com/vanvalenlab/kiosk-benchmarking.git
+git clone https://github.com/vanvalenlab/kiosk-client.git
 
 # move into the new repository directory
-cd kiosk-benchmarking
+cd kiosk-client
 
 # install the requirements
 pip install -r requirements.txt
@@ -28,17 +28,17 @@ pip install -r requirements.txt
 The only thing necessary to use the CLI is the image file to process, the type of job, and the IP address or FQDN of the DeepCell Kiosk.
 
 ```bash
-# from within the kiosk-benchmarking repository
-python benchmarking path/to/image.png \
+# from within the kiosk-client repository
+python kiosk_client path/to/image.png \
   --job-type segmentation \
   --host 123.456.789.012
 ```
 
 It is also possible to override the default model and post-processing function for a given job type.
 
 ```bash
-# from within the kiosk-benchmarking repository
-python benchmarking path/to/image.png \
+# from within the kiosk-client repository
+python kiosk_client path/to/image.png \
   --job-type segmentation \
   --host 123.456.789.012 \
   --model ModelName:0 \
@@ -54,8 +54,8 @@ A new job is created every `START_DELAY` seconds up to `COUNT` jobs.
 The upload time can be simulated by changing the start delay.
 
 ```bash
-# from within the kiosk-benchmarking repository
-python benchmarking path/to/image.png \
+# from within the kiosk-client repository
+python kiosk_client path/to/image.png \
   --job-type segmentation \
   --host 123.456.789.012 \
   --model ModelName:0 \
@@ -74,9 +74,9 @@ Each job can be configured using environmental variables in a `.env` file. Most
 
 | Name | Description | Default Value |
 | :--- | :--- | :--- |
-| `API_HOST` | **REQUIRED**: Hostname and port for the *kiosk-frontend* API server. | `""` |
-| `STORAGE_BUCKET` | **REQUIRED**: Cloud storage bucket address (e.g. `"gs://bucket-name"`). | `""` |
 | `JOB_TYPE` | **REQUIRED**: Name of job workflow. | `"segmentation"` |
+| `API_HOST` | **REQUIRED**: Hostname and port for the *kiosk-frontend* API server. | `""` |
+| `STORAGE_BUCKET` | Cloud storage bucket address (e.g. `"gs://bucket-name"`). Required if using `benchmark` mode and `upload-results`. | `""` |
 | `MODEL` | Name and version of the model hosted by TensorFlow Serving (e.g. `"modelname:0"`). Overrides default model for the given `JOB_TYPE` | `"modelname:0"` |
 | `SCALE` | Rescale data by this float value for model compatibility. | `1` |
 | `LABEL` | Integer value of label type. | `""` |

bin/entrypoint.sh

@@ -2,7 +2,7 @@
 
 for (( i=0; i<${NUM_CYCLES}; i++ ))
 do
-  python -m benchmarking \
+  python -m kiosk_client \
     $FILE \
     --job-type=$JOB_TYPE \
     --host=$API_HOST \

benchmarking/__init__.py → kiosk_client/__init__.py

@@ -7,7 +7,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.github.com/vanvalenlab/kiosk-benchmarking/LICENSE
+#     http://www.github.com/vanvalenlab/kiosk-client/LICENSE
 #
 # The Work provided may be used for non-commercial academic purposes only.
 # For any other use of the Work, including commercial use, please contact:
@@ -27,10 +27,10 @@
 from __future__ import division
 from __future__ import print_function
 
-from benchmarking import cost
-from benchmarking import job
-from benchmarking import manager
-from benchmarking import utils
+from kiosk_client import cost
+from kiosk_client import job
+from kiosk_client import manager
+from kiosk_client import utils
 
 del absolute_import
 del division

benchmarking/__main__.py → kiosk_client/__main__.py

@@ -7,7 +7,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.github.com/vanvalenlab/kiosk-benchmarking/LICENSE
+#     http://www.github.com/vanvalenlab/kiosk-client/LICENSE
 #
 # The Work provided may be used for non-commercial academic purposes only.
 # For any other use of the Work, including commercial use, please contact:
@@ -36,8 +36,8 @@
 
 from twisted.internet import reactor
 
-from benchmarking import manager
-from benchmarking import settings
+from kiosk_client import manager
+from kiosk_client import settings
 
 
 def valid_filepath(parser, arg):
@@ -54,7 +54,7 @@ def valid_filepath(parser, arg):
 
 def get_arg_parser():
     parser = argparse.ArgumentParser(
-        prog='kioskcli',
+        prog='kioskclient',
         description='The Kicsk-CLI is a Command Line Interface (CLI) for '
                     'interacting with the DeepCell Kiosk.'
     )

benchmarking/cost.py → kiosk_client/cost.py

@@ -7,7 +7,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.github.com/vanvalenlab/kiosk-benchmarking/LICENSE
+#     http://www.github.com/vanvalenlab/kiosk-client/LICENSE
 #
 # The Work provided may be used for non-commercial academic purposes only.
 # For any other use of the Work, including commercial use, please contact:
@@ -34,7 +34,7 @@
 
 import requests
 
-from benchmarking import settings
+from kiosk_client import settings
 
 
 # defining Google Cloud prices

benchmarking/cost_test.py → kiosk_client/cost_test.py

@@ -7,7 +7,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.github.com/vanvalenlab/kiosk-benchmarking/LICENSE
+#     http://www.github.com/vanvalenlab/kiosk-client/LICENSE
 #
 # The Work provided may be used for non-commercial academic purposes only.
 # For any other use of the Work, including commercial use, please contact:
@@ -34,7 +34,7 @@
 import pytest
 import requests.exceptions
 
-from benchmarking import cost
+from kiosk_client import cost
 
 
 class FakeCreationData:

benchmarking/job.py → kiosk_client/job.py

@@ -7,7 +7,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.github.com/vanvalenlab/kiosk-benchmarking/LICENSE
+#     http://www.github.com/vanvalenlab/kiosk-client/LICENSE
 #
 # The Work provided may be used for non-commercial academic purposes only.
 # For any other use of the Work, including commercial use, please contact:
@@ -38,7 +38,7 @@
 from twisted.internet import error as twisted_errors
 from twisted.web import _newclient as twisted_client
 
-from benchmarking.utils import sleep, strip_bucket_prefix
+from kiosk_client.utils import sleep, strip_bucket_prefix
 
 
 class Job(object):

benchmarking/job_test.py → kiosk_client/job_test.py

@@ -7,7 +7,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.github.com/vanvalenlab/kiosk-benchmarking/LICENSE
+#     http://www.github.com/vanvalenlab/kiosk-client/LICENSE
 #
 # The Work provided may be used for non-commercial academic purposes only.
 # For any other use of the Work, including commercial use, please contact:
@@ -37,7 +37,7 @@
 
 from twisted.internet import defer
 
-from benchmarking import job
+from kiosk_client import job
 
 global FAILED
 FAILED = False  # global toggle for failed responses

benchmarking/manager.py → kiosk_client/manager.py

@@ -7,7 +7,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.github.com/vanvalenlab/kiosk-benchmarking/LICENSE
+#     http://www.github.com/vanvalenlab/kiosk-client/LICENSE
 #
 # The Work provided may be used for non-commercial academic purposes only.
 # For any other use of the Work, including commercial use, please contact:
@@ -38,11 +38,11 @@
 from twisted.internet import defer, reactor
 from twisted.web.client import HTTPConnectionPool
 
-from benchmarking.job import Job
-from benchmarking.utils import iter_image_files, sleep, strip_bucket_prefix
-from benchmarking import settings
+from kiosk_client.job import Job
+from kiosk_client.utils import iter_image_files, sleep, strip_bucket_prefix
+from kiosk_client import settings
 
-from benchmarking.cost import CostGetter
+from kiosk_client.cost import CostGetter
 
 
 class JobManager(object):

benchmarking/manager_test.py → kiosk_client/manager_test.py

@@ -7,7 +7,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.github.com/vanvalenlab/kiosk-benchmarking/LICENSE
+#     http://www.github.com/vanvalenlab/kiosk-client/LICENSE
 #
 # The Work provided may be used for non-commercial academic purposes only.
 # For any other use of the Work, including commercial use, please contact:
@@ -37,8 +37,8 @@
 import pytest
 import pytest_twisted
 
-from benchmarking import manager
-from benchmarking import settings
+from kiosk_client import manager
+from kiosk_client import settings
 
 
 class TestJobManager(object):

benchmarking/settings.py → kiosk_client/settings.py

@@ -7,7 +7,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.github.com/vanvalenlab/kiosk-benchmarking/LICENSE
+#     http://www.github.com/vanvalenlab/kiosk-client/LICENSE
 #
 # The Work provided may be used for non-commercial academic purposes only.
 # For any other use of the Work, including commercial use, please contact:

benchmarking/utils.py → kiosk_client/utils.py

@@ -7,7 +7,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.github.com/vanvalenlab/kiosk-benchmarking/LICENSE
+#     http://www.github.com/vanvalenlab/kiosk-client/LICENSE
 #
 # The Work provided may be used for non-commercial academic purposes only.
 # For any other use of the Work, including commercial use, please contact:

benchmarking/utils_test.py → kiosk_client/utils_test.py

@@ -7,7 +7,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.github.com/vanvalenlab/kiosk-benchmarking/LICENSE
+#     http://www.github.com/vanvalenlab/kiosk-client/LICENSE
 #
 # The Work provided may be used for non-commercial academic purposes only.
 # For any other use of the Work, including commercial use, please contact:
@@ -36,7 +36,7 @@
 from PIL import Image
 import pytest
 
-from benchmarking import utils
+from kiosk_client import utils
 
 
 class TestUtils(object):

setup.py

@@ -7,7 +7,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.github.com/vanvalenlab/kiosk-benchmarking/LICENSE
+#     http://www.github.com/vanvalenlab/kiosk-client/LICENSE
 #
 # The Work provided may be used for non-commercial academic purposes only.
 # For any other use of the Work, including commercial use, please contact:
@@ -26,14 +26,14 @@
 from setuptools import setup
 from setuptools import find_packages
 
-setup(name='Kiosk_Benchmarking',
+setup(name='Kiosk_Client',
       version='0.4.0',
-      description='Benchmarking utility for the DeepCell Kiosk.',
+      description='ClI client for the DeepCell Kiosk.',
       author='Van Valen Lab',
       author_email='vanvalenlab@gmail.com',
-      url='https://github.com/vanvalenlab/kiosk-benchmarking',
+      url='https://github.com/vanvalenlab/kiosk-client',
       download_url='https://github.com/vanvalenlab/'
-                   'kiosk-benchmarking/tarball/0.4.0',
+                   'kiosk-client/tarball/0.4.0',
       license='LICENSE',
       install_requires=['boto3',
                         'google-cloud-storage',