justadudewhohacks/face-api.js

Q: How to serialize/unserialize FullFaceDescriptions?

Open

#227 opened on Feb 27, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (15,839 stars) (3,649 forks)batch import
enhancementgood first issuehelp wanted

Description

Detecting faces is great, but can be slow. I'd like to save the detections to an IndexDB and do some math on them when all are completed.

Is there a standard/easy way to do this? I've got a Dexie hacky way with

db.addFace = async function(imageName, tileLocation, ffd) {
  return await db.faces.add({
    'image_name':imageName,
    'tile_x':tileLocation.x,
    'tile_y':tileLocation.y,
    'x':ffd.detection.box.x,
    'y':ffd.detection.box.y,
    'w':ffd.detection.box.width,
    'h':ffd.detection.box.height,
    'score':ffd.detection.score,
    'descriptor':ffd.descriptor,
    'landmarks': ffd.landmarks,
    'expressions': ffd.expressions
  });
};

that I'm sure is a bad idea.

Contributor guide

Tech stack
typescriptjavascripttensorflow
Domain
machine learningapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
unclear
Prerequisites
Basic understanding of face api.jsJavaScript serialization concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Investigate the FullFaceDescriptions class in the source code (likely in src/classes/FullFaceDescription.ts) to understand its structure. Check the issue comments for any guidance from maintainers. Propose a PR to add a serialize/deserialize method, possibly using toJSON() and fromJSON() patterns. Ensure compatibility with IndexedDB storage.