luxonis_ml.telemetry.context

module documentation

Undocumented

Function base_context Create base context for all events.
Function is_ci Best-effort detection of CI environments.
Function is_luxonis_cloud Return True when telemetry runs inside the Luxonis cloud.
Function normalized_processor Return a coarse processor family for telemetry.
Constant RESERVED_METADATA_KEYS Undocumented
def base_context(*, library_name: str, library_version: str | None, session_id: str, source_component: str | None) -> dict[str, Any]:

Create base context for all events.

Parameters
library_name:strName of the emitting library.
library_version:str | NoneVersion string for the library.
session_id:strRandom per-process session ID.
source_component:str | NoneOptional component name for the emitter. If omitted, the library name is reused.
Returns
dict[str, Any]The shared base context attached to events.
def is_ci() -> bool:

Best-effort detection of CI environments.

def is_luxonis_cloud() -> bool:

Return True when telemetry runs inside the Luxonis cloud.

def normalized_processor() -> str:

Return a coarse processor family for telemetry.

RESERVED_METADATA_KEYS =

Undocumented

Value
frozenset(set(['$process_person_profile',
               '$session_id',
               'source_product',
               'source_component',
               'sdk_version']))