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.

Sign up for GitHub

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

Jump to bottom

Add tabular example to getting start in readme #688

Merged
merged 3 commits into from
Jan 11, 2024
Merged

Add tabular example to getting start in readme #688

merged 3 commits into from
Jan 11, 2024

Conversation

geek-yang
Copy link
Member

@geek-yang geek-yang commented Jan 11, 2024 •
edited
Loading

Add tabular example to getting start section in readme.

This PR closes #686 .

@geek-yang geek-yang marked this pull request as ready for review January 11, 2024 10:22
@elboyran
Copy link
Contributor

There seems to be a dead link found by the markdown checker.

elboyran
elboyran approved these changes Jan 11, 2024
View reviewed changes
Copy link
Contributor

@elboyran elboyran left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks!
The only remark I have is for "Run using the XAI methods of your choice.", We don't have RISE supported (yet). right? Maybe we still leave it like you wrote to be future proof.

@geek-yang
Copy link
Member Author

Looks good to me, thanks! The only remark I have is for "Run using the XAI methods of your choice.", We don't have RISE supported (yet). right? Maybe we still leave it like you wrote to be future proof.

Thanks for the review. We have both RISE and SHAP (soon to be merged) for now and plan to support RISE in the future. So I think we can leave it like this.

@geek-yang
Copy link
Member Author

There seems to be a dead link found by the markdown checker.

It is due to a broken link for the joss badge. Not relevant with this PR, but it is fixed here.

@geek-yang geek-yang merged commit b4793b2 into main Jan 11, 2024
17 checks passed
@geek-yang geek-yang deleted the tabular_example_readme branch January 11, 2024 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elboyran elboyran elboyran approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add tabular example in the Getting started section of the README.
2 participants
@geek-yang @elboyran