Skip to content

Commit

Permalink
Merge branch 'gm/readme' into 'master'
Browse files Browse the repository at this point in the history
update README

See merge request glenn.moynihan/models.jl!1
  • Loading branch information
Glenn Moynihan committed Feb 12, 2020
2 parents 1141783 + 2af4c89 commit c67bcd3
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,11 @@
[![Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://invenia.pages.invenia.ca/Models.jl/)
[![Build Status](https://gitlab.invenia.ca/invenia/Models.jl/badges/master/build.svg)](https://gitlab.invenia.ca/invenia/Models.jl/commits/master)
[![Coverage](https://gitlab.invenia.ca/invenia/Models.jl/badges/master/coverage.svg)](https://gitlab.invenia.ca/invenia/Models.jl/commits/master)

This package defines the `Model` type and a common API for constructing a generic model, including

* Model Fitting (`fit`, `predict`)
* Model Traits (`output_type`, `estimate_type`)
* Test utils for testing downstream interfaces (`FakeModel`)

For common examples of the interface being implemented see [BaselineModels.jl](https://gitlab.invenia.ca/invenia/research/BaselineModels.jl).

0 comments on commit c67bcd3

Please sign in to comment.