alonisser / mlshed

Simple local/remote machine learning model store for Python.

mlshed

Simple local/remote model store for Python.

from mlshed import Model

Contents

• 1   Installation
• 2   Features
• 3   Use
• 4   Contributing
  • 4.1   Installing for development
  • 4.2   Running the tests
  • 4.3   Adding documentation
• 5   Credits

1   Installation

pip install mlshed

2   Features

• Pure python.
• Supports Python 3.5+.

3   Use

TBA

4   Contributing

Package author and current maintainer is Shay Palachy ([e-mail]); You are more than welcome to approach him for help. Contributions are very welcomed.

4.1   Installing for development

Clone:

git clone [e-mail]:shaypal5/mlshed.git

Install in development mode, including test dependencies:

cd mlshed
pip install -e '.[test]'

4.2   Running the tests

To run the tests use:

cd mlshed
pytest

4.3   Adding documentation

The project is documented using the numpy docstring conventions, which were chosen as they are perhaps the most widely-spread conventions that are both supported by common tools such as Sphinx and result in human-readable docstrings. When documenting code you add to this project, follow these conventions.

Additionally, if you update this README.rst file, use python setup.py checkdocs to validate it compiles.

5   Credits

Created by Shay Palachy ([e-mail]).