Metadata-Version: 2.1
Name: biome-text
Version: 1.0.0rc2
Summary: Biome-text is a light-weight open source Natural Language Processing toolbox built with AllenNLP
Home-page: https://www.recogn.ai/
Author: Recognai
Author-email: francisco@recogn.ai
License: UNKNOWN
Description: <p align="center">
            <br>
            <img src="https://github.com/recognai/biome-text/raw/master/docs/biome_text_logo_for_readme.png" width="600"/>
            <br>
        <p>
        <p align="center">
            <a href="https://travis-ci.org/recognai/biome-text">
                <img alt="Build" src="https://travis-ci.org/recognai/biome-text.svg?branch=master">
            </a>
            <a href="https://github.com/recognai/biome-text/blob/master/LICENSE.txt">
                <img alt="GitHub" src="https://img.shields.io/github/license/recognai/biome-text.svg?color=blue">
            </a>
            <a href="https://www.recogn.ai/biome-text/index.html">
                <img alt="Documentation" src="https://img.shields.io/website/http/www.recogn.ai/biome-text/index.html.svg?down_color=red&down_message=offline&up_message=online">
            </a>
            <a href="https://github.com/recognai/biome-text/releases">
                <img alt="GitHub release" src="https://img.shields.io/github/release/recognai/biome-text.svg">
            </a>
        </p>
        
        <h3 align="center">
        <p>Natural Language Processing library built with AllenNLP and Huggingface Transformers
        </h3>
        
        ## Quick Links
        
        - [Documentation](https://www.recogn.ai/biome-text/documentation/)
        
        
        ## Features
        
        * State-of-the-art and not so state-of-the-art models trained with **your own data** with a simple workflow.
        
        * **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 and Huggingface Transformers**
        
        ## Installation
        
        You can install biome.text with pip or from source.
        
        
        ### Pip
        
        
        The recommended way of installing the library is using pip. You can install everything required for the library:
        
        ```shell
        pip install biome-text
        ```
        
        ### Install from Source
        To install biome-text from source, clone the repository from github:
        
        ````shell
        git clone https://github.com/recognai/biome-text.git
        cd biome-text
        python -m pip install .
        ````
        
        If the `make` command is enabled in your system, you can use already defined make directives:
        
        ````shell
        make install
        ````  
        
        or 
        ````shell
        make dev
        ````
        for a developer installation
        
        You can see defined directives as follow:
        ````shell script
        make help
        ````
        
        ### Test
        Test biome-text with pytest
        
        ````shell script
        cd biome-text
        pytest
        ````
        
        ## Licensing
        
        The code in this project is licensed under Apache 2 license.
        
Platform: UNKNOWN
Requires-Python: >=3.6.1
Description-Content-Type: text/markdown
Provides-Extra: testing
