diff --git a/README b/README index 413c967a6042e3f2a22690cd198b95838723272d..6dfa654bccf9b95f3d1972824458a007c83d8b33 100644 --- a/README +++ b/README @@ -46,3 +46,16 @@ If the input file contains annotations in channels other than those defined in the config, they will be preserved (this makes it possible to e.g. chunk files already annotated with named entities). + + +Example call using the bundled model: + +iobber kpwr.ini -d model-kpwr03/ my_xces_input.xml -i xces -O ccl_chunked_output.xml + +This will read the given XCES-encoded file and produce CCL output. Note: the +kpwr.ini config assumes the input file has been morphosyntactically tagged and +the NKJP tagset is employed. + +Iobber also supports chunking stdin to stdout, as well as chunking multiple +files at a time, see -h for details. +