google / flutter-mediapipe

Apache License 2.0
188 stars 10 forks source link

Contributing setup #61

Open charlieforward9 opened 4 months ago

charlieforward9 commented 4 months ago

Description

Working through the contribution guide, fledging out issues as I go.

Related Issues

17

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

charlieforward9 commented 4 months ago

@craiglabenz

I'm currently working on the sync-headers part of my project to add the vision headers from MediaPipe. I've reviewed the documentation, which describes the classes in Java. For the text tasks, we include headers from the c folder, and for the genai task, we use the cc folder.

https://github.com/google/flutter-mediapipe/blob/5ee4fb14eb304725d3b91bfb3992e59d004b5eaa/tool/builder/lib/sync_headers.dart#L19-L23

I noticed that there's also a Java folder in the list, but I imagine I should use c or cc, since core is c.

To be clear, could you confirm which headers should be used specifically for the vision tasks?

Thank you!

craiglabenz commented 3 months ago

Good question, @charlieforward9. I don't know why the genai headers are in a different location, but I suspect it was a breakdown in convention / consistency. For vision, you want the header files located at mediapipe/tasks/c/vision/<task-name>/<task-name>.h.