.. TextFlow documentation master file, created by
   sphinx-quickstart on Sat Jan  2 18:20:38 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to TextFlow's documentation!
====================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   usage/installation
   usage/quickstart

Quick Summary
-------------

TextFlow is a minimalist interface for full text processing with natural language tools.
As of now, the app is capable of running projects from end to end.
i.e. it is capable of getting annotations, processing them and creating models on the fly.
There are two (2) main components of this system:

1. Annotator
    1. Interface for Annotation
    2. Annotation Agreement
2. Modeling
    1. Automatic Model Training
    2. Automated Model Evaluation

The platform is highly extensible for running a specific NLP project and very much beneficial for researchers.

To read the full documentation please visit [here]() (not complete).

Contributions
-------------

We highly value your feedback on this project,
so let us know. Kindly place an issue for any bugs or feature recommendations.

About
-----

You can contact the author via his e-mail:`ysenarath.93@gmail.com`.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`