videoflow package

Subpackages

• videoflow.components package
  • Submodules
  • videoflow.components.descriptor module
    • ComponentDescriptor
      • ComponentDescriptor.all_inputs_accept()
      • ComponentDescriptor.command
      • ComponentDescriptor.description
      • ComponentDescriptor.device
      • ComponentDescriptor.finite
      • ComponentDescriptor.from_dict()
      • ComponentDescriptor.image_for()
      • ComponentDescriptor.images
      • ComponentDescriptor.input_accepts()
      • ComponentDescriptor.inputs
      • ComponentDescriptor.is_native
      • ComponentDescriptor.license
      • ComponentDescriptor.local_command
      • ComponentDescriptor.name
      • ComponentDescriptor.output
      • ComponentDescriptor.params_schema
      • ComponentDescriptor.partitionable
      • ComponentDescriptor.protocol
      • ComponentDescriptor.python_class
      • ComponentDescriptor.role
      • ComponentDescriptor.singleton
      • ComponentDescriptor.validate_params()
      • ComponentDescriptor.version
    • IO_ANY
    • load_descriptor()
  • videoflow.components.oci module
    • COMPONENT_ARTIFACT_TYPE
    • COMPONENT_MEDIA_TYPE
    • cache_dir_for()
    • cosign_verify()
    • default_cache_root()
    • inspect_component()
    • is_oci_ref()
    • parse_oci_ref()
    • pull_component()
    • push_component()
• videoflow.consumers package
  • Submodules
  • videoflow.consumers.basic module
    • CommandlineConsumer
      • CommandlineConsumer.consume()
    • FileAppenderConsumer
      • FileAppenderConsumer.consume()
    • VoidConsumer
      • VoidConsumer.consume()
    • WebhookConsumer
      • WebhookConsumer.consume()
  • videoflow.consumers.video module
    • VideofileWriter
      • VideofileWriter.close()
      • VideofileWriter.consume()
      • VideofileWriter.open()
• videoflow.core package
  • Submodules
  • videoflow.core.compiler module
    • NodeSpec
      • NodeSpec.blob_readers
      • NodeSpec.command
      • NodeSpec.component_ref
      • NodeSpec.descriptor
      • NodeSpec.device_type
      • NodeSpec.from_dict()
      • NodeSpec.gpu_count
      • NodeSpec.gpu_resource_name
      • NodeSpec.has_children
      • NodeSpec.image
      • NodeSpec.is_finite
      • NodeSpec.is_native
      • NodeSpec.is_remote
      • NodeSpec.join_policy
      • NodeSpec.kind
      • NodeSpec.name
      • NodeSpec.nb_tasks
      • NodeSpec.node_class
      • NodeSpec.params
      • NodeSpec.parents
      • NodeSpec.partition_by
      • NodeSpec.protocol_version
      • NodeSpec.to_dict()
    • compile_flow()
    • has_native_components()
    • has_remote_components()
    • specs_from_tasks_data()
    • validate_wire_compatibility()
  • videoflow.core.constants module
  • videoflow.core.context module
    • RuntimeContext
      • RuntimeContext.input_info
      • RuntimeContext.set_event_timestamp()
      • RuntimeContext.set_partition_key()
  • videoflow.core.engine module
    • ExecutionEngine
      • ExecutionEngine.allocate_and_run_tasks()
      • ExecutionEngine.join_task_processes()
      • ExecutionEngine.signal_flow_termination()
    • Messenger
      • Messenger.ack_inputs()
      • Messenger.check_for_termination()
      • Messenger.close()
      • Messenger.fail_inputs()
      • Messenger.last_input_info()
      • Messenger.last_input_key()
      • Messenger.publish_message()
      • Messenger.publish_stop_signal()
      • Messenger.receive_message()
      • Messenger.set_output_event_timestamp()
      • Messenger.set_output_partition_key()
  • videoflow.core.flow module
    • Flow
      • Flow.flow_id
      • Flow.flow_type
      • Flow.join()
      • Flow.run()
      • Flow.run_id
      • Flow.stop()
      • Flow.tasks_data()
      • Flow.topological_sort()
    • build_tasks_data()
  • videoflow.core.graph module
    • GraphEngine
      • GraphEngine.topological_sort()
  • videoflow.core.node module
    • ConsumerNode
      • ConsumerNode.consume()
      • ConsumerNode.idempotent
      • ConsumerNode.join_policy
      • ConsumerNode.metadata
      • ConsumerNode.partition_by
    • FunctionProcessorNode
      • FunctionProcessorNode.get_params()
      • FunctionProcessorNode.process()
    • JoinPolicyArg
    • Leaf
    • ModuleNode
      • ModuleNode.get_params()
      • ModuleNode.nodes
    • Node
      • Node.add_child()
      • Node.children
      • Node.close()
      • Node.get_params()
      • Node.image
      • Node.name
      • Node.open()
      • Node.parents
      • Node.remove_child()
    • OneTaskProcessorNode
    • ProcessorNode
      • ProcessorNode.change_device()
      • ProcessorNode.device_type
      • ProcessorNode.gpu_count
      • ProcessorNode.gpu_resource_name
      • ProcessorNode.join_policy
      • ProcessorNode.nb_tasks
      • ProcessorNode.partition_by
      • ProcessorNode.process()
    • ProducerNode
      • ProducerNode.is_finite
      • ProducerNode.next()
    • TaskModuleNode
      • TaskModuleNode.get_params()
      • TaskModuleNode.process()
  • videoflow.core.policies module
    • JOIN_TRACE
    • JoinPolicy
      • JoinPolicy.default_for()
      • JoinPolicy.from_dict()
      • JoinPolicy.to_dict()
    • MISSING_DROP
  • videoflow.core.remote module
    • RemoteConsumer
      • RemoteConsumer.consume()
    • RemoteNodeMixin
      • RemoteNodeMixin.component_command
      • RemoteNodeMixin.component_ref
      • RemoteNodeMixin.descriptor
      • RemoteNodeMixin.get_params()
      • RemoteNodeMixin.local_command
    • RemoteProcessor
      • RemoteProcessor.process()
    • RemoteProducer
      • RemoteProducer.next()
    • component()
  • videoflow.core.task module
    • ConsumerTask
    • NodeTask
      • NodeTask.computation_node
      • NodeTask.run()
    • ProcessorTask
      • ProcessorTask.change_device()
      • ProcessorTask.device_type
    • ProducerTask
    • Task
      • Task.run()
