Installation using MySQL database and Store filenames with emoticons: Difference between pages

From LogicalDOC Community Wiki
(Difference between pages)
Jump to navigationJump to search
No edit summary
 
Giuseppe (talk | contribs)
No edit summary
 
Line 1: Line 1:
__TOC__ <br> Starting from LD 5.0 MySQL 5.1 is the recommended external RDBMS for the software.<br>LogicalDOC Enterprise Edition installs this database during the installation procedure.<br> <br> Follow the steps required to perform the installation.
= Preparing a Dataset with Label Studio =


== Proceed with the installation of the MySQL database  ==
This guide explains how to create an annotated dataset for YOLO training using Label Studio.


MySQL 5.1) Download the installer: mysql-5.1.37-win32.msi<br>
Install Label Studio using pip:


=== Perform the installation of MySQL  ===
<pre>
pip install label-studio
</pre>


[[Image:MySQL Database Usage.gif|thumb|left|100px|MySQL Database Usage]]
Verify the installation:


*select Typical as type of setup<br>  
<pre>
*select Detailed Configuration<br>
python -m label_studio.server --help
*select Developer Machine<br>
</pre>
*select Multifunctional Database<br>


Proceed to complete the installation<br> <br> the most important thing in my opinion is set the usage of the database as Multifunctional.  
Or refer to the official installation guide:
https://labelstud.io/guide/install


== Connect to the server and create the DB schema for LogicalDOC  ==


launch the MySQL Command Line Client<br> <br> connect as root with the password you previously asseigned to the user.<br> <br> launch the following commands:<br> <br> CREATE DATABASE logicaldoc;<br>
=== Enable Local File Storage ===


GRANT ALL PRIVILEGES ON *.* TO 'logicaldoc'@'%' IDENTIFIED BY 'sa' WITH GRANT OPTION;<br> (this create a user 'logicaldoc' with password 'sa' that can access the db from every host)<br> <br> FLUSH PRIVILEGES;<br> <br> COMMIT;<br> <br> EXIT;
For large projects it is not recommended to upload images directly through the Label Studio interface. Instead, configure a local directory that contains the images to annotate.


== Run the setup of LogicalDOC  ==
To enable local file access, configure the following environment variables before starting Label Studio:


Log on to the setup of your. application LogicalDOC<br> http://localhost:8080/logicaldoc/setup/<br>  
<pre>
LABEL_STUDIO_LOCAL_FILES_SERVING_ENABLED=true
LABEL_STUDIO_LOCAL_FILES_DOCUMENT_ROOT=/path/to/images
</pre>


=== Select the MySQL DB  ===


[[Image:Database Configuration.gif|thumb|left|100px|Database Configuration]]enter the jdbc Connection Url for the database:<br> jdbc:mysql://localhost:3306/logicaldoc<br>


specify "logicaldoc" as the Username, "sa" as the Password<br> <br> Start the creation of tables and the population of the initial data by pressing the button on the right (Continue).<br> <br> If you still have problem to complete the setup procedure try to compare the file my.ini in your MySQL installation folder with that other contained in this compressed archive [[Media:My.zip|my.zip]]


<br>
=== Starting Label Studio ===
 
Label Studio can be started using one of the following methods.
 
 
==== Default Startup ====
 
If local file storage is not required, Label Studio can be started with the default configuration:
 
<pre>
label-studio start
</pre>
 
or
 
<pre>
python -m label_studio.server start
</pre>
 
By default, the application is available at:
 
<pre>
http://localhost:8080
</pre>
 
==== Startup with Local File Storage ====
 
When working with large datasets, it is recommended to configure Local Storage so that images are accessed directly from the filesystem.
 
Windows example:
 
<pre>
set LABEL_STUDIO_PORT=8081
set LABEL_STUDIO_LOCAL_FILES_SERVING_ENABLED=true
set LABEL_STUDIO_LOCAL_FILES_DOCUMENT_ROOT=C:\Users\username\Documents\label-studio
 
python -m label_studio.server start
</pre>
 
After startup, Label Studio will be available at:
 
<pre>
http://localhost:8081
</pre>
 
The directory specified by '''LABEL_STUDIO_LOCAL_FILES_DOCUMENT_ROOT''' can then be configured as Local Storage within a Label Studio project.
 
Port '''8081''' is used to avoid conflicts with the default LogicalDOC installation, which typically runs on port '''8080'''.
 
 
=== Create a Project ===
 
# Login to Label Studio
# Click '''Create Project'''
# Enter a project name
# Configure the labeling interface
# Save the project
 
=== Import Images ===
 
# Open the project
# Click '''Import'''
# Select '''Local Storage'''
 
=== Configure Local Storage ===
 
# Open the project
# Navigate to '''Settings > Cloud Storage'''
# Click '''Add Source Storage'''
# Select '''Local Files'''
# Configure the path specified by LABEL_STUDIO_LOCAL_FILES_DOCUMENT_ROOT
# Click '''Sync Storage'''
 
