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

misc updates to the repo readme #34

Merged
merged 2 commits into from
May 20, 2024
Merged

misc updates to the repo readme #34

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
730250d
misc updates to the repo readme
devoncarew May 14, 2024
70f35bb
Merge branch 'main' into readme
craiglabenz May 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 29 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ This repository will be home to the source code for the `mediapipe_vision`, `med

| Package | Description | Version |
| --- | --- | --- |
| [mediapipe_core](packages/mediapipe-core/) | Shared logic and utilities required by other MediaPipe Task packages. | 0.0.1 |
| [mediapipe_text](packages/mediapipe-task-text/) | An implementation of the MediaPipe Text APIs | 0.0.1 |
| [mediapipe_genai](packages/mediapipe-task-genai/) | An implementation of the MediaPipe GenAI APIs | 0.0.1 |
| [mediapipe_core](packages/mediapipe-core/) | Shared logic and utilities required by other MediaPipe Task packages. | ![pub package](https://img.shields.io/pub/v/mediapipe_core) |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh right, duh!

| [mediapipe_text](packages/mediapipe-task-text/) | An implementation of the MediaPipe Text APIs | ![pub package](https://img.shields.io/pub/v/mediapipe_text) |
| [mediapipe_genai](packages/mediapipe-task-genai/) | An implementation of the MediaPipe GenAI APIs | ![pub package](https://img.shields.io/pub/v/mediapipe_genai) |

## Supported Tasks

Expand All @@ -27,42 +27,42 @@ This repository will be home to the source code for the `mediapipe_vision`, `med
</tr>
<tr>
<td>Classification</td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/yes.png" /></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/yes.png" /></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/no.png"/></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/no.png"/></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/yes.png" /></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/no.png"/></td>
<td align="center">✅</td>
<td align="center">✅</td>
<td align="center">-</td>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Does a red emoji make sense here instead of a single dash?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I tend to think of an unfilled square as more 'missing' rather than an error state, but this is your readme :) I can try that out something like ❌ or ✖.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Hmm, that's a good point. We can go with -.

<td align="center">-</td>
<td align="center">✅</td>
<td align="center">-</td>
</tr>
<tr>
<td>Embedding</td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/yes.png" /></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/yes.png" /></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/no.png"/></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/no.png"/></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/yes.png" /></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/no.png"/></td>
<td align="center">✅</td>
<td align="center">✅</td>
<td align="center">-</td>
<td align="center">-</td>
<td align="center">✅</td>
<td align="center">-</td>
</tr>
<tr>
<td>Language Detection</td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/yes.png" /></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/yes.png" /></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/no.png"/></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/no.png"/></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/yes.png" /></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/no.png"/></td>
<td align="center">✅</td>
<td align="center">✅</td>
<td align="center">-</td>
<td align="center">-</td>
<td align="center">✅</td>
<td align="center">-</td>
</tr>
<tr>
<td colspan="7" align="center"><strong>GenAI</strong></td>
</tr>
<tr>
<td>Inference</td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/yes.png" /></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/yes.png" /></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/no.png"/></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/no.png"/></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/yes.png" /></td>
<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/no.png"/></td>
<td align="center">✅</td>
<td align="center">✅</td>
<td align="center">-</td>
<td align="center">-</td>
<td align="center">✅</td>
<td align="center">-</td>
</tr>
<tr>
<td colspan="7" align="center"><strong>Audio</strong></td>
Expand All @@ -86,6 +86,8 @@ The Google Cloud Storage bucket in question only gives read-list access to a spe

After this, create and merge a PR with the changes and then proceed to `Releasing to pub.dev`.

<!--
### Releasing to pub.dev

TODO
-->