Skip to content

Commit f16718b

Browse files
committed
docs: add roadmap to readme
1 parent d4d3f93 commit f16718b

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ ipython_config.py
8787
# pyenv
8888
.python-version
8989

90+
.vscode/
91+
9092
# pipenv
9193
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
9294
# However, in case of collaboration, if having platform-specific dependencies or dependencies

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,16 @@
22

33
Better insights into Machine Learning models performance.
44

5-
Modelsight is a collection of functions that create publication-ready graphics for the visual evaluation of your binary classifiers.
5+
Modelsight is a collection of functions that create publication-ready graphics for the visual evaluation of binary classifiers adhering to the scikit-learn interface.
66

7-
It is strongly oriented towards the evaluation of already fitted `ExplainableBoostingClassifier` of the [interpretml](https://github.com/interpretml/interpret) package.
7+
Modelsight is strongly oriented towards the evaluation of already fitted `ExplainableBoostingClassifier` of the [interpretml](https://github.com/interpretml/interpret) package.
88

99
## Installation
1010
```console
1111
$ pip install modelsight
1212
```
1313

1414
## Usage
15-
1615
See the [example](/docs/example.ipynb) notebook.
1716

1817
## Contributing
@@ -23,6 +22,13 @@ Interested in contributing? Check out the contributing guidelines. Please note t
2322

2423
`modelsight` was created by Francesco Pisu. It is licensed under the terms of the GNU General Public License v3.0 license.
2524

25+
## Roadmap
26+
- Features
27+
[] Average ROC and PR curves
28+
[] Feature importance (Global explanation)
29+
[] Individualized explanations (Local explanation)
30+
31+
2632
## Credits
2733

2834
`modelsight` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).

0 commit comments

Comments
 (0)