summaryrefslogtreecommitdiff
path: root/README
blob: 47b5235511101e617ee988e83a96734fb6d8965f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
cdec is a fast decoder.

SPEED COMPARISON
------------------------------------------------------------------------------

Here is a comparison with a couple of other decoders doing SCFG decoding:

  Decoder  Lang.   BLEU    Run-Time        Memory
  cdec     c++     31.47   0.37 sec/sent   1.0-1.1GB
  Joshua   Java    31.55   2.34 sec/sent   4.0-4.8GB
  Hiero    Python  31.22   27.2 sec/sent   1.7-1.9GB

The maximum number of pops from candidate heap at each node is k=30, no other
pruning, 3gm LM, Chinese-English translation task.


GETTING STARTED
------------------------------------------------------------------------------

See the BUILDING file for instructions on how to build the software.  To
explore the decoder's features, the best way to get started is to look
at cdec's command line options or to have a look at the test cases in
the tests/system_tests/ directory.  Each of these can be run with a command
like ./cdec -c cdec.ini -i input.txt -w weights .  The files should be
self explanatory.


EXTRACTING A SYNCHRONOUS GRAMMAR / PHRASE TABLE
------------------------------------------------------------------------------
cdec does not include code for generating grammars.  To build these, you will
need to write your own software or use an existing package like Joshua, Hiero,
or Moses.


OPTIMIZING / TRAINING MODELS
------------------------------------------------------------------------------
cdec does include code for optimizing models, according to a number of
training criteria, including training models as CRFs (with latent derivation
variables), MERT (over hypergraphs) to opimize BLEU, TER, etc.

Eventually, I will provide documentation for this.


ALIGNMENT / SYNCHRONOUS PARSING / CONSTRAINED DECODING
------------------------------------------------------------------------------
cdec can be used as an aligner.  For examples, see the test cases.


COPYRIGHT AND LICENSE
------------------------------------------------------------------------------
Copyright (c) 2009 by Chris Dyer <redpony@gmail.com>

See the file LICENSE.txt for the licensing terms that this software is
released under. This software also includes the file m4/boost.m4 which is
licensed under the LGPL v3, for more information refer to the comments
in that file.