• videoflow.deploy package
  • Submodules
  • videoflow.deploy.build module
    • autobuild()
    • base_image_for()
    • build_context_for()
    • build_image()
    • default_tag()
    • docker_gpus_available()
    • ensure_base_image()
    • find_dockerfile()
    • image_exists()
    • run_in_image()
  • videoflow.deploy.cli module
    • build_parser()
    • main()
  • videoflow.deploy.cluster module
    • ClusterFlavorHandler
      • ClusterFlavorHandler.hostpath_warning()
      • ClusterFlavorHandler.load_images()
      • ClusterFlavorHandler.matches()
      • ClusterFlavorHandler.name
    • allocatable_gpus()
    • current_context()
    • detect_cluster()
    • get_cluster_flavor()
    • gpu_preflight()
    • hostpath_warning()
    • load_images()
    • nvidia_runtimeclass()
    • register_cluster_flavor()
  • videoflow.deploy.compile module
    • compile_to_dict()
    • load_flow()
    • main()
    • specs_from_document()
  • videoflow.deploy.gpu module
    • DEFAULT_GPU_RESOURCE
    • ExclusiveGpu
      • ExclusiveGpu.name
      • ExclusiveGpu.pod_resources()
      • ExclusiveGpu.preflight_problems()
    • GPU_POOL_LABEL
    • GpuStrategy
      • GpuStrategy.cleanup()
      • GpuStrategy.name
      • GpuStrategy.pod_resources()
      • GpuStrategy.preflight_problems()
      • GpuStrategy.prepare()
    • SHARED_NEEDS_RUNTIME_CLASS
    • SharedGpu
      • SharedGpu.name
      • SharedGpu.pod_resources()
      • SharedGpu.preflight_problems()
    • get_gpu_mode()
    • register_gpu_mode()
    • registered_gpu_modes()
    • resolve_gpu_resource()
  • videoflow.deploy.images module
    • parse_override()
    • resolve_image()
    • validate_image_pull_policy()
  • videoflow.deploy.infra module
    • ensure_infra()
    • ensure_namespace()
    • infra_urls()
    • nats_manifests()
    • redis_manifests()
    • service_exists()
    • teardown_infra()
    • wait_infra_ready()
  • videoflow.deploy.localinfra module
    • docker_available()
    • ensure_local_infra()
    • local_infra_urls()
    • nats_running()
    • port_open()
    • redis_running()
    • teardown_local_infra()
    • wait_local_infra_ready()
  • videoflow.deploy.manifests module
    • Mount
      • Mount.container_path
      • Mount.host_path
      • Mount.name
      • Mount.read_only
    • ProvisionSplit
      • ProvisionSplit.provision
      • ProvisionSplit.worker
    • delete_resources()
    • dump_manifests()
    • flow_spec_configmap()
    • gpu_demand()
    • headless_service()
    • k8s_name()
    • nats_configmap()
    • network_policy()
    • node_configmap()
    • parse_mounts()
    • pod_disruption_budget()
    • provision_init_job()
    • render_manifests()
    • scaled_object()
    • split_provision_manifests()
    • workload()
  • videoflow.deploy.solution module
    • ask_questions()
    • ensure_config()
    • find_prepare()
    • find_template()
    • load_template()
    • prepare_command()
    • register_question_type()
    • registered_question_types()
    • render_config()
    • resolve_mounts()
    • run_prepare_local()
    • validate_question_types()
