Skip to main content

focusedgaze

Webcam eye-gaze tracking as a Python library. Point a laptop camera at a face and get a screen coordinate.

Status: in development (0.0.0). Two modules are implemented and tested: the One Euro filter and the positioning gate. The gaze pipeline itself is not. The API shown below is the agreed contract, not working code, and every block that describes it is marked. Do not depend on this release. See MIGRATION_AUDIT.md for what has actually landed.


What it does

webcam frame
  → MediaPipe face landmarks → smoothed square face crop
  → L2CS-Net gaze model (ONNX) → (pitch, yaw)
  → per-person polynomial calibration → (x, y) in [0, 1] over the screen
  → One Euro filter → steady coordinates

What you need before any of it works

Three things, and the second and third are the ones that catch people out.

A webcam, and light. The face has to be detectable. A muted camera or an unlit room produces no landmarks and therefore no gaze, and the failure looks identical to a bug. This has cost this project two recording sessions already.

A calibration, per person. There is no useful uncalibrated mode. The model gives you a gaze direction in radians, and turning that into a point on your screen depends on where your screen is, how far away you sit, and your face. A calibration is specific to one person, one machine, and roughly one seating position. Someone else sitting down in your chair will get bad results until they calibrate for themselves.

The gaze model weights, which you fetch yourself. focusedgaze will not download them. They derive from the Gaze360 dataset, which its authors restrict to non-commercial research use, so this project does not distribute or mirror them. This is a deliberate refusal, not a missing feature. See Licence below, and read NOTICE before you use this commercially.

Install

pip install focusedgaze[directml]   # Windows GPU via DirectX 12
pip install focusedgaze[cuda]       # NVIDIA
pip install focusedgaze[cpu]        # anywhere

Pick one. The base install is deliberately provider-agnostic: focusedgaze does not choose an ONNX execution provider for you, because the right choice depends on hardware it cannot see. Installing the base package with no provider extra still imports cleanly, which CI checks on every run. Reporting a missing provider as a named error rather than a bare ImportError is the agreed design, but the model loader does not exist yet, so today there is nothing to raise it.

The provider is worth getting right. On the reference machine, an RTX 4060 running Windows, the gaze model takes about 15 ms per frame through DirectML and about 104 ms on CPU. That is the difference between roughly 30 frames per second end to end and roughly 5.

Other extras: [calibration] to fit a profile, [server] for the WebSocket bridge, [export] to convert the PyTorch weights to ONNX.

Python 3.12–3.14. Tested on 3.12, 3.13 and 3.14 in CI.

What works today

The filter and the positioning gate are extracted, tested against the original implementation, and usable now:

from focusedgaze.core.filters import OneEuroFilter2D

# Smooths a jittery 2D signal. Defaults match the deployed system.
f = OneEuroFilter2D(min_cutoff=0.7, beta=0.6, d_cutoff=1.0)

for x, y, t in [(0.50, 0.50, 0.00), (0.55, 0.48, 0.03), (0.52, 0.51, 0.07)]:
    sx, sy = f.filter(x, y, t)
    print(f"{sx:.4f} {sy:.4f}")

focusedgaze.core.positioning provides PositioningGate, which tells you whether a face is close enough, far enough, and centred enough to give a usable reading. It works on MediaPipe landmarks without needing the gaze model.

The intended API

None of this runs yet. It is the contract Phase 2 through Phase 4 are being built against, shown here so the shape can be reviewed rather than discovered late.

# Pure: you supply frames. No camera, no I/O, testable anywhere.
est = GazeEstimator(profile=CalibrationProfile.load("default"))
result = est.process(frame_bgr, timestamp=t)

# Convenience: it owns the webcam.
with WebcamGazeTracker(profile="default") as tracker:
    for result in tracker.stream():
        if result.ok:
            print(result.x, result.y)

The pure path is the point of the design. Anything that already has frames can use this library: a video file, another capture library, a camera shared with a hand tracker, or a test that needs to be reproducible. Owning the webcam is the convenience layer, not the foundation.

Accuracy

The honest summary is that accuracy is uneven across the screen, and the bottom is the worst part.

On the reference setup, held-out validation error after calibration is about 8.9% of screen size, and that average hides the spread: roughly 3–8% across the top and centre, and 13–14% along the bottom edge. If you are placing targets, put them where the tracker is good, and do not put anything small or important along the bottom.

Accuracy degrades when the lighting changes, when you move closer or further than you calibrated at, and when a different person sits down. The positioning gate exists to catch the distance case: it enforces the 45–65 cm range the calibration was collected in.

A figure this README used to quote is not currently supported. Earlier versions claimed 2.0–2.4 cm within a session and about 3.0 cm on a held-out session. Those numbers come from an accuracy script in the original project whose output has never been recorded in this repository, so there is nothing here to back them. They have been removed rather than repeated. The percentage figures above are recorded, and come from the original system's documentation. Re-measuring in centimetres is scheduled before the milestone scripts are deleted.

Platform support

Platform Status
Windows 10/11 Tested
Linux Structurally supported, untested. CI runs the non-hardware suite only
macOS Structurally supported, untested

Camera backends and ONNX providers are abstracted, so other platforms should work. A classifier is a claim though, and only Windows is claimed for v0.1. CI does prove the pure core computes identical results on Linux, which is evidence the abstractions are real rather than aspirational, but nobody has pointed a camera at it there.

Licence

The code is MIT. See LICENSE.

The model weights are not, and this matters if you are evaluating focusedgaze for a product. The gaze model is an ONNX export of L2CS-Net trained on the Gaze360 dataset, whose authors state that use of the dataset and code is for non-commercial research only. Weights trained on it are normally treated as a derived work carrying the same restriction. So: focusedgaze does not ship them, does not mirror them, and will not download them for you. You obtain them from the official L2CS-Net distribution and convert them locally.

This is a conservative reading of the upstream terms and not legal advice. Full detail is in NOTICE.

Author: Muhammad Asif Khan, https://github.com/muhammad-asifkhan

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

focusedgaze-0.0.0.tar.gz (67.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

focusedgaze-0.0.0-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file focusedgaze-0.0.0.tar.gz.

File metadata

  • Download URL: focusedgaze-0.0.0.tar.gz
  • Upload date:
  • Size: 67.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for focusedgaze-0.0.0.tar.gz
Algorithm Hash digest
SHA256 5129303b0949070b5af44665e18532b3a30854f5f7b1ef69af42270f16be0d6c
MD5 599c3c9fbddebc3e9c26173c99d54cd8
BLAKE2b-256 f1a4bfaf24a20f641bdfad7c43aa1506bfa13d60d694fd4beb4827c2f928d679

See more details on using hashes here.

Provenance

The following attestation bundles were made for focusedgaze-0.0.0.tar.gz:

Publisher: release.yml on muhammad-asifkhan/focusedgaze

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file focusedgaze-0.0.0-py3-none-any.whl.

File metadata

  • Download URL: focusedgaze-0.0.0-py3-none-any.whl
  • Upload date:
  • Size: 21.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for focusedgaze-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 55c3bfc1b14b6db26d780df5ff10240ac4a591b50ecdf04f47396bb9009f42d1
MD5 c2414307d2f8123672eeb2d14b5d65a7
BLAKE2b-256 4aa35e551174fc019293a2056f4bb252087a1c37737a386e74d2da68de841448

See more details on using hashes here.

Provenance

The following attestation bundles were made for focusedgaze-0.0.0-py3-none-any.whl:

Publisher: release.yml on muhammad-asifkhan/focusedgaze

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.0

2 files

This release

0.0.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page