flair
=====

.. _flair_docs_mainpage:


**Version**: |version|

**Useful links**:
`Getting started <tutorial/intro.html>`_ |
`Source Repository <https://github.com/flairNLP/flair>`_ |
`Issue Tracker <https://github.com/flairNLP/flair/issues>`_ |

Flair is a very simple framework for state-of-the-art Natural Language Processing (NLP)

.. grid:: 2

    .. grid-item-card::
        :img-top: ./_static/tutorial.svg

        Tutorial
        ^^^^^^^^

        New to Flair? Check out the Tutorials. It contains an introduction to Flair's main concepts.

        +++

        .. button-ref:: tutorial/index
            :expand:
            :color: secondary
            :click-parent:

            To the tutorials

    .. grid-item-card::
        :img-top: ./_static/api.svg

        API-docs
        ^^^^^^^^

        The API-docs provides in-depth information on the classes and functions designed for public use.

        +++

        .. button-ref:: api/index
            :expand:
            :color: secondary
            :click-parent:

            To the API docs

    .. grid-item-card::
        :img-top: ./_static/contributing.svg

        Contributor's Guide
        ^^^^^^^^^^^^^^^^^^^

        Want to add to the codebase? Can help add to the
        documentation? The contributing guidelines will guide you through the
        process of improving Flair.

        +++

        .. button-ref:: contributing/index
            :expand:
            :color: secondary
            :click-parent:

            To the contributor's guide

    .. grid-item-card::
        :img-top: ./_static/glossary.svg

        Glossary
        ^^^^^^^^

        Not sure what the exact meaning of certain terms is? Find their definition in the Glossary.

        +++

        .. button-ref:: glossary/index
            :expand:
            :color: secondary
            :click-parent:

            To the glossary

.. toctree::
   :maxdepth: 3
   :hidden:

   Tutorials <tutorial/index>
   API reference <api/index>
   Contributing <contributing/index>
   Glossary <glossary/index>