*-----------------------------------------------------------------------------------------------*
* A framework for multitask sequence labeling dedicated for natural language processing tasks.  *
*                                                                                               *
* Authors: Michał Marcińczuk (2010–2014) (coordinator),                                         *
*          Michał Krautforst (2013-2014), Jan Kocoń (2014)                                      *
*          Dominik Piasecki (2013), Maciej Janicki (2011)                                       *
* Contact: michal.marcinczuk@pwr.wroc.pl                                                        *
*                                                                                               *
*          G4.19 Research Group, Wrocław University of Technology                               *
*-----------------------------------------------------------------------------------------------*

In this file you will find how to use Liner2. To find the installation 
guideline please see INSTALL. To find the license terms please see LICENSE.

This is only brief introduction to Liner2. To see the complete description
of Liner2 options please visit: http://nlp.pwr.wroc.pl/redmine/projects/inforex-liner/wiki
    
=== Run ===

The pack with models can be downloaded from http://nlp.pwr.wroc.pl/liner2.

Pipe mode
---------

In pipe mode Liner2 reads text from a single file or standard input and print the results 
in a defined format to a file or standard output.

Process ccl file and write results to a file in ccl format:

  ./liner2-cli pipe -m liner24-model-n82/config-n82.ini -f resources/sample-sentence.xml -t sentence-output.xml

Process ccl file and write results to a standard output as list of tuples:

  ./liner2-cli pipe -m liner24-model-n82/config-n82.ini -f resources/sample-sentence.xml -o tuples


Interactive mode
----------------

Interactive mode — process plain text entered into console (requires maca):

  ./liner2-cli interactive -m liner24-model-n82/config-n82.ini -i plain -o tuples -maca -


Batch mode
----------

In batch mode Liner2 process set of files listed in given batch file. The batch file must contain 
a list of absolute or relative paths to files. The relative paths are translated to the absolute 
path in regard to the location of the batch file.

Process set of files in ccl format:

  ./liner2-cli pipe -m liner24-model-n82/config-n82.ini -f folder1/batch.txt -o t folder2/batch.txt -i batch:ccl -o batch:ccl
