hubai_sdk.utils.telemetry

module documentation

Undocumented

Class ApiKeySource Undocumented
Class CommandMetadata Undocumented
Class CommandName Undocumented
Class ConfigSource Undocumented
Class ConversionFlowStep Undocumented
Class ConversionPhase Undocumented
Class FailureReason Undocumented
Class IdentifierType Undocumented
Class InvocationSurface Undocumented
Class OperationName Undocumented
Class OperationTelemetrySpec Undocumented
Class QuantizationInputType Undocumented
Class TargetResource Undocumented
Class TelemetryGroup Undocumented
Class TelemetryResult Undocumented
Class VisibilityFilterValue Undocumented
Class VisibilityValue Undocumented
Function bucket_file_size Undocumented
Function bucket_limit Undocumented
Function bucket_max_quantization_images Undocumented
Function bucket_nonzero_count Undocumented
Function bucket_result_count Undocumented
Function bucket_rvc2_shaves Undocumented
Function bucket_yolo_class_count Undocumented
Function bucket_zero_count Undocumented
Function build_client_initialized_properties Undocumented
Function build_command_properties Undocumented
Function build_conversion_flow_properties Undocumented
Function build_conversion_result_properties Undocumented
Function build_conversion_summary Undocumented
Function build_instance_created_properties Undocumented
Function build_instance_downloaded_properties Undocumented
Function build_instance_files_listed_properties Undocumented
Function build_instance_uploaded_properties Undocumented
Function build_instances_listed_properties Undocumented
Function build_model_created_properties Undocumented
Function build_model_identifier_properties Undocumented
Function build_model_updated_properties Undocumented
Function build_models_listed_properties Undocumented
Function build_variant_created_properties Undocumented
Function build_variants_listed_properties Undocumented
Function capture_client_initialized Undocumented
Function capture_conversion_configured Undocumented
Function capture_conversion_result Undocumented
Function capture_operation_result Undocumented
Function command_metadata Undocumented
Function command_result_from_exception Undocumented
Function config_source_from_path Undocumented
Function conversion_failure_reason Undocumented
Function current_conversion_run_id Undocumented
Function failure_reason_from_exception Undocumented
Function file_extension Undocumented
Function get_component_telemetry Undocumented
Function get_or_create_conversion_run_id Undocumented
Function identifier_type Undocumented
Function instrument_hubai_cli Undocumented
Function invocation_surface Undocumented
Function pop_cli_failure_reason Undocumented
Function quantization_input_type Undocumented
Function record_cli_failure_reason Undocumented
Function reset_conversion_run_id Undocumented
Function sort_mode Undocumented
Function telemetry_operation Undocumented
Function visibility_filter Undocumented
Function visibility_value Undocumented
Constant CLIENT_INITIALIZED_EVENT Undocumented
Constant COMMAND_EVENT Undocumented
Constant CONVERSION_CONFIGURED_EVENT Undocumented
Constant CONVERSION_FLOW_NAME Undocumented
Constant CONVERSION_RESULT_EVENT Undocumented
Constant HUBAI_SDK_TELEMETRY_DEFAULTS Undocumented
Constant INSTANCE_CONFIG_RETRIEVED_EVENT Undocumented
Constant INSTANCE_CREATED_EVENT Undocumented
Constant INSTANCE_DELETED_EVENT Undocumented
Constant INSTANCE_DOWNLOAD_COMPLETED_EVENT Undocumented
Constant INSTANCE_FILE_UPLOADED_EVENT Undocumented
Constant INSTANCE_FILES_LISTED_EVENT Undocumented
Constant INSTANCE_RETRIEVED_EVENT Undocumented
Constant INSTANCES_LISTED_EVENT Undocumented
Constant MODEL_CREATED_EVENT Undocumented
Constant MODEL_DELETED_EVENT Undocumented
Constant MODEL_RETRIEVED_EVENT Undocumented
Constant MODEL_UPDATED_EVENT Undocumented
Constant MODELS_LISTED_EVENT Undocumented
Constant OPERATION_RESULT_EVENT Undocumented
Constant VARIANT_CREATED_EVENT Undocumented
Constant VARIANT_DELETED_EVENT Undocumented
Constant VARIANT_RETRIEVED_EVENT Undocumented
Constant VARIANTS_LISTED_EVENT Undocumented
Function _bind_arguments Undocumented
Function _capture_operation_result Undocumented
Function _capture_success_event Undocumented
Function _drop_none Undocumented
Function _emit_command_event Undocumented
Function _failure_reason_from_status_code Undocumented
Function _is_builtin_cyclopts_command Undocumented
Function _iter_unique_subapps Undocumented
Function _primary_name Undocumented
Function _sdk_version Undocumented
Function _wrap_command_callback Undocumented
Function _wrap_cyclopts Undocumented
Constant _CLI_FAILURE_REASON Undocumented
Constant _CONVERSION_RUN_ID Undocumented
def bucket_file_size(value: int) -> str:

Undocumented

def bucket_limit(value: int) -> str:

Undocumented

