Skip to content

Commit

Permalink
Tweak help docs
Browse files Browse the repository at this point in the history
  • Loading branch information
microbit-robert committed Dec 12, 2024
1 parent 1eb3c4f commit 840d30e
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/ml_get_event_certainty.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Gets the latest certainty value for an ML action.
ml.getCertainty(ml.event.Unknown)
```

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.
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.

## Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/ml_is_event_detected.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Checks if an ML action is the estimated action.
ml.isDetected(ml.event.Unknown)
```

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.
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.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/ml_on_event_start.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# on ML start

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.
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.

```sig
ml.onStart(ml.event.Unknown, function () {
Expand Down
2 changes: 1 addition & 1 deletion docs/ml_on_event_stop.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# on ML stop

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.
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.

```sig
ml.onStop(ml.event.Unknown, function () {
Expand Down
2 changes: 1 addition & 1 deletion docs/ml_on_event_stop_detailed.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# on ML stop

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.
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.

```sig
ml.onStopDetailed(ml.event.Unknown, function (duration) {
Expand Down

0 comments on commit 840d30e

Please sign in to comment.