Skip to content

CAMeL-Lab/ced_word_alignment

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Character Edit Distance Based Word Alignment

The purpose of this code is to find alignments between parallel sentences in the same language but with different spelling conventions. The ideal use case is that of source text with spelling errors, and its target corrected form.

Basic Approach

For each sentence, a basic edit distance based alignment is performed at the word level. This is followed by a post-processing step that looks at the context of the edit distance operations and decides the best match between the words within the sentence.

Assumptions

  • Sentences are aligned.
  • No changes to the word order.
  • Text is in the same script and encoding.

Contents

  • align_text.py main script that produces the alignments.
  • alignmnet.py basic alignment script that is used in the initial step.
  • requirements.txt necessary dependencies needed to run the scripts.
  • sample/ a directory with sample sentences for demonstrating the examples below.
  • README.md this document.

Requirements

  • Python 3.6 and above.

To use, you need to first install the necessary dependencies by running the following command:

pip install -r requirements.txt

Usage

Usage:
    align_text.py (-s SOURCE | --source=SOURCE)
               (-t TARGET | --target=TARGET)
               (-m MODE | --mode=MODE)
               (-o OUTPUT | --out OUTPUT)
    align_text.py (-h | --help) 

Options:
  -s SOURCE --source=SOURCE
        source/reference/gold sentences file
  -t TARGET --target=TARGET
        target/hypothesis/prediction sentences file
  -m MODE --mode=MODE
        Two modes to choose from: 
            1- 'align' To produce full alignments (one-to-many and many-to-one)
            2- 'basic' To produce basic alignments with operation and distance details (one-to-one)
  -o OUTPUT --output=OUTPUT
        Prefix for single output files
  -h --help
        Show this screen.

Examples from Arabic (Source/Refrence/Gold vs Target/Hypothesis/Prediction)

Inputs

Source/Refrence/Gold sentence

خالد : اممممممممممممممممم اذا بتروحون العصر اوكي ماعندي مانع بس لاتتأخرون

Target/Hypothesis/Prediction sentence

خالد : امم اذا بتروحون العصر اوكيه ما عندي مانع بس لا تتأخرون

Full alignment

python align_text.py -s sample/sample.ar.source -t sample/sample.ar.target -m align -o sample/sample.ar

Output

Source alignments are saved to: sample/sample.ar.source.align
Target alignments are saved to: sample/sample.ar.target.align
Side by side alignments are saved to: sample/sample.ar.coAlign

Side by side view (found in the .coAlign file)

Source/Refrence/Gold Target/Hypothesis/Prediction
خالد خالد
: :
اممممممممممممممممم امم
اذا اذا
بتروحون بتروحون
العصر العصر
اوكي اوكيه
ماعندي ما عندي
مانع مانع
بس بس
لاتتأخرون لا تتأخرون

Notes on output

You can notice here whenever there is a split or merge on either side they are collapsed on the respective side, thus, we can have one-to-many, and many-to-one cases.


Basic alignment

python align_text.py -s sample/sample.ar.source -t sample/sample.ar.target -m basic -o sample/sample.ar

Output

Basic alignments are saved to: sample/sample.ar.basic
Source/Refrence/Gold op Target/Hypothesis/Prediction Alignment Details
خالد = خالد (1, 1, 'n', 0)
: = : (2, 2, 'n', 0)
اممممممممممممممممم | امم (3, 3, 's', 1.7)
اذا = اذا (4, 4, 'n', 1.7)
بتروحون = بتروحون (5, 5, 'n', 1.7)
العصر = العصر (6, 6, 'n', 1.7)
اوكي | اوكيه (7, 7, 's', 2.1)
< ما (None, 8, 'i', 3.1)
ماعندي | عندي (8, 9, 's', 3.7)
مانع = مانع (9, 10, 'n', 3.7)
بس = بس (10, 11, 'n', 3.7)
< لا (None, 12, 'i', 4.7)
لاتتأخرون | تتأخرون (11, 13, 's', 5.2)

Notes on output

  • Operations generated are those applied to the Source to generate the target.

  • Operations (op) are defined as follows:

op Description
= No change (n)
| Substitution (s)
< Insertion (i)
> Deletion (d)
  • Alignment Details is a compact representation of the alignment:
(<source_idx>, <targe_idx>, op, editdistance_score)

License

ced_word_alignment is available under the MIT license. See the LICENSE file for more info.

About

A character edit distance based word aligner.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages