Merge pull request #1147 from roboflow/feature/batch-processing-api

Add Swagger for Batch Processing and Data Staging services

Author: PawelPeczek-Roboflow

docs/workflows/batch_processing/about.md

@@ -60,6 +60,17 @@ By installing `inference-cli` you gain access to the `inference rf-cloud` comman
 managed components of the Roboflow Platform — including `batch-processing` and `data-staging`, the core components of 
 the Roboflow Batch Processing offering.
 
+!!! hint "Inference CLI setup"
+
+    To follow the tutorial you must install `inference-cli` and export your Roboflow API key.
+
+    ```bash
+    pip install inference-cli
+    export ROBOFLOW_API_KEY="YOUR-API-KEY-GOES-HERE"
+    ```
+    
+    If you struggle to find the API key, check our [guide](https://docs.roboflow.com/api-reference/authentication). 
+
 The typical flow of interaction with the CLI is as follows:
 
 First, ingest data into the platform. For images, use the following command:
@@ -89,20 +100,32 @@ Once the data is ingested - you can trigger batch job.
 For images, use the following command:
 
 ```bash
-inference rf-cloud batch-processing process-images-with-workflow --workflow-id <workflow-id> --batch-id <batch-id>
+inference rf-cloud batch-processing process-images-with-workflow \
+  --workflow-id <workflow-id> \
+  --batch-id <batch-id> \
+  --machine-type gpu
 ```
 
 For videos:
 
 ```bash
-inference rf-cloud batch-processing process-videos-with-workflow --workflow-id <workflow-id> --batch-id <batch-id>
+inference rf-cloud batch-processing process-videos-with-workflow \
+  --workflow-id <workflow-id> \
+  --batch-id <batch-id> \
+  --machine-type gpu \
+  --max-video-fps <your-desired-fps>
 ```
 
 !!! hint "How would I know `<workflow-id>`?"
 
     Workflow ID can be found in Roboflow App - open Workflow Editor of selected Workflow, hit "Deploy" button 
     and find identifier in code snippet.
 
+!!! hint "GPU vs CPU"
+
+    By default, processing run on CPU device, but if you require extra compute power - use `--machine-type gpu` 
+    option of the above commands.
+
 Command will **display the ID of the job**, which can be used to check the job status: 
 
 ```bash
@@ -176,7 +199,7 @@ potential costs.
 * Certain Workflow blocks requiring access to env variables and local storage (like File Sink and Environment 
 Secret Store) are blacklisted and will not execute.
 
-* Service only works with Workflows that define **singe** input image parameter.
+* Service only works with Workflows that define **single** input image parameter.
 
 
 ## Technical Details of Batch Processing
@@ -191,7 +214,7 @@ for processing (each batch is processed by a single job).
 output batch that you can retrieve later. We **advise** using `export` stage outputs, as they are optimized for 
 network transfer (content is compressed / packed into an archive).
 
-* A running job in the  `processing` tage can be aborted using both the UI and CLI.
+* A running job in the  `processing` stage can be aborted using both the UI and CLI.
 
 * An aborted or failed job can be restarted using the mentioned tools.
 

docs/workflows/batch_processing/api_reference.md

@@ -0,0 +1,6 @@
+Below you can find API reference for **Data Staging** and **Batch Processing** services. Specifications can
+be used to build API integrations.
+
+<swagger-ui src="./batch_processing_swagger.json"/>
+
+<swagger-ui src="./data_staging_swagger.json"/>