Skip to content

Commit

Permalink
Update README.md (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
btamadio authored Feb 25, 2021
1 parent ecab2f9 commit a8d718b
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
![Go workflow badge](https://github.com/stitchfix/mab/actions/workflows/go.yml/badge.svg)
![Go report card badge](https://goreportcard.com/badge/github.com/stitchfix/mab)

# mab: Multi-Armed Bandits Go Library
# Mab
Multi-Armed Bandits Go Library

<p align="center"><img src="https://user-images.githubusercontent.com/5180129/108548622-f2df8200-72a0-11eb-8cc2-b4f1e839dffd.png" width="720"></p>
<p align="center">
<a href="https://github.com/stitchfix/mab/actions/workflows/go.yml"><img src="https://github.com/stitchfix/mab/actions/workflows/go.yml/badge.svg" alt="Build Status"></img></a>
<a href="https://goreportcard.com/report/github.com/stitchfix/mab"><img src="https://goreportcard.com/badge/github.com/stitchfix/mab" alt="Go Report Card"></img></a>
<a href="https://pkg.go.dev/github.com/stitchfix/mab"><img src="https://pkg.go.dev/badge/github.com/stitchfix/mab.svg" alt="Go Reference"></img></a>
</p>

* [Description](#description)
* [Installation](#installation)
* [Usage](#usage)
+ [Creating a bandit and selecting arms](#bandit)
+ [Numerical integration with `numint`](#numint)
* [Documentation](#documentation)
* [License](#license)

## Description

Expand Down Expand Up @@ -179,7 +190,7 @@ use the `Proportional` strategy to make sure that the sampler uses the normalize
A Mab `Sampler` selects an arm given the set of selection probabilities and a string. The default sampler implementation
uses the SHA1 hash of the input string (mod 1000) to determine the arm.

### Numerical Integration with numint
### Numint

The Thompson sampling strategy depends on an integrator for computing probabilities.

Expand All @@ -198,6 +209,10 @@ combinations of normal and beta distributions.

See the `numint` README and documentation for more details.

## Documentation

More detailed refence docs can be found on [pkg.go.dev](https://pkg.go.dev/github.com/stitchfix/mab)

## License

Mab and Numint are licensed under the Apache 2.0 license. See the LICENSE file for terms and conditions for use, reproduction, and
Expand Down

0 comments on commit a8d718b

Please sign in to comment.