barn

Simple local/remote dataset store for Python.

from barn import Dataset
twitter_usa = Dataset(name='twitter_usa', task='NER')
# download from an azure block blob storage and load into a dataframe
twitter_usa.download(tags=['preprocessed'], version='20180305')
df = twitter_usa.df(tags=['preprocessed'], version='20180305')

1   Installation

pip install barn

2   Features

• Pure python.
• Supports Python 3.5+.

3   Use

TBA

4   Contributing

Package author and current maintainer is Shay Palachy (shay.palachy@gmail.com); You are more than welcome to approach him for help. Contributions are very welcomed.

4.1   Installing for development

Clone:

git clone git@github.com:shaypal5/barn.git

Install in development mode, including test dependencies:

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

4.2   Running the tests

To run the tests use:

cd barn
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 (shay.palachy@gmail.com).