Documentation update, particularly on metrics #103
Merged
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 documentation of the Unraphael project, including improvements to the contributing guidelines, credits, project description, and detailed steps for image clustering. The most important changes are categorized into updates to contributing guidelines, credits and contact information, project description, and image clustering documentation.
Updates to Contributing Guidelines:
docs/CONTRIBUTING.md: Updated the path reference for the contributing guidelines.Credits and Contact Information:
docs/credits.md: Added a detailed credits and contact information section, including general inquiries, technical support, collaboration opportunities, and social media links.Project Description:
docs/index.md: Added a comprehensive description of the Unraphael tool, highlighting its purpose, features, and applicability beyond the study of Raphael's paintings.Image Clustering Documentation:
docs/steps/clustering.md: Enhanced the documentation for the image clustering process, detailing key features, preprocessing steps, clustering methods, and evaluation metrics. This includes a structured workflow for displaying, equalizing, aligning, and clustering images, as well as viewing cluster results and performance metrics. [1] [2] [3] [4]Navigation Updates:
mkdocs.yml: Updated the navigation structure to include the new credits page and reorganized the tutorials section.