pearmut 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
pearmut/constants.py ADDED
@@ -0,0 +1,93 @@
1
+ """Default instructions for different annotation protocols."""
2
+
3
+ # Default instructions for each protocol
4
+ # These are used when no custom instructions are provided
5
+ PROTOCOL_INSTRUCTIONS = {
6
+ "DA": """
7
+ <ul>
8
+ <li>Score each translation using the slider based on meaning preservation and quality.
9
+ <strong>Important:</strong> The relative order of scores matters; ensure better translations have higher
10
+ scores than worse ones.
11
+ <ul>
12
+ <li>0: <strong>Nonsense</strong>: most information is lost.</li>
13
+ <li>33%: <strong>Broken</strong>: major gaps and narrative issues.</li>
14
+ <li>66%: <strong>Middling</strong>: minor issues with grammar or consistency.</li>
15
+ <li>100%: <strong>Perfect</strong>: meaning and grammar align completely with the source.</li>
16
+ </ul>
17
+ </li>
18
+ </ul>
19
+ """,
20
+ "ESA": """
21
+ <ul>
22
+ <li>Error spans:
23
+ <ul>
24
+ <li><strong>Click</strong> on the start of an error, then <strong>click</strong> on the end to mark an
25
+ error span.</li>
26
+ <li><strong>Hover</strong> over an existing highlight to change error severity (minor/major) or remove it.
27
+ </li>
28
+ </ul>
29
+ Error severity:
30
+ <ul>
31
+ <li><span class="instruction_sev" id="instruction_sev_minor">Minor:</span> Style, grammar, or word choice
32
+ could be better.</li>
33
+ <li><span class="instruction_sev" id="instruction_sev_major">Major:</span> Meaning is significantly
34
+ changed or is hard to understand.</li>
35
+ </ul>
36
+ <strong>Tip</strong>: Mark the general area of the error (doesn't need to be exact). Use separate highlights
37
+ for different errors.
38
+ Use <code>[missing]</code> at the end of a sentence for omitted content.<br>
39
+ </li>
40
+ <li>Score each translation using the slider based on meaning preservation and quality.
41
+ <strong>Important:</strong> The relative order of scores matters; ensure better translations have higher
42
+ scores than worse ones.
43
+ <ul>
44
+ <li>0: <strong>Nonsense</strong>: most information is lost.</li>
45
+ <li>33%: <strong>Broken</strong>: major gaps and narrative issues.</li>
46
+ <li>66%: <strong>Middling</strong>: minor issues with grammar or consistency.</li>
47
+ <li>100%: <strong>Perfect</strong>: meaning and grammar align completely with the source.</li>
48
+ </ul>
49
+ </li>
50
+ </ul>
51
+ """,
52
+ "MQM": """
53
+ <ul>
54
+ <li>Error spans:
55
+ <ul>
56
+ <li><strong>Click</strong> on the start of an error, then <strong>click</strong> on the end to mark an
57
+ error span.</li>
58
+ <li><strong>Hover</strong> over an existing highlight to change error severity (minor/major) or remove it.
59
+ </li>
60
+ </ul>
61
+ Error severity:
62
+ <ul>
63
+ <li><span class="instruction_sev" id="instruction_sev_minor">Minor:</span> Style, grammar, or word choice
64
+ could be better.</li>
65
+ <li><span class="instruction_sev" id="instruction_sev_major">Major:</span> Meaning is significantly
66
+ changed or is hard to understand.</li>
67
+ </ul>
68
+ <strong>Tip</strong>: Mark the general area of the error (doesn't need to be exact). Use separate highlights
69
+ for different errors.
70
+ Use <code>[missing]</code> at the end of a sentence for omitted content.<br>
71
+ </li>
72
+ <li>Score each translation using the slider based on meaning preservation and quality.
73
+ <strong>Important:</strong> The relative order of scores matters; ensure better translations have higher
74
+ scores than worse ones.
75
+ <ul>
76
+ <li>0: <strong>Nonsense</strong>: most information is lost.</li>
77
+ <li>33%: <strong>Broken</strong>: major gaps and narrative issues.</li>
78
+ <li>66%: <strong>Middling</strong>: minor issues with grammar or consistency.</li>
79
+ <li>100%: <strong>Perfect</strong>: meaning and grammar align completely with the source.</li>
80
+ </ul>
81
+ </li>
82
+ <li>
83
+ Error types:
84
+ After highlighting an error fragment, you will be asked to select the specific error type (main category and
85
+ subcategory).
86
+ If you are unsure about which errors fall under which categories, please consult the <a
87
+ href="https://themqm.org/the-mqm-typology/"
88
+ style="font-weight: bold; text-decoration: none; color: black;">typology
89
+ definitions</a>.
90
+ </li>
91
+ </ul>
92
+ """,
93
+ }