Skip to content

Update documentation for v2.0 - #183

Draft
Agustin-Picard wants to merge 4 commits into
masterfrom
update-docs-v2.0
Draft

Update documentation for v2.0#183
Agustin-Picard wants to merge 4 commits into
masterfrom
update-docs-v2.0

Conversation

@Agustin-Picard

Copy link
Copy Markdown
Member

This pull request updates the documentation to introduce and describe the new Holistic CRAFT feature for concept-based explanations, expands the supported Python and TensorFlow versions, and clarifies installation and usage instructions. It also improves the organization and coverage of modules and tutorials, and updates compatibility and feature tables throughout the docs.

Major documentation updates:

Holistic CRAFT and concept-based explanations:

  • Added extensive documentation and usage examples for Holistic CRAFT (HolisticCraftTf, HolisticCraftTorch), including support for object detection models through the upcoming xplique-adapters package, and clarified when to use Holistic CRAFT versus regular CRAFT. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]

Module and compatibility updates:

  • Updated the README and module tables to reflect the addition of the Example-based module (now five modules in total), expanded supported Python versions (3.10–3.13), and updated TensorFlow support to versions 2.18–2.20. Installation instructions for PyTorch dependencies are also clarified. [1] [2] [3] [4] [5]

Tutorials and references:

  • Added and reorganized tutorials and documentation links for Holistic CRAFT and stability metrics, and improved cross-references between concept extraction methods. [1] [2] [3] [4]

General improvements and clarifications:

  • Improved the language and structure of module descriptions, clarified the status of the xplique-adapters package, and updated links to point to the latest documentation. [1] [2] [3]

These changes ensure the documentation accurately reflects the new features and compatibility, and provides clear guidance for users on installation, supported workflows, and the use of Holistic CRAFT for both classification and object detection models.

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.

1 participant