From 57db5fe4245d43a03aa1934d836ef24682b495f1 Mon Sep 17 00:00:00 2001 From: MCamp859 Date: Mon, 4 Feb 2019 11:34:30 -0500 Subject: [PATCH] Minor text edits for branding, punctuation, and TM symbol in title. Signed-off-by: MCamp859 --- source/clear-linux/tutorials/greengrass.rst | 102 +++++++++++--------- 1 file changed, 54 insertions(+), 48 deletions(-) diff --git a/source/clear-linux/tutorials/greengrass.rst b/source/clear-linux/tutorials/greengrass.rst index f0db1859..35bd05d5 100644 --- a/source/clear-linux/tutorials/greengrass.rst +++ b/source/clear-linux/tutorials/greengrass.rst @@ -1,40 +1,42 @@ .. _greengrass: -Enable AWS Greengrass* and OpenVINO™ on |CL-ATTR| -################################################# +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 -accelerators (CPU, 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 +Hardware accelerated Function-as-a-Service (FaaS) enables cloud developers to +deploy inference functionalities [1] on Intel® IoT edge devices with +accelerators (CPU, Integrated GPU, Intel® FPGA, and Intel® Movidius™ +technology). 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 edge devices with accelerators. -This tutorial will demonstrate how to: +This tutorial demonstrates 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 +* Install the OpenVINO™ toolkit and Amazon Web Services\* (AWS\*) + Greengrass\* software stacks +* Use AWS Greengrass\* and AWS Lambda\* to deploy the FaaS samples from the cloud Supported Platforms ******************* * Operating System: |CL| latest release -* Hardware: Intel® core platforms (Tutorial supports inference on CPU only) +* Hardware: Intel® core platforms (This tutorial supports inference on CPU only.) Description of Samples ********************** -The AWS Greengrass samples are located at the `Edge-Analytics-FaaS`_. For this tutorial we will use the 1.0 version of the source code. +The AWS Greengrass samples are located at the `Edge-Analytics-FaaS`_. This +tutorial uses the 1.0 version of the source code. We provide the following AWS Greengrass samples: * `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* + networks such as AlexNet and GoogLeNet and publishes top-10 results on AWS\* IoT Cloud every second. * `greengrass_object_detection_sample_ssd.py`_ @@ -56,8 +58,8 @@ Create user accounts ==================== 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). +user in |CL| and create a user account for the Greengrass services to use (see +Greengrass user below). #. Create a new user and set a password for that user. Enter the following commands as ``root``: @@ -82,9 +84,8 @@ services to use (see Greengrass user below). .. 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. + By default, |CL| does not create an :file:`/etc/fstab` file. + You must create this file before the Greengrass service runs. Add required bundles ==================== @@ -100,7 +101,7 @@ for the OpenVINO software stack: Learn more about how to :ref:`swupd-guide`. -The ``computer-vision-basic`` bundle will install the OpenVINO software, +The ``computer-vision-basic`` bundle installs the OpenVINO™ toolkit, along with the edge device models needed. Converting Deep Learning Models @@ -109,8 +110,8 @@ Converting Deep Learning Models Locate Sample Models -------------------- -There are two types of provided models that can be used in conjunction with AWS Greengrass -for this tutorial: classification or object detection. +There are two types of provided models that can be used in conjunction with +AWS Greengrass for this tutorial: classification or object detection. To complete this tutorial using an image classification model, download the BVLC Alexnet model files `bvlc_alexnet.caffemodel`_ and `deploy.prototxt`_ @@ -126,7 +127,7 @@ with the Greengrass object detection sample. Running Model Optimizer ----------------------- -Follow these instructions for `converting deep learning models to Intermediate Representation using Model Optimizer`_. To optimize either of the afformentioned sample models, run one of the following commands. +Follow these instructions for `converting deep learning models to Intermediate Representation using Model Optimizer`_. To optimize either of the sample models described above, run one of the following commands. For classification using BVLC Alexnet model: @@ -148,31 +149,31 @@ For object detection using SqueezeNetSSD-5Class model: In these examples: -* ```` is :file:`/usr/share/openvino/models` +* ```` is :file:`/usr/share/openvino/models`. * ```` 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 Intermediate Representation + (IR) is stored. 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 + entire input shape must be provided as an argument to the model + optimizer. For example, to use batch size 1, you must provide “--input_shape [1,3,227,227]”. Configuring an AWS Greengrass group =================================== -For each Intel® edge platform, we need to create a new AWS Greengrass group +For each Intel® edge platform, you must 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`_ + `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`_. In @@ -181,7 +182,7 @@ cloud and edge. .. note:: - You will not need to run the ``cgroupfs-mount.sh`` script in step #6 + You do 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|. @@ -196,7 +197,7 @@ cloud and edge. Creating and Packaging Lambda Functions ======================================= -#. Complete steps 1-4 of the tutorial at `Create and Package Lambda Function`_ . +#. Complete steps 1-4 of the tutorial at `Create and Package Lambda Function`_. .. note:: @@ -282,20 +283,20 @@ configuring the lambda function for AWS Greengrass. (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`_ + lambda function by following the steps 10-14 in `Configure the Lambda Function`_. .. note:: The “Optional topic filter” field should be the topic mentioned inside the lambda function. - For example, openvino/ssd or openvino/classification + For example: openvino/ssd or openvino/classification Local Resources --------------- #. Select `this link to add local resources and access privileges`_. - Following are the local resources needed for the CPU: + The following table describes the local resources needed for the CPU: .. list-table:: **Local Resources** :widths: 20, 20, 20, 20 @@ -336,37 +337,42 @@ 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 + variable ``enable_iot_cloud_output``. You 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 + using the subscription topic specified in the lambda. (For example, topics + may include ‘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`_ + 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 + processed data to the cloud. You must 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 - AWS Greengrass samples to store the JPEG images. The images are named using the timestamp and uploaded to S3. + 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. You must 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 - by ‘PARAM_OUTPUT_DIRECTORY’. + 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 -----------