Skip to content

Commit

Permalink
Added a couple of tutorial notebooks.
Browse files Browse the repository at this point in the history
This diff adds a couple of notebooks that illustrates some of the basics of the
library. It also improved the existing notebook on EP.
  • Loading branch information
lucasmaystre committed Jul 6, 2017
1 parent b6726b3 commit 51b3b22
Show file tree
Hide file tree
Showing 4 changed files with 611 additions and 101 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,22 @@ data, using a variety of algorithms:
- Rank Centrality
- Approximate Bayesian inference with expectation propagation

## Installation
## Getting started

Simply type
To install the latest release directly from PyPI, simply type

pip install choix

The library is under active development, use at your own risk.
To get started, you might want to explore one of these notebooks:

- [Introduction using pairwise comparison data](notebooks/intro-pairwise.ipynb)
- [Using ChoiceRank to understand traffic on a network](notebooks/choicerank-tutorial.ipynb)
- [Approximate Bayesian inference using EP](notebooks/ep-example.ipynb)

You can also find more information on the [official
documentation](http:https://choix.lum.li/en/latest/). In particular, the [API
reference](http:https://choix.lum.li/en/latest/api.html) contains a good summary of
the library's features.

## References

Expand Down
Loading

0 comments on commit 51b3b22

Please sign in to comment.