Skip to content

Conversation

@Amikumarsingh
Copy link

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.

Copy link
Owner

@ombhojane ombhojane left a 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:

  1. The main class in our package is XAIWrapper, not ModelExplainer
  2. Some of the methods mentioned don't exist in our current implementation
  3. 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:

  1. Update all examples to use XAIWrapper instead of ModelExplainer
  2. Update the method names to match our actual API:
    • fit() instead of fit_model()
    • analyze() instead of explain_model()
    • Use actual method signatures from our codebase

changes commited
@Amikumarsingh
Copy link
Author

@ombhojane made the changes accordingly.

@ombhojane
Copy link
Owner

#39 is the similar issue, please go through it.
we're expecting user guide in that format. along function snippets you created

@Amikumarsingh
Copy link
Author

made some changes please have a look @ombhojane

Copy link
Owner

@ombhojane ombhojane left a 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:

  1. 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.
  2. 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.
@Amikumarsingh
Copy link
Author

@ombhojane made the changes accordingly.

@ombhojane
Copy link
Owner

Ahh, user guide already exists as I mentioned a PR earlier, I really appreciate your efforts! Please checkout docs directory.
You may look to enhance that user guide, check the content if everything it right and add missing content relevant to our python package

@Praveen-koujalagi
Copy link

is it still open to contribute @Amikumarsingh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation good first issue Good for newcomers gssoc-ext hacktoberfest-accepted level2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants