Skip to content

Commit

Permalink
docs: Add troubleshooting section on accessing LS data (#533)
Browse files Browse the repository at this point in the history
Co-authored-by: Caitlin Wheeless <[email protected]>
  • Loading branch information
caitlinwheeless and Caitlin Wheeless authored Sep 9, 2024
1 parent f45a92a commit 1faa0be
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,3 +293,14 @@ docker compose build --no-cache
You might see these errors if you send multiple concurrent requests.

Note that the provided ML backend examples are offered in development mode, and do not support production-level inference serving.

## Troubleshooting the ML backend failing to make simple auto-annotations or unable to see predictions

You must ensure that the ML backend can access your Label Studio data. If it can't, you might encounter the following issues:

* `no such file or directory` errors in the server logs.
* You are unable to see predictions when loading tasks in Label Studio.
* Your ML backend appears to be connected properly, but cannot seem to complete any auto annotations within tasks.

To remedy this, ensure you have set the `LABEL_STUDIO_URL` and `LABEL_STUDIO_API_KEY` environment variables. For more information, see [Allow the ML backend to access Label Studio data](https://labelstud.io/guide/ml#Allow-the-ML-backend-to-access-Label-Studio-data).

4 changes: 2 additions & 2 deletions label_studio_ml/examples/nemo_asr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ This example works with the Label Studio's pre-built **Audio Transcription** tem

But you can use any other labeling interface that combines `<Audio>` and `<TextArea>` elements.

> Warning: If you use files hosted in Label Studio (e.g. audio files directly uploaded via import dialog), you must provide the `LABEL_STUDIO_URL` and `LABEL_STUDIO_API_KEY` environment variables to the ML backend. For more information about finding your Label Studio API key, [see our documentation](https://labelstud.io/guide/user_account#Access-token).
> Warning: If you use files hosted in Label Studio (meaning they were added using the import action), hosted in cloud storage, or connected through local storage, then you must provide the `LABEL_STUDIO_URL` and `LABEL_STUDIO_API_KEY` environment variables to the ML backend. For more information, see [Allow the ML backend to access Label Studio data](https://labelstud.io/guide/ml#Allow-the-ML-backend-to-access-Label-Studio-data). For information about finding your Label Studio API key, see [Access token](https://labelstud.io/guide/user_account#Access-token).
## Running with Docker (recommended)

Expand Down Expand Up @@ -99,4 +99,4 @@ The following common parameters are available:

## Customization

The ML backend can be customized by adding your own models and logic inside `./nemo_asr/model.py`.
The ML backend can be customized by adding your own models and logic inside `./nemo_asr/model.py`.

0 comments on commit 1faa0be

Please sign in to comment.