Skip to content

start object-detection.md to docsify #209

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

start object-detection.md to docsify #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b0432e4
start object-detection.md to docsify
yiyujin Jul 10, 2025
21e1db4
add ObjectDetection to sidebar
yiyujin Jul 22, 2025
a33a64b
add object detection (introduction)
yiyujin Jul 29, 2025
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
39 changes: 39 additions & 0 deletions docs/reference/object-detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# ObjectDetection

<center>
<img class="header-img" src="assets/header-image-classifier.png" alt="ImageClassifier Header Image" >
<p class="img-credit"> Image Credit: <a href="https://thenounproject.com/creator/naveena.160" target="_blank" title="Naveen">Naveen</a> | <a href='mailto:[email protected]'>Contribute ♥️</a> </p>
</center>

## Description

The ml5.js objectDetection is a pre-trained model that can detect object from an image or a video.

### Supported models
The ml5.js objectDetection uses pre-trained **Tensorflow.js CocoSsd model** by default.

Support for more models such as Transformer.js is under development.

### Model and Data Provenance
ml5.js team believes that it is important to not only use the model, but to understand where it is coming from : what data was used, who trained and for waht reason. For more information on the model, please visit [Model and Data Provenance](https://archive-docs.ml5js.org/#/reference/object-detector?id=model-and-data-provenance)


### Functionality
The ml5.js objectDetection detects objects in a source input.

The source input can be :

- **Webcam**
- **Image File**
- **Video File**

## Quick Start
Run and explore pre-built examples!

### Examples - p5 sketches
- [ObjectDetection Webcam]()
- [ObjectDetection Image]()
- [ObjectDetection Video]()

### Video Tutorials
- [ml5.js: Object Detection with COCO-SSD](https://youtu.be/QEzRxnuaZCk) by the Coding Train
1 change: 1 addition & 0 deletions docs/sidebar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
- [ImageClassifier](/reference/image-classifier.md)
- [SoundClassifier](/reference/sound-classifier.md)
- [Sentiment](/reference/sentiment.md)
- [ObjectDetection](/reference/object-detection.md)

<div class="sidebar-spacer">&nbsp;</div>

Expand Down