Skip to content

Commit

Permalink
docs: DOC-207: Add a warning about importing files through the LS UI (#…
Browse files Browse the repository at this point in the history
…5682)

Highlighted guidance about not importing files through the UI for large
or important projects

- [X] Community docs
- [X] Enterprise docs

---------

Co-authored-by: Max Tkachenko <makseq@gmail.com>
  • Loading branch information
caitlinwheeless and makseq committed Apr 5, 2024
1 parent 51566f4 commit 7dd845a
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/source/guide/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,16 @@ Get data into Label Studio by importing files, referencing URLs, or syncing with

## General guidelines for importing data

* For larger projects, do not upload data through the Label Studio interface. This works fine for proof of concept projects, but it is not recommended for larger projects. We recommend that you configure external storage instead.
* It’s best to keep about 100k tasks / 100k annotations per project for optimal performance.
* Avoid frequent imports because each new import requires lengthy background operations. One import per 30 seconds will work without overloads.

!!! warning
For large projects or business critical projects, do not [upload media files through the Label Studio interface](#Import-data-from-the-Label-Studio-UI). This is especially true for files such as images, audio, video, timeseries, etc.

Uploading data through the Label Studio UI works fine for proof of concept projects, but it is not recommended for larger projects. You will also face challenges when you want export your data or move it to another Label Studio instance or even just redeploy Label Studio. Finally, Label Studio is not designed as a hosting service at scale and does not have backups for imported media resources.

We strongly recommend that you configure [source storage](storage) instead.

## Types of data you can import into Label Studio

You can import many types of data, including text, timeseries, audio, and image data. The file types supported depend on the type of data.
Expand Down Expand Up @@ -490,6 +496,13 @@ If you're running Label Studio on Docker and want to add local file storage, you

## Import data from the Label Studio UI

!!! warning
For large projects or business critical projects, do not upload media files through the Label Studio interface. This is especially true for files such as images, audio, video, timeseries, etc.

Uploading data through the Label Studio UI works fine for proof of concept projects, but it is not recommended for larger projects. You will also face challenges when you want export your data or move it to another Label Studio instance or even just redeploy Label Studio. Finally, Label Studio is not designed as a hosting service at scale and does not have backups for imported media resources.

We strongly recommend that you configure [source storage](storage) instead.

To import data from the Label Studio UI, do the following:
1. On the Label Studio UI, open the Data Manager page for a specific project.
2. Click **Import** to open the Import dialog.
Expand Down

0 comments on commit 7dd845a

Please sign in to comment.