Skip to content

Commit

Permalink
include more useful help links
Browse files Browse the repository at this point in the history
  • Loading branch information
ppalmes committed May 15, 2019
1 parent 4eb936a commit 09015e9
Showing 1 changed file with 36 additions and 3 deletions.
39 changes: 36 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# TSML (Time Series Machine Learning)
# TSML

TSML on Julia 1.0: [![Build Status](https://travis-ci.org/ppalmes/TSML.jl.svg?branch=master)](https://travis-ci.org/ppalmes/TSML.jl)
*A Julia package for time series data processing, classification, clustering and prediction*

| **Documentation** | **Build Status** |
|:-------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|
| [![][docs-stable-img]][docs-stable-url] | Julia 1.0: [![][travis-img]][travis-url] |

## Installation
TSML is included in the Julia package repository. TSML can be installed from the `julia>` REPL by typing
TSML is part of the Julia package repository. It can be installed from the `julia>` REPL by typing
`]` to enter into the `pkg>` REPL mode and run:

```
Expand All @@ -21,6 +25,15 @@ julia> Pkg.add("TSML")
- [**Stable**](https://ibm.github.io/TSML.jl/)
- [**Alternative link**](https://ibm.github.io/TSML.jl/docs/build/)

## Questions and Contributions

Any usage questions can be posted in:
- [Julia Slack](https://julialang.org/community/)
- [Gitter TSML Community][gitter-url]
- [Julia Discourse forum][discourse-tag-url]

We welcome contributions, feature requests, and suggestions. Here is the link to open an [issue][issues-url] for any problems you encounter. If you want to contribute, please follow the guidelines in [contributors page][contrib-url].

## Overview

TSML (Time Series Machine Learning) is package for Time Series data processing, classification, and prediction. It combines ML libraries from Python's ScikitLearn, R's Caret, and Julia using a common API and allows seamless ensembling and integration of heterogenous ML libraries to create complex models for robust time-series prediction.
Expand Down Expand Up @@ -71,3 +84,23 @@ respipe2 = transform!(mpipeline2)
# Show statistics including blocks of missing data stats
@show respipe2
```


[contrib-url]: https://github.com/IBM/TSML.jl/blob/master/CONTRIBUTORS.md
[discourse-tag-url]: https://discourse.julialang.org/tags/TSML
[gitter-url]: https://gitter.im/TSMLearning/community

[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: https://ibm.github.io/TSML.jl/docs/build/
[travis-img]: https://travis-ci.org/ppalmes/TSML.jl.svg?branch=master
[travis-url]: https://travis-ci.org/ppalmes/TSML.jl
[issues-url]: https://github.com/IBM/TSML.jl/issues

<!--
[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
[docs-dev-url]: https://ibm.github.io/TSML.jl/
[appveyor-img]:
[appveyor-url]:
[codecov-img]:
[codecov-url]:
-->

0 comments on commit 09015e9

Please sign in to comment.