spiegel-keyman/common/test/predictive-text/README.md
Eddie Antonio Santos 6ae6027b2a
Add a basic README.
2019-04-12 09:15:54 -06:00

900 B

Predictive Text testing CLI

Provides a command line interface to try out predictive text models.

Install

NOTE: Requires Node >= 10.0

Install dependencies with npm:

npm install 

Usage

Start it like so:

$ node .

You will be presented with a prompt. Type any phrase in the model's language. Press Tab to start choosing a prediction. Press the left and right arrow keys to go through suggestions. Press Enter to select the given suggestion. Press Esc.

Press Ctrl+D or Ctrl+C to quit.

> He
[ Hello ] [ Hey ] [ He he ]

ROADMAP

  • The command line interface!
  • -f filename to load a model from a file
  • LMPATH environment variable to load a named model by id: e.g,. node . example.crk.wordlist will load the given model, provided LMPATH is defined.