Skip to content

Commit 840d30e

Browse files
Tweak help docs
1 parent 1eb3c4f commit 840d30e

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

docs/ml_get_event_certainty.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Gets the latest certainty value for an ML action.
66
ml.getCertainty(ml.event.Unknown)
77
```
88

9-
The ML model runs several times a second and calculates a certainty value for each action. The estimated action is the action with the highest certainty (an action is not considered when its certainty is below the recognition point). Some programs may want to access the certainty values directly, for example to display or log them. Most programs can use the estimated action instead of certainty values.
9+
The ML model runs several times a second and calculates a certainty value for each action. The estimated action is the action with the highest certainty. An action cannot be the estimated action when its certainty is below the recognition point. Some programs may need to use the certainty values directly, for example to display or log them. Most programs can use the estimated action instead of certainty values.
1010

1111
## Parameters
1212

docs/ml_is_event_detected.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Checks if an ML action is the estimated action.
66
ml.isDetected(ml.event.Unknown)
77
```
88

9-
The ML model updates its estimated action several times a second. This block compares the latest value of the estimated value to the action you choose. Use the boolean value to make logical decisions in your program.
9+
The ML model updates its estimated action several times a second. This function compares the latest value of the estimated value to the action you choose. Use the boolean value to make logical decisions in your program.
1010

1111
Some programs will be easier to write using the “on ML start” and “on ML stop” event handlers instead.
1212

docs/ml_on_event_start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# on ML start
22

3-
Start an [event handler](/reference/event-handler) (part of the program that will run when something happens) This handler works when when the ML model’s estimated action changes to the action you select.
3+
Start an [event handler](/reference/event-handler) (part of the program that will run when something happens). This handler works when when the ML model’s estimated action changes to the action you select.
44

55
```sig
66
ml.onStart(ml.event.Unknown, function () {

docs/ml_on_event_stop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# on ML stop
22

3-
Start an [event handler](/reference/event-handler) (part of the program that will run when something happens) This handler works when when the ML model’s estimated action changes to the action you select.
3+
Start an [event handler](/reference/event-handler) (part of the program that will run when something happens). This handler works when when the ML model’s estimated action changes to the action you select.
44

55
```sig
66
ml.onStop(ml.event.Unknown, function () {

docs/ml_on_event_stop_detailed.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# on ML stop
22

3-
Start an [event handler](/reference/event-handler) (part of the program that will run when something happens) This handler works when when the ML model’s estimated action changes to the action you select.
3+
Start an [event handler](/reference/event-handler) (part of the program that will run when something happens). This handler works when when the ML model’s estimated action changes to the action you select.
44

55
```sig
66
ml.onStopDetailed(ml.event.Unknown, function (duration) {

0 commit comments

Comments
 (0)