Skip to content

Commit

Permalink
Add Usage and Table of Contents, to the README file, enhance Installa…
Browse files Browse the repository at this point in the history
…tion section, and fix top header (#143)

* Add Usage and Table of Contents sections to README, capitalize title, and improve installation option descriptions in README

* Update README.md

* Update README.md

* Apply suggestions from code review

---------

Co-authored-by: Osvaldo A Martin <[email protected]>
  • Loading branch information
NicholasLindner and aloctavodia authored Feb 12, 2024
1 parent 4d9fec3 commit 548e5c6
Showing 1 changed file with 29 additions and 3 deletions.
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,32 @@

# Bayesian Additive Regression Trees for Probabilistic programming with PyMC
# Bayesian Additive Regression Trees for Probabilistic Programming with PyMC

![pymc-bart logo](docs/logos/pymc_bart.png)

PyMC-BART extends [PyMC](https://github.com/pymc-devs/pymc) probabilistic programming framework to be able to define and solve models including a BART random variable. PyMC-BART also includes a few helpers function to aid with the interpretation of those models and perform variable selection.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Contributions](#contributions)
- [Code of Conduct](#code-of-conduct)
- [Citation](#citation)
- [License](#license)
- [Donations](#donations)
- [Sponsors](#sponsors)


## Installation

PyMC-BART is available on Conda-Forge. To set up a suitable Conda environment, run
PyMC-BART is available on Conda-Forge. If you magange your Python dependencies and environments with Conda, this is your best option. You may also perfer to install this way if you want an easy-to-use, isolated setup in a seperate environment. This helps avoid interfering with other projects or system-wide Python installations. To set up a suitable Conda environment, run:

```bash
conda create --name=pymc-bart --channel=conda-forge pymc-bart
conda activate pymc-bart
```

Alternatively, it can be installed with
Alternatively, you can use pip installation. This installation is generally perfered by users who use pip, Python's package installer. This is the best choice for users who are not using Conda or for those who want to install PyMC-BART into a virtual environment managed by venv or virtualenv. In this case, run:

```bash
pip install pymc-bart
Expand All @@ -27,6 +38,21 @@ In case you want to upgrade to the bleeding edge version of the package you can
pip install git+https://github.com/pymc-devs/pymc-bart.git
```

## Usage

Get started by using PyMC-BART to set up a BART model:

```python
import pymc as pm
import pymc_bart as pmb

X, y = ... # Your data replaces "..."
with pm.Model() as model:
bart = pmb.BART('bart', X, y)
...
idata = pm.sample()
```

## Contributions
PyMC-BART is a community project and welcomes contributions.
Additional information can be found in the [Contributing Readme](https://github.com/pymc-devs/pymc-bart/blob/main/CONTRIBUTING.md)
Expand Down

0 comments on commit 548e5c6

Please sign in to comment.