Docs review (#26)

* fix: removing accounting/entitlements route references after being deleted

* feat: refactor of jobs methods

Author: raul-casallas

CONTRIBUTING.adoc

@@ -138,8 +138,6 @@ Run tests:
 
 - `$ py.test`
 
-//validate this one with Raúl.
-
 Or specify the test that you want to run:
 
 - `$ py.test tests.test_client`

README.md

@@ -61,7 +61,7 @@ The code below is applicable for `text/plain` input type.
 Submit a job providing the model, version, and input file:
 
 ```python
-job = client.jobs.submit_files('ed542963de', '0.0.27', {'input.txt': './some-file.txt'})
+job = client.jobs.submit_file('ed542963de', '0.0.27', {'input.txt': './some-file.txt'})
 ```
 
 Hold until the inference is complete and results become available:
@@ -149,14 +149,10 @@ Currently we support the following API routes:
 |Update processing engines|client.models.update_processing_engines()|[api/resource/models](https://models.modzy.com/docs/management/processing/set-processing)|
 |Get minimum engines|client.models.get_minimum_engines()|[api/models/processing-engines](https://models.modzy.com/docs/management/processing/get-minimum-engines)|
 |List tags|client.tags.get_all()|[api/models/tags](https://models.modzy.com/docs/marketplace/tags/retrieve-tags)|
-|Submit a Job (Single Text)|client.jobs.submit_text()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-text)|
-|Submit a Job (Multiple Text)|client.jobs.submit_text_bulk()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-text)|
-|Submit a Job (Single Embedded)|client.jobs.submit_bytes()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-embedded)|
-|Submit a Job (Multiple Embedded)|client.jobs.submit_bytes_bulk()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-embedded)|
-|Submit a Job (Single File)|client.jobs.submit_files()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-aws)|
-|Submit a Job (Multiple Files)|client.jobs.submit_files_bulk()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-aws)|
-|Submit a Job (Single AWS S3)|client.jobs.submit_aws_s3()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-aws)|
-|Submit a Job (Multiple AWS S3)|client.jobs.submit_aws_s3_bulk()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-aws)|
+|Submit a Job (Text)|client.jobs.submit_text()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-text)|
+|Submit a Job (Embedded)|client.jobs.submit_embedded()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-embedded)|
+|Submit a Job (File)|client.jobs.submit_file()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-aws)|
+|Submit a Job (AWS S3)|client.jobs.submit_aws_s3()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-aws)|
 |Submit a Job (JDBC)|client.jobs.submit_jdbc()|[api/jobs](https://models.modzy.com/docs/jobs/jobs/submit-job-jdbc)|
 |Cancel job|job.cancel()|[api/jobs/:job-id](https://models.modzy.com/docs/jobs/jobs/cancel-pending-job)  |
 |Hold until inference is complete|job.block_until_complete()|[api/jobs/:job-id](https://models.modzy.com/docs/jobs/jobs/retrieve-job-details)  |

modzy/_util.py

@@ -65,3 +65,9 @@ def file_to_chunks(file_like, chunk_size):
 def bytes_to_chunks(byte_array, chunk_size):
     for i in range(0, len(byte_array), chunk_size):
         yield byte_array[i:i + chunk_size]
+
+
+def depth(d):
+    if d and isinstance(d, dict):
+        return max(depth(v) for k, v in d.items()) + 1
+    return 0

modzy/jobs.py

@@ -9,7 +9,7 @@
 sys.path.insert(0, '..')
 from modzy import ApiClient
 
- 
+
 # Always configure the logger level (ie: DEBUG, INFO, WARNING, ERROR, CRITICAL)
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
@@ -87,7 +87,7 @@
 # If you send a correct input key, but a wrong AWS S3 value key, the model fails to process the input.
 sources["wrong-value"] = {"image": {'bucket': BUCKET_NAME, 'key': "wrong-aws-file-key.png"}}
 # When you have all your inputs ready, you can use our helper method to submit the job as follows:
-job = client.jobs.submit_aws_s3_bulk(model.modelId, modelVersion.version, sources, ACCESS_KEY, SECRET_ACCESS_KEY, "us-west-2")
+job = client.jobs.submit_aws_s3(model.modelId, modelVersion.version, sources, ACCESS_KEY, SECRET_ACCESS_KEY, "us-west-2")
 # Modzy creates the job and queue for processing. The job object contains all the info that you need to keep track
 # of the process, the most important being the job identifier and the job status.
 logger.info("job: %s", job)

samples/job_with_aws_input_sample.py

@@ -83,7 +83,7 @@
 # If you send a correct input key but some wrong values, the model fails too.
 sources["wrong-value"] = {"input": config_bytes, "config.json":image_bytes}
 # When you have all your inputs ready, you can use our helper method to submit the job as follows:
-job = client.jobs.submit_bytes_bulk(model.modelId, modelVersion.version, sources)
+job = client.jobs.submit_embedded(model.modelId, modelVersion.version, sources)
 # Modzy creates the job and queue for processing. The job object contains all the info that you need to keep track
 # of the process, the most important being the job identifier and the job status.
 logger.info("job: %s", job)

samples/job_with_embedded_input_sample.py

@@ -84,7 +84,7 @@
 # If you send a correct input key but some wrong values, the model fails too.
 sources["wrong-value"] = {"input": config_bytes, "config.json":image_bytes}
 # When you have all your inputs ready, you can use our helper method to submit the job as follows:
-job = client.jobs.submit_files_bulk(model.modelId, modelVersion.version, sources)
+job = client.jobs.submit_file(model.modelId, modelVersion.version, sources)
 # Modzy creates the job and queue for processing. The job object contains all the info that you need to keep track
 # of the process, the most important being the job identifier and the job status.
 logger.info("job: %s", job)

samples/job_with_file_input_sample.py

@@ -73,7 +73,7 @@
 # If you send a wrong input key, the model fails to process the input.
 sources["wrong-key"] = {"a.wrong.key": "This input is wrong!"}
 # When you have all your inputs ready, you can use our helper method to submit the job as follows:
-job = client.jobs.submit_text_bulk(model.modelId, modelVersion.version, sources)
+job = client.jobs.submit_text(model.modelId, modelVersion.version, sources)
 # Modzy creates the job and queue for processing. The job object contains all the info that you need to keep track
 # of the process, the most important being the job identifier and the job status.
 logger.info("job: %s", job)

samples/job_with_text_input_sample.py

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.5.5
+current_version = 0.5.6
 commit = True
 tag = True
 

setup.cfg

@@ -40,6 +40,6 @@
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/modzy/sdk-python',
-    version='0.5.5',
+    version='0.5.6',
     zip_safe=False,
 )