Release notes v1.0.1

[brimoor]

Summary by CodeRabbit

• New Features

  • Video playback now supports the timeline API.
  • Utilities added for a new rerun panel.
  • Enhanced documentation with new examples for session management, loading samples, and managing remote sessions.

• Bug Fixes

  • Resolved issues preventing |Classifications| labels from rendering.
  • Fixed bugs hindering the launch of the app via fiftyone quickstart and fiftyone app launch commands.
  • Addressed a bug related to the classes argument in COCO format.

• Updates

  • Auth0 connection issue for proxy deployments fixed.
  • Dependency for voxel51-eta updated to >=0.13.

[coderabbitai]

Walkthrough

The pull request introduces updates to the release notes for the FiftyOne platform, specifically for versions 2.1.1 and 1.0.1, both released on October 8, 2024. Key highlights include fixes for Auth0 connections behind proxies, updates to dependencies, enhancements in app functionality, and various bug fixes. Additionally, two new methods were added to document these changes in the release notes.

Changes

File	Change Summary
docs/source/release-notes.rst	- Added method fiftyone_teams_2_1_1() - Added method fiftyone_1_0_1() - Updated release notes for FiftyOne Teams 2.1.1 and FiftyOne 1.0.1 detailing various enhancements and bug fixes.
docs/source/user_guide/app.rst	- Expanded documentation on session management, updating sessions, loading samples, remote sessions, sidebar functionality, color schemes, workspaces, patches and clips views, and tagging.

Possibly related PRs

• release note cleanup #4384: The changes in this PR involve updates to the release notes, which may relate to the documentation updates in the main PR.
• FiftyOne Teams 1.7/FiftyOne v0.24.0 release notes #4433: This PR also updates the release notes, indicating a connection to the documentation changes in the main PR.
• Teams 1.7.1/OSS 0.24.1 release notes #4456: Similar to the previous PRs, this one updates the release notes, suggesting relevance to the main PR's documentation updates.
• Updating release notes #4476: This PR focuses on updating release notes, which aligns with the documentation changes made in the main PR.
• Release notes v1.0.0 #4839: This PR updates the release notes for a specific version, which is related to the documentation updates in the main PR.

Suggested reviewers

• findtopher

🐇 In the garden where changes bloom,
New notes added to dispel the gloom.
With fixes and updates, our app shines bright,
FiftyOne's journey takes joyful flight!
🌼✨

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5936d8f and 1057939.

📒 Files selected for processing (1)

• docs/source/user_guide/app.rst (1 hunks)

🧰 Additional context used

🔇 Additional comments (29)

docs/source/user_guide/app.rst (29)

Line range hint 1-21: Introduction section looks good and provides a clear overview.

The introduction section effectively introduces the FiftyOne App and its purpose. It includes a relevant image and a note about the plugin framework, which is helpful for users.

---

Line range hint 23-54: App environments section is informative and well-structured.

This section provides useful information about different environments where the FiftyOne App can be used. The reference to the environments guide is helpful for users seeking more detailed information.

---

Line range hint 56-214: Sessions section is comprehensive and well-explained.

The Sessions section provides detailed information on creating and managing App sessions. It includes code examples, explanations, and notes for different scenarios. The content is clear and helpful for users.

---

Line range hint 216-384: Remote sessions section is thorough and well-documented.

This section provides clear instructions for setting up and using remote sessions, including both Python and CLI methods. The explanations are detailed and easy to follow.

---

Line range hint 386-1010: Using the sidebar section is extensive and informative.

This section covers various aspects of using the sidebar, including filtering, lightning mode, and sidebar groups. The content is well-organized and includes helpful examples and images.

---

Line range hint 1012-1099: Using the view bar section is concise and clear.

The explanation of the view bar functionality is straightforward and includes a helpful image to illustrate its use.

---

Line range hint 1101-1155: Grouping samples section effectively explains the feature.

This section provides a clear explanation of how to group samples in the App, including relevant images and descriptions of the functionality.