• videoflow.engines package
  • Submodules
  • videoflow.engines.kubernetes module
    • KubernetesExecutionEngine
      • KubernetesExecutionEngine.dump_failed_logs()
      • KubernetesExecutionEngine.join_task_processes()
      • KubernetesExecutionEngine.schedulability_report()
      • KubernetesExecutionEngine.signal_flow_termination()
      • KubernetesExecutionEngine.teardown()
      • KubernetesExecutionEngine.wait_for_completion()
  • videoflow.engines.local module
    • LocalProcessEngine
      • LocalProcessEngine.failures()
      • LocalProcessEngine.join_task_processes()
      • LocalProcessEngine.report_failures()
      • LocalProcessEngine.signal_flow_termination()
      • LocalProcessEngine.wait_for_completion()
    • inherited_python_path()
    • needs_container_image()
• videoflow.messaging package
  • Submodules
  • videoflow.messaging.grouping module
    • CollectEntry
      • CollectEntry.event_ts
      • CollectEntry.is_stop_signal
      • CollectEntry.message
      • CollectEntry.metadata
    • EnvelopeEntry
      • EnvelopeEntry.blob_ref
      • EnvelopeEntry.event_ts
      • EnvelopeEntry.flow_id
      • EnvelopeEntry.from_decoded()
      • EnvelopeEntry.is_stop_signal
      • EnvelopeEntry.message
      • EnvelopeEntry.metadata
      • EnvelopeEntry.parent_span_id
      • EnvelopeEntry.producer_name
      • EnvelopeEntry.replica_id
      • EnvelopeEntry.run_id
      • EnvelopeEntry.seq
      • EnvelopeEntry.span_id
      • EnvelopeEntry.trace_id
      • EnvelopeEntry.type
    • GroupAssembler
      • GroupAssembler.add()
      • GroupAssembler.has_pending_from()
      • GroupAssembler.pop_ready()
      • GroupAssembler.sweep()
    • GroupEntry
    • ReadyGroup
    • TimeGroupAssembler
      • TimeGroupAssembler.add()
      • TimeGroupAssembler.has_pending_from()
      • TimeGroupAssembler.pop_ready()
      • TimeGroupAssembler.sweep()
    • TraceGroupAssembler
      • TraceGroupAssembler.add()
      • TraceGroupAssembler.has_pending_from()
      • TraceGroupAssembler.pop_ready()
      • TraceGroupAssembler.sweep()
    • make_assembler()
  • videoflow.messaging.nats_messenger module
    • NATSMessenger
      • NATSMessenger.ack_inputs()
      • NATSMessenger.check_for_termination()
      • NATSMessenger.close()
      • NATSMessenger.fail_inputs()
      • NATSMessenger.last_input_info()
      • NATSMessenger.last_input_key()
      • NATSMessenger.publish_message()
      • NATSMessenger.publish_stop_signal()
      • NATSMessenger.receive_message()
      • NATSMessenger.set_output_event_timestamp()
      • NATSMessenger.set_output_partition_key()
  • videoflow.messaging.topology module
    • DEFAULT_MAX_RETRIES
    • DEFAULT_REALTIME_BUFFER
    • consumer_config_for()
    • control_subject_for()
    • delete_run_streams()
    • dlq_stream_config()
    • dlq_stream_name()
    • dlq_subject_for()
    • durable_name_for()
    • eos_anchor_config()
    • eos_anchor_durable_name_for()
    • eos_consumer_config()
    • eos_durable_name_for()
    • eos_subject_for()
    • max_deliver_for()
    • partitioned_durable_name_for()
    • provision_flow()
    • provision_flow_connect()
    • provision_flow_sync()
    • sanitize()
    • stream_config_for()
    • stream_label_selector()
    • stream_name_for()
    • subject_for()
