Skip to content

Commit

Permalink
Add doc translations
Browse files Browse the repository at this point in the history
  • Loading branch information
microbit-grace committed Jan 2, 2025
1 parent 89ee488 commit 1d37aca
Show file tree
Hide file tree
Showing 37 changed files with 1,169 additions and 3 deletions.
8 changes: 6 additions & 2 deletions bin/update-translations.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,13 @@ for language in $languages; do
lower="${language,,}"
prefix="${1}/${language}"
cp "${prefix}/ui.en.json" "simx/lang/ui.${lower}.json"

mkdir -p "_locales/${language}"
cp "${prefix}/machine-learning-jsdoc-strings.json" "_locales/${language}/machine-learning-jsdoc-strings.json"
cp "${prefix}/machine-learning-strings.json" "_locales/${language}/machine-learning-strings.json"
cp "${prefix}/machine-learning-jsdoc-strings.json" "_locales/${language}"
cp "${prefix}/machine-learning-strings.json" "_locales/${language}"

mkdir -p "docs/_locales/${language}"
cp -r "${prefix}/docs/." "docs/_locales/${language}"
done

cd simx
Expand Down
32 changes: 32 additions & 0 deletions docs/_locales/es-ES/ml_get_event_certainty.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# al iniciarse el ML

Obtiene el último valor de certeza de una acción ML.

```sig
ml.getCertainty(ml.event.Unknown)
```

El modelo ML se ejecuta varias veces por segundo y calcula un valor de certeza para cada acción. La acción estimada es la acción con mayor certeza. Una acción no puede ser la acción estimada cuando su certeza está por debajo del punto de reconocimiento. Es posible que algunos programas necesiten utilizar directamente los valores de certeza, por ejemplo para visualizarlos o registrarlos. La mayoría de los programas pueden utilizar la acción estimada en lugar de los valores de certeza.

## Parámetros

- **evento**: una de las acciones en las que se ha entrenado el modelo de aprendizaje automático.

## Devuelve

- un porcentaje como [número](/types/number) de 0 a 100, que representa la certeza del modelo ML de que ésta es la acción que se está realizando. La certeza para "unknown" es siempre 0.

## Ejemplo

Este ejemplo muestra la certeza del modelo ML, en porcentaje, de que la acción actual es "aplaudiendo" cada segundo.

```blocks
loops.everyInterval(1000, function () {
basic.showNumber(ml.getCertainty(ml.event.Clapping))
})
```

```package
machine-learning-help-stubs=github:microbit-foundation/pxt-microbit-ml-help-stubs#v0.0.1
machine-learning=github:microbit-foundation/pxt-microbit-ml#v1.0.2
```
36 changes: 36 additions & 0 deletions docs/_locales/es-ES/ml_is_event_detected.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# is ML detected

Comprueba si una acción ML es la acción estimada.

```sig
ml.isDetected(ml.event.Unknown)
```

El modelo ML actualiza su acción estimada varias veces por segundo. Esta función devuelve "cierto" si la acción elegida está actualmente estimada. Utiliza el valor booleano para tomar decisiones lógicas en tu programa.

Algunos programas serán más fáciles de escribir utilizando los manejadores de eventos «on ML start» y «on ML stop» en su lugar.

## Parámetros

- **evento**: una de las acciones en las que se ha entrenado el modelo de aprendizaje automático. El valor especial `unknown` representa el caso en que ninguna acción tiene una certeza superior al punto de reconocimiento.

## Devuelve

- un valor [booleano](/types/boolean) que es `cierto` si la acción ML es la acción estimada, `falso` si la acción ML no es la acción estimada.

## Ejemplo

Este ejemplo mostrará un icono de tic en la pantalla LED si la acción estimada es `aplaudiendo` en el momento en que se comprueba la sentencia condicional.

```blocks
basic.forever(function () {
if (ml.isDetected(ml.event.Clapping)) {
basic.showIcon(IconNames.Yes)
}
})
```

```package
machine-learning-help-stubs=github:microbit-foundation/pxt-microbit-ml-help-stubs#v0.0.1
machine-learning=github:microbit-foundation/pxt-microbit-ml#v1.0.2
```
29 changes: 29 additions & 0 deletions docs/_locales/es-ES/ml_on_event_start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# on ML start

Inicia un [manejador de eventos](/reference/event-handler) (parte del programa que se ejecutará cuando algo suceda). Este manejador funciona cuando la acción estimada del modelo ML cambia a la acción que tú seleccionas.

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

El modelo ML actualiza su acción estimada varias veces por segundo, pero este controlador de eventos solo se ejecuta cuando cambia la acción estimada.

## Parámetros

- **evento**: una de las acciones en las que se ha entrenado el modelo de aprendizaje automático. El valor especial `unknown` representa el caso en que ninguna acción tiene una certeza superior al punto de reconocimiento.

## Ejemplo

Este ejemplo reproduce una melodía musical de fondo cuando la acción «aplaudir» tiene una certeza superior al punto de reconocimiento.

