Skip to content

Commit 548e5c6

Browse files
Add Usage and Table of Contents, to the README file, enhance Installation 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]>
1 parent 4d9fec3 commit 548e5c6

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,32 @@
11

2-
# Bayesian Additive Regression Trees for Probabilistic programming with PyMC
2+
# Bayesian Additive Regression Trees for Probabilistic Programming with PyMC
33

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

66
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.
77

8+
## Table of Contents
9+
10+
- [Installation](#installation)
11+
- [Usage](#usage)
12+
- [Contributions](#contributions)
13+
- [Code of Conduct](#code-of-conduct)
14+
- [Citation](#citation)
15+
- [License](#license)
16+
- [Donations](#donations)
17+
- [Sponsors](#sponsors)
18+
819

920
## Installation
1021

11-
PyMC-BART is available on Conda-Forge. To set up a suitable Conda environment, run
22+
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:
1223

1324
```bash
1425
conda create --name=pymc-bart --channel=conda-forge pymc-bart
1526
conda activate pymc-bart
1627
```
1728

18-
Alternatively, it can be installed with
29+
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:
1930

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

41+
## Usage
42+
43+
Get started by using PyMC-BART to set up a BART model:
44+
45+
```python
46+
import pymc as pm
47+
import pymc_bart as pmb
48+
49+
X, y = ... # Your data replaces "..."
50+
with pm.Model() as model:
51+
bart = pmb.BART('bart', X, y)
52+
...
53+
idata = pm.sample()
54+
```
55+
3056
## Contributions
3157
PyMC-BART is a community project and welcomes contributions.
3258
Additional information can be found in the [Contributing Readme](https://github.com/pymc-devs/pymc-bart/blob/main/CONTRIBUTING.md)

0 commit comments

Comments
 (0)