Skip to content

Latest commit

 

History

History

samples

README.md

Samples

Every Dart sample in the docs, one file per sample. Each file is the doc's code block byte for byte: change both together, then run python3 -B tool/samples_index.py and python3 -B tool/check_docs.py (it fails, naming the doc and line, on any difference).

A dash in Modes is a mode the task offers that has no sample yet. Platforms come from the coverage matrix (tool/coverage/matrix.json). The runnable object detection app is in apps/object_detection.

vision

Task Modes Other samples Web Android iOS macOS Linux Windows
common browser_overlay (web only), capabilities
face_detector image, video, live_stream rgb_pixels CPU, GPU CPU CPU (GPU planned) CPU CPU CPU
face_landmarker image, video, live_stream count_faces, expressions_image, expressions_live_stream, expressions_video, gpu, model_from_asset, transformation_matrixes CPU, GPU CPU, GPU CPU (GPU planned) CPU CPU, GPU CPU
gesture_recognizer image, video, live_stream CPU, GPU CPU CPU (GPU planned) CPU CPU CPU
hand_landmarker image, video, live_stream CPU, GPU CPU CPU (GPU planned) CPU CPU CPU
holistic_landmarker image, video, live_stream mask_and_blendshapes CPU, GPU CPU CPU (GPU planned) CPU CPU CPU
image_classifier image, video, live_stream region_of_interest CPU, GPU CPU, GPU CPU (GPU planned) CPU CPU, GPU CPU
image_embedder image, video, live_stream quantized CPU, GPU CPU, GPU CPU (GPU planned) CPU CPU CPU
image_segmenter image, video, live_stream confidence_masks CPU, GPU CPU CPU (GPU planned) CPU CPU, GPU CPU
interactive_segmenter image CPU, GPU CPU CPU CPU CPU no
object_detector image, video, live_stream guide/create_image, guide/create_live_stream, guide/create_video, guide/input_image, guide/input_live_stream, guide/input_video, guide/results, guide/run_image, guide/run_live_stream, guide/run_video CPU, GPU CPU, GPU CPU (GPU planned) CPU CPU, GPU CPU
pose_landmarker image, video, live_stream segmentation_masks CPU, GPU CPU CPU (GPU planned) CPU CPU CPU

audio

Task Modes Other samples Web Android iOS macOS Linux Windows
audio_classifier clip, stream capabilities CPU CPU CPU CPU CPU CPU
audio_transcriber clip, stream prewarm CPU, GPU CPU CPU (GPU planned) CPU, GPU CPU CPU
text_to_speech utterance, stream CPU CPU CPU CPU, GPU CPU CPU

text

Task Modes Other samples Web Android iOS macOS Linux Windows
common capabilities
language_detector detect CPU CPU CPU CPU CPU CPU
text_classifier classify, top_category CPU CPU CPU CPU CPU CPU
text_embedder embed CPU CPU CPU CPU CPU CPU
text_embedder (embedding_gemma model) question_answering, semantic_similarity CPU CPU CPU CPU CPU CPU
text_proofreader proofread no CPU CPU CPU CPU CPU
text_summarizer capabilities, key_points, summarize no CPU CPU CPU CPU CPU

retrieval

Task Modes Other samples Web Android iOS macOS Linux Windows
semantic_retriever text, image, audio_and_content manage_records, persistent_database no CPU CPU CPU CPU CPU
universal_embedder text: -, image, audio no CPU CPU CPU CPU CPU

decision

Task Modes Other samples Web Android iOS macOS Linux Windows
decision_maker single, batch no CPU CPU CPU CPU CPU

core

Task Modes Other samples Web Android iOS macOS Linux Windows
model_store clear, prefetch
web_runtime self_hosted

Where each sample appears

