pearmut 0.2.6__py3-none-any.whl → 0.2.7__py3-none-any.whl

pearmut-0.2.6.dist-info/METADATA

@@ -1,350 +0,0 @@
-Metadata-Version: 2.4
-Name: pearmut
-Version: 0.2.6
-Summary: A tool for evaluation of model outputs, primarily MT.
-Author-email: Vilém Zouhar <vilem.zouhar@gmail.com>
-License: apache-2.0
-Project-URL: Repository, https://github.com/zouharvi/pearmut
-Project-URL: Issues, https://github.com/zouharvi/pearmut/issues
-Keywords: evaluation,machine translation,human evaluation,annotation
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: fastapi>=0.110.0
-Requires-Dist: uvicorn>=0.29.0
-Requires-Dist: wonderwords>=3.0.0
-Requires-Dist: psutil>=7.1.0
-Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Dynamic: license-file
-
-# Pearmut 🍐
-
-Pearmut is a **Platform for Evaluation and Reviewing of Multilingual Tasks**.
-It evaluates model outputs, primarily translation but also various other NLP tasks.
-Supports multimodality (text, video, audio, images) and a variety of annotation protocols ([DA](https://aclanthology.org/N15-1124/), [ESA](https://aclanthology.org/2024.wmt-1.131/), [ESA<sup>AI</sup>](https://aclanthology.org/2025.naacl-long.255/), [MQM](https://doi.org/10.1162/tacl_a_00437), paired ESA, etc).
-
-[![PyPi version](https://badgen.net/pypi/v/pearmut/)](https://pypi.org/project/pearmut)
-&nbsp;
-[![PyPI download/month](https://img.shields.io/pypi/dm/pearmut.svg)](https://pypi.python.org/pypi/pearmut/)
-&nbsp;
-[![PyPi license](https://badgen.net/pypi/license/pearmut/)](https://pypi.org/project/pearmut/)
-&nbsp;
-[![build status](https://github.com/zouharvi/pearmut/actions/workflows/test.yml/badge.svg)](https://github.com/zouharvi/pearmut/actions/workflows/test.yml)
-
-<img width="1000" alt="Screenshot of ESA/MQM interface" src="https://github.com/user-attachments/assets/4fb9a1cb-78ac-47e0-99cd-0870a368a0ad" />
-
-## Quick start
-
-You do not need to clone this repository. Simply install with pip and run locally:
-```bash
-# install the package
-pip install pearmut
-# download two campaign definitions
-wget https://raw.githubusercontent.com/zouharvi/pearmut/refs/heads/main/examples/esa_encs.json
-wget https://raw.githubusercontent.com/zouharvi/pearmut/refs/heads/main/examples/da_enuk.json
-# load them into pearmut
-pearmut add esa_encs.json
-pearmut add da_enuk.json
-# start pearmut (will show management links)
-pearmut run
-```
-
-## Starting a campaign
-
-First, install the package
-```bash
-pip install pearmut
-```
-
-A campaign is described in a single JSON file (see [examples/](examples/)).
-One of the simplest ones, where each user has a pre-defined list of tasks (`task-based`), is:
-```python
-{
-  "info": {
-    "assignment": "task-based",
-    "template": "pointwise",
-    "protocol_score": true,                 # we want scores [0...100] for each segment
-    "protocol_error_spans": true,           # we want error spans
-    "protocol_error_categories": false,     # we do not want error span categories
-  },
-  "campaign_id": "wmt25_#_en-cs_CZ",
-  "data": [
-    # data for first task/user
-    [
-      [
-        # each evaluation item is a document
-        {
-          "instructions": "Evaluate translation from en to cs_CZ",  # message to show to users above the first item
-          "src": "This will be the year that Guinness loses its cool. Cheers to that!",
-          "tgt": "Nevím přesně, kdy jsem to poprvé zaznamenal. Možná to bylo ve chvíli, ..."
-        },
-        {
-          "src": "I'm not sure I can remember exactly when I sensed it. Maybe it was when some...",
-          "tgt": "Tohle bude rok, kdy Guinness přijde o svůj „cool“ faktor. Na zdraví!"
-        }
-        ...
-      ],
-      # more document
-      ...
-    ],
-    # data for second task/user
-    [
-        ...
-    ],
-    # arbitrary number of users (each corresponds to a single URL to be shared)
-  ]
-}
-```
-In general, the task item can be anything and is handled by the specific protocol template.
-For the standard ones (ESA, DA, MQM), we expect each item to be a dictionary (corresponding to a single document unit) that looks as follows:
-```python
-# single document definition
-[
-  {
-    "src": "A najednou se všechna tato voda naplnila dalšími lidmi a dalšími věcmi.", # mandatory for ESA/MQM/DA
-    "tgt": "And suddenly all the water became full of other people and other people." # mandatory for ESA/MQM/DA
-  },
-  {
-    "src": "toto je pokračování stejného dokumentu",
-    "tgt": "this is a continuation of the same document",
-    ...  # all other keys that will be stored, useful for your analysis
-  }
-],
-... # definition of another item (document)
-```
-
-## Pre-filled Error Spans (ESA<sup>AI</sup> Support)
-
-For workflows where you want to provide pre-filled error annotations (e.g., ESA<sup>AI</sup>), you can include an `error_spans` key in each item.
-These spans will be loaded into the interface as existing annotations that users can review, modify, or delete.
-
-```python
-{
-  "src": "The quick brown fox jumps over the lazy dog.",
-  "tgt": "Rychlá hnědá liška skáče přes líného psa.",
-  "error_spans": [
-    {
-      "start_i": 0,         # character index start (inclusive)
-      "end_i": 5,           # character index end (inclusive)
-      "severity": "minor",  # "minor", "major", "neutral", or null
-      "category": null      # MQM category string or null
-    },
-    {
-      "start_i": 27,
-      "end_i": 32,
-      "severity": "major",
-      "category": null
-    }
-  ]
-}
-```
-
-For **listwise** template, `error_spans` is a 2D array where each inner array corresponds to error spans for that candidate.
-
-See [examples/esaai_prefilled.json](examples/esaai_prefilled.json) for a complete example.
-
-## Tutorial and Attention Checks
-
-You can add validation rules to items for tutorials or attention checks. Items with `validation` field will be checked before submission:
-
-```python
-{
-  "src": "The quick brown fox jumps.",
-  "tgt": "Rychlá hnědá liška skáče.",
-  "validation": {
-    "warning": "Please set score between 70-80.",  # shown on failure (omit for silent logging)
-    "score": [70, 80],                             # required score range [min, max]
-    "error_spans": [{"start_i": [0, 2], "end_i": [4, 8], "severity": "minor"}],  # expected spans
-    "allow_skip": true                             # show "skip tutorial" button
-  }
-}
-```
-
-- Tutorial items: Include `allow_skip: true` and `warning` to let users skip after seeing the feedback
-- Loud attention checks: Include `warning` without `allow_skip` to force users to retry
-- Silent attention checks: Omit `warning` to silently log failures without user notification (useful for quality control with bad translations)
-
-For listwise template, `validation` is an array where each element corresponds to a candidate. 
-The dashboard shows failed/total validation checks per user, and ✅/❌ based on whether they pass the threshold.
-Set `validation_threshold` in `info` to control pass/fail: integer for max failed count, float in [0,1) for max failed proportion.
-See [examples/tutorial_pointwise.json](examples/tutorial_pointwise.json) and [examples/tutorial_listwise.json](examples/tutorial_listwise.json) for complete examples.
-
-## Single-stream Assignment
-
-We also support a simple allocation where all annotators draw from the same pool (`single-stream`). Items are randomly assigned to annotators from the pool of unfinished items:
-```python
-{
-    "campaign_id": "my campaign 6",
-    "info": {
-        "assignment": "single-stream",
-        "template": "pointwise",
-        "protocol_score": True,                # collect scores
-        "protocol_error_spans": True,          # collect error spans
-        "protocol_error_categories": False,    # do not collect MQM categories, so ESA
-        "users": 50,                           # number of annotators (can also be a list, see below)
-    },
-    "data": [...], # list of all items (shared among all annotators)
-}
-```
-
-
-We also support dynamic allocation of annotations (`dynamic`, not yet ⚠️), which is more complex and can be ignored for now:
-```python
-{
-    "campaign_id": "my campaign 6",
-    "info": {
-        "assignment": "dynamic",
-        "template": "listwise",
-        "protocol_k": 5,
-        "users": 50,
-    },
-    "data": [...], # list of all items
-}
-```
-
-## Pre-defined User IDs and Tokens
-
-By default, user IDs and completion tokens are automatically generated. The `users` field can be:
-- A number (e.g., `50`) to generate that many random user IDs
-- A list of strings (e.g., `["alice", "bob"]`) to use specific user IDs
-- A list of dictionaries to specify user IDs with custom tokens:
-```python
-{
-    "info": {
-        ...
-        "users": [
-            {"user_id": "alice", "token_pass": "alice_done", "token_fail": "alice_fail"},
-            {"user_id": "bob", "token_pass": "bob_done"}  # missing tokens are auto-generated
-        ],
-    },
-    ...
-}
-```
-
-To load a campaign into the server, run the following.
-It will fail if an existing campaign with the same `campaign_id` already exists, unless you specify `-o/--overwrite`.
-It will also output a secret management link. Then, launch the server:
-```bash
-pearmut add my_campaign_4.json
-pearmut run
-```
-
-## Campaign options
-
-In summary, you can select from the assignment types
-
-- `task-based`: each user has a predefined set of items
-- `single-stream`: all users are annotating together the same set of items
-- `dynamic`: WIP ⚠️
-
-and independently of that select your protocol template:
-
-- `pointwise`: evaluate a single output given a single output
-  - `protocol_score`: ask for score 0 to 100
-  - `protocol_error_spans`: ask for highlighting error spans
-  - `protocol_error_categories`: ask for highlighting error categories
-- `listwise`: evaluate multiple outputs at the same time given a single output ⚠️
-  - `protocol_score`: ask for score 0 to 100
-  - `protocol_error_spans`: ask for highlighting error spans
-  - `protocol_error_categories`: ask for highlighting error categories
-
-## Campaign management
-
-When adding new campaigns or launching pearmut, a management link is shown that gives an overview of annotator progress but also an easy access to the annotation links or resetting the task progress (no data will be lost).
-This is also the place where you can download all progress and collected annotations (these files exist also locally but this might be more convenient).
-
-<img width="800" alt="Management dashboard" src="https://github.com/user-attachments/assets/800a1741-5f41-47ac-9d5d-5cbf6abfc0e6" />
-
-Additionally, at the end of an annotation, a token of completion is shown which can be compared to the correct one that you can download in metadat from the dashboard.
-An intentionally incorrect token can be shown if the annotations don't pass quality control.
-
-<img width="500" alt="Token on completion" src="https://github.com/user-attachments/assets/40eb904c-f47a-4011-aa63-9a4f1c501549" />
-
-
-## Multimodal Annotations
-
-We also support anything HTML-compatible both on the input and on the output.
-This includes embedded YouTube videos, or even simple `<video ` tags that point to some resource somewhere.
-For an example, try [examples/multimodal.json](examples/multimodal.json).
-Tip: make sure the elements are already appropriately styled.
-
-<img width="1000" alt="Preview of multimodal elements in Pearmut" src="https://github.com/user-attachments/assets/77c4fa96-ee62-4e46-8e78-fd16e9007956" />
-
-## CLI Commands
-
-Pearmut provides the following commands:
-
-- `pearmut add <file(s)>`: Add one or more campaign JSON files. Supports wildcards (e.g., `pearmut add examples/*.json`).
-  - `-o/--overwrite`: Overwrite existing campaigns with the same ID.
-  - `--server <url>`: Prefix server URL for protocol links (default: `http://localhost:8001`).
-- `pearmut run`: Start the Pearmut server.
-  - `--port <port>`: Port to run the server on (default: 8001).
-  - `--server <url>`: Prefix server URL for protocol links.
-- `pearmut purge [campaign]`: Remove campaign data.
-  - Without arguments: Purges all campaigns (tasks, outputs, progress).
-  - With campaign name: Purges only the specified campaign's data.
-
-
-## Hosting Assets
-
-To host local assets (e.g., audio files, images, videos), use the `assets` key in your campaign file:
-
-```python
-{
-    "campaign_id": "my_campaign",
-    "info": { 
-      "assets": {
-        "source": "videos",              # path to directory containing assets
-        "destination": "assets/my_videos"  # where to mount (must start with "assets/")
-      },
-      ...
-    },
-    "data": [ ... ]
-}
-```
-
-Files in `videos/` become accessible at `localhost:8001/assets/my_videos/`.
-This creates a symlink, so the source directory must exist throughout the annotation period.
-If another campaign already uses the destination path, the add command will fail.
-
-## Development
-
-Pearmut works by running a server that responds to requests from the frontend.
-These requests are not template-based but rather carry only data (which gives flexibility in designing new protocols and interfaces).
-By default, the frontend is served from `static/` which is pre-built when you `pip install pearmut`.
-To make changes locally, clone the repository and run the following, which will recompile the frontend on changes (server changes need server restart):
-```bash
-cd pearmut
-# watch the frontend for changes (in a separate terminal)
-npm install web/ --prefix web/
-npm run build --prefix web/ # `watch` for rebuild on code change
-
-# install local package as editable
-pip3 install -e .
-# add existing data from WMT25, this generates annotation links
-# sets up progress/log files in current working folder
-pearmut add examples/wmt25_#_en-cs_CZ.json
-pearmut add examples/wmt25_#_cs-de_DE.json
-# shows a management link for all loaded campaigns and reload on change
-pearmut run
-```
-
-Optionally, you can specify `--server` in `pearmut add` and `pearmut run` to show correct URL prefixes.
-The `pearmut run` also accepts `--port` (default 8001). 
-
-If you wish to create a new protocol (referenceable from `info->template`), simply create a new HTML and TS file in `web/src` and add a rule to `webpack.config.js` so that your template gets built.
-A template can call the server for data etc (see [web/src/pointwise.ts](web/src/pointwise.ts) as an exmple).
-
-To run the platform, you need to run this on some publicly-facing server, or run it locally and tunnel your port to a public IP/domain.
-
-## Citation
-
-If you use this work in your paper, please cite as:
-```bibtex
-@misc{zouhar2025pearmut,
-    author={Vilém Zouhar},
-    title={Pearmut: Platform for Evaluating and Reviewing of Multilingual Tasks},
-    url={https://github.com/zouharvi/pearmut/},
-    year={2025},
-}

pearmut-0.2.6.dist-info/licenses/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.