Skip to content

Commit 7c96a92

Browse files
committed
update installation and overview
1 parent d94f3b0 commit 7c96a92

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,29 @@
11

22
Bayesian Additive Regression Trees for Probabilistic programming with PyMC
33

4+
## Overview
5+
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 help interpret those models and perform variable selection.
6+
7+
8+
## Installation
9+
10+
PyMC-BART requires a working Python interpreter (3.8+). 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.
11+
12+
Assuming a standard Python environment is installed on your machine (including pip), PyMC-BART itself can be installed in one line using pip:
13+
14+
pip install pymc-bart
15+
16+
Alternatively, if you want the bleeding edge version of the package you can install from GitHub:
17+
18+
pip install git+https://github.com/pymc-devs/pymc-bart.git
19+
420

521
## Contributions
6-
pymc_bart is a community project and welcomes contributions.
22+
PyMC-BART is a community project and welcomes contributions.
723
Additional information can be found in the [Contributing Readme](https://github.com/pymc-devs/pymc_bart/blob/main/CONTRIBUTING.md)
824

9-
1025
## Code of Conduct
11-
pymc_bart wishes to maintain a positive community. Additional details
26+
PyMC-BART wishes to maintain a positive community. Additional details
1227
can be found in the [Code of Conduct](https://github.com/pymc-devs/pymc_bart/blob/main/CODE_OF_CONDUCT.md)
1328

1429
## Citation
@@ -28,7 +43,7 @@ primaryClass={stat.CO}
2843
```
2944

3045
## Donations
31-
pymc_bart, as other pymc-devs projects, is a non-profit project under the NumFOCUS umbrella. If you want to support pymc_bart financially, you can donate [here](https://numfocus.org/donate-to-pymc).
46+
PyMC-BART , as other pymc-devs projects, is a non-profit project under the NumFOCUS umbrella. If you want to support PyMC-BART financially, you can donate [here](https://numfocus.org/donate-to-pymc).
3247

3348
## Sponsors
3449
[![NumFOCUS](https://www.numfocus.org/wp-content/uploads/2017/07/NumFocus_LRG.png)](https://numfocus.org)

0 commit comments

Comments
 (0)