Enhance documentation for LocalModel #187
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The range and standard deviation of the features has a huge influence on the distance measure (distance between the data and the interest of interest) and therewith lime results when the LocalModel function is used. This is also discussed, e.g., in this stackoverflow thread for clustering analyses.
In the lime package by Pedersen and Bernesty, features are scaled before the distance measure is computed. However, there might be reasons where scaling is not desired, e.g., when features have some kind of natural scale. But I think it would at least be a good idea to inform the iml user that scaling the features might be advisable when they want to use lime as an interpretation technique as scaling can influence the computed distance. Therefore, I added this text to the documentation of the LocalModel function, so users can decide themselves whether they would like to scale their features or get more information about the topic.
Thanks for providing and taking care of this package!
Mirka