diff --git a/README.md b/README.md index faf8839..7053314 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/index.md b/docs/index.md index f00bbe9..378fe14 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 @@ -58,15 +81,6 @@ plt.show() -## 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.