From 1faa0be03c1b90826e805489708e7c516001846d Mon Sep 17 00:00:00 2001 From: Caitlin Wheeless Date: Mon, 9 Sep 2024 14:38:58 -0500 Subject: [PATCH] docs: Add troubleshooting section on accessing LS data (#533) Co-authored-by: Caitlin Wheeless --- README.md | 11 +++++++++++ label_studio_ml/examples/nemo_asr/README.md | 4 ++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 64f06fae5..f5420eac3 100644 --- a/README.md +++ b/README.md @@ -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). + diff --git a/label_studio_ml/examples/nemo_asr/README.md b/label_studio_ml/examples/nemo_asr/README.md index 03c191b05..808b638b9 100644 --- a/label_studio_ml/examples/nemo_asr/README.md +++ b/label_studio_ml/examples/nemo_asr/README.md @@ -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 `