Cherry-picking #5224 for release

[brimoor]

Cherry-picking #5224 for release

Summary by CodeRabbit

• New Features
  • Introduced support for models with 'zero-shot' and 'transformer' in their names, enabling detection of multiple classes including "person", "dog", "cat", "bird", "car", "tree", and "chair".
  • Enhanced functionality to apply these models to datasets and launch the FiftyOne app for analysis.

[coderabbitai]

Walkthrough

The changes introduce a new conditional block in the _render_model_content function of the make_model_zoo_docs.py script. This block is specifically designed to handle models containing the terms 'zero-shot' and 'transformer' in their names, enabling the loading of a predefined list of classes and applying the model to the dataset. The modifications enhance the script's functionality without altering the overall structure or logic of existing templates and rendering functions.

Changes

File	Change Summary
docs/scripts/make_model_zoo_docs.py	Added a conditional block in _render_model_content to handle models with 'zero-shot' and 'transformer' in their names, loading specific classes and applying the model to the dataset.

Possibly related PRs

• Fixed example for zero-shot-detection-transformer-torch #5224: This PR directly modifies the same _render_model_content function in docs/scripts/make_model_zoo_docs.py to handle the 'zero-shot-detection-transformer-torch' model, which is the same model addressed in the main PR.

🐰 In the garden, where models play,
A new friend hops in, hip-hip-hooray!
With classes of creatures, both big and small,
The zero-shot magic will capture them all!
So let’s render the joy, let’s share the delight,
With FiftyOne shining, our future is bright! 🌟

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8e85dd4 and ec234cd.

📒 Files selected for processing (1)

• docs/scripts/make_model_zoo_docs.py (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/scripts/make_model_zoo_docs.py

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

🧹 Outside diff range and nitpick comments (1)

docs/scripts/make_model_zoo_docs.py (1)

176-184: Consider adding a second example demonstrating custom classes.

Since this is a zero-shot detection model, it would be helpful to show users how to use their own custom classes, similar to how the CLIP model example demonstrates this flexibility.

Here's a suggested addition to the template:

    session = fo.launch_app(dataset)

+    #
+    # Make predictions with custom classes
+    #
+
+    model = foz.load_zoo_model(
+        "{{ name }}",
+        classes=["airplane", "boat", "traffic light", "stop sign", "pizza"],
+    )
+
+    dataset.apply_model(model, label_field="custom_predictions")
+    session.refresh()

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 525bfde and 8e85dd4.

📒 Files selected for processing (1)

• docs/scripts/make_model_zoo_docs.py (1 hunks)

🔇 Additional comments (1)

docs/scripts/make_model_zoo_docs.py (1)

176-184: LGTM! The template changes look good.

The new conditional block for 'zero-shot-detection-transformer-torch' follows the established pattern and provides a clear example of model usage with predefined classes.

[jacobmarks]

LGTM 👍