Add support for exports using existing COCO IDs

[brimoor]

Adds an optional coco_id parameter that can be passed when export()ing in COCO format that preserves existing COCO image IDs that are stored on a field of your dataset.

Note that, as the example below shows, we already support storing COCO IDs upon import by passing the include_id=True parameter.

import fiftyone as fo
import fiftyone.zoo as foz

dataset = foz.load_zoo_dataset("quickstart")
dataset.set_values("coco_id", list(range(100, 300)))

dataset.export(
    export_dir="/tmp/coco-labels.json",
    dataset_type=fo.types.COCODetectionDataset,
    label_field="ground_truth",
    coco_id="coco_id",
)

dataset2 = fo.Dataset.from_dir(
    dataset_dir="/tmp/coco-labels.json",
    dataset_type=fo.types.COCODetectionDataset,
    include_id=True,
)

assert dataset.bounds("coco_id") == (100, 299)
assert dataset2.bounds("coco_id") == (100, 299)

Summary by CodeRabbit

• New Features
  • Added support for specifying custom COCO IDs for images in the COCO dataset exporter. This allows for more flexible handling and mapping of image IDs during export.

[coderabbitai[bot]]

Walkthrough

The COCODetectionDatasetExporter class in fiftyone/utils/coco.py has been enhanced with a new coco_id parameter, allowing users to specify which field contains COCO IDs for each image. This update includes modifications to image ID mapping and export functionalities to accommodate the new parameter, ensuring consistency in handling COCO dataset formats.

Changes

File	Change Summary
fiftyone/utils/coco.py	Added coco_id parameter and corresponding handling in the COCODetectionDatasetExporter class, including adjustments to image ID mapping and export functionalities to use coco_id.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant COCODetectionDatasetExporter
    participant System

    User->>COCODetectionDatasetExporter: Initialize with coco_id parameter
    COCODetectionDatasetExporter->>System: Store coco_id and prepare _image_id_map
    User->>COCODetectionDatasetExporter: Invoke log_collection with dataset
    COCODetectionDatasetExporter->>System: Use coco_id field for image ID mapping
    User->>COCODetectionDatasetExporter: Call export_sample for image export
    COCODetectionDatasetExporter->>System: Retrieve and map image ID using coco_id
    System->>COCODetectionDatasetExporter: Return mapped image ID
    COCODetectionDatasetExporter->>User: Complete image export with updated image ID

Poem

🐇 In the land of data, a new key did soar,
To map out the images, COCO IDs to the core.
With codes and numbers, structured and neat,
Exporting samples becomes a treat.
Hopping through data, precise and spry,
Fiftyone's exporter now reaches sky high! 🌟

---

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 as 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. 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.