apiergentili commited on
Commit
3a54dbf
1 Parent(s): 17e0e5a

Remove dash from script name

Browse files

# Why is the change needed?

Currently, the script that allows to adapt Neo-GATE to the given neomorpheme paradigm is named `neo-gate_adapt.py`.
The dash (or hyphen) in the name makes importing code from the script more complex than it needs to be, due to how Python handles dashes.

While there are ways to import scripts that include dashes in their name, removing the dash would make it easier to import code from the script and make the naming more coherent with the evaluation code published in [fbk-NEUTR-evAL](https://github.com/hlt-mt/fbk-NEUTR-evAL/blob/main/src/fbk_neutreval/cli/neogate_evaluation.py).

# What changes does the patch introduce?

This changes renames `neo-gate_adapt.py` into `neogate_adapt.py`.
It also updates the repository's README file to reflect this change and corrects a typo.

# How was this patch tested?

No test required.

README.md CHANGED
@@ -66,7 +66,7 @@ Please refer to [the original paper](https://arxiv.org/abs/2405.08477) for full
66
 
67
  ## Curation rationale
68
 
69
- Neo-GATE was designed to allow for the evalution of gender-inclusive MT and to be adaptable to any neomorpheme paradigm in Italian.
70
  To this aim, the original Italian references found in GATE were edited so as to have placeholder tags in place of gendered morphemes and function words (articles, possessive adjectives, etc.) referred to human entities.
71
  The tags were designed to cover all parts of the grammar which express grammatical gender, and to be replaced with corresponding forms in the desired neomorpheme paradigm.
72
 
@@ -76,15 +76,15 @@ To adapt Neo-GATE to the desired neomorpheme paradigm, a `.json` file mapping Ne
76
  See `schwa.json` or `asterisk.json` for an example.
77
  For more information on the tagset, see Table 8 in [the original paper](https://arxiv.org/abs/2405.08477).
78
 
79
- To create the adapted references and annotations, use the `neo-gate_format.py` script with the following syntax:
80
 
81
- python neo-gate_adapt.py --tagset JSON_FILE_PATH --out OUTPUT_FILE_NAME
82
 
83
  This command will create two files: `OUTPUT_FILE_NAME.ref`, containing the adapted references, and `OUTPUT_FILE_NAME.ann`, containing the adapted annotations.
84
 
85
  For instance, to generate the references and the annotations adapted to the Schwa paradigm provided in the example file `schwa.json`, the following command can be used:
86
 
87
- python neo-gate_adapt.py --tagset schwa.json --out neogate_schwa
88
 
89
  This will create the two files `neogate_schwa.ref` and `neogate_schwa.ann`.
90
 
 
66
 
67
  ## Curation rationale
68
 
69
+ Neo-GATE was designed to allow for the evaluation of gender-inclusive MT and to be adaptable to any neomorpheme paradigm in Italian.
70
  To this aim, the original Italian references found in GATE were edited so as to have placeholder tags in place of gendered morphemes and function words (articles, possessive adjectives, etc.) referred to human entities.
71
  The tags were designed to cover all parts of the grammar which express grammatical gender, and to be replaced with corresponding forms in the desired neomorpheme paradigm.
72
 
 
76
  See `schwa.json` or `asterisk.json` for an example.
77
  For more information on the tagset, see Table 8 in [the original paper](https://arxiv.org/abs/2405.08477).
78
 
79
+ To create the adapted references and annotations, use the `neogate_adapt.py` script with the following syntax:
80
 
81
+ python neogate_adapt.py --tagset JSON_FILE_PATH --out OUTPUT_FILE_NAME
82
 
83
  This command will create two files: `OUTPUT_FILE_NAME.ref`, containing the adapted references, and `OUTPUT_FILE_NAME.ann`, containing the adapted annotations.
84
 
85
  For instance, to generate the references and the annotations adapted to the Schwa paradigm provided in the example file `schwa.json`, the following command can be used:
86
 
87
+ python neogate_adapt.py --tagset schwa.json --out neogate_schwa
88
 
89
  This will create the two files `neogate_schwa.ref` and `neogate_schwa.ann`.
90
 
neo-gate_adapt.py → neogate_adapt.py RENAMED
File without changes