Metadata-Version: 2.0
Name: longling
Version: 1.0.0
Summary: handy wrapper for many libs
Home-page: https://gitlab.com/tswsxk/longling.git
Author: Sherlock, Shiwei Tong
Author-email: tongsw@mail.ustc.edu.cn
License: LICENSE.txt
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: pip
Provides-Extra: dev
Requires-Dist: pytest (>=4); extra == 'dev'
Requires-Dist: pytest-cov (>=2.6.0); extra == 'dev'
Requires-Dist: pytest-pep8 (>=1); extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: sphinx-rtd-theme; extra == 'dev'
Requires-Dist: recommonmark; extra == 'dev'
Requires-Dist: setuptools (>=40); extra == 'dev'
Requires-Dist: wheel; extra == 'dev'
Provides-Extra: doc
Requires-Dist: sphinx; extra == 'doc'
Requires-Dist: sphinx-rtd-theme; extra == 'doc'
Requires-Dist: recommonmark; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest (>=4); extra == 'test'
Requires-Dist: pytest-cov (>=2.6.0); extra == 'test'
Requires-Dist: pytest-pep8 (>=1); extra == 'test'

# longling

[![Documentation Status](https://readthedocs.org/projects/longling/badge/?version=latest)](https://longling.readthedocs.io/zh/latest/index.html)
[![PyPI](https://img.shields.io/pypi/v/longling.svg)](https://pypi.python.org/pypi/longling)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/longling.svg)](https://pypi.python.org/pypi/longling)

This project aims to provide some handy toolkit functions to help construct the
architecture. 
Full documentation [here](https://longling.readthedocs.io/zh/latest/index.html).

## Installation

### pip
```bash
pip install longling
```
### source
clone the repository and then run `python setup.py install`:
```bash
git clone https://github.com/tswsxk/longling.git
python setup.py install
```

### Notation
Due to the possible multi version of deep learning frameworks like 
mxnet(for cpu) and mxnet-cu90(for gpu, with cuda version 9.0), 
it is good to install such frameworks in advance. 
For swift installation, use `--no-dependencies` option as follows:
```bash
# pip
pip install longling --no-dependencies
# source
python setup.py install --no-dependencies
```

## Overview
The project contains several modules for different purposes:

* [lib](https://longling.readthedocs.io/zh/latest/submodule/lib/index.html) serves as the basic toolkit that can be used in any place without extra dependencies.

* [ML](https://longling.readthedocs.io/zh/latest/submodule/ML/index.html) provides many interfaces to quickly build machine learning tools.

## Quick scripts
The project provide several cli scripts to help construct different 
architecture.

### Neural Network
* [glue](https://longling.readthedocs.io/zh/latest/submodule/ML/MxnetHelper/glue.html) for mxnet-gluon


