Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
Add a link to the temporary Haddocks
  • Loading branch information
dpkatz committed Jun 8, 2018
1 parent 4661e11 commit c73bbc2
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
# HaskellGBM

A Haskell wrapper around LightGBM.
A Haskell wrapper around the [Microsoft LightGBM
library](https://github.com/Microsoft/LightGBM) for machine learning
uses. The emphasis here is on using Haskell types to help ensure that
the hyperparameter settings chosen by the user are coherent and
in-bounds at all times.

This software is not on Hackage yet - in the meantime you can find
Haddock API documentation
[here](https://dpkatz.github.io/haddocks/HaskellGBM-0.1.0.0/index.html)
and a tutorial blog post
[here](https://dpkatz.github.io/posts/using-lightgbm-from-haskell/).

__N.B. This package is still under heavy development including API changes.__

__N.B. This is pre-alpha software - the API and the implementation are both subject to change at a moment's notice.__

You can find a tutorial on how to use it at https://dpkatz.github.io/posts/using-lightgbm-from-haskell/.

0 comments on commit c73bbc2

Please sign in to comment.