github.com/NLP-Suite/nlp-suite-runner

NLP Suite Runner

The NLP Suite Runner is the new, official tool to install and run the NLP Suite. The NLP Suite Runner is a binary that automatically installs 3 main packages:

• NLP Suite UI: the user interface to interact with the NLP Suite Agent
• NLP Suite Agent: the core algorithms and tools provided by the NLP Suite
• Stanford CoreNLP: a dependency needed to run the NLP Suite

The NLP Suite Runner requires the presence and installation of Docker Desktop.

⚙️ Requirements

To install the NLP Suite, Docker desktop requires at least 4GB of RAM. The NLP Suite Runner strongly encourages that you have at least 10 GB of storage available.

📦 Installation

To install the NLP Suite Runner, first ensure that you have downloaded and installed Docker Desktop. You can find a list of NLP Suite Runner binaries for your operating system in the latest release here.

Mac

Mac and Linux systems can easily extract .tar.gz files without additional tools.

M-Chip Series

If you have a mac running the ARM M-chip series, ensure that you install the darwin-arm64 version of the NLP Suite Runner.

Intel Chip Series

If you have the Intel chip, you will need to install the darwin-amd64 version of the NLP Suite Runner.

Windows

To extract the runner, you will need 7-zip, a file archiver tool for Windows.

You most likely will need to install the windows-amd64 version of the NLP Suite Runner. If your device has an ARM chip, ensure you have windows-arm64 installed. To check which version you have, check here.

⚡️ Running the NLP Suite Runner

First ensure that you have first started Docker Desktop. It is required to run the NLP Suite Runner. To run the NLP Suite Runner, double click the binary/exe to start it.

Mac Systems

You may see an error indicating that the NLP Suite Runner cannot be opened because it is not coming from a trusted source. This is expected to occur the first time you run the NLP Suite Runner. To start the runner, follow these instructions to allow the NLP Suite Runner to open.

Windows / Linux Systems

There are no known issues for starting and running the NLP Suite Runner at this time.

Input / Output Directories

Currently, the input and output directories are hard coded. DO NOT TRY ALTER THE INPUT AND OUTPUT PATHS.

For Mac users, the folder is located in your home folder. The home folder may not directly appear in your Finder. To convinently add your home folder to Finder, use these instructions.

Make sure that the files are uploaded individually into the input directory and not inside of another folder.

Updating the NLP Suite Runner

While the NLP Suite Runner automatically updates the installed packages mentioned above, the NLP Suite Runner does not automatically update itself. Periodically check this page to ensure you have the latest version installed.

📣 Reporting issues

If there are any issues you are encountering, header over to Issues to open a ticket.

💻 Contributing

If you would like to contribute to the NLP Suite, please contact Roberto Franzosi