• videoflow.processors package
  • Subpackages
    • videoflow.processors.vision package
      • Submodules
      • videoflow.processors.vision.annotators module
      • videoflow.processors.vision.counters module
      • videoflow.processors.vision.detectors module
      • videoflow.processors.vision.pose module
      • videoflow.processors.vision.segmentation module
      • videoflow.processors.vision.trackers module
      • videoflow.processors.vision.transformers module
  • Submodules
  • videoflow.processors.aggregators module
    • CountAggregator
      • CountAggregator.process()
    • MaxAggregator
      • MaxAggregator.process()
    • MinAggregator
      • MinAggregator.process()
    • MultiplicationAggregator
      • MultiplicationAggregator.process()
    • SumAggregator
      • SumAggregator.process()
  • videoflow.processors.basic module
    • IdentityProcessor
      • IdentityProcessor.process()
    • JoinerProcessor
      • JoinerProcessor.process()
• videoflow.producers package
  • Submodules
  • videoflow.producers.basic module
    • IntProducer
      • IntProducer.next()
  • videoflow.producers.video module
    • ImageFolderReader
      • ImageFolderReader.close()
      • ImageFolderReader.next()
      • ImageFolderReader.open()
    • ImageProducer
      • ImageProducer.close()
      • ImageProducer.next()
      • ImageProducer.open()
    • TIMESTAMP_CLOCK
    • VideoDeviceReader
      • VideoDeviceReader.get_params()
    • VideoFileReader
      • VideoFileReader.get_params()
    • VideoFolderReader
      • VideoFolderReader.close()
      • VideoFolderReader.next()
      • VideoFolderReader.open()
    • VideoUrlReader
      • VideoUrlReader.get_params()
    • VideofileReader
    • VideostreamReader
      • VideostreamReader.close()
      • VideostreamReader.next()
      • VideostreamReader.open()
• videoflow.runtime package
  • Submodules
  • videoflow.runtime.health module
    • HealthServer
      • HealthServer.start()
      • HealthServer.stop()
    • HealthState
      • HealthState.beat()
      • HealthState.incr()
      • HealthState.is_live()
      • HealthState.is_ready()
      • HealthState.mark_ready()
      • HealthState.observe()
      • HealthState.render_metrics()
    • InstrumentedMessenger
      • InstrumentedMessenger.ack_inputs()
      • InstrumentedMessenger.check_for_termination()
      • InstrumentedMessenger.close()
      • InstrumentedMessenger.fail_inputs()
      • InstrumentedMessenger.last_input_info()
      • InstrumentedMessenger.last_input_key()
      • InstrumentedMessenger.publish_message()
      • InstrumentedMessenger.publish_stop_signal()
      • InstrumentedMessenger.receive_message()
      • InstrumentedMessenger.set_output_event_timestamp()
      • InstrumentedMessenger.set_output_partition_key()
  • videoflow.runtime.idempotency module
    • IdempotencyStore
      • IdempotencyStore.mark()
      • IdempotencyStore.seen()
    • RedisIdempotencyStore
      • RedisIdempotencyStore.mark()
      • RedisIdempotencyStore.seen()
    • idempotency_key()
  • videoflow.runtime.logging_config module
    • JsonFormatter
      • JsonFormatter.format()
    • configure_logging()
  • videoflow.runtime.provision module
    • main()
  • videoflow.runtime.worker module
    • build_node_from_env()
    • main()
    • require_node_kind()
    • run_from_env()
