Updates Docs and Readme #300
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…te-readme # Conflicts: # README.md
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request includes several updates to the
shapiqpackage, focusing on documentation improvements, version updates, and code enhancements for better clarity and accuracy. The most important changes include updating the version number, refining the documentation, adding new references, and updating the README.This PR closes #288.
Documentation Updates:
README.md: Added new sections for computing Shapley values, contributing guidelines, license information, and funding acknowledgments. Updated existing sections with more detailed explanations and examples. [1] [2] [3]shapiq/approximator/marginals/stratified.py: Improved documentation for theStratifiedSamplingSVclass, including more detailed explanations and references. [1] [2] [3] [4] [5]shapiq/approximator/montecarlo/shapiq.py: Enhanced documentation for theSHAPIQandUnbiasedKernelSHAPclasses with additional references and examples. [1] [2] [3] [4]Version Update:
shapiq/__init__.py: Updated the version number from1.1.1.devto1.1.2.Changelog Update:
CHANGELOG.md: Updated the changelog to reflect the new versionv1.1.2and listed the changes made in this release.Code Clarity Improvements:
shapiq/approximator/marginals/stratified.py: Removed unnecessary comments and improved the readability of the code. [1] [2]shapiq/approximator/montecarlo/svarmiq.py: Enhanced documentation for theSVARMIQandSVARMclasses with additional references and clearer explanations. [1] [2] [3]shapiq/approximator/permutation/sii.py: Improved documentation for thePermutationSamplingSIIclass with additional references.