From a3ea96283dfb102b98a6efcc02a4909e45af8b47 Mon Sep 17 00:00:00 2001 From: Beth Dean Date: Tue, 6 Nov 2018 09:36:04 -0800 Subject: [PATCH] updated incorrect bundle name --- source/clear-linux/tutorials/greengrass.rst | 244 ++++++++++---------- 1 file changed, 121 insertions(+), 123 deletions(-) diff --git a/source/clear-linux/tutorials/greengrass.rst b/source/clear-linux/tutorials/greengrass.rst index 315f0804..86120285 100644 --- a/source/clear-linux/tutorials/greengrass.rst +++ b/source/clear-linux/tutorials/greengrass.rst @@ -3,25 +3,25 @@ Enable AWS Greengrass* and OpenVINO™ on |CL-ATTR| ################################################# -Hardware accelerated Function-as-a-Service (FaaS) enables cloud developers -to deploy inference functionalities [1] on Intel® IoT edge devices with +Hardware accelerated Function-as-a-Service (FaaS) enables cloud developers +to deploy inference functionalities [1] on Intel® IoT edge devices with accelerators (Integrated GPU, Intel® FPGA, and Intel® Movidius™). These -functions provide a great developer experience and seamless migration of -visual analytics from cloud to edge in a secure manner using a containerized -environment. Hardware-accelerated FaaS provides the best-in-class -performance by accessing optimized deep learning libraries on Intel® IoT +functions provide a great developer experience and seamless migration of +visual analytics from cloud to edge in a secure manner using a containerized +environment. Hardware-accelerated FaaS provides the best-in-class +performance by accessing optimized deep learning libraries on Intel® IoT edge devices with accelerators. -This tutorial shows how to: +This tutorial shows how to: * Set up the Intel® edge device with |CL-ATTR| * Install the OpenVINO™ and AWS Greengrass* software stacks -* Use AWS Greengrass and lambdas to deploy the FaaS samples from the cloud +* Use AWS Greengrass and lambdas to deploy the FaaS samples from the cloud Supported Platforms ******************* -* Operating System: |CL-ATTR| latest release +* Operating System: |CL-ATTR| latest release * Hardware: Intel® core platforms (Tutorial supports inference on CPU only) Description of Samples @@ -32,7 +32,7 @@ The AWS Greengrass samples are located at the `Edge-Analytics-FaaS`_. We provide the following AWS Greengrass samples: * :file:`greengrass_classification_sample.py` - + This AWS Greengrass sample classifies a video stream using classification networks such as AlexNet and GoogLeNet and publishes top-10 results on AWS* IoT Cloud every second. @@ -41,7 +41,7 @@ We provide the following AWS Greengrass samples: This AWS Greengrass sample detects objects in a video stream and classifies them using single-shot multi-box detection (SSD) networks such - as SSD Squeezenet, SSD Mobilenet, and SSD300. This sample publishes + as SSD Squeezenet, SSD Mobilenet, and SSD300. This sample publishes detection outputs such as class label, class confidence, and bounding box coordinates on AWS IoT Cloud every second. @@ -51,13 +51,13 @@ Converting Deep Learning Models Sample Models ============= -For classification, `download the BVLC Alexnet model`_ as an example. -Any custom pre-trained classification models can be used with the +For classification, `download the BVLC Alexnet model`_ as an example. +Any custom pre-trained classification models can be used with the classification sample. -For object detection, the sample models optimized for Intel® edge platforms -are present at :file:`/usr/share/openvino/models`. These models are provided -as an example; however, any custom pre-trained SSD models can be used with +For object detection, the sample models optimized for Intel® edge platforms +are present at :file:`/usr/share/openvino/models`. These models are provided +as an example; however, any custom pre-trained SSD models can be used with the object detection sample. Running Model Optimizer @@ -79,42 +79,42 @@ For object detection using SqueezeNetSSD-5Class model: .. code-block:: bash - python3 mo.py --framework caffe --input_model + python3 mo.py --framework caffe --input_model SqueezeNetSSD-5Class.caffemodel --input_proto - SqueezeNetSSD-5Class.prototxt + SqueezeNetSSD-5Class.prototxt --data_type --output_dir -In these examples: +In these examples: -* ```` is :file:`/usr/share/openvino/models` +* ```` is :file:`/usr/share/openvino/models` -* ```` is FP32 or FP16, depending on target device. +* ```` is FP32 or FP16, depending on target device. -* ```` is the directory where the user wants to store the - Intermediate Representation (IR). IR contains .xml format corresponding - to the network structure and .bin format corresponding to weights. This - .xml file should be passed to . +* ```` is the directory where the user wants to store the + Intermediate Representation (IR). IR contains .xml format corresponding + to the network structure and .bin format corresponding to weights. This + .xml file should be passed to . * In the BVLC Alexnet model, the prototxt defines the input shape with - batch size 10 by default. In order to use any other batch size, the - entire input shape needs to be provided as an argument to the model - optimizer. For example, to use batch size 1, you can provide + batch size 10 by default. In order to use any other batch size, the + entire input shape needs to be provided as an argument to the model + optimizer. For example, to use batch size 1, you can provide “--input_shape [1,3,227,227]”. Installing |CL| on the edge device ********************************** -Start with a clean installation of |CL| on a new system, using the +Start with a clean installation of |CL| on a new system, using the :ref:`bare-metal-install`, found in :ref:`get-started`. Create user accounts ==================== -After |CL| is installed, create two user accounts. Create an administrative +After |CL| is installed, create two user accounts. Create an administrative user in |CL|. You will also create a user account for the Greengrass -services to use (see Greengrass user below). +services to use (see Greengrass user below). -#. Create a new user and set a password for that user. Enter the following +#. Create a new user and set a password for that user. Enter the following commands as ``root``: .. code-block:: bash @@ -122,7 +122,7 @@ services to use (see Greengrass user below). useradd passwd -#. Next, enable the :command:`sudo` command for your new ````. Add +#. Next, enable the :command:`sudo` command for your new ````. Add ```` to the ``wheel`` group: .. code-block:: bash @@ -136,18 +136,18 @@ services to use (see Greengrass user below). useradd ggc_user groupadd ggc_group -#. Create a :file:`/etc/fstab` file. +#. Create a :file:`/etc/fstab` file. .. code-block:: bash touch /etc/fstab - .. note:: - - By default |CL| does not create an :file:`/etc/fstab` file. - The Greengrass service needs to have the file created before + .. note:: + + By default |CL| does not create an :file:`/etc/fstab` file. + The Greengrass service needs to have the file created before it will run. - + Add required bundles ==================== @@ -156,67 +156,67 @@ enable the OpenVINO software stack: .. code-block:: bash - swupd bundle-add os-clr-on-clear desktop-autostart computer-vision-basic + swupd bundle-add os-clr-on-clr desktop-autostart computer-vision-basic .. note:: - Learn more about how to :ref:`swupd-guide`. + Learn more about how to :ref:`swupd-guide`. -The ``computer-vision-basic`` bundle will install the OpenVINO software, +The ``computer-vision-basic`` bundle will install the OpenVINO software, along with the edge device models needed. Configuring an AWS Greengrass group =================================== -For each Intel® edge platform, we need to create a new AWS Greengrass group -and install AWS Greengrass core software to establish the connection between +For each Intel® edge platform, we need to create a new AWS Greengrass group +and install AWS Greengrass core software to establish the connection between cloud and edge. #. To create an AWS Greengrass group, follow the `AWS Greengrass developer guide`_ - + #. To install and configure AWS Greengrass core on edge platform, follow - the instructions at `Start AWS Greengrass on the Core Device`_. + the instructions at `Start AWS Greengrass on the Core Device`_. .. note:: You will not need to run the ``cgroupfs-mount.sh`` script in step #6 - of Module 1 of the `AWS Greengrass developer guide`_ because this is - enabled already in |CL|. + of Module 1 of the `AWS Greengrass developer guide`_ because this is + enabled already in |CL|. Creating and Packaging Lambda Functions ======================================= -#. Complete the tutorial at `Configure AWS Greengrass on AWS IoT`_ . - - .. note:: +#. Complete the tutorial at `Configure AWS Greengrass on AWS IoT`_ . - This creates the tarball needed to create the AWS Greengrass - environment on the edge device. + .. note:: -#. Assure to download both the security resources and the AWS Greengrass - core software. + This creates the tarball needed to create the AWS Greengrass + environment on the edge device. - .. note:: +#. Assure to download both the security resources and the AWS Greengrass + core software. - Security certificates are linked to your AWS* account. + .. note:: -#. Replace greengrassHelloWorld.py with Greengrass samples: + Security certificates are linked to your AWS* account. + +#. Replace greengrassHelloWorld.py with Greengrass samples: * greengrass_classification_sample.py - * greengrass_object_detection_sample_ssd.py + * greengrass_object_detection_sample_ssd.py -#. Zip these files with extracted Greengrass SDK folders from the previous - step into :file:`greengrass_sample_python_lambda.zip`. +#. Zip these files with extracted Greengrass SDK folders from the previous + step into :file:`greengrass_sample_python_lambda.zip`. The zip should contain: - + * greengrasssdk - * greengrass sample - - For the sample, choose one of these: + * greengrass sample + + For the sample, choose one of these: - greengrass_classification_sample.py @@ -229,15 +229,15 @@ Creating and Packaging Lambda Functions zip -r greengrass_lambda.zip greengrasssdk greengrass_object_detection_sample_ssd.py -#. Follow steps 6-11 to `complete creating lambdas`_. - - .. note:: +#. Follow steps 6-11 to `complete creating lambdas`_. - In the AWS documentation, step 9(a), while uploading the zip file, - make sure to name the handler as below depending on the AWS Greengrass + .. note:: + + In the AWS documentation, step 9(a), while uploading the zip file, + make sure to name the handler as below depending on the AWS Greengrass sample you are using: - * greengrass_object_detection_sample_ssd.function_handler (or) + * greengrass_object_detection_sample_ssd.function_handler (or) * greengrass_classification_sample.function_handler Deploying Lambdas @@ -246,18 +246,18 @@ Deploying Lambdas Configuring the Lambda function ------------------------------- -After creating the Greengrass group and the lambda function, start -configuring the lambda function for AWS Greengrass. +After creating the Greengrass group and the lambda function, start +configuring the lambda function for AWS Greengrass. #. Follow steps 1-8 in `Configure the Lambda Function`_ of the AWS - documentation. + documentation. #. In addition to the details mentioned in step 8, change the Memory limit to 2048MB to accommodate large input video streams. #. Add the following environment variables as key-value pairs when editing the lambda configuration and click on update: - + .. list-table:: **Table 1. Environment Variables: Lambda Configuration** :widths: 20 80 :header-rows: 1 @@ -265,7 +265,7 @@ configuring the lambda function for AWS Greengrass. * - Key - Value * - PARAM_MODEL_XML - - /, where is user specified and + - /, where is user specified and contains IR.xml, the Intermediate Representation file from Intel® Model Optimizer * - PARAM_INPUT_SOURCE - /input.webm to be specified by user. Holds both input and @@ -281,19 +281,19 @@ configuring the lambda function for AWS Greengrass. - User specified for classification sample. (e.g. 1 for top-1 result, 5 for top-5 results) -#. Add subscription to subscribe, or publish messages from AWS Greengrass - lambda function by following the steps 10-14 in `Configure the Lambda Function`_ +#. Add subscription to subscribe, or publish messages from AWS Greengrass + lambda function by following the steps 10-14 in `Configure the Lambda Function`_ - .. note:: - - The “Optional topic filter” field should be the topic + .. note:: + + The “Optional topic filter” field should be the topic mentioned inside the lambda function. - + For example, openvino/ssd or openvino/classification Local Resources --------------- -#. Select `this link to add local resources and access privileges`_. +#. Select `this link to add local resources and access privileges`_. Following are the local resources needed for the CPU: @@ -301,71 +301,71 @@ Local Resources :widths: 20, 20, 20, 20 :header-rows: 1 - * - Name - - Resource type - - Local path + * - Name + - Resource type + - Local path - Access - - * - ModelDir - - Volume - - to be specified by user + + * - ModelDir + - Volume + - to be specified by user - Read-Only - * - Webcam - - Device + * - Webcam + - Device - /dev/video0 - Read-Only - * - DataDir - - Volume - - to be specified by user. Holds both input and output + * - DataDir + - Volume + - to be specified by user. Holds both input and output data. - Read and Write Deploy ------ -To `deploy the lambda function to AWS Greengrass core device`_, select -“Deployments” on group page and follow the instructions. +To `deploy the lambda function to AWS Greengrass core device`_, select +“Deployments” on group page and follow the instructions. Output Consumption ------------------ -There are four options available for output consumption. These options are -used to report, stream, upload, or store inference output at an interval +There are four options available for output consumption. These options are +used to report, stream, upload, or store inference output at an interval defined by the variable ``reporting_interval`` in the AWS Greengrass samples. a. IoT Cloud Output: - This option is enabled by default in the AWS Greengrass samples using a - variable ``enable_iot_cloud_output``. We can use it to verify the lambda - running on the edge device. It enables publishing messages to IoT cloud - using the subscription topic specified in the lambda (For example, - ‘openvino/classification’ for classification and ‘openvino/ssd’ for - object detection samples). For classification, top-1 result with class - label are published to IoT cloud. For SSD object detection, detection - results such as bounding box co-ordinates of objects, class label, and - class confidence are published. + This option is enabled by default in the AWS Greengrass samples using a + variable ``enable_iot_cloud_output``. We can use it to verify the lambda + running on the edge device. It enables publishing messages to IoT cloud + using the subscription topic specified in the lambda (For example, + ‘openvino/classification’ for classification and ‘openvino/ssd’ for + object detection samples). For classification, top-1 result with class + label are published to IoT cloud. For SSD object detection, detection + results such as bounding box co-ordinates of objects, class label, and + class confidence are published. Follow the instructions here to `view the output on IoT cloud`_ - + b. Kinesis Streaming: - - This option enables inference output to be streamed from the edge device - to cloud using Kinesis [3] streams when ‘enable_kinesis_output’ is set - to True. The edge devices act as data producers and continually push - processed data to the cloud. The users need to set up and specify - Kinesis stream name, Kinesis shard, and AWS region in the AWS Greengrass + + This option enables inference output to be streamed from the edge device + to cloud using Kinesis [3] streams when ‘enable_kinesis_output’ is set + to True. The edge devices act as data producers and continually push + processed data to the cloud. The users need to set up and specify + Kinesis stream name, Kinesis shard, and AWS region in the AWS Greengrass samples. c. Cloud Storage using AWS S3 Bucket: - - When the ‘enable_s3_jpeg_output’ variable is set to True, it enables uploading and storing processed frames (in JPEG format) in an AWS S3 bucket. The users need to set up and specify the S3 bucket name in the + + When the ‘enable_s3_jpeg_output’ variable is set to True, it enables uploading and storing processed frames (in JPEG format) in an AWS S3 bucket. The users need to set up and specify the S3 bucket name in the AWS Greengrass samples to store the JPEG images. The images are named using the timestamp and uploaded to S3. d. Local Storage: - - When the ‘enable_s3_jpeg_output’ variable is set to True, it enables storing processed frames (in JPEG format) on the edge device. The - images are named using the timestamp and stored in a directory specified + + When the ‘enable_s3_jpeg_output’ variable is set to True, it enables storing processed frames (in JPEG format) on the edge device. The + images are named using the timestamp and stored in a directory specified by ‘PARAM_OUTPUT_DIRECTORY’. References @@ -391,7 +391,7 @@ References .. _Configure the Lambda Function: https://docs.aws.amazon.com/greengrass/latest/developerguide/config-lambda.html -.. _Add local resources and access privileges: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html +.. _Add local resources and access privileges: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html .. _deploy the lambda function to AWS Greengrass core device: https://docs.aws.amazon.com/greengrass/latest/developerguide/configs-core.html @@ -402,5 +402,3 @@ References .. _this link to add local resources and access privileges: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html .. _Configure AWS Greengrass on AWS IoT: https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-config.html - -