Metadata-Version: 2.1
Name: seqscore
Version: 0.2.0
Summary: UNKNOWN
Home-page: https://github.com/bltlab/seqscore
Author: Constantine Lignos
Author-email: lignos@brandeis.edu
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: ~=3.8
Description-Content-Type: text/markdown
Requires-Dist: attrs (>=19.2.0)
Requires-Dist: click
Requires-Dist: tabulate

# SeqScore

SeqScore: Scoring for named entity recognition and other sequence labeling tasks


# Installation

Normal installation: `pip install seqscore`

If you need to install from a copy of this repository, use: `pip install
-e .`


# Usage

## Overview

For a list of commands, run `seqscore --help`.

Some examples:
```
seqscore score prediction_conll_file --reference reference_conll_file
seqscore validate encoding input_conll_file
seqscore dump encoding input_conll_file output_delim_file
```

Scoring only supports BIO chunk encoding. Validation can be done for IO, BIO, and BIOES.
At the moment, `dump` only supports BIO, but support will be added for IO and BIOES.


# Features coming soon!

* More documentation
* Conversion between encodings (e.g. BIO<->BIOES)
* More error analysis tools


# Setting up for development

1. Create environment: `conda create -y -n seqscore python=3.8`
2. Activate the environment: `conda activate seqscore`
3. Install dependencies: `pip install -r requirements.txt`
4. Install seqscore: `pip install -e .`


