Skip to content

Commit

Permalink
update the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wd60622 committed Jan 9, 2024
1 parent 25b92b2 commit 8b12953
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 9 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,31 @@ Bayesian conjugate models in Python
pip install conjugate-models
```

## Features

- [Connection to Scipy Distributions](./docs/examples/scipy-connection.md) with `dist` attribute
- [Built in Plotting](./docs/examples/plotting.md) with `plot_pdf` and `plot_pmf` methods
- [Vectorized Operations](./docs/examples/vectorized-inputs.md) for parameters and data
- [Indexing Parameters](./docs/examples/indexing.md) for subsetting and slicing
- [Generalized Numerical Inputs](./docs/examples/generalized-inputs.md) for inputs other than builtins and numpy arrays
- [Unsupported Distributions](./docs/examples/pymc-sampling.md) for sampling from unsupported distributions

## Supported Models

Many likelihoods are supported including

- `Bernoulli` / `Binomial`
- `Categorical` / `Multinomial`
- `Poisson`
- `Normal` (including linear regression)
- and [many more](./docs/models.md)

## Basic Usage

1. Define prior distribution from `distributions` module
1. Pass data and prior into model from `models` modules
1. Analytics with posterior and posterior predictive distributions

```python
from conjugate.distributions import Beta, BetaBinomial
from conjugate.models import binomial_beta, binomial_beta_posterior_predictive
Expand Down
32 changes: 23 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,31 @@ Bayesian conjugate models in Python
pip install conjugate-models
```

## Features

- [Connection to Scipy Distributions](examples/scipy-connection.md) with `dist` attribute
- [Built in Plotting](examples/plotting.md) with `plot_pdf` and `plot_pmf` methods
- [Vectorized Operations](examples/vectorized-inputs.md) for parameters and data
- [Indexing Parameters](examples/indexing.md) for subsetting and slicing
- [Generalized Numerical Inputs](examples/generalized-inputs.md) for inputs other than builtins and numpy arrays
- [Unsupported Distributions](examples/pymc-sampling.md) for sampling from unsupported distributions

## Supported Models

Many likelihoods are supported including

- `Bernoulli` / `Binomial`
- `Categorical` / `Multinomial`
- `Poisson`
- `Normal` (including linear regression)
- and [many more](models.md)

## Basic Usage

1. Define prior distribution from `distributions` module
1. Pass data and prior into model from `models` modules
1. Analytics with posterior and posterior predictive distributions

```python
from conjugate.distributions import Beta, BetaBinomial
from conjugate.models import binomial_beta, binomial_beta_posterior_predictive
Expand Down Expand Up @@ -58,15 +81,6 @@ plt.show()

<img height=400 src="images/binomial-beta.png" title="Binomial Beta Comparison">

## Features

- [Connection to Scipy Distributions](examples/scipy-connection.md) with `dist` attribute
- [Built in Plotting](examples/plotting.md) with `plot_pdf` and `plot_pmf` methods
- [Vectorized Operations](examples/vectorized-inputs.md) for parameters and data
- [Indexing Parameters](examples/indexing.md) for subsetting and slicing
- [Generalized Numerical Inputs](examples/generalized-inputs.md) for inputs other than builtins and numpy arrays
- [Unsupported Distributions](examples/pymc-sampling.md) for sampling from unsupported distributions

## Too Simple?

Simple model, sure. Useful model, potentially.
Expand Down

0 comments on commit 8b12953

Please sign in to comment.