Sample Docs
audio/audio_classifier/capabilities.dart packages/mediapipe-task-audio/README.md
audio/audio_classifier/clip.dart packages/mediapipe-task-audio/README.md
audio/audio_classifier/stream.dart packages/mediapipe-task-audio/README.md
audio/audio_transcriber/clip.dart packages/mediapipe-task-audio/README.md
audio/audio_transcriber/prewarm.dart packages/mediapipe-task-audio/README.md
audio/audio_transcriber/stream.dart packages/mediapipe-task-audio/README.md
audio/text_to_speech/stream.dart packages/mediapipe-task-audio/README.md
audio/text_to_speech/utterance.dart packages/mediapipe-task-audio/README.md
core/model_store/clear.dart doc/mediapipe_core.md
core/model_store/prefetch.dart doc/mediapipe_core.md
core/web_runtime/self_hosted.dart doc/mediapipe_core.md
decision/decision_maker/batch.dart packages/mediapipe-task-decision/README.md
decision/decision_maker/single.dart packages/mediapipe-task-decision/README.md
retrieval/semantic_retriever/audio_and_content.dart packages/mediapipe-task-retrieval/README.md
retrieval/semantic_retriever/image.dart packages/mediapipe-task-retrieval/README.md
retrieval/semantic_retriever/manage_records.dart packages/mediapipe-task-retrieval/README.md
retrieval/semantic_retriever/persistent_database.dart packages/mediapipe-task-retrieval/README.md
retrieval/semantic_retriever/text.dart packages/mediapipe-task-retrieval/README.md
retrieval/universal_embedder/audio.dart packages/mediapipe-task-retrieval/README.md
retrieval/universal_embedder/image.dart packages/mediapipe-task-retrieval/README.md
text/common/capabilities.dart packages/mediapipe-task-text/README.md
text/language_detector/detect.dart packages/mediapipe-task-text/README.md
text/text_classifier/classify.dart packages/mediapipe-task-text/README.md
text/text_classifier/top_category.dart MIGRATION.md
text/text_embedder/embed.dart packages/mediapipe-task-text/README.md
text/text_embedder/question_answering.dart packages/mediapipe-task-text/README.md
text/text_embedder/semantic_similarity.dart packages/mediapipe-task-text/README.md
text/text_proofreader/proofread.dart packages/mediapipe-task-text/README.md
text/text_summarizer/capabilities.dart packages/mediapipe-task-text/README.md
text/text_summarizer/key_points.dart packages/mediapipe-task-text/README.md
text/text_summarizer/summarize.dart packages/mediapipe-task-text/README.md
vision/common/browser_overlay.dart packages/mediapipe-task-vision/README.md
vision/common/capabilities.dart doc/guides/vision/options_and_outputs.md
vision/face_detector/image.dart packages/mediapipe-task-vision/README.md
vision/face_detector/live_stream.dart doc/guides/vision/video_and_live_stream.md
vision/face_detector/rgb_pixels.dart doc/guides/vision/options_and_outputs.md
vision/face_detector/video.dart doc/guides/vision/video_and_live_stream.md
vision/face_landmarker/count_faces.dart README.md, packages/mediapipe-core/README.md
vision/face_landmarker/expressions_image.dart packages/mediapipe-task-vision/README.md
vision/face_landmarker/expressions_live_stream.dart doc/guides/vision/video_and_live_stream.md
vision/face_landmarker/expressions_video.dart doc/guides/vision/video_and_live_stream.md
vision/face_landmarker/gpu.dart packages/mediapipe-task-vision/README.md
vision/face_landmarker/image.dart packages/mediapipe-task-vision/README.md
vision/face_landmarker/live_stream.dart packages/mediapipe-task-vision/README.md
vision/face_landmarker/model_from_asset.dart packages/mediapipe-task-vision/README.md
vision/face_landmarker/transformation_matrixes.dart doc/guides/vision/options_and_outputs.md
vision/face_landmarker/video.dart packages/mediapipe-task-vision/README.md
vision/gesture_recognizer/image.dart packages/mediapipe-task-vision/README.md
vision/gesture_recognizer/live_stream.dart doc/guides/vision/video_and_live_stream.md
vision/gesture_recognizer/video.dart doc/guides/vision/video_and_live_stream.md
vision/hand_landmarker/image.dart packages/mediapipe-task-vision/README.md
vision/hand_landmarker/live_stream.dart doc/guides/vision/video_and_live_stream.md
vision/hand_landmarker/video.dart doc/guides/vision/video_and_live_stream.md
vision/holistic_landmarker/image.dart packages/mediapipe-task-vision/README.md
vision/holistic_landmarker/live_stream.dart doc/guides/vision/video_and_live_stream.md
vision/holistic_landmarker/mask_and_blendshapes.dart doc/guides/vision/options_and_outputs.md
vision/holistic_landmarker/video.dart doc/guides/vision/video_and_live_stream.md
vision/image_classifier/image.dart packages/mediapipe-task-vision/README.md
vision/image_classifier/live_stream.dart doc/guides/vision/video_and_live_stream.md
vision/image_classifier/region_of_interest.dart doc/guides/vision/options_and_outputs.md
vision/image_classifier/video.dart doc/guides/vision/video_and_live_stream.md
vision/image_embedder/image.dart packages/mediapipe-task-vision/README.md
vision/image_embedder/live_stream.dart doc/guides/vision/video_and_live_stream.md
vision/image_embedder/quantized.dart doc/guides/vision/options_and_outputs.md
vision/image_embedder/video.dart doc/guides/vision/video_and_live_stream.md
vision/image_segmenter/confidence_masks.dart doc/guides/vision/options_and_outputs.md
vision/image_segmenter/image.dart packages/mediapipe-task-vision/README.md
vision/image_segmenter/live_stream.dart doc/guides/vision/video_and_live_stream.md
vision/image_segmenter/video.dart doc/guides/vision/video_and_live_stream.md
vision/interactive_segmenter/image.dart packages/mediapipe-task-vision/README.md
vision/object_detector/guide/create_image.dart doc/guides/vision/object_detector.md
vision/object_detector/guide/create_live_stream.dart doc/guides/vision/object_detector.md
vision/object_detector/guide/create_video.dart doc/guides/vision/object_detector.md
vision/object_detector/guide/input_image.dart doc/guides/vision/object_detector.md
vision/object_detector/guide/input_live_stream.dart doc/guides/vision/object_detector.md
vision/object_detector/guide/input_video.dart doc/guides/vision/object_detector.md
vision/object_detector/guide/results.dart doc/guides/vision/object_detector.md
vision/object_detector/guide/run_image.dart doc/guides/vision/object_detector.md
vision/object_detector/guide/run_live_stream.dart doc/guides/vision/object_detector.md
vision/object_detector/guide/run_video.dart doc/guides/vision/object_detector.md
vision/object_detector/image.dart packages/mediapipe-task-vision/README.md
vision/object_detector/live_stream.dart doc/guides/vision/video_and_live_stream.md
vision/object_detector/video.dart doc/guides/vision/video_and_live_stream.md
vision/pose_landmarker/image.dart packages/mediapipe-task-vision/README.md
vision/pose_landmarker/live_stream.dart doc/guides/vision/video_and_live_stream.md
vision/pose_landmarker/segmentation_masks.dart doc/guides/vision/options_and_outputs.md
vision/pose_landmarker/video.dart doc/guides/vision/video_and_live_stream.md