From 74fa836938b95010386c81cb66501914165c2e30 Mon Sep 17 00:00:00 2001 From: John Bampton Date: Tue, 9 Mar 2021 22:38:01 +1000 Subject: [PATCH] chore: fix grammar and spelling --- CONTRIBUTING.md | 4 ++-- README.md | 6 +++--- core/python3AiActionLoop/samples/smart-body-crop/common.py | 6 +++--- gradle/README.md | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8f8faad..91185578 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,7 @@ # Contributing to Apache OpenWhisk -Anyone can contribute to the OpenWhisk project and we welcome your contributions. +Anyone can contribute to the OpenWhisk project, and we welcome your contributions. There are multiple ways to contribute: report bugs, improve the docs, and contribute code, but you must follow these prerequisites and guidelines: @@ -50,7 +50,7 @@ Please raise any bug reports or enhancement requests on the respective project r list to see if your issue has already been raised. A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong. -Provide as much context as possible so we can try to recreate the issue. +Provide as much context as possible, so we can try to recreate the issue. A good enhancement request comes with an explanation of what you are trying to do and how that enhancement would help you. diff --git a/README.md b/README.md index 3b99a0f3..b6c6a922 100644 --- a/README.md +++ b/README.md @@ -180,7 +180,7 @@ Create a json file called `python-data-init-params.json` which will contain the } } ``` -Also create a json file `python-data-run-params.json` which will contain the parameters to the function used to trigger it. Notice here we're creating 2 separate file from the beginning since this is good practice to make the distinction between what needs to be send via the `init` API and what needs to be sent via the `run` API: +Also create a json file `python-data-run-params.json` which will contain the parameters to the function used to trigger it. Notice here we're creating 2 separate file from the beginning since this is good practice to make the distinction between what needs to be sent via the `init` API and what needs to be sent via the `run` API: ```json { "value": { @@ -322,7 +322,7 @@ XXX_THE_END_OF_A_WHISK_ACTIVATION_XXX XXX_THE_END_OF_A_WHISK_ACTIVATION_XXX ``` -#### At this point you can edit python-fib-run.json an try other `fib_n` values. All you have to do is save `python-fib-run.json` and trigger the function again. Notice that here we're just modifying the parameters of our function; therefore, there's no need to re-run/re-initialize our container that contains our Python runtime. +#### At this point you can edit python-fib-run.json and try other `fib_n` values. All you have to do is save `python-fib-run.json` and trigger the function again. Notice that here we're just modifying the parameters of our function; therefore, there's no need to re-run/re-initialize our container that contains our Python runtime. #### You can also automate most of this process through [docker actions](https://github.com/apache/openwhisk/tree/master/tools/actionProxy) by using `invoke.py` @@ -410,4 +410,4 @@ This action runtime enables developers to create AI Services with OpenWhisk. It Follow these steps to import the project into your IntelliJ IDE. - Import project as gradle project. -- Make sure working directory is root of the project/repo. +- Make sure the working directory is root of the project/repo. diff --git a/core/python3AiActionLoop/samples/smart-body-crop/common.py b/core/python3AiActionLoop/samples/smart-body-crop/common.py index 4c6ece12..9aa16ac2 100644 --- a/core/python3AiActionLoop/samples/smart-body-crop/common.py +++ b/core/python3AiActionLoop/samples/smart-body-crop/common.py @@ -84,7 +84,7 @@ class CocoPart(Enum): NMS_Threshold = 0.1 InterMinAbove_Threshold = 6 -Inter_Threashold = 0.1 +Inter_Threshold = 0.1 Min_Subset_Cnt = 4 Min_Subset_Score = 0.8 Max_Human = 96 @@ -162,7 +162,7 @@ def estimate_pose(heatMat, pafMat): # if two humans share a part (same part idx and coordinates), merge those humans if set(c1['uPartIdx']) & set(c2['uPartIdx']) != empty_set: is_merged = True - # extend human1 connectios with human2 connections + # extend human1 connections with human2 connections conns_by_human[h1].extend(conns_by_human[h2]) conns_by_human.pop(h2) # delete human2 break @@ -243,7 +243,7 @@ def get_score(x1, y1, x2, y2, pafMatX, pafMatY): pafYs[idx] = pafMatY[my][mx] local_scores = pafXs * vx + pafYs * vy - thidxs = local_scores > Inter_Threashold + thidxs = local_scores > Inter_Threshold return sum(local_scores * thidxs), sum(thidxs) diff --git a/gradle/README.md b/gradle/README.md index 14842f14..fc28d4d2 100644 --- a/gradle/README.md +++ b/gradle/README.md @@ -41,14 +41,14 @@ Project level options that can be used on `distDocker`: ### Test -To run tests one uses the `test` task. OpenWhisk consolidates tests into a single `tests` project. Hence the command to run all tests is `gradle :tests:test`. +To run tests one uses the `test` task. OpenWhisk consolidates tests into a single `tests` project. Hence, the command to run all tests is `gradle :tests:test`. It is possible to run specific tests using [Gradle testfilters](https://docs.gradle.org/current/userguide/java_plugin.html#test_filtering). For example `gradle :tests:test --tests "your.package.name.TestClass.evenMethodName"`. Wildcard `*` may be used anywhere. ## Build your own `build.gradle` In Gradle, most of the tasks we use are default tasks provided by plugins in Gradle. The [`scala` Plugin](https://docs.gradle.org/current/userguide/scala_plugin.html) for example includes tasks, that are needed to build Scala projects. Moreover, Gradle is aware of *Applications*. The [`application` Plugin](https://docs.gradle.org/current/userguide/application_plugin.html) provides tasks that are required to distribute a self-contained application. When `application` and `scala` are used in conjunction, they hook into each other and provide the tasks needed to distribute a Scala application. `distTar` for example compiles the Scala code, creates a jar containing the compiled classes and resources and creates a Tarball including that jar and all of its dependencies (defined in the dependencies section of `build.gradle`). It also creates a start-script which correctly sets the classpath for all those dependencies and starts the app. -In OpenWhisk, we want to distribute our application via Docker images. Hence we wrote a "plugin" that creates the task `distDocker`. That task will build an image from the `Dockerfile` that is located next to the `build.gradle` it is called from, for example Controller's `Dockerfile` and `build.gradle` are both located at `core/controller`. +In OpenWhisk, we want to distribute our application via Docker images. Hence, we wrote a "plugin" that creates the task `distDocker`. That task will build an image from the `Dockerfile` that is located next to the `build.gradle` it is called from, for example Controller's `Dockerfile` and `build.gradle` are both located at `core/controller`. If you want to create a new `build.gradle` for your component, simply put the `Dockerfile` right next to it and include `docker.gradle` by using