Skip to content
This repository has been archived by the owner on May 21, 2022. It is now read-only.

Commit

Permalink
update README and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Evizero committed Mar 31, 2017
1 parent 135b423 commit df07a26
Show file tree
Hide file tree
Showing 3 changed files with 726 additions and 16 deletions.
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,28 @@

*Utility package for subsetting, partitioning, and resampling
Machine Learning datasets. Aside from providing common
functionality, this library also defines a set of common
interfaces and functions, that can (and should) be extended to
work with custom user-defined data structures.*
functionality, this library also allows for first class support
of custom user-defined data structures.*

| **Package Status** | **Package Evaluator** | **Build Status** |
|:------------------:|:---------------------:|:-----------------:|
| [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.md) [![Documentation Status](https://img.shields.io/badge/docs-latest-blue.svg?style=flat)](http://mldatapatternjl.readthedocs.io/en/latest/?badge=latest) | [![MLDataPattern](http://pkg.julialang.org/badges/MLDataPattern_0.5.svg)](http://pkg.julialang.org/?pkg=MLDataPattern) [![MLDataPattern](http://pkg.julialang.org/badges/MLDataPattern_0.6.svg)](http://pkg.julialang.org/?pkg=MLDataPattern) | [![Build Status](https://travis-ci.org/JuliaML/MLDataPattern.jl.svg?branch=master)](https://travis-ci.org/JuliaML/MLDataPattern.jl) [![Coverage Status](https://coveralls.io/repos/github/JuliaML/MLDataPattern.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaML/MLDataPattern.jl?branch=master) |

## Introduction

While the sole focus of the whole package are the data access
pattern. These include data-partitioning, -subsampling, and
-iteration. The main design principle behind the access pattern
is based on the assumption that the data a user is working with
is likely of some very user-specific custom type. That said,
there was also a lot of attention put into first class support
for those types that are most commonly employed to represent the
data of interest, such as ``Array``.
Typical Machine Learning experiments require a lot of rather
mundane but error prone data handling glue-code. One particularly
interesting category of data handling functionality are what we
call *data access pattern*. These include data-splitting,
-subsampling, -iteration, and k-fold partitioning.

Data Access Pattern are the sole focus of this package. The main
design principle it follows, is first class support of
user-defined data source. This is based on the assumption that
the data a user is working with, is likely of some very
user-specific custom type. That said, we also put a lot of
attention into first class support for the most commonly used
data container, such as ``Array``.

## Example

Expand Down
Loading

0 comments on commit df07a26

Please sign in to comment.