summaryrefslogtreecommitdiff
path: root/example_extff/README.md
diff options
context:
space:
mode:
authorChris Dyer <cdyer@cab.ark.cs.cmu.edu>2012-10-11 23:13:12 -0400
committerChris Dyer <cdyer@cab.ark.cs.cmu.edu>2012-10-11 23:13:12 -0400
commitf49ebcba9974a60ec3df2b6c97c7048186a5954d (patch)
tree0d88a436699817809171159b718c1228aaea6082 /example_extff/README.md
parentc25a0afc5d50b47fc2ffa388d8e43a7b93f6f266 (diff)
example external feature function
Diffstat (limited to 'example_extff/README.md')
-rw-r--r--example_extff/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/example_extff/README.md b/example_extff/README.md
new file mode 100644
index 00000000..f2aba487
--- /dev/null
+++ b/example_extff/README.md
@@ -0,0 +1,8 @@
+This is an example of an _external_ feature function which is loaded as a dynamically linked library at run time to compute feature functions over derivations in a hypergraph. To load feature external feature functions, you can specify them in your `cdec.ini` configuration file as follows:
+
+ feature_function=External /path/to/libmy_feature.so
+
+Any extra options are passed to the external library.
+
+*Note*: the build system uses [GNU Libtool](http://www.gnu.org/software/libtool/) to create the shared library. This may be placed in a hidden directory called `./libs`.
+