Skip to content

Commit dfa5712

Browse files
docs: Add links to ml-backend directory (#625)
Co-authored-by: caitlinwheeless <[email protected]>
1 parent 1faa0be commit dfa5712

File tree

21 files changed

+120
-3
lines changed

21 files changed

+120
-3
lines changed

label_studio_ml/examples/bert_classifier/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ The NewModel is a BERT-based text classification model that is designed to work
2727
- Automatically download the labeled tasks from Label Studio and prepare the data for training.
2828
- Customize the training parameters such as learning rate, number of epochs, and weight decay.
2929

30+
## Before you begin
31+
32+
Before you begin, you must install the [Label Studio ML backend](https://github.com/HumanSignal/label-studio-ml-backend?tab=readme-ov-file#quickstart).
33+
34+
This tutorial uses the [`bert_classifier` example](https://github.com/HumanSignal/label-studio-ml-backend/tree/master/label_studio_ml/examples/bert_classifier).
35+
3036

3137
## Running with Docker (recommended)
3238

label_studio_ml/examples/easyocr/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ The primary function of this connection is to recognize and extract text from im
2424

2525
In the context of Label Studio, this connection enhances the platform's labeling capabilities, allowing users to automatically generate labels for text in images. This can be particularly useful in tasks such as data annotation, document digitization, and more.
2626

27+
## Before you begin
28+
29+
Before you begin, you must install the [Label Studio ML backend](https://github.com/HumanSignal/label-studio-ml-backend?tab=readme-ov-file#quickstart).
30+
31+
This tutorial uses the [`easyocr` example](https://github.com/HumanSignal/label-studio-ml-backend/tree/master/label_studio_ml/examples/easyocr).
32+
2733
## Labeling configuration
2834

2935
The EasyOCR model connection can be used with the default labeling configuration for OCR in Label Studio. This configuration typically involves defining the types of labels to be used (e.g., text, handwriting, etc.) and the regions of the image where these labels should be applied.

label_studio_ml/examples/flair/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ image: "/tutorials/flair.png"
2020

2121
This example demonstrates how to use Flair NER model with Label Studio.
2222

23+
## Before you begin
24+
25+
Before you begin, you must install the [Label Studio ML backend](https://github.com/HumanSignal/label-studio-ml-backend?tab=readme-ov-file#quickstart).
26+
27+
This tutorial uses the [`flair` example](https://github.com/HumanSignal/label-studio-ml-backend/tree/master/label_studio_ml/examples/flair).
28+
2329
## Quickstart
2430

2531
1. Build and start the Machine Learning backend on `http://localhost:9090`

label_studio_ml/examples/gliner/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ The GLiNER model is a BERT family model for generalist NER. We download the mode
2424
model is
2525
available on [GitHub](https://github.com/urchade/GLiNER).
2626

27+
## Before you begin
28+
29+
Before you begin, you must install the [Label Studio ML backend](https://github.com/HumanSignal/label-studio-ml-backend?tab=readme-ov-file#quickstart).
30+
31+
This tutorial uses the [`gliner` example](https://github.com/HumanSignal/label-studio-ml-backend/tree/master/label_studio_ml/examples/gliner).
32+
2733

2834
## Running with Docker (recommended)
2935

label_studio_ml/examples/grounding_dino/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ This integration will allow you to:
2929

3030
See [here](https://github.com/IDEA-Research/GroundingDINO) for more details about the pre-trained Grounding DINO model.
3131

32+
## Before you begin
33+
34+
Before you begin, you must install the [Label Studio ML backend](https://github.com/HumanSignal/label-studio-ml-backend?tab=readme-ov-file#quickstart).
35+
36+
This tutorial uses the [`grounding_dino` example](https://github.com/HumanSignal/label-studio-ml-backend/tree/master/label_studio_ml/examples/grounding_dino).
37+
3238

3339
## Quickstart
3440

label_studio_ml/examples/grounding_sam/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ This integration will allow you to:
3232

3333
See [here](https://github.com/IDEA-Research/GroundingDINO) for more details about the pre-trained Grounding DINO model.
3434

35+
## Before you begin
36+
37+
Before you begin, you must install the [Label Studio ML backend](https://github.com/HumanSignal/label-studio-ml-backend?tab=readme-ov-file#quickstart).
38+
39+
This tutorial uses the [`grounding_sam` example](https://github.com/HumanSignal/label-studio-ml-backend/tree/master/label_studio_ml/examples/grounding_sam).
40+
3541

3642
## Quickstart
3743

label_studio_ml/examples/huggingface_llm/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ This machine learning backend is designed to work with Label Studio, providing a
2323

2424
Check [text generation pipelines on Hugging Face](https://huggingface.co/tasks/text-generation) for more details.
2525

26+
## Before you begin
27+
28+
Before you begin, you must install the [Label Studio ML backend](https://github.com/HumanSignal/label-studio-ml-backend?tab=readme-ov-file#quickstart).
29+
30+
This tutorial uses the [`huggingface_llm` example](https://github.com/HumanSignal/label-studio-ml-backend/tree/master/label_studio_ml/examples/huggingface_llm).
31+
2632
## Label Studio XML labeling config
2733

2834
This ML backend is compatible with a Label Studio labeling configuration that uses a `<TextArea>` tag. Here is an example of a compatible labeling configuration:

label_studio_ml/examples/huggingface_ner/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,13 @@ The model instantiates `AutoModelForTokenClassification` from Hugging Face's tra
2525
- If you want to use this model only in inference mode, it serves predictions from the pre-trained model.
2626
- If you want to fine-tune the model, you can use the Label Studio interface to provide training data and train the model.
2727

28-
Read more about the compatible models from [Hugging Face's official documentation](https://huggingface.co/docs/transformers/en/tasks/token_classification)
28+
Read more about the compatible models from [Hugging Face's official documentation](https://huggingface.co/docs/transformers/en/tasks/token_classification).
29+
30+
## Before you begin
31+
32+
Before you begin, you must install the [Label Studio ML backend](https://github.com/HumanSignal/label-studio-ml-backend?tab=readme-ov-file#quickstart).
33+
34+
This tutorial uses the [`huggingface_ner` example](https://github.com/HumanSignal/label-studio-ml-backend/tree/master/label_studio_ml/examples/huggingface_ner).
2935

3036

3137
## Labeling configuration

label_studio_ml/examples/interactive_substring_matching/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ image: "/tutorials/interactive-substring-matching.png"
2020

2121
The Machine Learning (ML) backend is designed to enhance the efficiency of auto-labeling in Named Entity Recognition (NER) tasks. It achieves this by selecting a keyword and automatically matching the same keyword in the provided text.
2222

23+
## Before you begin
24+
25+
Before you begin, you must install the [Label Studio ML backend](https://github.com/HumanSignal/label-studio-ml-backend?tab=readme-ov-file#quickstart).
26+
27+
This tutorial uses the [`interactive_substring_matching` example](https://github.com/HumanSignal/label-studio-ml-backend/tree/master/label_studio_ml/examples/interactive_substring_matching).
28+
2329
## Recommended labeling config
2430

2531
This ML backend works with the default NER template from Label Studio. You can find this by selecting Label Studio's pre-built NER template when configuring the labeling interface. It is available under **Natural Language Processing > Named Entity Recognition**.

label_studio_ml/examples/langchain_search_agent/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ This example demonstrates how to use Label Studio with a custom Machine Learning
2727
It uses a [Langchain](https://www.langchain.com/)-based agent that accepts a text input, searches for Google,
2828
and returns the answer based on the search results (a.k.a Retrieval Augmented Generation).
2929

30+
## Before you begin
31+
32+
Before you begin, you must install the [Label Studio ML backend](https://github.com/HumanSignal/label-studio-ml-backend?tab=readme-ov-file#quickstart).
33+
34+
This tutorial uses the [`langchain_search_agent` example](https://github.com/HumanSignal/label-studio-ml-backend/tree/master/label_studio_ml/examples/langchain_search_agent).
35+
3036
## Prerequisites
3137

3238
### Use Google Search

0 commit comments

Comments
 (0)