def bucket_max_quantization_images(value: int) -> str:

Undocumented

def bucket_nonzero_count(value: int) -> str:

Undocumented

def bucket_result_count(value: int) -> str:

Undocumented

def bucket_rvc2_shaves(value: int) -> str:

Undocumented

def bucket_yolo_class_count(value: int) -> str:

Undocumented

def bucket_zero_count(value: int) -> str:

Undocumented

def build_client_initialized_properties(api_key_source: ApiKeySource) -> dict[str, Any]:

Undocumented

def build_command_properties(*, command_name: CommandName, command_group: TelemetryGroup, result: TelemetryResult, duration_ms: int, failure_reason: FailureReason | None = None) -> dict[str, Any]:

Undocumented

def build_conversion_flow_properties(conversion_run_id: str, flow_step: ConversionFlowStep, properties: dict[str, Any]) -> dict[str, Any]:

Undocumented

def build_conversion_result_properties(*, result: TelemetryResult, duration_ms: int, failure_reason: FailureReason | None = None, downloaded_file_count: int | None = None) -> dict[str, Any]:

Undocumented

def build_conversion_summary(*, target: str, config_source: ConfigSource, input_model_type: ModelType, invocation_surface: InvocationSurface, existing_model_reused: bool, existing_variant_reused: bool, quantization_mode: str | None, quantization_input_type: QuantizationInputType, max_quantization_images: int | None, yolo_version: str | None, yolo_class_names: list[str] | None, yolo_input_shape_provided: bool, tool_version_provided: bool, input_shape_provided: bool, download_output_dir_provided: bool, input_count: int, target_options: Mapping[str, Any]) -> dict[str, Any]:

Undocumented

def build_instance_created_properties(arguments: dict[str, Any], _result: Any) -> dict[str, Any]:

Undocumented

def build_instance_downloaded_properties(arguments: dict[str, Any], result: Path) -> dict[str, Any]:

Undocumented

def build_instance_files_listed_properties(arguments: dict[str, Any], result: list[Any]) -> dict[str, Any]:

Undocumented

def build_instance_uploaded_properties(arguments: dict[str, Any], _result: Any) -> dict[str, Any]:

Undocumented

def build_instances_listed_properties(arguments: dict[str, Any], result: list[Any]) -> dict[str, Any]:

Undocumented

def build_model_created_properties(arguments: dict[str, Any], _result: Any) -> dict[str, Any]:

Undocumented

def build_model_identifier_properties(arguments: dict[str, Any], _result: Any) -> dict[str, Any]:

Undocumented

def build_model_updated_properties(arguments: dict[str, Any], _result: Any) -> dict[str, Any]:

Undocumented

def build_models_listed_properties(arguments: dict[str, Any], result: list[Any]) -> dict[str, Any]:

Undocumented

def build_variant_created_properties(arguments: dict[str, Any], _result: Any) -> dict[str, Any]:

Undocumented

def build_variants_listed_properties(arguments: dict[str, Any], result: list[Any]) -> dict[str, Any]:

Undocumented

def capture_client_initialized(api_key_source: ApiKeySource):

Undocumented

def capture_conversion_configured(conversion_run_id: str, properties: dict[str, Any]):

Undocumented

def capture_conversion_result(conversion_run_id: str, properties: dict[str, Any]):

Undocumented

def capture_operation_result(*, spec: OperationTelemetrySpec, exc: BaseException | None, duration_ms: int, bound_arguments: dict[str, Any] | None = None):

Undocumented

def command_metadata(command_path: str) -> CommandMetadata | None:

Undocumented

def command_result_from_exception(exc: BaseException | None) -> TelemetryResult:

Undocumented

def config_source_from_path(path: str, *, is_archive: bool, is_yaml: bool) -> ConfigSource:

Undocumented

def conversion_failure_reason(exc: BaseException | None, *, phase: ConversionPhase) -> FailureReason | None:

Undocumented

def current_conversion_run_id() -> str | None:

Undocumented

def failure_reason_from_exception(exc: BaseException | None) -> FailureReason | None:

Undocumented

def file_extension(path: str | Path) -> str:

Undocumented

def get_component_telemetry() -> Telemetry:

Undocumented

def get_or_create_conversion_run_id() -> str:

Undocumented

def identifier_type(identifier: UUID | str | None) -> IdentifierType | None:

Undocumented

def instrument_hubai_cli(app: cyclopts.App):

Undocumented

def invocation_surface() -> InvocationSurface:

Undocumented

def pop_cli_failure_reason() -> FailureReason | None:

Undocumented

def quantization_input_type(quantization_data: str | None, *, custom_zip: bool = False) -> QuantizationInputType:

Undocumented

def record_cli_failure_reason(exc: BaseException):

Undocumented

def reset_conversion_run_id(previous_value: str | None):

Undocumented

def sort_mode(value: str, *, allowed: set[str]) -> str:

Undocumented

def telemetry_operation(spec: OperationTelemetrySpec) -> Callable[[Callable[..., Any]], Callable[..., Any]]:

Undocumented

