Skip to content

Commit

Permalink
add Yann's paper (#52)
Browse files Browse the repository at this point in the history
  • Loading branch information
aloctavodia authored Oct 11, 2023
1 parent aa53673 commit 24924b6
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 7 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Kullback-Leibler projections for Bayesian model selection in Python.
## Overview

Kulprit _(Pronounced: kuːl.prɪt)_ is a package for variable selection for [Bambi](https://github.com/bambinos/bambi) models.
Kulprit is under active development so use with care. If you find any bugs or have any feature requests, please open an issue.


## Installation
Expand All @@ -27,7 +28,7 @@ Alternatively, if you want the bleeding edge version of the package you can inst

## Documentation

The Kulprit documentation can be found in the [official docs](https://kulprit.readthedocs.io/en/latest/)
The Kulprit documentation can be found in the [official docs](https://kulprit.readthedocs.io/en/latest/). If you are not familiar with the theory behind Kulprit or need some practical advice on how to use Kulprit or interpret its results, we recommend you read the paper [Robust and efficient projection predictive inference](https://arxiv.org/abs/2306.15581). You may also find useful this [guide](https://avehtari.github.io/modelselection/CV-FAQ.html) on Cross-Validation and model selection.


## Development
Expand All @@ -41,6 +42,23 @@ Kulprit is a community project and welcomes contributions. Additional informatio

For a list of contributors see the [GitHub contributor](https://github.com/bambinos/kulprit/graphs/contributors) page


## Citation

If you use Bambi and want to cite it please use

```
@misc{mclatchie2023,
title={Robust and efficient projection predictive inference},
author={Yann McLatchie and Sölvi Rögnvaldsson and Frank Weber and Aki Vehtari},
year={2023},
eprint={2306.15581},
archivePrefix={arXiv},
primaryClass={stat.ME}
}
```


## Donations

If you want to support Kulprit financially, you can [make a donation](https://numfocus.org/donate-to-pymc) to our sister project PyMC.
Expand Down
36 changes: 30 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,16 @@ Kullback-Leibler projections for Bayesian model selection
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black

Kulprit is under active development so use with care. If you find any bugs or have any feature requests, please open an issue on GitHub.


Dependencies
============
Kulprit is tested on Python 3.9+.

Besides this documentation, we also recomend you to read [Robust and efficient projection predictive inference](https://arxiv.org/abs/2306.15581). The paper is not
about Kulprit, but introduces the theory behind Kulprit and also provides some practical advice. You may also find useful this [guide](https://avehtari.github.io/modelselection/CV-FAQ.html)
on Cross-Validation and model selection.

Installation
============

Kulprit requires a working Python interpreter (3.9+). We recommend installing Python and key numerical libraries using the [Anaconda Distribution](https://www.anaconda.com/products/individual#Downloads), which has one-click installers available on all major platforms.
Kulprit requires a working Python interpreter (3.9+). We recommend installing Python and key numerical libraries using the `Anaconda Distribution <https://www.anaconda.com/products/individual#Downloads>`_, which has one-click installers available on all major platforms.

Assuming a standard Python environment is installed on your machine (including pip), Kulprit itself can be installed in one line using pip:

Expand All @@ -39,16 +38,41 @@ Alternatively, if you want the bleeding edge version of the package you can inst
pip install git+https://github.com/bambinos/kulprit.git
Dependencies
============

Kulprit is tested on Python 3.9+. Dependencies are listed in `pyproject.toml` and should all be installed by the Kulprit installer; no further action should be required.


Contributing
============

We welcome contributions from interested individuals or groups!
For information about contributing to Kulrpit check out our instructions, policies, and guidelines `here <https://github.com/bambinos/kulprit/blob/main/CONTRIBUTING.md>`_.


Contributors
============
See the `GitHub contributor page <https://github.com/bambinos/kulprit/graphs/contributors>`_.


Citation
========

If you find Kulprit useful in your work, please cite the following paper:

.. code-block:: latex

@misc{mclatchie2023,
title={Robust and efficient projection predictive inference},
author={Yann McLatchie and Sölvi Rögnvaldsson and Frank Weber and Aki Vehtari},
year={2023},
eprint={2306.15581},
archivePrefix={arXiv},
primaryClass={stat.ME}
}


Donations
============

Expand Down

0 comments on commit 24924b6

Please sign in to comment.