Metadata-Version: 2.1
Name: keras_crf
Version: 0.2.0
Summary: A more elegant and convenient CRF built on tensorflow-addons.
Home-page: https://github.com/luozhouyang/keras-crf
Author: ZhouYang Luo
Author-email: zhouyang.luo@gmail.com
License: Apache Software License
Description: # keras-crf
        
        ![Python package](https://github.com/luozhouyang/keras-crf/workflows/Python%20package/badge.svg)
        [![PyPI version](https://badge.fury.io/py/keras-crf.svg)](https://badge.fury.io/py/keras-crf)
        [![Python](https://img.shields.io/pypi/pyversions/keras-crf.svg?style=plastic)](https://badge.fury.io/py/keras-crf)
        
        A more elegant and convenient CRF built on tensorflow-addons.
        
        
        > Python Compatibility is limited to [tensorflow/addons](https://github.com/tensorflow/addons), you can check the compatibility from it's home page.
        
        ## Installation
        
        ```bash
        pip install keras-crf
        ```
        
        ## Usage
        
        Here is an example to show you how to build a CRF model easily:
        
        ```python
        import tensorflow as tf
        
        from keras_crf import CRFModel
        
        # build backbone model, you can use large models like BERT
        sequence_input = tf.keras.layers.Input(shape=(None,), dtype=tf.int32, name='sequence_input')
        outputs = tf.keras.layers.Embedding(100, 128)(sequence_input)
        outputs = tf.keras.layers.Dense(256)(outputs)
        base = tf.keras.Model(inputs=sequence_input, outputs=outputs)
        
        # build CRFModel, 5 is num of tags
        model = CRFModel(base, 5)
        
        # no need to specify a loss for CRFModel, model will compute crf loss by itself
        model.compile(
            optimizer=tf.keras.optimizers.Adam(3e-4)
            metrics=['acc'],
            )
        # you can now train this model
        model.fit(dataset, epochs=10, callbacks=None)
        
        # or summary the model
        model.build(tf.TensorShape([None, 256]))
        model.summary()
        ```
        
        The model summary:
        
        ```bash
        Model: "crf_model"
        _________________________________________________________________
        Layer (type)                 Output Shape              Param #   
        =================================================================
        model (Functional)           (None, None, 256)         2737408   
        _________________________________________________________________
        crf (CRF)                    multiple                  1320      
        =================================================================
        Total params: 2,738,728
        Trainable params: 2,738,728
        Non-trainable params: 0
        _________________________________________________________________
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Description-Content-Type: text/markdown
