Skip to content

Commit 52f301a

Browse files
committed
readme file added
1 parent a2b3d1c commit 52f301a

File tree

2 files changed

+34
-61
lines changed

2 files changed

+34
-61
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# explainX
2+
3+
explainX.ai helps data scientists understand, explain and validate any machine learning model - in just one line of code. Checkout explainx.ai to learn more.
4+
5+
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar.
6+
7+
```bash
8+
pip install explainx``
9+
10+
## Usage
11+
12+
#Import the library
13+
from explainx import *
14+
15+
#Load Dataset
16+
X_data, Y_data = explainx.dataset_boston()
17+
18+
#Pass X_data, Y_data as numpy arrays into your XGBoost Model
19+
model = xgboost.train({"learning_rate": 0.01}, xgboost.DMatrix(X, label=Y_data), 100)
20+
21+
#Pass your X_data, Y_data, y_variable name, model and model name to the explainx function
22+
explainx.ai(X_data, Y_data, model, model_name="xgboost")
23+
24+
#Click on the link to access the dashboard
25+
App running on https://127.0.0.1:8050
26+
```
27+
28+
## Contributing
29+
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
30+
31+
Please make sure to update tests as appropriate.
32+
33+
## License
34+
[MIT](https://choosealicense.com/licenses/mit/)

compile code.ipynb

Lines changed: 0 additions & 61 deletions
This file was deleted.

0 commit comments

Comments
 (0)