You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: README.md
+29-3Lines changed: 29 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,32 @@
1
1
2
-
# Bayesian Additive Regression Trees for Probabilistic programming with PyMC
2
+
# Bayesian Additive Regression Trees for Probabilistic Programming with PyMC
3
3
4
4

5
5
6
6
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.
7
7
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
+
8
19
9
20
## Installation
10
21
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:
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:
19
30
20
31
```bash
21
32
pip install pymc-bart
@@ -27,6 +38,21 @@ In case you want to upgrade to the bleeding edge version of the package you can
0 commit comments