---

Line range hint 1157-1285: Field visibility section is well-documented and includes useful examples.

The explanation of field visibility options is thorough and includes both manual selection and filter rules. The content is clear and helpful for users.

---

Line range hint 1287-1516: Color schemes section is comprehensive and well-illustrated.

This section provides detailed information on configuring color schemes in both the App and Python. The explanations are clear, and the included images are helpful.

---

Line range hint 1518-1628: Saving views section is concise and informative.

The explanation of saving and managing views is clear and includes relevant images to illustrate the process.

---

Line range hint 1630-1724: Viewing a sample section is brief but informative.

This section provides a clear explanation of how to view and interact with individual samples in the App.

---

Line range hint 1726-1789: Using the image visualizer section is well-explained and includes helpful tips.

The explanation of the image visualizer functionality is clear and includes useful information about keyboard shortcuts and customization options.

---

Line range hint 1791-1861: Using the video visualizer section effectively explains the feature.

This section provides a clear overview of the video visualizer functionality, including keyboard shortcuts and customization options.

---

Line range hint 1863-2037: Using the 3D visualizer section is comprehensive and well-documented.

The explanation of the 3D visualizer functionality is thorough and includes detailed information about controls, configuration options, and supported features.

---

Line range hint 2039-2352: Spaces section is extensive and well-explained.

This section provides a comprehensive overview of the Spaces feature, including configuration options in both the App and Python. The explanations are clear and include relevant code examples.

---

Line range hint 2354-2508: Saving workspaces section is thorough and well-documented.

The explanation of saving and managing workspaces is clear and includes both App and Python methods. The content is helpful for users who want to customize their workspace layouts.

---

Line range hint 2510-2534: Samples panel section is brief but informative.

This section provides a concise explanation of the Samples panel functionality.

---

Line range hint 2536-2592: Histograms panel section effectively explains the feature.

The explanation of the Histograms panel functionality is clear and includes information about different modes and customization options.

---

Line range hint 2594-2702: Embeddings panel section is comprehensive and well-illustrated.

This section provides a thorough explanation of the Embeddings panel functionality, including configuration options and interaction methods.

---

Line range hint 2704-2855: Map panel section is well-documented and includes configuration information.

The explanation of the Map panel functionality is clear and includes information about setup requirements, interaction methods, and configuration options.

---

Line range hint 2857-2944: Selecting samples section is concise and informative.

This section provides a clear explanation of how to select samples in the App and access the selected samples in Python.

---

Line range hint 2946-3022: Selecting labels section effectively explains the feature.

The explanation of selecting labels in the App is clear and includes information about how to access the selected labels in Python.

---

Line range hint 3024-3134: Tags and tagging section is comprehensive and well-explained.

This section provides a thorough overview of tagging functionality in the App, including both sample and label tagging methods.

---

Line range hint 3136-3236: Viewing object patches section is well-documented and includes useful information.

The explanation of object patches functionality is clear and includes information about how to create and interact with object patches views.

---

Line range hint 3238-3330: Viewing evaluation patches section effectively explains the feature.

This section provides a clear explanation of evaluation patches functionality, including how to create and interact with evaluation patches views.

---

Line range hint 3332-3420: Viewing video clips section is comprehensive and well-illustrated.

The explanation of video clips functionality is thorough and includes information about different types of clips and how to interact with them in the App.

---

Line range hint 3422-3570: Sorting by similarity section is well-documented and includes subsections for different similarity types.

This section provides clear explanations for image, object, and text similarity functionality in the App.

---

Line range hint 3572-3654: Multiple media fields section effectively explains the feature.

The explanation of how to work with multiple media fields is clear and includes a practical example of using thumbnail images.

---

Line range hint 3656-3879: Configuring the App section is comprehensive and well-structured.

This section provides detailed information about different ways to configure the App, including global, session-specific, and dataset-specific configurations. The explanations are clear and include relevant code examples.

---

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.