Creation of a project: NER
From the header, click on Create new project.
1/ Project tab
Fill in the required fields:
- Customer
- Project type
- Project name
- Project deadline
- Project description
Non-mandatory fields:
- Default markers: appears on the item later
- to delete: indicates an item to delete
- to check: indicates an item to check
- to discuss: indicates an item to discuss
You can define access levels for the imported item :
- the admin
- the data scientist
- the user
2/ Files tab
the fields :
- Config file: config file
- Annotations file: file containing the annotations linked to the item
- Predictions file: file containing the predictions linked to the item
Unlike annotations, predictions come from a pre-trained model. After the import, we can choose whether to keep them or not.
As for the mandatory field:
- item file: this is a list that must be prepared in advance including the type of item and a unique id
3/ Labeling tab
You can define what you want to do with the project.
- Task Title: defines the name
- Task Type: defines the type
You can add a new label by clicking on Add a new label.
The fields :
- Label Code: must be unique
- Label Name: does not necessarily have to have the same name as Label Code
- Color: defines the color of the label
- Hotkey: allows you to create a keyboard shortcut
- Label Description: describes the label
caution
Once these labels have been defined, it is no longer possible to modify them later.
4/ Annotation Guide tab
Here you can define annotation rules.
Once the specifications of a project have been filled in, you can click on Add a new task to start filling in the details of another project.
ex config.json
{
"tasks": [
{
"conditions": [],
"exposed": true,
"type": "classifications",
"annotationPourcent": 4,
"annotationCount": 15,
"_id": "60cee9b5c6009f001ccb75f8",
"project": "60cee9b5c6009f001ccb75f7",
"color": "#ff4d4f",
"value": "en",
"hotkey": "e",
"label": "english",
"category": "language",
"updatedAt": "2021-06-20T07:09:41.715Z",
"createdAt": "2021-06-20T07:09:41.715Z",
"__v": 0,
"description": null,
"max": null,
"min": null
},
{
"conditions": [],
"exposed": true,
"type": "classifications",
"annotationPourcent": 84,
"annotationCount": 378,
"_id": "60cee9b5c6009f001ccb75f9",
"project": "60cee9b5c6009f001ccb75f7",
"color": "#597ef7",
"value": "fr",
"hotkey": "f",
"label": "french",
"category": "language",
"updatedAt": "2021-06-20T07:09:41.715Z",
"createdAt": "2021-06-20T07:09:41.715Z",
"__v": 0,
"description": null,
"max": null,
"min": null
},
{
"conditions": [],
"exposed": true,
"type": "classifications",
"annotationPourcent": 14,
"annotationCount": 60,
"_id": "60cee9b5c6009f001ccb75fa",
"project": "60cee9b5c6009f001ccb75f7",
"color": "#73d13d",
"value": "unk",
"hotkey": "u",
"label": "unknown",
"category": "language",
"updatedAt": "2021-06-20T07:09:41.715Z",
"createdAt": "2021-06-20T07:09:41.715Z",
"__v": 0,
"description": null,
"max": null,
"min": null
},
{
"conditions": [],
"exposed": true,
"type": "classifications",
"annotationPourcent": 1,
"annotationCount": 4,
"_id": "60cee9b5c6009f001ccb75fb",
"project": "60cee9b5c6009f001ccb75f7",
"description": "Document will potentially overfit the NER model",
"color": "#ff4d4f",
"value": "true",
"hotkey": "t",
"label": "true",
"category": "overfit",
"updatedAt": "2021-06-20T07:09:41.715Z",
"createdAt": "2021-06-20T07:09:41.715Z",
"__v": 0,
"max": null,
"min": null
},
{
"conditions": [],
"exposed": true,
"type": "ner",
"annotationPourcent": 22,
"annotationCount": 98,
"_id": "60cee9b5c6009f001ccb75fc",
"project": "60cee9b5c6009f001ccb75f7",
"color": "#36cfc9",
"value": "web",
"hotkey": "w",
"label": "web",
"category": "entity",
"updatedAt": "2021-06-20T07:09:41.716Z",
"createdAt": "2021-06-20T07:09:41.716Z",
"__v": 0,
"description": null,
"max": null,
"min": null
},
{
"conditions": [],
"exposed": true,
"type": "ner",
"annotationPourcent": 70,
"annotationCount": 318,
"_id": "60cee9b5c6009f001ccb75fd",
"project": "60cee9b5c6009f001ccb75f7",
"color": "#597ef7",
"value": "address",
"hotkey": "a",
"label": "address",
"category": "entity",
"updatedAt": "2021-06-20T07:09:41.716Z",
"createdAt": "2021-06-20T07:09:41.716Z",
"__v": 0,
"description": null,
"max": null,
"min": null
},
{
"conditions": [],
"exposed": true,
"type": "ner",
"annotationPourcent": 23,
"annotationCount": 104,
"_id": "60cee9b5c6009f001ccb75fe",
"project": "60cee9b5c6009f001ccb75f7",
"color": "#bae637",
"value": "number",
"hotkey": "n",
"label": "number",
"category": "entity",
"updatedAt": "2021-06-20T07:09:41.716Z",
"createdAt": "2021-06-20T07:09:41.716Z",
"__v": 0,
"description": null,
"max": null,
"min": null
},
{
"conditions": [],
"exposed": true,
"type": "ner",
"annotationPourcent": 77,
"annotationCount": 348,
"_id": "60cee9b5c6009f001ccb75ff",
"project": "60cee9b5c6009f001ccb75f7",
"color": "#fa8c16",
"value": "date",
"hotkey": "d",
"label": "date",
"category": "entity",
"updatedAt": "2021-06-20T07:09:41.717Z",
"createdAt": "2021-06-20T07:09:41.717Z",
"__v": 0,
"description": null,
"max": null,
"min": null
},
{
"conditions": [],
"exposed": true,
"type": "ner",
"annotationPourcent": 25,
"annotationCount": 113,
"_id": "60cee9b5c6009f001ccb7600",
"project": "60cee9b5c6009f001ccb75f7",
"color": "#9254de",
"value": "person",
"hotkey": "p",
"label": "person",
"category": "entity",
"updatedAt": "2021-06-20T07:09:41.717Z",
"createdAt": "2021-06-20T07:09:41.717Z",
"__v": 0,
"description": null,
"max": null,
"min": null
},
{
"conditions": [],
"exposed": true,
"type": "ner",
"annotationPourcent": 69,
"annotationCount": 310,
"_id": "60cee9b5c6009f001ccb7601",
"project": "60cee9b5c6009f001ccb75f7",
"color": "#ff4d4f",
"value": "org",
"hotkey": "o",
"label": "org",
"category": "entity",
"updatedAt": "2021-06-20T07:09:41.717Z",
"createdAt": "2021-06-20T07:09:41.717Z",
"__v": 0,
"description": null,
"max": null,
"min": null
},
{
"conditions": [],
"exposed": true,
"type": "ner",
"annotationPourcent": 1,
"annotationCount": 4,
"_id": "61f110db9f8a97001c5ce61d",
"project": "60cee9b5c6009f001ccb75f7",
"color": "#ffec3d",
"value": "key",
"label": "key",
"hotkey": "k",
"category": "entity",
"min": null,
"max": null,
"updatedAt": "2022-01-26T09:14:03.650Z",
"createdAt": "2022-01-26T09:14:03.650Z",
"__v": 0
}
],
"name": "CV NER",
"client": "LJN",
"type": "text",
"highlights": [],
"description": "Assign NER tags to the tokens of raw CV strings.",
"admins": ["admin@test.com"],
"users": [],
"dataScientists": ["data@test.com"],
"defaultTags": ["To delete", "To check", "To discuss"],
"showPredictions": false,
"prefillPredictions": false,
"filterPredictionsMinimum": 0.4,
"deadline": "2021-08-31T13:53:35.175Z",
"entitiesRelationsGroup": []
}
ex items.jsonlines
{
"predictions": {
"raw": { "Category": { "labels": [{ "value": "P03", "proba": 0.9940561436 }] } },
"keys": [{ "value": "P03", "proba": 0.9940561436 }]
},
"uuid": "20200626_500k_19050300000023992_174390",
"data": {
"text": "Bonjour,Vous trouverez ci-dessous le message vocal le 03.05.2019 a 10:40:59 par un demandeur d'emploi de votre agence."
},
"type": "text",
"metadata": {},
"description": "",
"annotated": false,
"createdAt": 1658755619299,
"velocity": null,
"lastAnnotator": {}
}
ex annotations.jsonlines
{
"item": {
"uuid": "3cbc0986-d195-11eb-82b5-acde48001122",
"datatype": "text",
"data": {
"text": "EXPERIENCE PROFESSIONNELLE ET PROJETS 08.2014-12.2014 Stage de fin d’étude au Laboratoire de Biomécanique des Chocs (LBMC IFSTTAR-UCBL) de Lyon Sujet : Etude de la variabilité de la densité du cartilage costal en fonction de la croissance, a partir de l'imagerie médicale (CT scan)."
}
},
"itemMetadata": {
"createdAt": 1624172982039,
"updated": "2022-01-26T09:15:56.172Z",
"seenAt": "2022-01-26T09:15:56.171Z"
},
"tags": ["exp"],
"comments": [],
"metadata": {},
"annotationMetadata": {
"annotatedBy": "data@test.com",
"annotatedAt": "2021-06-21T09:31:00.795Z",
"createdAt": "2021-06-21T09:31:00.783Z"
},
"annotation": {
"ner": {
"entity": {
"entities": [
{
"value": "date",
"start_char": 39,
"end_char": 54,
"ent_id": 0
},
{
"value": "org",
"start_char": 118,
"end_char": 135,
"ent_id": 1
},
{
"value": "org",
"start_char": 79,
"end_char": 116,
"ent_id": 2
},
{
"value": "address",
"start_char": 140,
"end_char": 144,
"ent_id": 3
},
{
"value": "key",
"start_char": 0,
"end_char": 37,
"ent_id": 4
},
{
"value": "key",
"start_char": 55,
"end_char": 78,
"ent_id": 5
},
{
"value": "key",
"start_char": 146,
"end_char": 153,
"ent_id": 6
}
]
},
"relations": []
},
"classifications": {
"language": { "labels": [{ "value": "fr" }] }
}
},
"historicAnnotations": []
}