-
Notifications
You must be signed in to change notification settings - Fork 0
/
database_review.yaml
executable file
·170 lines (137 loc) · 6.23 KB
/
database_review.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
{
"port": 9001,
"server_name": "potato annotator",
"annotation_task_name": "Ambiguous questions to databases",
# Potato will write the annotation file for all annotations to this
# directory, as well as per-annotator output files and state information
# necessary to restart annotation.
"output_annotation_dir": "annotation_output_database_review/",
# The output format for the all-annotator data. Allowed formats are:
# * jsonl
# * json (same output as jsonl)
# * csv
# * tsvlss tex
#
"output_annotation_format": "json",
# If annotators are using a codebook, this will be linked at the top to the
# instance for easy access
"annotation_codebook_url": "",
"data_files": [
"data_files/attachment_1tab_val_databases/data.json"
],
"item_properties": {
"id_key": "id",
"text_key": "text",
"kwargs": ["item"]
},
# #list_as_text is used when the input text is actually a list of texts, usually used for best-worst-scaling
# "list_as_text": {
# "text_list_prefix_type": 'None',
# "horizontal": True,
# },
"user_config": {
"allow_all_users": True,
"users": [ ],
},
#defining the ways annotators entering the annotation system
"login": {
"type": 'url_direct', #can be 'password' or 'url_direct'
"url_argument": 'PROLIFIC_PID' # when the login type is set to 'url_direct', 'url_argument' must be setup for a direct url argument login
},
#the jumping-to-id function will be disabled if "jumping_to_id_disabled" is True
"jumping_to_id_disabled": True,
#the navigation bar will be hidden to the annotators if "hide_navbar" is True
"hide_navbar": True,
# define the surveyflow of the system, set up the pages before and after the data annotation page
"surveyflow": {
"on": False,
#"order" : ['pre_annotation', 'prestudy_passed', 'prestudy_failed', 'post_annotation'],
"order" : ['pre_annotation', 'post_annotation'],
"pre_annotation": [], # 'surveyflow/intro.jsonl', , 'surveyflow/Consent.jsonl'
"post_annotation": [],
# If set, we will automatically generate testing questions similar to the annotation instances, but explicitly ask the annotator to choose one option
# "testing": ['surveyflow/testing.jsonl'],
},
#prestudy test, annotators who fail this test will be disalloed to continue annotation
"prestudy": {
"on": False,
"minimum_score": 0.8,
"groundtruth_key": 'whether_match',
"question_key": 'Whether the presented sentences are discussing the same scientific finding',
"answer_mapping": {'Yes': True, 'No': False},
"pass_page": 'surveyflow/prestudy_pass.jsonl',
"fail_page": 'surveyflow/prestudy_fail.jsonl'
},
"automatic_assignment": {
#whether do automatic task assignment for annotators, default False.
"on": True,
"output_filename": 'task_assignment.json',
"sampling_strategy": 'ordered',
"labels_per_instance": 1,
"instance_per_annotator": 100,
"test_question_per_annotator": 0, # you must set up the test question in surveyflow to use this function
"users": [ ],
},
# How many seconds do you want the annotators spend on each instance, after
# that, an alert will be sent per alert_time_each_instance seconds.
"alert_time_each_instance": 10000000,
# "horizontal_key_bindings": true,
"annotation_schemes": [
{
"annotation_type": "radio",
"name": "vague_review",
"title": "Validate this database and item",
"description": "Validate this database and item",
# adding requirements for labels, when "required" is True, the annotators will be asked to finish the current instance to proceed
"label_requirement": {"required":False},
"horizontal": False,
"labels": [
"Ok", "Maybe", "Bad",
]
# If true, numbers [1-len(labels)] will be bound to each
# label. Aannotations with more than 10 are not supported with this
# simple keybinding and will need to use the full item specification
# to bind all labels to keys.
#"sequential_key_binding": True,
},
{
"annotation_type": "text",
"name": "comments",
"description": "Your Comments (optional)",
"title": "Your Comments (optional)",
# adding requirements for labels, when "required" is True, the annotators will be asked to finish the current instance to proceed
"label_requirement": {"required":False},
# if you want to use multi-line textbox, turn on the text area and set the desired rows and cols of the textbox
"textarea": {
"on": True,
"rows": 1,
"cols": 120
},
"allow_paste": True
# If true, numbers [1-len(labels)] will be bound to each
# label. Aannotations with more than 10 are not supported with this
# simple keybinding and will need to use the full item specification
# to bind all labels to keys.
#"sequential_key_binding": True,
}
],
# The html that changes the visualiztation for your task. Change this file
# to influence the layout and description of your task. This is not a full
# HTML page, just the piece that does lays out your task's pieces
#"html_layout": "templates/examples/fixed_keybinding_layout.html",
"html_layout": "templates/layout_review.html",
# The core UI files for Potato. You should not need to change these normally.
#
# Exceptions to this might include:
# 1) You want to add custom CSS/fonts to style your task
# 2) Your layout requires additional JS/assets to render
# 3) You want to support additional keybinding magic
#
# if you want to use your own template,
# please replace the string as a path to the template
"base_html_template": "default",
"header_file": "templates/header.html",
"surveyflow_html_layout": "templates/layout_surveyflow.html",
# This is where the actual HTML files will be generated
"site_dir": "default"
}