Tài liệu LanguageFlow

Contents:

Underthesea LanguageFlow

https://img.shields.io/badge/latest-1.1.6-brightgreen.svg

Toolkit hỗ trợ quá trình huấn luyện mô hình xử lý ngôn ngữ tự nhiên tiếng Việt.

  • Nguồn mở: GNU General Public License v3

Prerequisite

Install dependencies

$ pip install fasttext

Cài đặt

Stable version

$ pip install https://github.com/undertheseanlp/languageflow/archive/master.zip

Latest version

$ pip install https://github.com/undertheseanlp/languageflow/archive/develop.zip

Installation

Stable release

To install LanguageFlow, run this command in your terminal:

$ pip install languageflow

This is the preferred method to install LanguageFlow, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for LanguageFlow can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/undertheseanlp/languageflow

Or download the tarball:

$ curl  -OL https://github.com/undertheseanlp/languageflow/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use LanguageFlow in a project:

import languageflow

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/undertheseanlp/languageflow/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

LanguageFlow could always use more documentation, whether as part of the official LanguageFlow docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/underthesea/lanugageflow/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up languageflow for local development.

  1. Fork the languageflow repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/languageflow.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv languageflow
$ cd languageflow/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 languageflow tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/undertheseanlp/languageflow/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_languageflow

Credits

Development Lead

Contributors

History

1.1.6 (2017-12-26)

  • Add data module to handle data downloading and data preprocessing
  • Add many new models: SGDClassifier, XGBoostClassier, FastTextClassifier, CRF
  • Add new feature: LanguageBoard
  • Automatic continuous integration with travis-ci
  • Build docs with readthedocs.org

1.1.5 (2017-12-11)

  • Refactor project to integrate with underthesea experiment

0.1.0 (2017-09-18)

  • First release on PyPI.

Indices and tables