arunadevikaruppasamy / biome-text Goto Github PK

Natural Language Processing library built with AllenNLP

Quick Links

• Documentation

Features

• State-of-the-art and not so state-of-the-art models trained with your own data with simple workflows.

• Exploration UI for error analysis with interpretations.

• Efficient data reading for (large) datasets in multiple formats and sources (CSV, Parquet, JSON, Elasticsearch, etc.).

• Modular configuration and extensibility of models, datasets and training runs programmatically or via config files.

• Use via cli or as plain Python (e.g., inside a Jupyter Notebook)

• Compatible with AllenNLP

Installation

You can install biome.text with pip or from source.

Pip

The recommended way for installing the library is using pip. You can install everything required for the library as follows:

pip install biome-text

Install from Source

To install biome-text from source, clone the repository from github:

git clone https://github.com/recognai/biome-text.git
cd biome-text
python -m pip install .[testing]

Then you must build static web resources for the explore UI to work:

cd ui 
npm install 
npm run build

Note: node>=12 is required in your machine. You can follow installation instructions here

If the make command is enabled in your system, you can use make dev directive:

make dev

And make ui for building static web resources needed for the explore UI method to work:

make ui

You can see all defined directives as follow:

make help

Test

Test biome-text with pytest

cd biome-text
pytest

Licensing

The code in this project is licensed under Apache 2 license.