```blocks
ml.onStart(ml.event.Clapping, function () {
music._playDefaultBackground(music.builtInPlayableMelody(Melodies.Dadadadum), music.PlaybackMode.InBackground)
})
```

```package
machine-learning-help-stubs=github:microbit-foundation/pxt-microbit-ml-help-stubs#v0.0.1
machine-learning=github:microbit-foundation/pxt-microbit-ml#v1.0.2
```
31 changes: 31 additions & 0 deletions docs/_locales/es-ES/ml_on_event_stop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# al detenerse el ML

Inicia un [manejador de eventos](/reference/event-handler) (parte del programa que se ejecutará cuando algo suceda). Este controlador funciona cuando la acción estimada del modelo ML cambia respecto a la acción que seleccionaste.

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

Cuando cambie una acción, se ejecutará el controlador de eventos de parada de la acción anterior, seguido del controlador de eventos de inicio de la acción siguiente.

Por ejemplo, si el controlador de eventos de inicio de una acción inicia la reproducción de música en segundo plano, puedes utilizar un controlador de eventos de parada para detenerla.

## Parámetros

- **evento**: una de las acciones en las que se ha entrenado el modelo de aprendizaje automático. El valor especial `unknown` representa el caso en que ninguna acción tiene una certeza superior al punto de reconocimiento.

## Ejemplo

Este ejemplo detiene la reproducción de una melodía musical cuando la acción estimada cambia de «aplaudir» a cualquier otra acción.

```blocks
ml.onStop(ml.event.Clapping, function () {
music.stopMelody(MelodyStopOptions.All)
})
```

```package
machine-learning-help-stubs=github:microbit-foundation/pxt-microbit-ml-help-stubs#v0.0.1
machine-learning=github:microbit-foundation/pxt-microbit-ml#v1.0.2
```
33 changes: 33 additions & 0 deletions docs/_locales/es-ES/ml_on_event_stop_detailed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# al detenerse el ML

Inicia un [manejador de eventos](/reference/event-handler) (parte del programa que se ejecutará cuando algo suceda). Este controlador funciona cuando la acción estimada del modelo ML cambia respecto a la acción que seleccionaste.

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

Cuando cambie una acción, se ejecutará el controlador de eventos de parada de la acción anterior, seguido del controlador de eventos de inicio de la acción siguiente.

Por ejemplo, si el controlador de eventos de inicio de una acción inicia la reproducción de música en segundo plano, puedes utilizar un controlador de eventos de parada para detenerla.

Al controlador del evento se le pasa un parámetro de «duración». La duración es el [número](/types/number) de milisegundos desde que esta acción se convirtió en la acción estimada. Puedes utilizar el parámetro de duración en tu código; por ejemplo, mostrándolo o utilizando una variable para mantener un total actualizado.

## Parámetros

- **evento**: una de las acciones en las que se ha entrenado el modelo de aprendizaje automático. El valor especial `unknown` representa el caso en que ninguna acción tiene una certeza superior al punto de reconocimiento.

## Ejemplo

Este ejemplo muestra en la pantalla LED, en segundos, cuánto tiempo ha durado la acción estimada de «aplaudir», cuando la acción estimada cambia de «aplaudir» a cualquier otra acción.

```blocks
ml.onStopDetailed(ml.event.Clapping, function (duration) {
basic.showNumber(duration / 1000)
})
```

```package
machine-learning-help-stubs=github:microbit-foundation/pxt-microbit-ml-help-stubs#v0.0.1
machine-learning=github:microbit-foundation/pxt-microbit-ml#v1.0.2
```
32 changes: 32 additions & 0 deletions docs/_locales/ja/ml_get_event_certainty.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# MLが開始したとき

MLの動きの確実性の値を取得します。

```sig
ml.getCertainty(ml.event.Unknown)
```

MLモデルは1秒間に数回実行され、各アクションの確実性の値を算出します。 推定した動きは、最も高い確実性を持つ動きです。 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.

## パラメータ

- **event**: one of the actions the machine learning model was trained on.

## Returns

- a percentage as a [number](/types/number) from 0 to 100, representing the ML model’s certainty that this is the action being performed. The certainty for `unknown` is always 0.

##

This example displays the ML model's certainty, in percent, that the current action is `clapping` every second.

```blocks
loops.everyInterval(1000, function () {
basic.showNumber(ml.getCertainty(ml.event.Clapping))
})
```

```package
machine-learning-help-stubs=github:microbit-foundation/pxt-microbit-ml-help-stubs#v0.0.1
machine-learning=github:microbit-foundation/pxt-microbit-ml#v1.0.2
```
36 changes: 36 additions & 0 deletions docs/_locales/ja/ml_is_event_detected.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# is ML detected

Checks if an ML action is the estimated action.

```sig
ml.isDetected(ml.event.Unknown)
```

The ML model updates its estimated action several times a second. This function returns `true` if the chosen action is currently estimated. 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.

## パラメータ

- **event**: one of the actions the machine learning model was trained on. The special value `unknown` represents the case where no action has a certainty above the recognition point.

## Returns

