<commit_before>Concraft-pl
===========

This package provides a morphosyntactic tagger for the Polish language.
The tool combines the following components into a pipeline:
* A morphosyntactic segmentation and analysis tool [Maca][maca],
* A morphosyntactic disambiguation library [Concraft][concraft],
* A simple frequency-driven lemmatiser (TODO).


Installation
============

You will need [Glasgow Haskell Compiler (GHC)][ghc] and the [Cabal][cabal] tool
to build Concraft-pl.  The easiest way to get both [GHC][ghc] and [Cabal][cabal]
is to install the latest [Haskell Platform][haskell-platform].

To install Concraft-pl from the official [Hackage repository][hackage-repo]
just run:

    cabal install concraft-pl

If you want to upgrade Concraft-pl to a newer version you should
update the package list first:

    cabal update 
    cabal install concraft-pl

To install the latest development version from github just run

    cabal install

from the `concraft-pl` toplevel directory.

Maca
----

Unless you plan to use a custom preprocessing pipeline or run [Maca][maca] on a
different machine (see section [Tagging analysed data](#tagging-analysed-data)),
you should also install the [Maca][maca] tool.
A detailed [installation guide][maca-install] can be found on the
[Maca][maca] homepage.



Data format
===========

The current version of Concraft-pl works on a simple `plain` text format supported by
the [Corpus2][corpus2] tools.  You will have to install these tools when you install
[Maca][maca] anyway, so you can use them to convert the output generated
by Concraft-pl to one of other formats supported by [Corpus2][corpus2].


Training
========

If you have the training material with disambiguation annotations (stored in the
`plain` text format) you can train the Concraft-pl model yourself.

    concraft-pl train config/nkjp-tagset.cfg train.plain -e eval.plain -o model.gz

The first program argument is a specification of the [NKJP][nkjp] morphosyntactic<commit_msg>Emphasize information about Maca dependency<commit_after>Concraft-pl
===========

This package provides a morphosyntactic tagger for the Polish language.
The tool combines the following components into a pipeline:
* A morphosyntactic segmentation and analysis tool [Maca][maca],
* A morphosyntactic disambiguation library [Concraft][concraft],
* A simple frequency-driven lemmatiser (TODO).


Installation
============

You will need [Glasgow Haskell Compiler (GHC)][ghc] and the [Cabal][cabal] tool
to build Concraft-pl.  The easiest way to get both [GHC][ghc] and [Cabal][cabal]
is to install the latest [Haskell Platform][haskell-platform].  

Unless you plan to use a custom preprocessing pipeline or run [Maca][maca] on a
different machine (see section [Tagging analysed data](#tagging-analysed-data)),
you will also need the [Maca][maca] tool. 
A detailed [installation guide][maca-install] can be found on the [Maca][maca]
homepage.

To install Concraft-pl from the official [Hackage repository][hackage-repo]
just run:

    cabal install concraft-pl

If you want to upgrade Concraft-pl to a newer version you should
update the package list first:

    cabal update 
    cabal install concraft-pl

To install the latest development version from github just run

    cabal install

from the `concraft-pl` toplevel directory.


Data format
===========

The current version of Concraft-pl works on a simple `plain` text format supported by
the [Corpus2][corpus2] tools.  You will have to install these tools when you install
[Maca][maca] anyway, so you can use them to convert the output generated
by Concraft-pl to one of other formats supported by [Corpus2][corpus2].


Training
========

If you have the training material with disambiguation annotations (stored in the
`plain` text format) you can train the Concraft-pl model yourself.

    concraft-pl train config/nkjp-tagset.cfg train.plain -e eval.plain -o model.gz

The first program argument is a specification of the [NKJP][nkjp] morphosyntactic
{'fraction_non_alphanumeric': 0.08745627186406797, 'fraction_numerical': 0.001999000499750125, 'mean_word_length': 4.818313953488372, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '274581', 'n_tokens_mistral': 1201, 'n_tokens_neox': 1137, 'n_words': 508}