Skip to content

Commit 8e7e0c4

Browse files
committed
update descriptions in setup.py and README.md
1 parent a9a3345 commit 8e7e0c4

File tree

3 files changed

+8
-10
lines changed

3 files changed

+8
-10
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,10 @@ The table below compares the execution times of FastTreeSHAP v1 and FastTreeSHAP
4242

4343
## Installation
4444

45-
You can clone the repository and install using pip:
45+
FastTreeSHAP package is available on PyPI and can be installed with pip:
4646

4747
```sh
48-
git clone https://github.com/linkedin/fasttreeshap.git
49-
cd fasttreeshap
50-
pip install .
48+
pip install fasttreeshap
5149
```
5250

5351
Installation troubleshooting:

fasttreeshap/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import warnings
44
import sys
55

6-
__version__ = '0.1.0'
6+
__version__ = '0.1.1'
77

88
# check python version
99
if (sys.version_info < (3, 0)):

setup.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -132,14 +132,14 @@ def run_setup(with_binary, with_openmp, test_xgboost, test_lightgbm, test_catboo
132132
setup(
133133
name='fasttreeshap',
134134
version=find_version("fasttreeshap", "__init__.py"),
135-
description='A fast version of TreeSHAP algorithm.',
136-
long_description="Fast TreeSHAP v1 and v2 are developed to improve the computational "
137-
+"efficiency of TreeSHAP for large datasets, and in practice v1 is 1.5x "
138-
+"faster, and v2 is 2.5x faster at the cost of a slightly higher memory usage.",
135+
description='A fast implementation of TreeSHAP algorithm.',
136+
long_description="FastTreeSHAP package implements two new algorithms FastTreeSHAP v1 and FastTreeSHAP v2, to improve the computational "
137+
+"efficiency of TreeSHAP for large datasets. In practice FastTreeSHAP v1 is 1.5x faster than TreeSHAP while keeping "
138+
+"the memory cost unchanged, and FastTreeSHAP v2 is 2.5x faster than TreeSHAP at the cost of a slightly higher memory usage.",
139139
long_description_content_type="text/markdown",
140140
url='http://github.com/linkedin/fasttreeshap',
141141
author='Jilei Yang',
142-
author_email='jlyang@linkedin.com',
142+
author_email='jlyang0712@gmail.com',
143143
license='BSD 2-CLAUSE',
144144
packages=[
145145
'fasttreeshap', 'fasttreeshap.explainers', 'fasttreeshap.plots', 'fasttreeshap.plots.colors',

0 commit comments

Comments
 (0)