Docs / Guides

Recipes

Short, runnable patterns for the most common LYNX tasks.

Basics
01 · Start here
Detect objects in an image

The starting point — load a model and get bounding boxes back.

02
Categorize an image

When the answer you need is "what is this" rather than "where is it".

03
Search and group similar images

Compare images numerically — find duplicates, build a similarity index, train your own classifier.

04
Set up your license and environment

Where to put your key, and how to confirm the GPU is actually engaged.

05
Make your code production-ready

A wrong key, an expired license, and a corrupt file each need different handling.

Video & streaming
06
Analyze a video file

Process video of any length without running out of memory.

07
Monitor multiple cameras at once

Watch every camera from a single inference session — better throughput than one process per stream.

08
Follow moving objects

Persistent IDs across frames — the foundation for counting, dwell time, and behaviors.

09
Make a model callable over HTTP

Expose LYNX as a web service so any language can call it.

Advanced
10
React to events in real time

Fire actions when something specific happens — a class detected, a zone entered, a line crossed.

11
Measure real-world distance

Bounding boxes give you shape; depth gives you "how far away is that thing".

12
Read a model's configuration

See exactly what input format and defaults a model expects, without reading anyone's prose.

13
Run the LYNX CLI from Python

Exact CLI behavior from inside Python — useful for reproducing CI runs in a notebook.

Diagnostics
14
Diagnose missing or wrong detections

When the model returns nothing useful, the cause is almost always preprocessing — find it in one call.

15
Help us improve the model

Send us a frame the model got wrong — the next training cycle benefits from real-world failures.