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

refactoring the documentation #17

Closed
wants to merge 2 commits into from
Closed

Conversation

luisa-hoerauf
Copy link

No description provided.

@luisa-hoerauf
Copy link
Author

I changed the explanations for Unicity, Summation and Association. The quotes are from the article you linked. An option would be as well to leave your description and put the quotes as an explanation for the illustration.

@@ -88,7 +88,9 @@ that is the difference of what's in the combination space in that coalition and
('D', 'A'),
('C', 'D', 'A')]
```
As you can see, for example when combination is `{'D'}` the corresponding complement is `('C', 'B', 'A')`. Note the difference in types, combination space is an `OrderedSet` of `frozenset`s so the Shapley value calculations are quicker while complement space is an `OrderedSet` of `Tuples` So handling it in your objective function is easier. Speaking of, let's make the worst objective function that just produces random values regardless of what's what (see the example `on ground-truth models.ipynb` for a more elaborate version.)[(see the example `on ground-truth models.ipynb` for a more elaborate version.)](https://github.com/kuffmode/msa/blob/main/examples/on%20ground-truth%20models.ipynb)
As you can see, for example when combination is `{'D'}` the corresponding complement is `('C', 'B', 'A')`. Note the difference in types, combination space is an `OrderedSet` of `frozenset`s so the Shapley value calculations are quicker while complement space is an `OrderedSet` of `Tuples` So handling it in your objective function is easier. Speaking of, let's make the worst objective function that just produces random values regardless of what's what (see the example `on ground-truth models.ipynb` for a more elaborate version).
For that we use the function 'random.randit' which returns random integers.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's actually "np.random.randint" because Python has a separate module called random, so it might be confusing.

@luisa-hoerauf
Copy link
Author

Hey you,
I wrote down my notes for you about the things I am not able to change.. That takes your knowledge :)
So lemme now if some points are not clear or something.

Chapter „home“:

  • „..most important player gets the biggest chunk. Shapley value is then that chunk”

Do you mean shapely value is that one big chunk or are shapely values the different chunks?
You should maybe already explain what shapely values mean e.g. : indicates which payout the players can expect depending on a coalition function. Or use your own explanation you use somewhere else: “shapely values are the summed up contributions of elements, while we calculate them in MSA through disturbance”.

  • Step from permutation space to combination space is not that clear. What does MSA do here? In the text you just say “MSA then produces a combination space”

General stuff:

  • Some head() table outputs do not work in safari
  • If you print out values, explain what that means: e.g. a value of -29,.. means that…
  • Big tables might need a slider on the top as well, otherwise not that handy
  • In API order of headlines maybe put “make permutation space” before “combination space”, to have same order as in your illustration (that one in “Home” chapter).
  • Explain above each code what the code means/ what you are doing there (even if its just a standard code for plotting, write it down)
  • You could alter the links you are using to links which open in a new tab automatically
  • Among the examples the “Minimal examples of how to use MSA” really explains how MSA works, that’s why you could put it at first
  • In “Mnist torch” you have a user warning after “Loading Data”

@kuffmode kuffmode closed this Jun 19, 2024
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.

None yet

2 participants