Metadata-Version: 2.1
Name: biome-text
Version: 2.1.0
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://github.com/recognai/biome-text/actions">
                <img alt="CI" src="https://github.com/recognai/biome-text/workflows/CI/badge.svg?branch=master&event=push">
            </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/">
                <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
        </h3>
        
        ## Quick Links
        - [Documentation](https://www.recogn.ai/biome-text/)
        
        
        ## 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
        
        For the installation we recommend setting up a fresh [conda](https://docs.conda.io/en/latest/miniconda.html) environment:
        
        ```shell script
        conda create -n biome python~=3.7.0 pip>=20.3.0
        conda activate biome
        ```
        
        Once the conda environment is activated, you can install the latest release via pip:
        
        ````shell script
        pip install -U biome-text
        ````
        
        After installing *biome.text*, the best way to test your installation is by running the *biome.text* cli command:
        
        ```shell script
        biome --help
        ```
        
        For the UI component to work you need a running [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html) instance.
        We recommend running [Elasticsearch via docker](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/docker.html#docker-cli-run-dev-mode):
        
        ````shell script
        docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch:7.3.2
        ````
        
        ## Get started
        
        The best way to see how *biome.text* works is to go through our [first tutorial](https://www.recogn.ai/biome-text/master/documentation/tutorials/1-Training_a_text_classifier.html).
        
        Please refer to our [documentation](https://www.recogn.ai/biome-text) for more tutorials, detailed user guides and how you can [contribute](https://www.recogn.ai/biome-text/v2.0.0/documentation/community/1-contributing.html) to *biome.text*.
        
        ## 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: dev
