Metadata-Version: 1.2
Name: pytorch-crf
Version: 0.7.1
Summary: Conditional random field in PyTorch
Home-page: https://github.com/kmkurn/pytorch-crf
Author: Kemal Kurniawan
Author-email: kemal@kkurniawan.com
License: MIT
Description: pytorch-crf
        ===========
        
        Conditional random field in `PyTorch <http://pytorch.org/>`_.
        
        .. image:: https://badge.fury.io/py/pytorch-crf.svg
           :target: https://badge.fury.io/py/pytorch-crf
        
        .. image:: https://travis-ci.org/kmkurn/pytorch-crf.svg?branch=master
           :target: https://travis-ci.org/kmkurn/pytorch-crf
        
        .. image:: https://coveralls.io/repos/github/kmkurn/pytorch-crf/badge.svg?branch=master
           :target: https://coveralls.io/github/kmkurn/pytorch-crf?branch=master
        
        .. image:: https://cdn.rawgit.com/syl20bnr/spacemacs/442d025779da2f62fc86c2082703697714db6514/assets/spacemacs-badge.svg
           :target: http://spacemacs.org
        
        This package provides an implementation of `conditional random field
        <https://en.wikipedia.org/wiki/Conditional_random_field>`_ (CRF) in PyTorch.
        This implementation borrows mostly from `AllenNLP CRF module
        <https://github.com/allenai/allennlp/blob/master/allennlp/modules/conditional_ra
        ndom_field.py>`_ with some modifications.
        
        Requirements
        ============
        
        - Python 3.6
        - PyTorch 1.0.0
        
        Installation
        ============
        
        Install with pip::
        
            $ pip install pytorch-crf
        
        Or, install from Github for the latest version::
        
            $ pip install git+https://github.com/kmkurn/pytorch-crf#egg=pytorch_crf
        
        Documentation
        =============
        
        https://pytorch-crf.readthedocs.io/en/latest/
        
        License
        =======
        
        MIT
        
        Contributing
        ============
        
        Contributions are welcome! Please follow these instructions to install
        dependencies and running the tests and linter. Make a pull request to
        ``develop`` branch once your contribution is ready.
        
        Installing dependencies
        -----------------------
        
        Make sure you setup a virtual environment with Python and PyTorch
        installed. Then, install all the dependencies in ``requirements.txt`` file and
        install this package in development mode.
        
        ::
        
            $ pip install -r requirements.txt
            $ pip install -e .
        
        Setup pre-commit hook
        ---------------------
        
        Simply run::
        
            $ ln -s ../../pre-commit.sh .git/hooks/pre-commit
        
        Running tests
        -------------
        
        Run ``pytest`` in the project root directory.
        
        Running linter
        --------------
        
        Run ``flake8`` in the project root directory. This will also run ``mypy``,
        thanks to ``flake8-mypy`` package.
        
Keywords: torch
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.6, <4
