CONTRIBUTING.md

Contributing to Kashgari

We are happy to accept your contributions to make Kashgari better and more awesome! You could contribute in various ways:

Adding New Models

New models can be of two basic types:

• New classification model
• New sequence labeling model

The new model must inherit from the ClassificationModel or SequenceLabelingModel. Here is an example to get you started

Documentation and Tutorials

• Check current documents and tutorials for any mistakes
• Add the missing comments to the source code
• Write your tutorial or blogs about Kashgari

Accuracy Benchmarks

• Use Kashgari your own data, and report the F-1 score.

New Tasks

Currently, Kashgari can handle text-classification and sequence-labeling tasks. If you want to apply Kashgari for a new task, please submit a request issue and explain why we would consider adding the new task to Kashgari