Difference between revisions of "User:Pankajksharma/Patcher"

From Apertium
Jump to navigation Jump to search
Line 1: Line 1:
−
Wiki page for GSoC work done by pankajksharma during GSoC 2014.
 +
Wiki page for GSoC work done by [[User:pankajksharma | pankajksharma]] during GSoC 2014.
  +
  +
Over here a screenshot of original algorithm along with how to use it is provided.
   
 
Application http://wiki.apertium.org/wiki/User:Pankajksharma/Application
  
Application http://wiki.apertium.org/wiki/User:Pankajksharma/Application
Line 5: Line 7:
 
For installation instructions, please visit: http://wiki.apertium.org/wiki/User:Pankajksharma/Patcher_Installation
  
For installation instructions, please visit: http://wiki.apertium.org/wiki/User:Pankajksharma/Patcher_Installation
   
  +
You can clone the project (using git) from https://github.com/pankajksharma/py-apertium
−
More information will be added soon.
  
−  
   
 
==Apertium Python Patcher==
  
==Apertium Python Patcher==
   
  +
For a given pair of sentences (S, S') having a Fuzzy match score above a certain threshold (simply put, similar to each other) in one natural language (say s). If T is the translation of S (say in another natural lanuguage t), the job of this patcher is to obtain T' i.e., the corresponding transaltion of S'.
−  
−
Takes an Apertium language pair, a source-language sentence S, and a target-language sentence T, and outputs the set of all possible pairs of subsegments (s,t) such that s is a subsegment of S, t a subsegment of T and t is the Apertium translation of s or vice-versa (a subsegment is a sequence of whole words).
  
   
 
See http://wiki.apertium.org/wiki/User:Pankajksharma/Application#Proposal for more detail.
  
See http://wiki.apertium.org/wiki/User:Pankajksharma/Application#Proposal for more detail.
   
 
===Algorithm===
  
===Algorithm===
−
Algorithm for the on the fly patching is developed by [[User:mlforcada|Mikel L. Forcada]] and [[User:pankajksharma|Pankaj K. Sharma]].
 +
This algorithm for on the fly patching is developed by [[User:mlforcada|Mikel L. Forcada]] and [[User:pankajksharma|Pankaj K. Sharma]].
   
 
[[File:on_the_fly_patcher.png]]
  
[[File:on_the_fly_patcher.png]]
  +
  +
==Scripts and how to run==
  +
  +
The project consists of multiple scripts. Here we've tried to provide a brief introduction, how to use and explain all possible options. Kindly reach the author if you face any difficulty.
   
 
===On the fly patching (repair.py)===
  
===On the fly patching (repair.py)===
   
−
usage: repair.py [-h] [-d D] [--min-fms MIN_FMS] [--min-len MIN_LEN]
 +
usage: repair.py [-h] [-v] [-t] [-c C] [-d D] [--cam] [--go]
−
[--max-len MAX_LEN]
 +
[--min-fms MIN_FMS] [--min-len MIN_LEN] [--max-len MAX_LEN]
 
S T S1 LP
  
S T S1 LP
   
  +
This is the main script which does on the fly patching for given (S, S1, T, LP).
−
On the fly repairing of sentence.
  
   
 
positional arguments:
  
positional arguments:
Line 42: Line 46:
 
-h, --help show this help message and exit
  
-h, --help show this help message and exit
   
−
-d D Specify the lanuguage-pair installation directory
 +
-v Verbose Mode
  +
  +
-t Show patching traces
  +
  +
-c C.db Specify the sqlite3 db to be used for caching
  +
  +
-d D Specify the lanuguage-pair installation directory
  +
  +
--cam Only those patches which cover all the mismatches
  +
  +
--go To patch only grounded mismatches
   
 
--min-fms MIN_FMS Minimum value of fuzzy match score of S and S1.
  
--min-fms MIN_FMS Minimum value of fuzzy match score of S and S1.
Line 49: Line 63:
   
 
--max-len MAX_LEN Maximum length of sub-segment allowed.
  
--max-len MAX_LEN Maximum length of sub-segment allowed.
  +
  +
example: python repair.py "the black dog was barking whole night" "el perro negro ladraba noche entera" "the black cat was barking whole night" en-es -v
   
 
===fms.py===
  
===fms.py===
Line 68: Line 84:
 
===reg_test.py===
  
===reg_test.py===
   
−
Regression test for our patcher
 +
Regression test for our patcher (repair.py). This script takes Out (the output of preprocess.py) and LP (the name of language pair).
   
−
usage: reg_test.py [-h] [-d D] [-v] [--mode MODE] [--min-fms MIN_FMS]
 +
usage: reg_test.py [-h] [-d D] [-c C] [-v] [--mode MODE] [--go]
−
[--min-len MIN_LEN] [--max-len MAX_LEN]
 +
[--min-fms MIN_FMS] [--min-len MIN_LEN] [--max-len MAX_LEN]
 
out LP
  
out LP
−  
   
 
positional arguments:
  
positional arguments:
  +
−  
−
out Output file generated from preprocess.py (en-es.pairs and en-es.pairs.s are included)
+
out Output file generated from test.py
   
 
LP Language Pair (sl-tl)
  
LP Language Pair (sl-tl)
Line 86: Line 101:
   
 
-d D Specify the lanuguage-pair installation directory
  
-d D Specify the lanuguage-pair installation directory
  +
  +
-c C Specify the sqlite3 db to be used for caching
   
 
-v Verbose Mode
  
-v Verbose Mode
   
−
--mode MODE Modes('all', 'cam', 'compare') default mode is all
 +
--mode MODE Modes('all', 'cam', 'compare')
  +
  +
--go To patch only grounded mismatches
   
 
--min-fms MIN_FMS Minimum value of fuzzy match score of S and S1.
  
--min-fms MIN_FMS Minimum value of fuzzy match score of S and S1.
Line 96: Line 115:
   
 
--max-len MAX_LEN Maximum length of sub-string allowed.
  
--max-len MAX_LEN Maximum length of sub-string allowed.
  +
   
 
Script understands following modes:
  
Script understands following modes:
Line 105: Line 125:
 
--compare Compares all reults for above two modes (verbose doesn't work in this mode)
  
--compare Compares all reults for above two modes (verbose doesn't work in this mode)
   
−
Example usage: python reg_test.py en-es.pairs en-es --mode compare
 +
Example usage: python reg_test.py pairs/en-es.pairs en-es --mode compare
   
   

Revision as of 10:55, 17 August 2014

Wiki page for GSoC work done by pankajksharma during GSoC 2014.

Over here a screenshot of original algorithm along with how to use it is provided.

Application http://wiki.apertium.org/wiki/User:Pankajksharma/Application

For installation instructions, please visit: http://wiki.apertium.org/wiki/User:Pankajksharma/Patcher_Installation

You can clone the project (using git) from https://github.com/pankajksharma/py-apertium

Apertium Python Patcher

For a given pair of sentences (S, S') having a Fuzzy match score above a certain threshold (simply put, similar to each other) in one natural language (say s). If T is the translation of S (say in another natural lanuguage t), the job of this patcher is to obtain T' i.e., the corresponding transaltion of S'.

See http://wiki.apertium.org/wiki/User:Pankajksharma/Application#Proposal for more detail.

Algorithm

This algorithm for on the fly patching is developed by Mikel L. Forcada and Pankaj K. Sharma.

On the fly patcher.png

Scripts and how to run

The project consists of multiple scripts. Here we've tried to provide a brief introduction, how to use and explain all possible options. Kindly reach the author if you face any difficulty.

On the fly patching (repair.py)

usage: repair.py [-h] [-v] [-t] [-c C] [-d D] [--cam] [--go] 

                [--min-fms MIN_FMS] [--min-len MIN_LEN] [--max-len MAX_LEN]
                S T S1 LP

This is the main script which does on the fly patching for given (S, S1, T, LP).

positional arguments: 

 S                  Second Sentence

 T                  First Sentence Translation

 S1                 Second Sentence

 LP                 Language Pair

optional arguments: 

 -h, --help         show this help message and exit

 -v                 Verbose Mode

 -t                 Show patching traces

 -c     C.db        Specify the sqlite3 db to be used for caching

 -d     D           Specify the lanuguage-pair installation directory

 --cam              Only those patches which cover all the mismatches

 --go               To patch only grounded mismatches

 --min-fms MIN_FMS  Minimum value of fuzzy match score of S and S1.

 --min-len MIN_LEN  Minimum length of sub-segment allowed.

 --max-len MAX_LEN  Maximum length of sub-segment allowed.

example: python repair.py "the black dog was barking whole night" "el perro negro ladraba noche entera" "the black cat was barking whole night" en-es -v

fms.py

usage: fms.py [-h] S S1

Provides FMS of strings S and S1 using Wagner-Fischer algorithm.

positional arguments: 

 S           First Sentence

 S1          Second Sentence

optional arguments: 

 -h, --help  show this help message and exit

reg_test.py

Regression test for our patcher (repair.py). This script takes Out (the output of preprocess.py) and LP (the name of language pair).

usage: reg_test.py [-h] [-d D] [-c C] [-v] [--mode MODE] [--go] 

                  [--min-fms MIN_FMS] [--min-len MIN_LEN] [--max-len MAX_LEN]
                  out LP

positional arguments: 

 out                Output file generated from test.py

 LP                 Language Pair (sl-tl)

optional arguments: 

 -h, --help         show this help message and exit

 -d D               Specify the lanuguage-pair installation directory

 -c C               Specify the sqlite3 db to be used for caching

 -v                 Verbose Mode

 --mode MODE        Modes('all', 'cam', 'compare')

 --go               To patch only grounded mismatches

 --min-fms MIN_FMS  Minimum value of fuzzy match score of S and S1.

 --min-len MIN_LEN  Minimum length of sub-string allowed.

 --max-len MAX_LEN  Maximum length of sub-string allowed.


Script understands following modes:

--all Includes all types of patched sentences

--cam Includes only those sentences which covers all mismatches

--compare Compares all reults for above two modes (verbose doesn't work in this mode)

Example usage: python reg_test.py pairs/en-es.pairs en-es --mode compare


preprocess.py

Preprocess the corpus for generating input for reg_test

usage: preprocess.py [-h] [-v] [--min-fms MIN_FMS] [--max-len MAX_LEN] 

                    SLF TLF SLFT TLFT OUT

positional arguments: 

 SLF                Source Language file for training

 TLF                Target Language file for training

 SLFT               Source Language file for testing

 TLFT               Target Language file for testing

 OUT                Output file for saving pairs

optional arguments: 

 -h, --help         show this help message and exit

 --min-fms MIN_FMS  Minimum value of fuzzy match score of S and S1(default 0.8)

 --max-len MAX_LEN  Maximum length of sentences allowed (default 25)

 example: python preprocess.py ../ap/mtacat/en.en-es.train ../ap/mtacat/es.en-es.train ../ap/mtacat/en.en-es.testset ../ap/mtacat/es.en-es.test en-es.pairs -v


file_stats.py

Calculates and show a histogram of the distribution of FMS between pair of sentences present in corpus F.

usage: file_stats.py [-h] [--min-fms MIN_FMS] F

positional arguments: 

 F                  Corpus path.

optional arguments: 

 -h, --help         show this help message and exit

 --min-fms MIN_FMS  Minimum value of fuzzy match score of S and S1.

stats.py

usage: stats.py [-h] [-d D] [--min-fms MIN_FMS] [--min-len MIN_LEN] 

               [--max-len MAX_LEN]
               D

Calulates FMS distribtution for all corpuses pressent in directory D.

positional arguments: 

 D                  Corpus directory.

optional arguments: 

 -h, --help         show this help message and exit

 -d D               Specify the lanuguage-pair installation directory

 --min-fms MIN_FMS  Minimum value of fuzzy match score of S and S1.

 --min-len MIN_LEN  Minimum length of sub-string allowed.

 --max-len MAX_LEN  Maximum length of sub-string allowed.

Set A generator

usage: A_generator.py [-h] [--min-fms MIN_FMS] [--min-len MIN_LEN] 

                     [--max-len MAX_LEN]
                     S S1

Generates set A.

positional arguments: 

 S                  First Sentence

 S1                 Second Sentence

optional arguments: 

 -h, --help         show this help message and exit

 --min-fms MIN_FMS  Minimum value of fuzzy match score of S and S1.

 --min-len MIN_LEN  Minimum length of sub-string allowed.

 --max-len MAX_LEN  Maximum length of sub-string allowed.


Example: python A_generator.py "some string" "some another string" --min-fms=0.6 --min-len=1 --max-len=3

Expected Output:

("some string", "some another string")

("string", "another string")


Set D generator

Usage: python D_generator.py --helpusage: D_generator.py [-h] [-d D] [--min-fms MIN_FMS] [--min-len MIN_LEN] [--max-len MAX_LEN] 

                     S T S1 LP

Generates set D.

positional arguments: 

 S                  Second Sentence

 T                  First Sentence Translation

 S1                 Second Sentence

 LP                 Language Pair

optional arguments: 

 -h, --help         show this help message and exit

 -d D               Specify the lanuguage-pair installation directory

 --min-fms MIN_FMS  Minimum value of fuzzy match score of S and S1.

 --min-len MIN_LEN  Minimum length of sub-string allowed.

 --max-len MAX_LEN  Maximum length of sub-string allowed.

Example: python D_generator.py "he changed his number recently" "Va canviar el seu número recentment" "he changed his address recently" en-ca

("Va canviar el seu", "Va canviar la seva adreça")

("Va canviar el seu número", "Va canviar el seu")

("Va canviar el seu número", "Va canviar la seva adreça")

("Va canviar el seu número recentment", "Va canviar la seva adreça recentment")

("El seu número", "El seu")

("El seu número", "La seva adreça")

("El seu número recentment", "La seva adreça recentment")

("Número recentment", "Recentment")

("Número recentment", "Adreça recentment")

pre_gsoc

For pre-SoC wok see [pre-soc/](https://github.com/pankajksharma/py-apertium/tree/master/pre_soc)

Retrieved from "https://wiki.apertium.org/w/index.php?title=User:Pankajksharma/Patcher&oldid=49854"