Project

General

Profile

This page is obsolete, please go to https://github.com/Bibliome/alvisnlp

Getting Started with AlvisNLP/ML

Requirements

Requirements included in the repo

These requirements do not need to be downloaded, they are listed here for information.

Compilation

Inform requirements

  • Make sure your JAVA_HOME environment variable points to the right Java install.
  • Make sure your ANT_HOME environment variable points to the right Ant install.
  • Make sure your PATH environment variable searches for the right ant.
  • Edit the build.properties file and set the weka.jarfile to the path to the weka-3-6.jar file.
  • Make sure your PATH environment variable searches for the right mvn.

[optional] Inform default parameter values

You can fill in values in the file core/src/main/resources/alvisnlp/app/cli/default-param-values.xml.

These values are default parameter values for the specified modules.

Compile

mvn clean install

This will fetch prerequisites and build AlvisNLP/ML.

Install

Before installing, the code must be compiled:

./install.sh INSTALL_DIR

INSTALL_DIR is the directory where AlvisNLP/ML will be installed. (!) The install.sh script deletes and re-creates INSTALL_DIR, except if the target directory is the current directory (.).
Several subdirectories are created:

  • bin: alvisnlp executable
  • doc: documentation (HTML API, HTML modules, PDF guides)
  • lib: core and module libraries, dependencies, (!) except for Weka
  • share: miscellanous helper files

Run AlvisNLP/ML

$INSTALL_DIR/bin/alvisnlp -help

Another option is to put $INSTALL_DIR/bin in the PATH environment variable.

export PATH=$INSTALL_DIR/bin:$PATH
alvisnlp -help