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: the pipeline is complete (0.0.0), and it is now runnable end to end. GazeEstimator, WebcamGazeTracker, the capture layer, calibration, the asset registry, the WebSocket server and all eight CLI commands are implemented and tested. The extraction reproduces the original pipeline bit-identically on 60 recorded frames: 60/60 identical, zero crop-box differences. See MIGRATION_AUDIT.md §49.

focusedgaze calibrate now runs a real session: a positioning check, a smooth-pursuit sweep on a full-screen canvas, per-region coverage accounting, and a robust fit. Until that landed, the collection loops existed but nothing drew a dot, so the command refused to start and the library could not produce screen coordinates for anybody. focusedgaze accuracy draws its grid for the same reason.

Still 0.0.0 and not yet released as a functional package: packaging verification and the release are Phases 9 and 10.

If something is not working, run focusedgaze setup first, then focusedgaze check --no-camera.

CI is green on Python 3.12, 3.13 and 3.14. It was red for five pushes on a platform assumption in the asset registry, since fixed. See MIGRATION_AUDIT.md §42.

Documentation

Start here For
docs/getting-started.md Start here. Install to a working gaze-controlled app, step by step, including swapping the model.
docs/what-you-need.md What you must supply and what you get back. The short version.
docs/complete-usage.md The full guide to the finished product, every section status-marked.
docs/usage.md What runs today, with examples that were executed.
docs/wire_format.md The WebSocket contract, read off the source.

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. A missing provider is reported as a named ProviderError naming the extras that fix it, never as a bare ImportError.

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.

The API

Two layers. You still need the model weights and a calibration, as described above.

from focusedgaze import GazeEstimator, WebcamGazeTracker, CalibrationProfile

# Pure: you supply frames. No camera, no network, testable anywhere.
est = GazeEstimator(profile=CalibrationProfile.load("alice"))
result = est.process(frame_bgr, timestamp=t)
if result.ok:
    print(result.x, result.y)

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

GazeEstimator never reaches the network: a missing model raises with the command that fetches it rather than downloading anything, which is what lets the whole pipeline run in CI against a recorded fixture.

Smaller pieces are usable on their own. focusedgaze.core.filters.OneEuroFilter2D smooths any jittery 2D signal, and focusedgaze.core.positioning.PositioningGate reports whether a face is close enough, far enough and centred enough, working on MediaPipe landmarks without the gaze model.

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 which part is worst varies between calibrations.

The originating project's documentation reports held-out validation error around 8.9% of screen size, spread as roughly 3–8% across the top and centre and 13–14% along the bottom edge. Our own two measured runs did not reproduce that pattern consistently: one was worst at the bottom-right, the other was among its best there and worst at the top-left.

So the design advice is the durable part: keep small or important targets away from the edges and corners, and give anything out there a generous hit area.

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.

Measured in centimetres, and it is a range on purpose. Roughly 3 to 6 cm average on a 34 cm-wide screen, best at the centre (1.0 cm in the better run), worst at whichever corner the calibration sweep covered least. Two runs by the same person on the same machine twenty minutes apart differed by a factor of two, and the failure pattern inverted between them, so a single number would mislead. Accuracy depends more on how well your calibration covered the screen than on anything else measured here. See docs/accuracy.md and MIGRATION_AUDIT.md section 50.

This replaces an earlier README claim of 2.0–2.4 cm, which had no source in this repository and was deleted rather than repeated.

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.1.0.tar.gz (332.2 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.1.0-py3-none-any.whl (180.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for focusedgaze-0.1.0.tar.gz
Algorithm Hash digest
SHA256 89862f07628ae6d184281e5d804cfbc94e92ae45653d30840a8729cb8dc5987d
MD5 e1822f89af338a5670ddd8f74f17540f
BLAKE2b-256 4253e9f7880c13c810c2a7e67840b7bd5addeedecb900817cf4b1d85305f4489

See more details on using hashes here.

Provenance

The following attestation bundles were made for focusedgaze-0.1.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.1.0-py3-none-any.whl.

File metadata

  • Download URL: focusedgaze-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 180.8 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1cdf8cbe26c3ccabd89dc530522375a69d71410977db008dae610b8635cc7e24
MD5 3c910ba3254c364dcafcf43a4c40c06a
BLAKE2b-256 c49184ea41582423ac64ea1c7486af67c4864d62a888fffc0ada1e6070ef140f

See more details on using hashes here.

Provenance

The following attestation bundles were made for focusedgaze-0.1.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

This release

0.1.0 This release

2 files

0.0.0

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