@@ -108,37 +108,38 @@ For **Directed Acyclic Graph (DAG)** implementation, there are 4 main components
108108
109109## Installation
110110
111- There are two ways to install ` bigtree ` , with pip (recommended) or conda.
111+ ` bigtree ` requires Python 3.8+. There are two ways to install ` bigtree ` , with pip (recommended) or conda.
112112
113113### a) Installation with pip
114114
115+ #### Basic Installation
116+
115117To install ` bigtree ` , run the following line in command prompt:
116118
117119``` console
118120$ pip install bigtree
119121```
120122
121- If tree needs to use pandas or polars methods, it requires additional dependencies.
122- Run the following lines in command prompt:
123+ #### Installing optional dependencies
124+
125+ ` bigtree ` have a number of optional dependencies, which can be installed using "extras" syntax.
123126
124127``` console
125- $ pip install ' bigtree[pandas]'
126- $ pip install ' bigtree[polars]'
128+ $ pip install ' bigtree[extra_1, extra_2]'
127129```
128130
129- If tree needs to be exported to image, it requires additional dependencies.
130- Run the following lines in command prompt:
131+ Examples of extra packages include:
131132
132- ``` console
133- $ pip install ' bigtree[image]'
134- $ brew install gprof2dot # for MacOS
135- $ conda install graphviz # for Windows
136- ```
133+ - ` all ` : include all optional dependencies
134+ - ` image ` : for exporting tree to image
135+ - ` pandas ` : for pandas methods
136+ - ` polars ` : for polars methods
137137
138- Alternatively, install all optional dependencies with the following line in command prompt:
138+ For ` image ` extra dependency, you may need to install more plugins.
139139
140140``` console
141- $ pip install ' bigtree[all]'
141+ $ brew install gprof2dot # for MacOS
142+ $ conda install graphviz # for Windows
142143```
143144
144145### b) Installation with conda
0 commit comments