Skip to content

Commit 1faa0be

Browse files
caitlinwheelessCaitlin Wheeless
and
Caitlin Wheeless
authored
docs: Add troubleshooting section on accessing LS data (#533)
Co-authored-by: Caitlin Wheeless <[email protected]>
1 parent f45a92a commit 1faa0be

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -293,3 +293,14 @@ docker compose build --no-cache
293293
You might see these errors if you send multiple concurrent requests.
294294

295295
Note that the provided ML backend examples are offered in development mode, and do not support production-level inference serving.
296+
297+
## Troubleshooting the ML backend failing to make simple auto-annotations or unable to see predictions
298+
299+
You must ensure that the ML backend can access your Label Studio data. If it can't, you might encounter the following issues:
300+
301+
* `no such file or directory` errors in the server logs.
302+
* You are unable to see predictions when loading tasks in Label Studio.
303+
* Your ML backend appears to be connected properly, but cannot seem to complete any auto annotations within tasks.
304+
305+
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).
306+

label_studio_ml/examples/nemo_asr/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This example works with the Label Studio's pre-built **Audio Transcription** tem
3838

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

41-
> 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).
41+
> 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).
4242
4343
## Running with Docker (recommended)
4444

@@ -99,4 +99,4 @@ The following common parameters are available:
9999

100100
## Customization
101101

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

0 commit comments

Comments
 (0)