- a [boolean](/types/boolean) value that is `true` if the ML action is the estimated action, `false` if the ML action is not the estimated action.

##

This example will show a tick icon on the LED display if the estimated action is `clapping` at the time the conditional statement is checked.

```blocks
basic.forever(function () {
if (ml.isDetected(ml.event.Clapping)) {
basic.showIcon(IconNames.Yes)
}
})
```

```package
machine-learning-help-stubs=github:microbit-foundation/pxt-microbit-ml-help-stubs#v0.0.1
machine-learning=github:microbit-foundation/pxt-microbit-ml#v1.0.2
```
29 changes: 29 additions & 0 deletions docs/_locales/ja/ml_on_event_start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# MLが開始したとき

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

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

The ML model updates its estimated action several times a second, but this event handler only runs when the estimated action changes.

## パラメータ

- **event**: one of the actions the machine learning model was trained on. The special value `unknown` represents the case where no action has a certainty above the recognition point.

##

This example plays a musical melody in the background when the action `clapping` has a certainty above the recognition point.

```blocks
ml.onStart(ml.event.Clapping, function () {
music._playDefaultBackground(music.builtInPlayableMelody(Melodies.Dadadadum), music.PlaybackMode.InBackground)
})
```

```package
machine-learning-help-stubs=github:microbit-foundation/pxt-microbit-ml-help-stubs#v0.0.1
machine-learning=github:microbit-foundation/pxt-microbit-ml#v1.0.2
```
31 changes: 31 additions & 0 deletions docs/_locales/ja/ml_on_event_stop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# on ML stop

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

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

When an action changes, the stop event handler for the previous action will run, followed by the start event handler for the next action.

For example, if your start event handler for an action starts music playing in the background, you could use a stop event handler to stop it.

## パラメータ

- **event**: one of the actions the machine learning model was trained on. The special value `unknown` represents the case where no action has a certainty above the recognition point.

##

This example stops playing a musical melody when the estimated action changes from `clapping` to any other action.

```blocks
ml.onStop(ml.event.Clapping, function () {
music.stopMelody(MelodyStopOptions.All)
})
```

```package
machine-learning-help-stubs=github:microbit-foundation/pxt-microbit-ml-help-stubs#v0.0.1
machine-learning=github:microbit-foundation/pxt-microbit-ml#v1.0.2
```
33 changes: 33 additions & 0 deletions docs/_locales/ja/ml_on_event_stop_detailed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# on ML stop

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

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

When an action changes, the stop event handler for the previous action will run, followed by the start event handler for the next action.

For example, if your start event handler for an action starts music playing in the background, you could use a stop event handler to stop it.

The event handler is passed a `duration` parameter. The duration is the [number](/types/number) of milliseconds since this action became the estimated action. You can use the duration parameter in your code, for example displaying it or using a variable to keep a running total.

## パラメータ

- **event**: one of the actions the machine learning model was trained on. The special value `unknown` represents the case where no action has a certainty above the recognition point.

##

This example shows on the LED display, in seconds, how long the estimated action was `clapping`, when the estimated action changes from `clapping` to any other action.

```blocks
ml.onStopDetailed(ml.event.Clapping, function (duration) {
basic.showNumber(duration / 1000)
})
```

```package
machine-learning-help-stubs=github:microbit-foundation/pxt-microbit-ml-help-stubs#v0.0.1
machine-learning=github:microbit-foundation/pxt-microbit-ml#v1.0.2
```
32 changes: 32 additions & 0 deletions docs/_locales/ko/ml_get_event_certainty.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# ML 시작 시

ML 작업에 대한 최신 확실성 값 얻기.

```sig
ml.getCertainty(ml.event.Unknown)
```

ML 모델은 초당 여러 번 실행되며 각 행동에 대한 확실성을 계산합니다. 예측한 행동은 확실성이 가장 높은 행동입니다. 어떤 행동의 확실성이 인식 지점(Recognition point)보다 낮다면 해당 행동은 추정되는 행동이 아닙니다. 어떤 프로그램에서는 확실성 수치를 표시하거나 기록하는 등 이 수치를 직접 사용해야 할 수 있습니다. 대부분의 프로그램은 확실성 수치 대신 추정되는 행동을 사용합니다.

## 매개 변수

- **이벤트**: 기계 학습 모델이 학습한 행동 중 하나

## 반환

- 0에서 100까지의 [number](/types/number)로 표시되는 백분율로, 수행하고 있는 행동에 대한 ML 모델의 확실성을 나타냅니다. '알 수 없음'의 확실성은 항상 0입니다.

## 예시

이 예시는 현재 행동이 매초 '박수'를 치고 있다는 ML 모델의 확실성을 백분율로 표시합니다.

```blocks
loops.everyInterval(1000, function () {
basic.showNumber(ml.getCertainty(ml.event.Clapping))
})
```

```package
machine-learning-help-stubs=github:microbit-foundation/pxt-microbit-ml-help-stubs#v0.0.1
machine-learning=github:microbit-foundation/pxt-microbit-ml#v1.0.2
```
Loading

0 comments on commit 1d37aca

Please sign in to comment.