Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance documentation for LocalModel #187

Merged
merged 1 commit into from
Apr 8, 2022

Conversation

mirka-henninger
Copy link
Contributor

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

@codecov-commenter
Copy link

Codecov Report

Merging #187 (7ba5dd6) into main (cf7266d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #187   +/-   ##
=======================================
  Coverage   90.04%   90.04%           
=======================================
  Files          17       17           
  Lines        1667     1667           
=======================================
  Hits         1501     1501           
  Misses        166      166           
Impacted Files Coverage Δ
R/LocalModel.R 97.59% <ø> (ø)

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@christophM
Copy link
Collaborator

christophM commented Apr 8, 2022

Thanks for the PR.

@christophM christophM merged commit 8a946e2 into giuseppec:main Apr 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants