Blame view

tools/openfst-1.6.7/README 3.08 KB
8dcb6dfcb   Yannick Estève   first commit
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
58
59
60
61
62
63
64
65
66
  OpenFst: Release 1.6.7.
  
  OpenFst is a library for constructing, combining, optimizing, and searching
  weighted finite-state transducers (FSTs).
  
  REQUIREMENTS:
    This version is known to work under Linux using g++ (>= 4.7) and OS X using
    XCode (>= 5). It is expected to work wherever adequate POSIX (dlopen,
    ssize_t, basename), C99 (snprintf, strtoll, <stdint.h>), and C++11
    (<unordered_set>, <unordered_map>, <forward_list>) support is available.
  
  INSTALLATION:
    Follow the generic GNU build system instructions in ./INSTALL. We
    recommend configuring with --enable-static=no for faster compiles.
  
    Optional features:
  
    --enable-bin             Enable fst::script and executables (def: yes)
    --enable-compact-fsts    Enable CompactFst extensions (def: no)
    --enable-compress        Enable compression extension (def: no)
    --enable-const-fsts      Enable ConstFst extensions (def: no)
    --enable-far             Enable FAR extensions (def: no)
    --enable-grm             Enable all dependencies of OpenGrm (def: no)
    --enable-linear-fsts     Enable LinearTagger/ClassifierFst extensions (def: no)
    --enable-lookahead-fsts  Enable LookAheadFst extensions (def: no)
    --enable-mpdt            Enable MPDT extensions (def: no)
    --enable-ngram-fsts      Enable NGramFst extensions (def: no)
    --enable-pdt             Enable PDT extensions (def: no)
    --enable-python          Enable Python extension (def: no)
    --enable-special         Enable special-matcher extensions (def: no)
  
    Configuring with --enable-bin=no gives very fast compiles, but excludes the
    command line utilities.
  
    Configuring with --enable-python will attempt to install the Python module to
    whichever site-packages (or dist-packages, on Debian or Ubuntu) is found
    during configuration.
  
    The flag --with-libfstdir specifies where FST extensions should be installed;
    it defaults to ${libdir}/fst.
  
    Compiling with -Wall -Wno-sign-compare under g++ should give no warnings from
    this library.
  
    If you encounter an error about loading shared objects when attempting to use
    the library immediately after installation, (e.g, `...cannot open shared
    object file...`) you may need to refresh your system's shared object cache.
    On Linux, this is accomplished by invoking ldconfig; the corresponding command
    on OS X is called update_dyld_shared_cache. Both of these require superuser
    privileges (and so should be executed with sudo).
  
  USAGE:
    Assuming you've installed under the default /usr/local, the FST binaries are
    found on /usr/local/bin.
  
    To use in your own program, include <fst/fstlib.h> and compile with 
    -I/usr/local/include. The compiler must support C++11 (for g++ add the flag
    -std=c++11). Link against /usr/local/lib/libfst.so and -ldl. Set your
    LD_LIBRARY_PATH (or equivalent) to contain /usr/local/lib. The linking is,
    by default, dynamic so that the Fst and Arc type DSO extensions can be used
    correctly if desired. Any extensions will be found under /usr/local/lib/fst
    or /usr/local/include/fst/extensions.
  
  DOCUMENTATION:
    See www.openfst.org for general documentation.
    See ./NEWS for updates since the last release.