[DOCS] Clustering Tutorial

[jacobmarks]

Workflow tutorial on clustering image datasets in FiftyOne with embeddings

Static PDF here: Clustering Images with Embeddings — FiftyOne 0.24.0 documentation.pdf

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

• No. You can skip the rest of this section.
• Yes. Give a description of this change to be included in the release
  notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

• App: FiftyOne application changes
• Build: Build and test infrastructure changes
• Core: Core fiftyone Python library changes
• Documentation: FiftyOne documentation changes
• Other

Summary by CodeRabbit

• Documentation
  • Added a new tutorial on clustering images with embeddings, covering basics, feature generation, using K-means and HDBSCAN algorithms, visualizing, and labeling clusters with GPT-4V.
  • Updated tutorials index with a link to the new "Clustering Images with Embeddings" tutorial.

[coderabbitai]

Walkthrough

A fresh tutorial on clustering images with embeddings has been introduced, guiding through the use of Scikit-learn and FiftyOne for this purpose. It spans from the basics of clustering to the application of algorithms like K-means and HDBSCAN, and even includes visualization and labeling with GPT-4V, enriching the learning resources available.

Changes

File Path	Change Summary
.../tutorials/clustering.ipynb	Introduced a tutorial on clustering images using embeddings with Scikit-learn and FiftyOne.
.../tutorials/index.rst	Added a new tutorial card for "Clustering Images with Embeddings" and included a link in the tutorial list.

🐇✨
In the realm of data, under the digital sky,
A new tutorial blooms, its wisdom vast and high.
Clustering images, a dance of dots and lines,
With algorithms as guides, through the data, it winds.
Rejoice in learning, for knowledge is a treasure,
Unlocked by curiosity, beyond any measure.
🌟📚

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between aff97ce and 06af687.

Files ignored due to path filters (11)

• docs/source/_static/images/tutorials/clustering.jpg is excluded by !**/*.jpg, !**/*.jpg
• docs/source/tutorials/images/clustering_color_by_cluster.gif is excluded by !**/*.gif, !**/*.gif
• docs/source/tutorials/images/clustering_compute_clusters_operator.gif is excluded by !**/*.gif, !**/*.gif
• docs/source/tutorials/images/clustering_dataset_in_app.jpg is excluded by !**/*.jpg, !**/*.jpg
• docs/source/tutorials/images/clustering_filter_by_cluster_number.gif is excluded by !**/*.gif, !**/*.gif
• docs/source/tutorials/images/clustering_get_clustering_info.jpg is excluded by !**/*.jpg, !**/*.jpg
• docs/source/tutorials/images/clustering_gpt4v_labeling.gif is excluded by !**/*.gif, !**/*.gif
• docs/source/tutorials/images/clustering_hdbscan.gif is excluded by !**/*.gif, !**/*.gif
• docs/source/tutorials/images/clustering_open_embeddings_panel.gif is excluded by !**/*.gif, !**/*.gif
• docs/source/tutorials/images/clustering_preview.jpg is excluded by !**/*.jpg, !**/*.jpg
• docs/source/tutorials/images/clustering_umap_limitation.gif is excluded by !**/*.gif, !**/*.gif

Files selected for processing (2)

• docs/source/tutorials/clustering.ipynb (1 hunks)
• docs/source/tutorials/index.rst (2 hunks)

Additional comments not posted (4)

docs/source/tutorials/index.rst (1)

162-167: The addition of the "Clustering Images with Embeddings" tutorial card looks good and follows the established format for tutorial cards. Ensure the clustering.html link and the image path ../_static/images/tutorials/clustering.jpg are correct and accessible.

docs/source/tutorials/clustering.ipynb (3)

1-215: The introduction and setup instructions in the tutorial are clear and informative. Ensure that all external links are accurate and that the installation commands for scikit-learn, fiftyone, umap-learn, and CLIP are up-to-date.

---

216-372: The sections on generating features, clustering, and visualizing clusters are well-explained and demonstrate the use of FiftyOne and Scikit-learn effectively. Ensure that the code snippets are efficient and follow best practices for data processing and visualization.

---

373-543: The sections on labeling clusters with GPT-4V and the conclusion are well-crafted, providing innovative insights and a comprehensive summary of the tutorial. Ensure the description of GPT-4V integration is accurate and that the conclusion effectively highlights the tutorial's main takeaways.

[brimoor]

Very nice! will pull this into fiftyone==0.23.8 😄