-
-
Notifications
You must be signed in to change notification settings - Fork 45
Enhance user guide #22
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
base: main
Are you sure you want to change the base?
Conversation
ombhojane
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this detailed contribution to our documentation! We really appreciate the effort to create a comprehensive user guide. However, there are some discrepancies between the guide and our actual codebase that we need to address:
- The main class in our package is
XAIWrapper, notModelExplainer - Some of the methods mentioned don't exist in our current implementation
- The API examples need to be updated to match our actual API
Could you please revise the guide to align with our current implementation? Here are some key points to address:
- Update all examples to use
XAIWrapperinstead ofModelExplainer - Update the method names to match our actual API:
fit()instead offit_model()analyze()instead ofexplain_model()- Use actual method signatures from our codebase
changes commited
|
@ombhojane made the changes accordingly. |
|
#39 is the similar issue, please go through it. |
|
made some changes please have a look @ombhojane |
ombhojane
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for contributing,
Your'e almost done. Please make following changes:
- EDAExplainer. ModelExplainer, etc. not at all exsitis in out package. Please document the only functions which are there. don't rely on ai, it hallucinates. Please confirm twice when you finalizing the doc.
- please have this user_guide.md in '/docs' dir. create a new /docs dir for this
Please do this necessary changes, Im looking to merge this
changed the model names which were not present in the repo.
|
@ombhojane made the changes accordingly. |
|
Ahh, user guide already exists as I mentioned a PR earlier, I really appreciate your efforts! Please checkout docs directory. |
|
is it still open to contribute @Amikumarsingh |
The goal of this update is to provide users with more detailed, accessible documentation that makes ExplainableAI easier to adopt and implement in machine learning projects. By adding real-world examples and best practices, this guide will help both beginner and advanced users maximize the value of the ExplainableAI package.