Skip to content

Commit

Permalink
Merge pull request #91 from mevbagci/patch-4
Browse files Browse the repository at this point in the history
Update Tutorial.md
  • Loading branch information
Myyyvothrr authored Aug 14, 2024
2 parents 2bc0013 + 81b28b8 commit 77215e1
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/tutorial/Tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ The Lua script is used as a communication interface between the annotation tool
The script contains two parts, the first being the `serialize` function that is called to transform the CAS object into a stream that is sent to the annotation tool.
The second part is the `deserialize` function that is utilized to transform the output of the annotation tool back into the CAS object.
For different examples of Lua scripts you can check our tutorials.
[![](https://mermaid.ink/img/pako:eNqNU9luwyAQ_BXEc9IPcKVKjnNVclTJSdXD5IGadYxkwMKgqo3y78VGoY578sTu7O4MAxxxoRjgCJe1ei0qqg1Ks2sikVutfTlo2lQollIZariSKFGiURKk8SUIrXOCB_hOqZrgPTrDYUZ6H4fkBdCC5rTm7zBEu8W4hqIfmmZjbOFYk3iLiAN2msq2VFpweeiop9MbtMzvrGms2RoNVOyH7SDZtzoY_ENJlo6xlVPyoLkBRIMLTsUPjGEbNoG_d9ZJ-OwM0LPjQKOhv_kT53NVWOFuybsxyzOgDPRowIUTgezpD7KxBUneH197qnn-uLkd9H498FfZMzS9cq0LHy19tPbR2kXI3yXq0iufXvmiBE-wAC0oZ-4JHzuMYFOBAIIjt2VQUlsbgok8uVJqjdq-yQJHRluYYK3socJRSevWRbZh1MCcU-eDOJcA40bpjf8j_Vc5fQA4R-qm?type=png)](https://mermaid.live/edit#pako:eNqNU9luwyAQ_BXEc9IPcKVKjnNVclTJSdXD5IGadYxkwMKgqo3y78VGoY578sTu7O4MAxxxoRjgCJe1ei0qqg1Ks2sikVutfTlo2lQollIZariSKFGiURKk8SUIrXOCB_hOqZrgPTrDYUZ6H4fkBdCC5rTm7zBEu8W4hqIfmmZjbOFYk3iLiAN2msq2VFpweeiop9MbtMzvrGms2RoNVOyH7SDZtzoY_ENJlo6xlVPyoLkBRIMLTsUPjGEbNoG_d9ZJ-OwM0LPjQKOhv_kT53NVWOFuybsxyzOgDPRowIUTgezpD7KxBUneH197qnn-uLkd9H498FfZMzS9cq0LHy19tPbR2kXI3yXq0iufXvmiBE-wAC0oZ-4JHzuMYFOBAIIjt2VQUlsbgok8uVJqjdq-yQJHRluYYK3socJRSevWRbZh1MCcU-eDOJcA40bpjf8j_Vc5fQA4R-qm)
```mermaid
flowchart LR;
subgraph Annotation Component
Expand Down Expand Up @@ -122,6 +123,7 @@ Docker is used to run the tool.
Docker containers are used to ensure that the analysis is performed in the same environment, regardless of the underlying host system.
Also, the Docker container is used to ensure that the analysis is reproducible, because every build of the Docker container is versioned, containing all needed code and data (e.g. model files).
The diagram below shows the structure of a Dockerfile:
[![](https://mermaid.ink/img/pako:eNp1kTtrwzAQgP_KoTleO3goxJYNHgqBkqnuoEhnR1Qv9Cg1If-9igSNly7HffqO03F3I9wKJC25KMu_mgtGNhsA4FYlbQK8FDp-zIRmjx4mzVacyScExzhCl83w42xAoOfzBCfr49P22U4mRKYUUHRoBBouMTwrSvua_hd3JeNjDlykQRhM9Juz0uy-G_b6W3prNO49zb63boNRqjJEaV0CHKFpXqGr0BXoK_QFaAVaYKgwFBjJgWj0mkmR93h7qJnEK-q8pjanAheWVB5jNvdcylK075vhpI0-4YF4m9YraRemQqbkBItIJVs903-vKGS0_q1eqhzs_guFyIvu?type=png)](https://mermaid.live/edit#pako:eNp1kTtrwzAQgP_KoTleO3goxJYNHgqBkqnuoEhnR1Qv9Cg1If-9igSNly7HffqO03F3I9wKJC25KMu_mgtGNhsA4FYlbQK8FDp-zIRmjx4mzVacyScExzhCl83w42xAoOfzBCfr49P22U4mRKYUUHRoBBouMTwrSvua_hd3JeNjDlykQRhM9Juz0uy-G_b6W3prNO49zb63boNRqjJEaV0CHKFpXqGr0BXoK_QFaAVaYKgwFBjJgWj0mkmR93h7qJnEK-q8pjanAheWVB5jNvdcylK075vhpI0-4YF4m9YraRemQqbkBItIJVs903-vKGS0_q1eqhzs_guFyIvu)
```mermaid
block-beta
columns 6
Expand All @@ -138,6 +140,7 @@ block-beta

# Rest Interface
The DUUI is designed to be used with REST interface, which is defined as:
[![](https://mermaid.ink/img/pako:eNpV0MtqwzAQBdBfEQPZJYRuXSiksZNuSkJtuqlKGaRJbLAe6FEwIf_eqUKKu9PMPTDiXkA5TVDBOaDvRVc_Srv5kPDWtJ2ET7FaPYlnnvdNJ9bfD-s0eYpTTGQ4ZVrAdga0U9mQTZgGZ2emnhnljMl2UMV8jThRmMmG5fHQ3qgPTlGMJV4stgXsGGysdXzDhX_JnpN3CvF--r5_4f3B_17DURwxoKHEjA0swVAwOGju4CKtEBJST4YkVPzUdMI8JgnSXpliTq6drIIqhUxLCC6fe6hOOEaesteYqB6QuzR_W9IDf_P11nIp-_oDP5h3lg?type=png)](https://mermaid.live/edit#pako:eNpV0MtqwzAQBdBfEQPZJYRuXSiksZNuSkJtuqlKGaRJbLAe6FEwIf_eqUKKu9PMPTDiXkA5TVDBOaDvRVc_Srv5kPDWtJ2ET7FaPYlnnvdNJ9bfD-s0eYpTTGQ4ZVrAdga0U9mQTZgGZ2emnhnljMl2UMV8jThRmMmG5fHQ3qgPTlGMJV4stgXsGGysdXzDhX_JnpN3CvF--r5_4f3B_17DURwxoKHEjA0swVAwOGju4CKtEBJST4YkVPzUdMI8JgnSXpliTq6drIIqhUxLCC6fe6hOOEaesteYqB6QuzR_W9IDf_P11nIp-_oDP5h3lg)
```mermaid
graph TD;
A["REST"] --> B["GET /v1/typesystem"]
Expand All @@ -157,7 +160,7 @@ The REST interface is used as a standardized way to communicate with the DUUI.

# Tutorials
We have prepared three tutorials with different levels of complexity. All tutorials use Python as the programming platform, however, all languages where a REST service can be created could be used as base for a DUUI tool.

[![](https://mermaid.ink/img/pako:eNptkDFvwyAQhf8KuiVLIu-ui5Taqrp0craQ4QJnG8Vgi0LVKsp_75lWHiozIHh3993Tu4OeDEEJfcB5EKfmSXnB53g-pTgFi-PlcJAv5wrFEKh73sU_uWjJR-v42snqKlvr5pHEKlbFVVYFyssWrtnAvWGkeiB9y7ij-USvSSyqyPIK3DRYbxBfUcc8an2fofW0ePwSS-E_FPbgKDi0hrO4LysUxIEcKSj5aajDNEYFyj-4FXlH--01lDEk2kOYUj9A2eH4wb80G7bdWORM3aqSsWzs_TftHPrjB1xuf0M?type=png)](https://mermaid.live/edit#pako:eNptkDFvwyAQhf8KuiVLIu-ui5Taqrp0craQ4QJnG8Vgi0LVKsp_75lWHiozIHh3993Tu4OeDEEJfcB5EKfmSXnB53g-pTgFi-PlcJAv5wrFEKh73sU_uWjJR-v42snqKlvr5pHEKlbFVVYFyssWrtnAvWGkeiB9y7ij-USvSSyqyPIK3DRYbxBfUcc8an2fofW0ePwSS-E_FPbgKDi0hrO4LysUxIEcKSj5aajDNEYFyj-4FXlH--01lDEk2kOYUj9A2eH4wb80G7bdWORM3aqSsWzs_TftHPrjB1xuf0M)
```mermaid
graph TD;
A[Tutorial]-->B[<a href='tutorial/Sentiment'><b>Simple Sentiment</b></a>]
Expand Down

0 comments on commit 77215e1

Please sign in to comment.