Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update labelstudio docs for multilabel classification #4781

Merged
merged 2 commits into from
Sep 12, 2024

Conversation

ehofesmann
Copy link
Member

@ehofesmann ehofesmann commented Sep 9, 2024

To be merged after: #4725

What changes are proposed in this pull request?

Updates the labelstudio integration documentation for the new support added in this PR: #4725

How is this patch tested? If it is not, please explain why.

Built the docs and verified the formatting.

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.

"The Labelstudio integration now supports multilabel classification annotation thanks to Ganesh Tata"

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
    • Updated documentation for the Label Studio integration to include support for multilabel classification.
    • Expanded the description of classification types to clarify multilabel classifications.
    • Acknowledgments section updated to include contributor Ganesh Tata.

@ehofesmann ehofesmann added documentation Documentation work annotation Issues related to FiftyOne's annotation API labels Sep 9, 2024
@ehofesmann ehofesmann requested a review from a team September 9, 2024 17:22
@ehofesmann ehofesmann self-assigned this Sep 9, 2024
Copy link
Contributor

coderabbitai bot commented Sep 9, 2024

Walkthrough

The documentation for the Label Studio integration has been updated to include support for multilabel classification. This includes adding references to multilabel classification in the list of supported label types and expanding the description of classification types to clarify their storage in |Classifications| fields. Additionally, the acknowledgments section has been updated to recognize a new contributor.

Changes

Files Change Summary
docs/source/integrations/labelstudio.rst Added reference for multilabel classification in supported label types and expanded classification types description. Updated acknowledgments to include Ganesh Tata.

Possibly related PRs

Poem

In fields of data, bright and new,
Multilabels bloom, a vibrant hue.
With Ganesh's name, we cheer and play,
Documentation shines, guiding the way!
Hops of joy for features grand,
In Label Studio, we take a stand! 🐇✨


Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f784591 and 038bb87.

Files selected for processing (1)
  • docs/source/integrations/labelstudio.rst (3 hunks)
Additional comments not posted (4)
docs/source/integrations/labelstudio.rst (4)

30-30: LGTM!

The change is approved. Adding multilabel classification to the list of supported label types enhances the documentation.


421-422: LGTM!

The change is approved. Adding a description for multilabel classifications provides clarity on how they are stored.


670-670: LGTM!

The change is approved. Acknowledging contributors is a good practice.


671-671: LGTM!

The change is approved. Acknowledging contributors is a good practice.


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
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.
    • @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.

@brimoor brimoor marked this pull request as ready for review September 12, 2024 01:46
Copy link
Contributor

@brimoor brimoor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@brimoor brimoor merged commit 62ec8a5 into develop Sep 12, 2024
14 checks passed
@brimoor brimoor deleted the docs/labelstudio-classifications branch September 12, 2024 03:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
annotation Issues related to FiftyOne's annotation API documentation Documentation work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants