Add a section of how to link IE with CMake project (#99)
[platform/upstream/dldt.git] / inference-engine / ie_bridges / python / sample / greengrass_samples / README.md
1 # This README demonstrates use of all GreenGrass samples
2  
3 # GreenGrass Classification Sample
4
5 This topic demonstrates how to build and run the GreenGrass Image Classification sample application, which does inference using image classification networks like AlexNet and GoogLeNet on on Intel® Processors, Intel® HD Graphics and Intel® FPGA.
6
7 ## Running
8
9 1. Modify the "accelerator" parameter inside the sample to deploy the sample on any accelerator option of your choice(CPU/GPU/FPGA)  
10    For CPU, please specify "CPU"  
11    For GPU, please specify "GPU"  
12    For FPGA, please specify "HETERO:FPGA,CPU"  
13 2. Enable the option(s) on how output is displayed/consumed 
14 3. Now follow the instructions listed in the Greengrass-FaaS-User-Guide.pdf to create the lambda and deploy on edge device using Greengrass
15  
16 ### Outputs
17
18 The application publishes top-10 results on AWS IoT Cloud every second by default. For other output consumption options, please refer to Greengrass-FaaS-User-Guide.pdf
19
20 ### How it works
21
22 Upon deployment,the sample application loads a network and an image to the Inference Engine plugin. When inference is done, the application publishes results to AWS IoT Cloud 
23
24 =====================================================================================================
25
26 # GreenGrass Object Detection Sample SSD
27
28 This topic demonstrates how to run the GreenGrass Object Detection SSD sample application, which does inference using object detection networks like Squeezenet-SSD on Intel® Processors, Intel® HD Graphics and Intel® FPGA.
29
30 ## Running
31
32 1. Modify the "accelerator" parameter inside the sample to deploy the sample on any accelerator option of your choice(CPU/GPU/FPGA)  
33    For CPU, please specify "CPU"  
34    For GPU, please specify "GPU"  
35    For FPGA, please specify "HETERO:FPGA,CPU"  
36 2. Enable the option(s) on how output is displayed/consumed 
37 3. Set the variable is_async_mode to 'True' for Asynchronous execution and 'False' for Synchronous execution
38 3. Now follow the instructions listed in the Greengrass-FaaS-User-Guide.pdf to create the lambda and deploy on edge device using Greengrass
39  
40 ### Outputs
41
42 The application publishes detection outputs such as class label, class confidence, and bounding box coordinates on AWS IoT Cloud every second. For other output consumption options, please refer to Greengrass-FaaS-User-Guide.pdf  
43
44 ### How it works
45
46 Upon deployment,the sample application loads a network and an image to the Inference Engine plugin. When inference is done, the application publishes results to AWS IoT Cloud 
47  
48
49