Skip to content
Snippets Groups Projects
Verified Commit e540a8b8 authored by Erwan Rouchet's avatar Erwan Rouchet
Browse files

Document worker_run in project exports

parent 7e9e3aaf
No related branches found
No related tags found
1 merge request!92Document worker_run in project exports
Pipeline #13897 passed
......@@ -34,6 +34,7 @@ moderator | `VARCHAR(255)` | Email of a user that validated or rejected the clas
confidence | `REAL` | Confidence level, between 0 and 1. Nullable.
high_confidence | `INTEGER` | Whether the worker states this class is the correct class for the element. Either 0 or 1.
worker_version_id | `VARCHAR(37)` | UUID of a worker version that created this classification. Nullable.
worker_run_id | `VARCHAR(37)` | UUID of a worker run that created this classification. Nullable.
### element
......@@ -49,6 +50,7 @@ polygon | `TEXT` | Coordinates of the element's polygon on the image, as a JSON
rotation_angle | `INTEGER` | Clockwise angle of rotation to apply on the image after cropping and mirroring.
mirrored | `INTEGER` | Whether or not to mirror the image along its vertical axis after cropping and before rotating.
worker_version_id | `VARCHAR(37)` | UUID of a worker version that created this element. Nullable.
worker_run_id | `VARCHAR(37)` | UUID of a worker run that created this element. Nullable.
confidence | `REAL` | Confidence level reported by the worker, between 0 and 1. Nullable.
### element_path
......@@ -79,6 +81,7 @@ validated | `INTEGER` | Validation state of the entity (0 or 1).
moderator | `VARCHAR(255)` | Email of a user that validated the entity. Null if the entity was not validated.
metas | `TEXT` | Arbitrary metadata about the entity, as a JSON object with string values. Nullable.
worker_version_id | `VARCHAR(37)` | UUID of a worker version that created this entity. Nullable.
worker_run_id | `VARCHAR(37)` | UUID of a worker run that created this entity. Nullable.
### entity_link
......@@ -118,7 +121,8 @@ name | `VARCHAR(250)` | Name of the metadata.
type | `VARCHAR(50)` | Type of the metadata: `text`, `date`, `reference`, etc.
value | `TEXT` | Value of the metadata.
entity_id | `VARCHAR(37)` | UUID of an entity linked to this metadata. Nullable.
worker_version_id | `VARCHAR(37)` | UUID of a worker version that created this entity. Nullable.
worker_version_id | `VARCHAR(37)` | UUID of a worker version that created this metadata. Nullable.
worker_run_id | `VARCHAR(37)` | UUID of a worker run that created this metadata. Nullable.
### transcription
......@@ -130,6 +134,7 @@ text | `TEXT` | Text of the transcription.
confidence | `REAL` | Confidence level reported by the worker, between 0 and 1. Nullable.
orientation | `TEXT` | [Text orientation](@/project/transcription.md#text-orientation): `horizontal-lr`, `horizontal-rl`, `vertical-lr` or `vertical-rl`.
worker_version_id | `VARCHAR(37)` | UUID of a worker version that created this transcription. Nullable.
worker_run_id | `VARCHAR(37)` | UUID of a worker run that created this transcription. Nullable.
### transcription_entity
......@@ -141,17 +146,31 @@ entity_id | `VARCHAR(37)` | UUID of the entity.
offset | `INTEGER` | Zero-based index of the first character in the transcription's text that maps to the entity.
length | `INTEGER` | Length of the portion of the transcription's text that maps to the entity.
worker_version_id | `VARCHAR(37)` | UUID of the worker version that created this transcription-entity link. Nullable.
worker_run_id | `VARCHAR(37)` | UUID of a worker run that created this transcription-entity link. Nullable.
confidence | `REAL` | Confidence level reported by the worker, between 0 and 1. Nullable.
### worker_version
Name | Type | Description
---- | ---- | -----------
id | `VARCHAR(37)` | UUID of the worker.
id | `VARCHAR(37)` | UUID of the worker version.
name | `VARCHAR(100)` | Human-readable name of the worker.
slug | `VARCHAR(100)` | Slug of the worker.
type | `VARCHAR(50)` | Type of the worker (recognizer, classifier, etc.).
revision | `VARCHAR(50)` | Hash of the Git commit that created this worker version.
repository_url | `TEXT` | URL of the Git repository that hosts this worker version.
### worker_run
Name | Type | Description
---- | ---- | -----------
id | `VARCHAR(37)` | UUID of the worker run.
worker_version_id | `VARCHAR(37)` | UUID of the worker version of this worker run.
model_version_id | `VARCHAR(37)` | UUID of the selected model version. Nullable.
model_id | `VARCHAR(37)` | UUID of the model of the selected model version. Nullable.
model_name | `VARCHAR(100)` | Name of the model of the selected model version. Nullable.
configuration_id | `VARCHAR(37)` | UUID of the selected worker configuration. Nullable.
configuration | `TEXT` | Contents of the selected worker configuration, as JSON. Nullable.
## Sample queries
......
This diff is collapsed.
%% Mermaid diagram for the database structure
graph LR
element_path --> element
element --> image
element --> worker_version
transcription --> element
element --> image
element --> worker_version
element --> worker_run
transcription --> element
transcription --> worker_version
classification --> element
transcription --> worker_run
classification --> element
classification --> worker_version
classification --> worker_run
entity --> worker_version
entity --> worker_run
entity --> entity_type
entity_role --> entity_type
entity_link --> entity
......@@ -15,3 +19,9 @@ graph LR
transcription_entity --> transcription
transcription_entity --> entity
transcription_entity --> worker_version
transcription_entity --> worker_run
metadata --> element
metadata --> entity
metadata --> worker_version
metadata --> worker_run
worker_run --> worker_version
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment