A project is a collection of documents and rules to annotate documents manually or automatically.
Creating a project
Once you have signed up and you have a user account, you are ready to create a new project.
1Choose a name for your project
2Choose a description for your project. Remember each project has a guidelines section where you can go into detail about the characteristics of your project.
If you selected some machines when you created your project, you probably want to start importing text to tagtog. Otherwise, you need to configure the project's settings either to annotate manually or automatically.
You can write the annotation guidelines for you or your team. It should define what and how to manually annotate. The more clear it is, the better the annotations and the training data you can generate.
Edit you turn on the mode to edit the guidelines. Clicking on
View you are on the preview mode and you can see the results of your changes. Once it is ready, just save it .
Only users with admin role can edit the guidelines.
Here you select which sections you want to manually or automatically annotate in scientific papers. The available sections are:
Introduction & Background,
Materials & Methods,
Results, Conclusion & Discussion,
Other. The sections not selected will be grayed out in the editor and manual annotations disabled.
You can also select how to annotate
Figures & Tables as in
To disable manual annotation, uncheck each section. Users will be able to read text in the editor as usual, however manual annotation won't be possible.
Here you should define what type of information you want to annotate manually or automatically. Meaning, which type of information you want to identify or annotate in text. You achieve this by defining
Entity Types (a.k.a. Entity Classes).
You must add one or more entity types. Each entity is defined by a
description (optional) and
color. For example in the project in the picture above we want to extract vehicle information and for that we have created entity types to annotate vehicle parts (
vehiclePart), vehicle types, (
vehicleType) and vehicle model (
vehicleModel). In order to easily identify the entities in the text, we will assign to each entity type a color.
As soon as you create one entity type, this will appear in the
Dictionaries panel. Each entity type can have associated one or more dictionaries (Dictionary format). From here you can upload, replace or download dictionaries.
As an example of dictionary, let's use the entity type
vehicleModel. For example,
Volkswagen Golf 7,
Golf Mk7 and
Golf VII all identify the same canonical or unique object, this object can be identified with an ID, e.g.:
VWGOLF7. Let's create our entry in the dictionary:
When you create a dictionary, you don't need to cover cases as plural, tenses, etc. tagtog uses the dictionary entries and applies grammar rules to identify potential entities doing such modifications for you.
In order to upload a dictionary, you first need to create a dictionary. Click on
New Dictionary under the entity type name and Save it. Two options will show up:
Download Dictionary and
Upload/Replace: you can use this option to upload a dictionary file. If the file was uploaded previously, it will be replaced with the new dictionary. Once you uploaded a dictionary, all new text imported is annotated automatically following the dictionary rules.
Download: you can use this option to download the dictionary being used in tagtog to your computer. This is very useful to make large edit operations and later replace the existing dictionary.
Dictionaries are automatically updated if a user adds new normalizations using the web editor. More information.
You can annotate relations in text. For that you must first create a new
Relation Type by clicking the
New Relation Type button. After just choose two Entity Types, those types you want to identify relations for. Optionally you can add a
description for the relation. For example, a new relation type between vehicle parts and vehicle models.
Currently you cannot extract relations in text automatically. However, as a workaround, you can extract the entities automatically and based on the distance in text, infer a relation.
Labels used to mark the documents or text you import. It is another type of annotation, but affecting the whole document.
To create a new Document Label, click on the button
New Document Label. Then, write a
name for the label (required),
type (required) and
You can create different types of Document Labels:
||The simplest label. Basically you mark the document as
||One or more words describing a document. This is particularly handy whether you don't have a specific list of options or if you do, it might change often. e.g. which disease is related to this clinical profile?|
||list of options which can describe a document. In this case the options should be written in the description of the label separated by commas. e.g. severity of the error report could be: low, medium, high or critical.|
Once saved, you can start using them on the web editor.
Soon you will be able to generate document labels automatically within tagtog. Now, as a workaround, you can infer the document label based on the entities extracted automatically.
Labels used to add attributes to existing entities. It is usual some attributes make sense only to some entity types (e.g. gender for person, not for city), you can assign an entity label to one specific entity type or all entity types.
To create a new Entity Label, click on the button
New Document Label. Then, write a
name for the label (required),
entity type you want to assign the label to (required), and a
You can create different types of Entity Labels:
||The simplest label. Basically you mark an entity as
||One or more words describing an entity. This is particularly handy whether you don't have a specific list of options or if you do, it might change often. e.g. you can add comments to entities.|
||list of options to describe an entity. In this case the options should be written in the description of the label separated by commas. e.g. if you are processing CVs you could add an entity label to the entities identifying skills. This enum entity label
By default, the new entity labels will be assigned to all entity types. Otherwise, you can choose or filter an entity type from the list of entity types.
Once saved, you can start using them on the web editor. When you add a label to an entity, remember that only those labels related to the entity type of the entity will show.
Soon you will be able to generate entity labels automatically within tagtog.
The webhooks are useful to integrate tagtog within your system. You can define webhooks to notify automatically an external system after a specific event in tagtog or API.
These events are:
|Import new document||A notification is sent when the user uploads a document.||
|Save document||A notification is sent when the user saves a document.||
When any of those events is triggered, we'll send a HTTP POST payload to the webhook's configured End Point URL.
We also send information in the delivery HTTP headers for you to better process the event:
||Source of the event. Possible values:
||Type of event. Possible values:
This is the required information to configure a webhook:
|End Point||URL pointing to the external system|
|Format||Format of the payload to be sent to the End Point. Currently you can select:
|Only GUI trigger||Check it if you want only GUI changes to trigger the webhook. Leave it unchecked if you want that both, API and GUI changes, trigger the webhook.|
These are the annotations that are created automatically while you are manually annotating a document. For example, if you annotate the gene:
BRA2. All the mentions of
BRA2 in this text will be automatically annotated (more information on pre-annotations).
In this panel you can decide which are the default settings for pre-annotations: pre-selections, pre-deselections and their case sensitivity. You can always change these settings on the web editor for specific documents.
Each time you press the button
Confirm in the annotation editor, in the background, a machine learning model is being trained with all the project documents confirmed. Next time you upload a new document, this model can predict new annotations based on this model. You can remove or add new annotations to continue training the model and get more accurate results.
If activated, machine learning will start annotating automatically from the first document confirmed. No deployments or complex configurations are required, just by annotating you can train a use a machine learning model.
If you don't want to use machine learning, deactivate this option.
More information on how Machine Learning works in tagtog.
Check this option to annotate directly over the native PDF document. This web interface only works with PDF files. If this option is unchecked, only the plain text stripped from the PDF is annotatable.
Take into consideration that if the PDF file is imported with the option unchecked, only the plain text version will be available for annotation. If you import the file with this option checked, both versions will be available: the native PDF annotation and the plain text annotation when the option is unchecked.
Find more information of the PDF annotation tool here.
In this panel you can invite and organize other users in your project, so they can collaborate in the annotation tasks. See for more info about roles and collaborative annotation.
Invite other users to your project
To add a new member simply write the tagtog username in the text box, choose the role, and click on
Add Member. Once added, they will receive an email notification.
With this setting you can automatically distribute the project's documents among your annotators. For example, if you choose 1 annotator, every uploaded document will be randomly assigned to one project's member to annotate. Otherwise, for example, if you choose 2 annotators, every uploaded document will be randomly assigned to 2 project's members; that is, every document will have to be annotated by at least 2 annotators. You can choose between different flows to annotate documents in group. Find here the options.
This overlapping is recommended to increase the overall quality of your annotation project. Using it, tagtog compares the annotations from different annotators to calculate their level of agreement (inter-annotator agreement), a good indicator of quality. For more information about quality management at tagtog, go here
In this section you can decide whether the project's owner (the person who created the project) should be assigned documents to annotate or not.
By default documents are not distributed, and therefore members annotate directly on the
master version. Once the task distribution is activated (number of annotators per document is 1 or more), members annotate on their own independent version.
When task distribution is activated, project members see by default (in Documents) the special search view
filter:TODO. This view lists the documents that the annotator still has to annotate or review, if any.
Only users with the role
admin can see/edit these project settings.
Export the project's settings (entity types, relation types, entity labels, document labels, etc.) as a JSON file to reuse as a template on new projects.
Import another project's settings. This will overwrite your current settings and remove all your project's documents. This should be applied solely on new projects.
Edit Project Description
You can change the description of your project at any moment. Just type the new description and click on Save.
Remove a project
To remove a project, go to its Settings > Admin. Click on the
Delete Project button. Please notice that removing a project will remove all the documents within the project.
Your project has also a tab “Downloads” to… download stuff 😉. Depending on your role in the project, and whether the project is public or private, you will see different actionable buttons.
In particular, with the button
Download All Documents (and their annotations) you can download as a Zip file all your project’s documents and their annotations (in anndoc format). This button is available only to project admins in private projects. It is available to all logged-in users in public projects.
Moreover, an analogous button
Download as Zip is present in all document searches and folders (“Documents” tab) to download as Zip the subset of documents that match the search.