Metadata-Version: 2.1
Name: textmetrics
Version: 0.0.1
Summary: Automatic text metrics---BLEU, ROUGE, and METEOR, pllus extras like vocab and ngrams.
Home-page: https://github.com/mbforbes/textmetrics/
Author: Maxwell Forbes
Author-email: mbforbes@gmail.com
License: MIT
Description: # textmetrics
        
        Automatic text metrics---BLEU, ROUGE, and METEOR, plus extras like vocab and
        ngrams.
        
        ## Usage
        
        ```bash
        # Compares each candidate (c) separately against all references (r).
        python -m textmetrics.main c1.txt c2.txt --references r1.txt r2.txt r3.txt
        ```
        
        ## Installation
        
        Requires:
        - Perl (for BLEU)
        - Java 1.8 (for METEOR)
        - Python 3.6+
        
        After cloning the repo, run:
        
        ```bash
        pip install -r requirements.txt
        ```
        
        ## Features
        
        - [x] BLEU
        - [x] ROUGE
        - [x] METEOR
        
        
        ## Notes
        
        BLEU and METEOR use the refernce implementations (in Perl and Java,
        respectively). We originally used the reference Perl implementation for ROUGE
        as well, but it ran so slowly that we opted for a Python reimplementation
        instead. (ROUGE's original Perl implementation is also more difficult to setup,
        even with wrapper libraries.)
        
        ## Worklist
        
        - [ ] pypi
        
        - [ ] API support
        
        - [ ] ROUGE crashes things if it decides there aren't sentences (e.g., run with
          README.md as input and reference)
        
        - [ ] Add back in orig ROUGE for completeness (place behind switch)
        
        - [ ] ngrams has divide by zero error. With two simple files (two lines each,
          same first line, differing second line) running with `2.txt --references
          1.txt 1.txt` triggered this divide by zero
        
        - [ ] Demo for better README
        
        - [ ] Tests
        
        - [ ] Early check in each module for whether program runnable + nice error
          message (e.g., no java or bad version, no perl or bad version, etc.)
        
Keywords: text-metrics text metrics nlp bleu rouge meteor ngrams vocabulary vocab
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