After synchronization, Label Studio automatically creates one task for each imported document image.
 
When importing images, choose '''Files''' as the import method.
 
Unlike CVAT, Label Studio creates one task for each imported document image.
 
[[File:LabelStudio-import-method.png|thumb|600px|center|Selecting the Files import method]]
 
=== Annotate Documents ===
 
# Open a task
# Select a label
# Draw a bounding box around the target area
# Save the annotation
 
Example labels:
 
* Invoice Number
* Date
* Seller Name
* Buyer Name
* Total Amount
 
[[File:LabelStudio-annotation-example.png|thumb|600px|center|Example annotation]]
 
=== Export the Dataset ===
 
# Open the project
# Click '''Export'''
# Select the desired format
 
Supported formats include:
 
* YOLO
* COCO
* Pascal VOC
* CSV
 
For YOLO training, export the dataset in YOLO format.
 
=== Dataset Formats ===
 
==== COCO ====
 
COCO is a JSON-based dataset format commonly used for object detection datasets.
 
More information:
https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-coco-overview.html
 
==== YOLO ====
 
YOLO datasets contain images and annotation files organized according to a predefined directory structure.
 
More information:
https://docs.cvat.ai/docs/dataset_management/formats/format-yolo/
 
==== YOLOv8 OBB ====
 
YOLOv8 OBB (Oriented Bounding Boxes) extends the standard YOLO format by supporting rotated bounding boxes using eight normalized coordinates.

Revision as of 12:49, 23 June 2026

Preparing a Dataset with Label Studio

This guide explains how to create an annotated dataset for YOLO training using Label Studio.

Install Label Studio using pip:

pip install label-studio

Verify the installation:

python -m label_studio.server --help

Or refer to the official installation guide: https://labelstud.io/guide/install


Enable Local File Storage

For large projects it is not recommended to upload images directly through the Label Studio interface. Instead, configure a local directory that contains the images to annotate.

To enable local file access, configure the following environment variables before starting Label Studio:

LABEL_STUDIO_LOCAL_FILES_SERVING_ENABLED=true
LABEL_STUDIO_LOCAL_FILES_DOCUMENT_ROOT=/path/to/images



Starting Label Studio

Label Studio can be started using one of the following methods.


Default Startup

If local file storage is not required, Label Studio can be started with the default configuration:

label-studio start

or

python -m label_studio.server start

By default, the application is available at:

http://localhost:8080

Startup with Local File Storage

When working with large datasets, it is recommended to configure Local Storage so that images are accessed directly from the filesystem.

Windows example:

set LABEL_STUDIO_PORT=8081
set LABEL_STUDIO_LOCAL_FILES_SERVING_ENABLED=true
set LABEL_STUDIO_LOCAL_FILES_DOCUMENT_ROOT=C:\Users\username\Documents\label-studio

python -m label_studio.server start

After startup, Label Studio will be available at:

http://localhost:8081

The directory specified by LABEL_STUDIO_LOCAL_FILES_DOCUMENT_ROOT can then be configured as Local Storage within a Label Studio project.

Port 8081 is used to avoid conflicts with the default LogicalDOC installation, which typically runs on port 8080.


Create a Project

  1. Login to Label Studio
  2. Click Create Project
  3. Enter a project name
  4. Configure the labeling interface
  5. Save the project

Import Images

  1. Open the project
  2. Click Import
  3. Select Local Storage

Configure Local Storage

  1. Open the project
  2. Navigate to Settings > Cloud Storage
  3. Click Add Source Storage
  4. Select Local Files
  5. Configure the path specified by LABEL_STUDIO_LOCAL_FILES_DOCUMENT_ROOT
  6. Click Sync Storage

After synchronization, Label Studio automatically creates one task for each imported document image.

When importing images, choose Files as the import method.

Unlike CVAT, Label Studio creates one task for each imported document image.

File:LabelStudio-import-method.png
Selecting the Files import method

Annotate Documents

  1. Open a task
  2. Select a label
  3. Draw a bounding box around the target area
  4. Save the annotation

Example labels:

  • Invoice Number
  • Date
  • Seller Name
  • Buyer Name
  • Total Amount
File:LabelStudio-annotation-example.png
Example annotation

Export the Dataset

  1. Open the project
  2. Click Export
  3. Select the desired format

Supported formats include:

  • YOLO
  • COCO
  • Pascal VOC
  • CSV

For YOLO training, export the dataset in YOLO format.

Dataset Formats

COCO

COCO is a JSON-based dataset format commonly used for object detection datasets.

More information: https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-coco-overview.html

YOLO

YOLO datasets contain images and annotation files organized according to a predefined directory structure.

More information: https://docs.cvat.ai/docs/dataset_management/formats/format-yolo/

YOLOv8 OBB

YOLOv8 OBB (Oriented Bounding Boxes) extends the standard YOLO format by supporting rotated bounding boxes using eight normalized coordinates.