diff options
Diffstat (limited to 'python/README.md')
| -rw-r--r-- | python/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/python/README.md b/python/README.md new file mode 100644 index 00000000..da9f9387 --- /dev/null +++ b/python/README.md @@ -0,0 +1,29 @@ +pycdec is a Python interface to cdec + +## Installation + +Build and install pycdec: + + python setup.py install + +## Grammar extractor + +Compile a parallel corpus and a word alignment into a suffix array representation: + + python -m cdec.sa.compile -f f.txt -e e.txt -a a.txt -o output/ -c extract.ini + +Extract grammar rules from the compiled corpus: + + cat input.txt | python -m cdec.sa.extract -c extract.ini -g grammars/ + +This will create per-sentence grammar files in the `grammars` directory and output annotated input suitable for translation with cdec. + +## Library usage + +A basic demo of pycdec's features is available in `test.py` + +More documentation will come as the API becomes stable. + +--- + +pycdec was contributed by [Victor Chahuneau](http://victor.chahuneau.fr) |