• videoflow.utils package
  • Submodules
  • videoflow.utils.downloader module
    • get_file()
    • validate_file()
  • videoflow.utils.generic_utils module
    • DelayedInterrupt
    • DelayedKeyboardInterrupt
    • Progbar
      • Progbar.add()
      • Progbar.update()
  • videoflow.utils.graph module
    • flatten()
    • has_cycle()
    • topological_sort()
  • videoflow.utils.parsers module
    • parse_label_map()
  • videoflow.utils.plugins module
    • load_plugin_group()
  • videoflow.utils.system module
    • get_gpus_available_to_process()
    • get_number_of_gpus()
    • get_system_gpus()
  • videoflow.utils.transforms module
    • resize_add_padding()
• videoflow.v1 package
  • Submodules
  • videoflow.v1.envelope_pb2 module
    • Envelope
      • Envelope.DESCRIPTOR
      • Envelope.MetadataEntry
  • videoflow.v1.payloads_pb2 module
    • BlobRef
      • BlobRef.DESCRIPTOR
    • Detections
      • Detections.DESCRIPTOR
    • Frame
      • Frame.DESCRIPTOR
    • Tensor
      • Tensor.DESCRIPTOR
    • Tracks
      • Tracks.DESCRIPTOR
  • videoflow.v1.value_pb2 module
    • ListValue
      • ListValue.DESCRIPTOR
    • MapValue
      • MapValue.DESCRIPTOR
      • MapValue.FieldsEntry
    • Value
      • Value.DESCRIPTOR
• videoflow.wire package
  • Submodules
  • videoflow.wire.serialization module
    • BlobStore
      • BlobStore.get()
      • BlobStore.put()
      • BlobStore.put_with_readers()
      • BlobStore.release()
    • COMPATIBLE_ENVELOPE_VERSIONS
    • DEFAULT_BLOB_TTL_SECONDS
    • DEFAULT_ENVELOPE_VERSION
    • EMITTABLE_ENVELOPE_VERSIONS
    • MAX_INLINE_PAYLOAD_BYTES
    • MSG_TYPE_DATA
    • PAYLOAD_ENTRY_POINT_GROUP
    • PAYLOAD_TENSOR
    • RawPayload
      • RawPayload.data
      • RawPayload.payload_type
    • RedisBlobStore
      • RedisBlobStore.get()
      • RedisBlobStore.put()
      • RedisBlobStore.put_with_readers()
      • RedisBlobStore.release()
    • decode_envelope()
    • derive_message_id()
    • encode_envelope()
    • make_blob_store()
    • register_blob_store()
    • register_payload_encoder()
    • register_payload_type()
    • registered_blob_store_schemes()

Submodules

videoflow.cli module

Moved to videoflow.deploy.cli.

This module remains as a permanent compatibility shim: the videoflow console script resolves videoflow.cli:main, and an installed entry point outlives the source tree it was generated from. Do not add code — edit videoflow/deploy/cli.py instead.

videoflow.compile module

Moved to videoflow.deploy.compile.

This module remains as a permanent compatibility shim: videoflow deploy spawns python -m videoflow.compile inside the solution image, so the host CLI and the image can be different videoflow versions in either direction and the old path must keep resolving. Do not add code — edit videoflow/deploy/compile.py instead.

videoflow.provision module

Moved to videoflow.runtime.provision.

This module remains as a permanent compatibility shim: python -m videoflow.provision is rendered into the provision init Job of every deployed flow, and those manifests may already be applied in a cluster. Do not add code — edit videoflow/runtime/provision.py instead.

videoflow.serialization module

Moved to videoflow.wire.serialization.

This module remains as a permanent compatibility shim: the wire format is the one thing a message outlives its producer on, so external importers may have pinned this module path, and it must keep resolving to the wire codec. Do not add code — edit videoflow/wire/serialization.py instead.

videoflow.version module

videoflow.worker module

Moved to videoflow.runtime.worker.

This module remains as a permanent compatibility shim, and is the most frozen path in the package: python -m videoflow.worker is the ENTRYPOINT baked into the published base images, inherited by every contrib component image, and spawned by the local engine. Already-built images cannot be retargeted. Do not add code — edit videoflow/runtime/worker.py instead.