Skip to content

Commit be062bf

Browse files
committed
docs: move labelstudio img into main assets folder
1 parent 97e145e commit be062bf

File tree

11 files changed

+21
-20
lines changed

11 files changed

+21
-20
lines changed

src/entity_extraction/LabelStudio_README.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ The finding fossils team setup a privately hosted version of LabelStudio using H
66

77
**Table of Contents**
88

9-
- [Label Studio Setup](#label-studio-setup--usage)
10-
- [Create Azure Blob Storage](#create-azure-blob-storage)
11-
- [Setup Postgres Database](#setup-postgres-database)
12-
- [Setup Label Studio External Storage](#setup-label-studio-external-storage)
13-
- [Label Studio Usage](#labeling-instructions)
14-
- [Account creation](#create-account)
15-
- [Navigation](#navigation)
16-
- [Labeling](#labeling)
9+
- [Label Studio Setup \& Usage](#label-studio-setup--usage)
10+
- [**Label Studio Setup**](#label-studio-setup)
11+
- [**Create Azure Blob Storage**](#create-azure-blob-storage)
12+
- [**Setup PostgreSQL Database**](#setup-postgresql-database)
13+
- [**Setup Label Studio External Storage**](#setup-label-studio-external-storage)
14+
- [**Label Studio Usage**](#label-studio-usage)
15+
- [**Account creation**](#account-creation)
16+
- [**Navigation**](#navigation)
17+
- [**Labeling**](#labeling)
1718
---
1819
## **Label Studio Setup**
1920
---
@@ -77,27 +78,27 @@ Inside the Label Studio instance
7778
2. Send your profile name to *Ty Andrews* to be added to the **Finding Fossils organization** on Hugging Face
7879
Email: [email protected], or create a new organization for a different project to work collaboratively with teammates.
7980
3. Once in the organization, navigate to the organization page from your profile.
80-
![Organization navigation](../../assets/org_nav.png)
81+
![Organization navigation](../../assets/labelstudio-instructions/org_nav.png)
8182

82-
4. In the organization page, click the space
83+
1. In the organization page, click the space
8384
**LabelStudio**.
84-
![LabelStudio tab](../../assets/labelstudio_tab.png)
85+
![LabelStudio tab](../../assets/labelstudio-instructions/labelstudio_tab.png)
8586

86-
5. Create a LabelStudio account and record your password in your password manager.
87-
![Create Account](../../assets/account_creation.png)
87+
1. Create a LabelStudio account and record your password in your password manager.
88+
![Create Account](../../assets/labelstudio-instructions/account_creation.png)
8889

8990
### **Navigation**
9091

9192
1. Open the **Green** project named like **Finding Fossils Labelling - Production** or create a new one.
92-
![Project tab](../../assets/green_tab.png)
93+
![Project tab](../../assets/labelstudio-instructions/green_tab.png)
9394

9495
2. Navigate to the settings menu of the project. Here, several options are available to tweak the settings to be compatible for your task,
95-
![Project Settings](../../assets/settings.png)
96+
![Project Settings](../../assets/labelstudio-instructions/settings.png)
9697

9798
- Review or create labelling instructions.
98-
![Labeling instructions button](../../assets/labeling_instructions_button.png)
99+
![Labeling instructions button](../../assets/labelstudio-instructions/labeling_instructions_button.png)
99100
- The instructions look like this:
100-
![Labeling instructions](../../assets/labeling_instructions.png)
101+
![Labeling instructions](../../assets/labelstudio-instructions/labeling_instructions.png)
101102

102103
- Labeling configuration:
103104
After syncing the buckets, the final step is to define the different categories of entities that the named entity recognition model will be trained to predict. A configuration file is used to define the classes and to initialize the UI components to aid a user label entities. A sample config file has the following tags:
@@ -123,11 +124,11 @@ For general information, [visit LabelStudios templates page.](https://labelstud.
123124
### **Labeling**
124125

125126
1. Select the task with **global_index** of 0, the **global index** indicates this is the start of the article and start labelling each task by moving onto the next **global_index** number.
126-
![Global Index of tasks](../../assets/global_index.png)
127+
![Global Index of tasks](../../assets/labelstudio-instructions/global_index.png)
127128
- **Ensure pre-labelled entities are correct and/or fix:** we have tried to auto-tag entities to make this faster but it’s not perfect and this is what we’re improving, so this commonly misses entities or gets them partially right.
128129
- **Label any missed entities:** these can be things with typos, words being smushed together, etc.
129130
2. **Using the labelling interface:**
130-
![Labeling](../../assets/labeling.png)
131+
![Labeling](../../assets/labelstudio-instructions/labeling.png)
131132
3. **Correct a pre-labelled entity:**
132133
- If it’s completely wrong, delete it
133134
- Select the label
@@ -136,4 +137,4 @@ For general information, [visit LabelStudios templates page.](https://labelstud.
136137
- Delete the entity using above
137138
- Select the correct label and click/drag the correct span of text
138139

139-
![Correct Entity](../../assets/correct_labels.png)
140+
![Correct Entity](../../assets/labelstudio-instructions/correct_labels.png)
-58.1 KB
Binary file not shown.
-122 KB
Binary file not shown.
-69.4 KB
Binary file not shown.
-58.6 KB
Binary file not shown.
-156 KB
Binary file not shown.
-161 KB
Binary file not shown.
-65.2 KB
Binary file not shown.
-92.1 KB
Binary file not shown.
-63.2 KB
Binary file not shown.

0 commit comments

Comments
 (0)