def visibility_filter(is_public: bool | None) -> VisibilityFilterValue:

Undocumented

def visibility_value(is_public: bool | None) -> VisibilityValue:

Undocumented

CLIENT_INITIALIZED_EVENT: str =

Undocumented

Value
'hubai_sdk_client_initialized'
COMMAND_EVENT: str =

Undocumented

Value
'hubai_sdk_command_ran'
CONVERSION_CONFIGURED_EVENT: str =

Undocumented

Value
'hubai_sdk_conversion_configured'
CONVERSION_FLOW_NAME: str =

Undocumented

Value
'hubai_sdk_conversion_lifecycle'
CONVERSION_RESULT_EVENT: str =

Undocumented

Value
'hubai_sdk_conversion_result_recorded'
HUBAI_SDK_TELEMETRY_DEFAULTS =

Undocumented

Value
TelemetryDefaults(enabled=True,
                  backend='posthog',
                  api_key='phc_ojEByaCiZZ5eigzaM43PaEVbfLfFDF5NgkXEMPabrT9a',
                  endpoint='https://us.i.posthog.com')
INSTANCE_CONFIG_RETRIEVED_EVENT: str =

Undocumented

Value
'hubai_sdk_instance_config_retrieved'
INSTANCE_CREATED_EVENT: str =

Undocumented

Value
'hubai_sdk_instance_created'
INSTANCE_DELETED_EVENT: str =

Undocumented

Value
'hubai_sdk_instance_deleted'
INSTANCE_DOWNLOAD_COMPLETED_EVENT: str =

Undocumented

Value
'hubai_sdk_instance_download_completed'
INSTANCE_FILE_UPLOADED_EVENT: str =

Undocumented

Value
'hubai_sdk_instance_file_uploaded'
INSTANCE_FILES_LISTED_EVENT: str =

Undocumented

Value
'hubai_sdk_instance_files_listed'
INSTANCE_RETRIEVED_EVENT: str =

Undocumented

Value
'hubai_sdk_instance_retrieved'
INSTANCES_LISTED_EVENT: str =

Undocumented

Value
'hubai_sdk_instances_listed'
MODEL_CREATED_EVENT: str =

Undocumented

Value
'hubai_sdk_model_created'
MODEL_DELETED_EVENT: str =

Undocumented

Value
'hubai_sdk_model_deleted'
MODEL_RETRIEVED_EVENT: str =

Undocumented

Value
'hubai_sdk_model_retrieved'
MODEL_UPDATED_EVENT: str =

Undocumented

Value
'hubai_sdk_model_updated'
MODELS_LISTED_EVENT: str =

Undocumented

Value
'hubai_sdk_models_listed'
OPERATION_RESULT_EVENT: str =

Undocumented

Value
'hubai_sdk_operation_result_recorded'
VARIANT_CREATED_EVENT: str =

Undocumented

Value
'hubai_sdk_variant_created'
VARIANT_DELETED_EVENT: str =

Undocumented

Value
'hubai_sdk_variant_deleted'
VARIANT_RETRIEVED_EVENT: str =

Undocumented

Value
'hubai_sdk_variant_retrieved'
VARIANTS_LISTED_EVENT: str =

Undocumented

Value
'hubai_sdk_variants_listed'
def _bind_arguments(signature: inspect.Signature, args: tuple[Any, ...], kwargs: dict[str, Any]) -> dict[str, Any]:

Undocumented

def _capture_operation_result(telemetry: Telemetry, *, spec: OperationTelemetrySpec, bound_arguments: dict[str, Any], exc: BaseException | None, duration_ms: int):

Undocumented

def _capture_success_event(telemetry: Telemetry, *, spec: OperationTelemetrySpec, bound_arguments: dict[str, Any], result: Any):

Undocumented

def _drop_none(properties: dict[str, Any]) -> dict[str, Any]:

Undocumented

def _emit_command_event(*, command_name: CommandName, command_group: TelemetryGroup, exc: BaseException | None, duration_ms: int):

Undocumented

def _failure_reason_from_status_code(status_code: int | None) -> FailureReason:

Undocumented

def _is_builtin_cyclopts_command(app: cyclopts.App, default_command: object) -> bool:

Undocumented

def _iter_unique_subapps(subapps: Iterable[object]) -> list[cyclopts.App]:

Undocumented

def _primary_name(name: tuple[str, ...] | str | None) -> str:

Undocumented

def _sdk_version() -> str | None:

Undocumented

def _wrap_command_callback(func: Callable[..., Any], *, command_name: CommandName, command_group: TelemetryGroup) -> Callable[..., Any]:

Undocumented

def _wrap_cyclopts(app: cyclopts.App, *, prefix: str):

Undocumented

_CLI_FAILURE_REASON: ContextVar[FailureReason | None] =

Undocumented

Value
ContextVar('hubai_sdk_cli_failure_reason',
           default=None)
_CONVERSION_RUN_ID: ContextVar[str | None] =

Undocumented

Value
ContextVar('hubai_sdk_conversion_run_id',
           default=None)