Ashrafb commited on
Commit
7cac30c
1 Parent(s): d16d0b2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -166
README.md CHANGED
@@ -1,168 +1,8 @@
1
  ---
2
- title: LabelStudio
3
- emoji: 🟧
4
- colorFrom: yellow
5
- colorTo: purple
6
  sdk: docker
7
- tags:
8
- - label-studio
9
- fullwidth: true
10
- license: apache-2.0
11
- app_port: 8080
12
- ---
13
- <img src="https://user-images.githubusercontent.com/12534576/192582340-4c9e4401-1fe6-4dbb-95bb-fdbba5493f61.png"/>
14
-
15
- [Website](https://hubs.ly/Q01CNgsd0) • [Docs](https://hubs.ly/Q01CN9Yq0) • [12K+ GitHub ⭐️!](https://hubs.ly/Q01CNbPQ0) • [Slack Community](https://hubs.ly/Q01CNb9H0)
16
-
17
- ## What is Label Studio?
18
-
19
- Label Studio is an open source data labeling platform. It lets you label audio,
20
- text, images, videos, and time series data with a simple, straightforward, and
21
- highly-configurable user interface. Label Studio can prepare new data or
22
- improve existing training data to get more accurate ML models.
23
-
24
-
25
- ## Label Studio in Hugging Face Spaces
26
-
27
- The Label Studio community is thrilled to offer Label Studio as a Hugging Face
28
- Spaces application. You can try the data-annotation interface, connect popular
29
- machine learning models, and share the application with collaborators. You can
30
- start immediately by creating an account or replicate the space and work in
31
- your own environment.
32
-
33
- ## Creating a Use Account and Logging In
34
-
35
- Begin by creating a new account in the Label Studio space, then log in with your
36
- credentials.
37
-
38
- **By default, these spaces permit anyone to create a new login
39
- account, allowing them to view and modify project configuration, data sets, and
40
- annotations. Without any modifications, treat this space like a demo environment.**
41
-
42
- ## Creating a Labeling Project
43
-
44
- After logging in, Label Studio will present you with a project view. Here you
45
- can create a new project with prompts to upload data and set up a custom
46
- configuration interface.
47
-
48
- **Note that in the default configuration, storage is local and temporary. Any
49
- projects, annotations, and configurations will be lost if the space is restarted.**
50
-
51
- ## Next Steps and Additional Resources
52
-
53
- To help with getting started, the Label Studio community curated a list of
54
- resources including tutorials and documentation.
55
-
56
- - 🚀 [Zero to One with Label Studio Tutorial](https://labelstud.io/blog/introduction-to-label-studio-in-hugging-face-spaces/)
57
- - 📈 [Try Label Studio Enterprise](https://hubs.ly/Q01CMLll0)
58
- - 🤗 [Tutorial: Using Label Studio with Hugging Face Datasets Hub](https://danielvanstrien.xyz/huggingface/huggingface-datasets/annotation/full%20stack%20deep%20learning%20notes/2022/09/07/label-studio-annotations-hub.html)
59
- - 💡 [Label Studio Docs](https://hubs.ly/Q01CN9Yq0)
60
-
61
-
62
- ![Gif of Label Studio annotating different types of data](https://raw.githubusercontent.com/heartexlabs/label-studio/master/images/annotation_examples.gif)
63
-
64
- ### Making your Label Studio Hugging Face Space production-ready
65
-
66
- By default this space allows for the unrestricted creation of new accounts
67
- will full access to all projects and data. This is great for trying out
68
- Label Studio and collaborating on projects, but you may want to restrict
69
- access to your space to only authorized users. Add the following environment
70
- variable to your spaces Dockerfile to disable public account creation for
71
- this space.
72
-
73
- ENV LABEL_STUDIO_DISABLE_SIGNUP_WITHOUT_LINK=true
74
-
75
- Set secrets in your space to create an inital user, and log in with your
76
- provided username and password. Do not set these in your Dockerfile, as they
77
- globally visible on a public space.
78
-
79
- LABEL_STUDIO_USERNAME
80
- LABEL_STUDIO_PASSWORD
81
-
82
- You will need to provide new users with an invitation link to join the space,
83
- which can be found in the Organizations interface of Label Studio.
84
-
85
- By default this space stores all project configuration and data annotations
86
- in local storage with Sqlite. If the space is reset, all configuration and
87
- annotation data in the space will be lost. You can enable configuration
88
- persistence in one of two ways:
89
-
90
- 1. Enabling Persistent Storage in your Space settings and configuring Label
91
- Studio to write its database and task storage there.
92
-
93
- 2. Connecting an external Postgres database and cloud storage to your space,
94
- guaranteeing that all project and annotation settings are preserved.
95
-
96
- ### Enabling Hugging Face Persistent Storage
97
-
98
- In the Hugging Face Label Studio Space settings, select the appropriate
99
- Persistent Storage tier. Note that Persistent Storage is a paid add-on.
100
- By default, persistent storage is mounted to /data. In your Space settings,
101
- set the following variables:
102
-
103
- LABEL_STUDIO_BASE_DATA_DIR=/data
104
- ENV STORAGE_PERSISTENCE=1
105
-
106
- Your space will restart. NOTE: if you have existing settings and data,
107
- they will be lost in this first restart. Data and setting will only be
108
- preserved on subsequent restarts of the space.
109
-
110
- ### Enabling Postgres Database and Cloud Storage
111
-
112
- Set the following secret variables to match your own hosted instance of
113
- Postgres. We strongly recommend setting these as secrets to prevent leaking
114
- information about your database service to the public in your spaces
115
- definition.
116
-
117
- DJANGO_DB=default
118
- POSTGRE_NAME=<postgres_name>
119
- POSTGRE_PORT=<db_port>
120
- POSTGRE_USER=<postgres_user>
121
- POSTGRE_PASSWORD=<password>
122
- POSTGRE_PORT=<db_port>
123
- POSTGRE_HOST=<db_host>
124
-
125
- Add the following environment variable to remove the warning about ephemeral
126
- storage.
127
-
128
- ENV STORAGE_PERSISTENCE=1
129
-
130
- Note that you will need to connect cloud storage to host data items that you
131
- want to annotate, as local storage will not be preserved across a space reset.
132
-
133
- By default the only data storage enabled for this space is local. In the case
134
- of a space reset, all data will be lost. To enable permanent storage, you
135
- must enable a cloud storage connector. We also strongly recommend enabling
136
- configuration persistence to preserve project data, annotations, and user
137
- settings. Choose the appropriate cloud connector and configure the secrets
138
- for it.
139
-
140
- #### Amazon S3
141
- STORAGE_TYPE=s3
142
- STORAGE_AWS_ACCESS_KEY_ID="<YOUR_ACCESS_KEY_ID>"
143
- STORAGE_AWS_SECRET_ACCESS_KEY="<YOUR_SECRET_ACCESS_KEY>"
144
- STORAGE_AWS_BUCKET_NAME="<YOUR_BUCKET_NAME>"
145
- STORAGE_AWS_REGION_NAME="<YOUR_BUCKET_REGION>"
146
- STORAGE_AWS_FOLDER=""
147
-
148
- #### Google Cloud Storage
149
-
150
- STORAGE_TYPE=gcs
151
- STORAGE_GCS_BUCKET_NAME="<YOUR_BUCKET_NAME>"
152
- STORAGE_GCS_PROJECT_ID="<YOUR_PROJECT_ID>"
153
- STORAGE_GCS_FOLDER=""
154
- GOOGLE_APPLICATION_CREDENTIALS="/opt/heartex/secrets/key.json"
155
-
156
- Azure Blob Storage
157
- ==================
158
-
159
- STORAGE_TYPE=azure
160
- STORAGE_AZURE_ACCOUNT_NAME="<YOUR_STORAGE_ACCOUNT>"
161
- STORAGE_AZURE_ACCOUNT_KEY="<YOUR_STORAGE_KEY>"
162
- STORAGE_AZURE_CONTAINER_NAME="<YOUR_CONTAINER_NAME>"
163
- STORAGE_AZURE_FOLDER=""
164
-
165
-
166
- ## Questions? Concerns? Want to get involved?
167
-
168
- Email the community team at [community@labelstud.io](mailto:community@labelstud.io)
 
1
  ---
2
+ title: Playgrounddocker
3
+ emoji: 🐢
4
+ colorFrom: purple
5
+ colorTo: blue
6
  sdk: docker
7
+ pinned: false
8
+ ---