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

{pearmut-0.2.5.dist-info → pearmut-0.2.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pearmut
-Version: 0.2.5
+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
@@ -67,7 +67,6 @@ One of the simplest ones, where each user has a pre-defined list of tasks (`task
     "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
-    "instructions": "Evaluate translation from en to cs_CZ",  # message to show to users
   },
   "campaign_id": "wmt25_#_en-cs_CZ",
   "data": [
@@ -76,6 +75,7 @@ One of the simplest ones, where each user has a pre-defined list of tasks (`task
       [
         # 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, ..."
         },
@@ -288,22 +288,25 @@ Pearmut provides the following commands:
 
 ## Hosting Assets
 
-If you need to host local assets (e.g., audio files, images, videos) via Pearmut, you can use the `assets` key in your campaign file.
-When present, this directory is symlinked to the `static/` directory so its contents become accessible from the server.
+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": "videos",  # path to directory containing assets
+      "assets": {
+        "source": "videos",              # path to directory containing assets
+        "destination": "assets/my_videos"  # where to mount (must start with "assets/")
+      },
       ...
     },
     "data": [ ... ]
 }
 ```
 
-For example, if `videos` contains `audio.mp3`, it will be accessible at `localhost:8001/assets/videos/audio.mp3`.
-The path can be absolute or relative to your current working directory.
+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
 
@@ -333,6 +336,8 @@ 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:

{pearmut-0.2.5.dist-info → pearmut-0.2.6.dist-info}/RECORD

@@ -1,19 +1,19 @@
 pearmut/app.py,sha256=Q-DDm5zR42hA2YS0_lej6L4DDVV1cSEbYsp66ykBrss,8261
 pearmut/assignment.py,sha256=GvulwsPEguA_rNZB58bDKYy1wVZX9j4vnmbrKH4m0Mo,10963
-pearmut/cli.py,sha256=ff3UdCToXP_U1iKLHTAuHo9eDsK5G6d8ToVmSZ-6wYI,12582
+pearmut/cli.py,sha256=pXPuLeu1ow557SrpPvLR-5jc1de1rBY5bR5PmiFMJyc,17975
 pearmut/utils.py,sha256=TWcbdTehg4CNwCpc5FuEOszpQM464LY0IQHHE_Sq1Zg,5293
 pearmut/static/dashboard.bundle.js,sha256=GGg5lNwwgzejCi1ZAI-p2HKp-oI8DWAgfytAoTL8fNE,91782
 pearmut/static/dashboard.html,sha256=fN-B0jyeezMZP4qisGA7lmQem-FqvfDP1i5ziErQK2M,2120
 pearmut/static/index.html,sha256=SC5M-NSTnJh1UNHCC5VOP0TKkmhNn6MHlY6L4GDacpA,849
-pearmut/static/listwise.bundle.js,sha256=mqWzLYe2TJ-S3Q2NFS-9XuNtkLUcgc6QnXmQSqMW7Hs,106639
+pearmut/static/listwise.bundle.js,sha256=Q5bGsvUE2dD9Rzm-1ED_F5oNjx2TW733rAJ3yusEg0o,106742
 pearmut/static/listwise.html,sha256=4A0a_GMVIjJmqT3lhJMT9huqvwgvrRfztt0KA0lJxKI,5308
-pearmut/static/pointwise.bundle.js,sha256=P2y3Nl5Jk4oFszIRdtrvhNO6xpCgcoTSyuzSYt1E8ng,108685
+pearmut/static/pointwise.bundle.js,sha256=4iAhWIuyLK53BOr98ntWvJtKO00hNcgdCDuUviM_uK4,108818
 pearmut/static/pointwise.html,sha256=2NZYyjpznXP2b4GMeDcrjRYI5hZ45l7QgI-RQjkRUqs,5024
 pearmut/static/assets/favicon.svg,sha256=gVPxdBlyfyJVkiMfh8WLaiSyH4lpwmKZs8UiOeX8YW4,7347
 pearmut/static/assets/style.css,sha256=BrPnXTDr8hQ0M8T-EJlExddChzIFotlerBYMx2B8GDk,4136
-pearmut-0.2.5.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pearmut-0.2.5.dist-info/METADATA,sha256=XpegNIi9CdspqSw8f_j-J4wD2LQShTIL6vFEFiAJz5E,14381
-pearmut-0.2.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pearmut-0.2.5.dist-info/entry_points.txt,sha256=eEA9LVWsS3neQbMvL_nMvEw8I0oFudw8nQa1iqxOiWM,45
-pearmut-0.2.5.dist-info/top_level.txt,sha256=CdgtUM-SKQDt6o5g0QreO-_7XTBP9_wnHMS1P-Rl5Go,8
-pearmut-0.2.5.dist-info/RECORD,,
+pearmut-0.2.6.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pearmut-0.2.6.dist-info/METADATA,sha256=-bVVeR4r6Ah0hMwjzfMR9oGKFY2X3A2_v2RUaHW8sCc,14587
+pearmut-0.2.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pearmut-0.2.6.dist-info/entry_points.txt,sha256=eEA9LVWsS3neQbMvL_nMvEw8I0oFudw8nQa1iqxOiWM,45
+pearmut-0.2.6.dist-info/top_level.txt,sha256=CdgtUM-SKQDt6o5g0QreO-_7XTBP9_wnHMS1P-Rl5Go,8
+pearmut-0.2.6.dist-info/RECORD,,