Skip to content

Commit d94f3b0

Browse files
committed
README.md
1 parent aebc0ac commit d94f3b0

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/index.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,32 @@ PyMC-BART
1919
Bayesian Additive Regression Trees for Probabilistic programming with PyMC
2020

2121

22+
Overview
23+
============
24+
PyMC-BART extends `PyMC <https://github.com/pymc-devs/pymc>`_. probabilistic programming framework to be able to define
25+
and solve models including a BART random variable. PyMC-BART also includes a few helpers function to help interpret
26+
those models and perform variable selection.
27+
28+
2229
Dependencies
2330
============
2431
PyMC-BART is tested on Python 3.8+ and depends on PyMC V4.
2532

33+
2634
Installation
2735
============
2836

37+
38+
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.
39+
40+
Assuming a standard Python environment is installed on your machine (including pip), PyMC-BART itself can be installed in one line using pip:
41+
42+
.. code-block:: bash
43+
44+
pip install pymc-bart
45+
46+
Alternatively, if you want the bleeding edge version of the package you can install from GitHub:
47+
2948
.. code-block:: bash
3049
3150
pip install git+https://github.com/pymc-devs/pymc-bart.git

0 commit comments

Comments
 (0)