Skip to content

Commit

Permalink
[python] add citation
Browse files Browse the repository at this point in the history
  • Loading branch information
hbaniecki committed Dec 29, 2020
1 parent fb6b246 commit 258bea4
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Expand Up @@ -26,3 +26,5 @@ python/dalex/pdoc_template/*
**/catboost_info/*
**/mlruns/*
*.log

*.gz
15 changes: 15 additions & 0 deletions python/dalex/README.md
Expand Up @@ -41,6 +41,21 @@ Other contributors:
* [Piotr Piatyszek](https://github.com/piotrpiatyszek) maintains the `arena` module
* [Jakub Wisnewski](https://github.com/jakwisn) maintains the `fairness` module

## Citation

If you use `dalex`, please cite our paper:

```
@article{dalex,
title={dalex: Responsible Machine Learning with Interactive Explainability and Fairness in Python},
author={Hubert Baniecki and Wojciech Kretowicz and Piotr Piatyszek and Jakub Wisniewski and Przemyslaw Biecek},
year={2020},
eprint={2012.14406},
archivePrefix={arXiv},
url={https://arxiv.org/abs/2012.14406}
}
```

-------------------------------------------


15 changes: 15 additions & 0 deletions python/dalex/dalex/documentation.md
Expand Up @@ -47,6 +47,21 @@ This package uses [plotly](https://plotly.com/python/) to render the plots:
* Use `show=False` parameter in `plot` method to return `plotly Figure` object
* It is possible to [edit the figures](https://plotly.com/python/#fundamentals) and [save them](https://plotly.com/python/static-image-export/)

## Citation

If you use `dalex`, please cite our paper:

```html
@article{dalex,
title={dalex: Responsible Machine Learning with Interactive Explainability and Fairness in Python},
author={Hubert Baniecki and Wojciech Kretowicz and Piotr Piatyszek and Jakub Wisniewski and Przemyslaw Biecek},
year={2020},
eprint={2012.14406},
archivePrefix={arXiv},
url={https://arxiv.org/abs/2012.14406}
}
```

## Developer

### Class diagram
Expand Down
1 change: 1 addition & 0 deletions python/dalex/setup.cfg
@@ -1,2 +1,3 @@
[metadata]
description-file = README.md
license_files = LICENSE

0 comments on commit 258bea4

Please sign in to comment.