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.

Sign up for GitHub

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

Jump to bottom

update docs for yolov8 #8379

Merged
merged 3 commits into from
Aug 30, 2024
Merged

update docs for yolov8 #8379

merged 3 commits into from
Aug 30, 2024

Conversation

Eldies
Copy link
Contributor

@Eldies Eldies commented Aug 30, 2024 •
edited by coderabbitai bot
Loading

Motivation and context

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • New Features

    • Added support for new data export formats for YOLOv8, enhancing capabilities for detection, instance segmentation, keypoints, and oriented bounding boxes.

  • Documentation

    • Improved clarity and structure of the documentation for data export formats, ensuring comprehensive details for each format, including file type, tasks, models, and compatibility.

@Eldies Eldies requested a review from mdacoca as a code owner August 30, 2024 10:05
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 30, 2024 •
edited
Loading

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The documentation for data export formats in CVAT has been updated to include new YOLOv8 formats for detection, instance segmentation, keypoints, and oriented bounding boxes. The table structure has been enhanced for clarity, maintaining existing formats while ensuring backward compatibility.

Changes

Files Change Summary
site/content/en/docs/manual/advanced/formats/_index.md Added new YOLOv8 formats: Detection, Instance Segmentation, Keypoints, and Oriented Bounding Boxes, each with specific details.

Poem

🐰 In the fields where data flows,
New formats sprout like blooming rows.
YOLOv8 hops in with flair,
Detection and more, beyond compare!
With clarity bright, our docs now shine,
A joyful leap for all, how divine! 🌼

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.

CodeRabbit Configuration 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[bot]
coderabbitai bot reviewed Aug 30, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2d6ac62 and aa06d09.

Files selected for processing (1)
  • site/content/en/docs/manual/advanced/formats/_index.md (1 hunks)
Additional comments not posted (4)
site/content/en/docs/manual/advanced/formats/_index.md (4)

49-49: Approved: YOLOv8 Detection 1.0 format entry.

The entry for YOLOv8 Detection 1.0 is correctly formatted and includes all necessary details.

50-50: Approved: YOLOv8 Segmentation 1.0 format entry.

The entry for YOLOv8 Segmentation 1.0 is correctly formatted and includes all necessary details for instance segmentation tasks.

51-51: Approved: YOLOv8 Pose 1.0 format entry.

The entry for YOLOv8 Pose 1.0 is correctly formatted and includes all necessary details for keypoints detection tasks.

52-52: Approved: YOLOv8 Oriented Bounding Boxes 1.0 format entry.

The entry for YOLOv8 Oriented Bounding Boxes 1.0 is correctly formatted and includes all necessary details for detection tasks with oriented bounding boxes.

@SpecLad
Copy link
Contributor

SpecLad commented Aug 30, 2024

You should also update the list in the README.

@Eldies
Copy link
Contributor Author

Eldies commented Aug 30, 2024

You should also update the list in the README.

done

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@SpecLad SpecLad merged commit ad8ceea into develop Aug 30, 2024
14 checks passed
@SpecLad SpecLad deleted the dl/yolo8-docs branch August 30, 2024 15:28
bschultz96 pushed a commit to bschultz96/cvat that referenced this pull request Sep 12, 2024
@Eldies
update docs for yolov8 (cvat-ai#8379)
9db8817
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@SpecLad SpecLad SpecLad approved these changes

@mdacoca mdacoca Awaiting requested review from mdacoca

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Eldies @SpecLad