The API reference seems to be broken.

marcotcr / lime

Lime: Explaining the predictions of any machine learning classifier

BSD 2-Clause "Simplified" License

11.5k stars 1.79k forks source link

The API reference seems to be broken. #565

Closed ytfksw closed 3 years ago

ytfksw commented 3 years ago

The API reference seems to be broken. For example, the API says that LimeImageExplainer has parameters such as "training_data", "training_labels" etc. https://lime-ml.readthedocs.io/en/latest/lime.html#lime.lime_image.LimeImageExplainer

On the other hand, there are no such parameters in the docstring of LimeImageExplainer.
https://github.com/marcotcr/lime/blob/a2c7a6fb70bce2e089cb146a31f483bf218875eb/lime/lime_image.py#L89-L116

ytfksw commented 3 years ago

I found the version in the page bottom of the API documentation and that is created at this hash commit 95a948bb.

I think it is better to update the the API documentation.

kennysong commented 3 years ago

The second paragraph of the docstring is also wrong. Looks like it was incorrectly copied from LimeTabularExplainer. Definitely confused me for a few minutes.

marcotcr commented 3 years ago

I think I fixed it now