embodichain.lab.sim.atomic_actions.tracking#
Typed tracking keeps command projection, versioned feedback routing, and metric evaluation separate from command transport. Policies can use these contracts for in-flight recovery checks and terminal acceptance without mixing joint, base-pose, or whole-body error units.
Typed, transport-neutral tracking contracts for atomic-action execution.
Channels and endpoint routes
|
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str |
|
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str |
|
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str |
|
Open string identifier for one typed endpoint-feedback channel. |
|
Immutable address understood by one tracking-feedback provider. |
|
Feedback address for one runtime endpoint and open tracking channel. |
|
Versioned provider route plus one immutable feedback address. |
|
Exact version of a command-to-tracking-state projector. |
|
Resolved source and projector for one endpoint tracking channel. |
Typed states and metrics
|
Immutable-by-ownership typed desired or observed tracking state. |
|
Batched joint positions with shape |
|
Batched homogeneous poses with shape |
|
Batched base poses and joint positions for whole-body tracking. |
|
Immutable tolerance configuration dispatched by exact metric ID/revision. |
|
Maximum absolute joint-error tolerance. |
|
Independent translation and rotation tolerances for base pose. |
|
Independent base-pose and joint-position tolerances. |
Tracking policies and command-aligned targets
|
Feedback checks used while a command sequence is still in flight. |
|
Terminal acceptance proven by typed endpoint feedback. |
|
Explicit terminal acceptance without endpoint feedback. |
|
Represent a PEP 604 union type |
|
Independent in-flight recovery signal and terminal acceptance contract. |
|
One endpoint-local desired state and its typed feedback route. |
|
Desired endpoint states associated with one command frame. |
|
Tracking frames aligned by index with an authoritative command sequence. |
Runtime extension points and built-ins
|
One synchronized typed observation from an exact feedback source. |
|
Per-row metric result with unit-preserving component errors. |
|
Versioned live port that reads one exact tracking source. |
|
Versioned pure projector from an endpoint command to desired state. |
|
Versioned evaluator for one exact metric configuration type. |
|
Immutable exact-version feedback-provider registry. |
|
Immutable exact-version command-projector registry. |
|
Immutable exact-version metric-evaluator registry. |
|
Built-in provider backed by |
|
Built-in projector for joint-position endpoint commands. |
|
Evaluator for |
|
Evaluator for |
|
Evaluator for |
|
Runtime facade for projecting commands and evaluating typed feedback. |
Classes:
|
Resolved source and projector for one endpoint tracking channel. |
|
Feedback address for one runtime endpoint and open tracking channel. |
|
Terminal acceptance proven by typed endpoint feedback. |
|
Feedback checks used while a command sequence is still in flight. |
|
Evaluator for |
|
Maximum absolute joint-error tolerance. |
|
Built-in projector for joint-position endpoint commands. |
|
Batched joint positions with shape |
|
Built-in provider backed by |
|
Evaluator for |
|
Independent translation and rotation tolerances for base pose. |
|
Batched homogeneous poses with shape |
|
Explicit terminal acceptance without endpoint feedback. |
|
Tracking frames aligned by index with an authoritative command sequence. |
|
Open string identifier for one typed endpoint-feedback channel. |
|
Versioned pure projector from an endpoint command to desired state. |
|
Per-row metric result with unit-preserving component errors. |
|
Immutable exact-version metric-evaluator registry. |
|
Immutable address understood by one tracking-feedback provider. |
|
One synchronized typed observation from an exact feedback source. |
|
Versioned live port that reads one exact tracking source. |
|
Immutable exact-version feedback-provider registry. |
|
Versioned provider route plus one immutable feedback address. |
|
Desired endpoint states associated with one command frame. |
|
Immutable tolerance configuration dispatched by exact metric ID/revision. |
|
Versioned evaluator for one exact metric configuration type. |
|
Independent in-flight recovery signal and terminal acceptance contract. |
|
Exact version of a command-to-tracking-state projector. |
|
Immutable exact-version command-projector registry. |
|
Runtime facade for projecting commands and evaluating typed feedback. |
|
One endpoint-local desired state and its typed feedback route. |
|
Immutable-by-ownership typed desired or observed tracking state. |
|
Evaluator for |
|
Independent base-pose and joint-position tolerances. |
|
Batched base poses and joint positions for whole-body tracking. |
- class embodichain.lab.sim.atomic_actions.tracking.EndpointTrackingChannelBinding[source]
Resolved source and projector for one endpoint tracking channel.
Methods:
__init__(channel_id, source, projector)snapshot()Return an independently owned channel binding.
Attributes:
route_fingerprintReturn the exact channel, source, and projector route identity.
- __init__(channel_id, source, projector)
- property route_fingerprint: tuple[str, Hashable, str, str]
Return the exact channel, source, and projector route identity.
- snapshot()[source]
Return an independently owned channel binding.
- Return type:
EndpointTrackingChannelBinding
- class embodichain.lab.sim.atomic_actions.tracking.EndpointTrackingFeedbackAddress[source]
Feedback address for one runtime endpoint and open tracking channel.
Methods:
__init__(target, channel_id)Attributes:
address_fingerprintReturn the endpoint- and channel-scoped address identity.
- __init__(target, channel_id)
- property address_fingerprint: Hashable
Return the endpoint- and channel-scoped address identity.
- class embodichain.lab.sim.atomic_actions.tracking.FeedbackTerminalAcceptance[source]
Terminal acceptance proven by typed endpoint feedback.
Methods:
__init__(metrics[, settle_timeout, ...])- __init__(metrics, settle_timeout=0.0, consecutive_acceptances=1)
- class embodichain.lab.sim.atomic_actions.tracking.InFlightTrackingPolicy[source]
Feedback checks used while a command sequence is still in flight.
Methods:
__init__(metrics[, consecutive_violations, ...])- __init__(metrics, consecutive_violations=1, grace_period=0.0)
- class embodichain.lab.sim.atomic_actions.tracking.JointPositionTrackingEvaluator[source]
Evaluator for
JointPositionTrackingMetric.Classes:
metric_typealias of
JointPositionTrackingMetric- metric_type
alias of
JointPositionTrackingMetric
- class embodichain.lab.sim.atomic_actions.tracking.JointPositionTrackingMetric[source]
Maximum absolute joint-error tolerance.
Methods:
__init__([tolerance])- __init__(tolerance=0.05)
- class embodichain.lab.sim.atomic_actions.tracking.JointPositionTrackingProjector[source]
Built-in projector for joint-position endpoint commands.
- class embodichain.lab.sim.atomic_actions.tracking.JointPositionTrackingState[source]
Batched joint positions with shape
(B, D).Methods:
__init__(positions)snapshot()Return an independently owned state snapshot.
Attributes:
batch_sizeReturn the represented environment count.
deviceReturn the tensor device.
- __init__(positions)
- property batch_size: int
Return the represented environment count.
- property device: device
Return the tensor device.
- snapshot()[source]
Return an independently owned state snapshot.
- Return type:
JointPositionTrackingState
- class embodichain.lab.sim.atomic_actions.tracking.PlanningContextTrackingFeedbackProvider[source]
Built-in provider backed by
PlanningContext.robot.
- class embodichain.lab.sim.atomic_actions.tracking.PoseTrackingEvaluator[source]
Evaluator for
PoseTrackingMetric.Classes:
metric_typealias of
PoseTrackingMetric- metric_type
alias of
PoseTrackingMetric
- class embodichain.lab.sim.atomic_actions.tracking.PoseTrackingMetric[source]
Independent translation and rotation tolerances for base pose.
Methods:
__init__([translation_tolerance, ...])- __init__(translation_tolerance=0.02, rotation_tolerance=0.05)
- class embodichain.lab.sim.atomic_actions.tracking.PoseTrackingState[source]
Batched homogeneous poses with shape
(B, 4, 4).Methods:
__init__(poses)snapshot()Return an independently owned state snapshot.
Attributes:
batch_sizeReturn the represented environment count.
deviceReturn the tensor device.
- __init__(poses)
- property batch_size: int
Return the represented environment count.
- property device: device
Return the tensor device.
- snapshot()[source]
Return an independently owned state snapshot.
- Return type:
PoseTrackingState
- class embodichain.lab.sim.atomic_actions.tracking.TimedTerminalAcceptance[source]
Explicit terminal acceptance without endpoint feedback.
Methods:
__init__([settle_duration])- __init__(settle_duration=0.0)
- class embodichain.lab.sim.atomic_actions.tracking.TimedTrackingSequence[source]
Tracking frames aligned by index with an authoritative command sequence.
Methods:
__init__(env_ids, frames)Attributes:
batch_sizeReturn the represented environment count.
deviceReturn the sequence tensor device.
frame_countReturn the number of command-aligned tracking frames.
- __init__(env_ids, frames)
- property batch_size: int
Return the represented environment count.
- property device: device
Return the sequence tensor device.
- property frame_count: int
Return the number of command-aligned tracking frames.
- embodichain.lab.sim.atomic_actions.tracking.TrackingChannelId
Open string identifier for one typed endpoint-feedback channel.
- class embodichain.lab.sim.atomic_actions.tracking.TrackingCommandProjector[source]
Versioned pure projector from an endpoint command to desired state.
Methods:
__init__(*args, **kwargs)project(command, binding)Project one command into the binding's desired tracking channel.
- __init__(*args, **kwargs)
- project(command, binding)[source]
Project one command into the binding’s desired tracking channel.
- Return type:
TrackingState
- class embodichain.lab.sim.atomic_actions.tracking.TrackingEvaluation[source]
Per-row metric result with unit-preserving component errors.
Methods:
__init__(channel_id, accepted_mask, ...[, ...])- __init__(channel_id, accepted_mask, valid_mask, normalized_error, component_errors=<factory>)
- class embodichain.lab.sim.atomic_actions.tracking.TrackingEvaluatorRegistry[source]
Immutable exact-version metric-evaluator registry.
Methods:
__init__([evaluators])- __init__(evaluators=())[source]
- class embodichain.lab.sim.atomic_actions.tracking.TrackingFeedbackAddress[source]
Immutable address understood by one tracking-feedback provider.
Attributes:
address_fingerprintReturn a stable, hashable address identity.
Methods:
snapshot()Return an independently owned address snapshot.
- abstract property address_fingerprint: Hashable
Return a stable, hashable address identity.
- snapshot()[source]
Return an independently owned address snapshot.
- Return type:
TrackingFeedbackAddress
- class embodichain.lab.sim.atomic_actions.tracking.TrackingFeedbackBatch[source]
One synchronized typed observation from an exact feedback source.
Methods:
__init__(source, state, valid_mask, timestamp)- __init__(source, state, valid_mask, timestamp)
- class embodichain.lab.sim.atomic_actions.tracking.TrackingFeedbackProvider[source]
Versioned live port that reads one exact tracking source.
Methods:
__init__(*args, **kwargs)observe(source, context)Read one synchronized typed feedback batch.
- __init__(*args, **kwargs)
- observe(source, context)[source]
Read one synchronized typed feedback batch.
- Return type:
TrackingFeedbackBatch
- class embodichain.lab.sim.atomic_actions.tracking.TrackingFeedbackProviderRegistry[source]
Immutable exact-version feedback-provider registry.
Methods:
__init__([providers])- __init__(providers=())[source]
- class embodichain.lab.sim.atomic_actions.tracking.TrackingFeedbackSourceRef[source]
Versioned provider route plus one immutable feedback address.
Methods:
__init__(provider_id, revision, address)snapshot()Return an independently owned source reference.
Attributes:
source_fingerprintReturn the exact versioned source identity.
- __init__(provider_id, revision, address)
- snapshot()[source]
Return an independently owned source reference.
- Return type:
TrackingFeedbackSourceRef
- property source_fingerprint: Hashable
Return the exact versioned source identity.
- class embodichain.lab.sim.atomic_actions.tracking.TrackingFrame[source]
Desired endpoint states associated with one command frame.
Methods:
__init__([setpoints])- __init__(setpoints=())
- class embodichain.lab.sim.atomic_actions.tracking.TrackingMetricCfg[source]
Immutable tolerance configuration dispatched by exact metric ID/revision.
Methods:
snapshot()Return an independently owned metric configuration.
- snapshot()[source]
Return an independently owned metric configuration.
- Return type:
TrackingMetricCfg
- class embodichain.lab.sim.atomic_actions.tracking.TrackingMetricEvaluator[source]
Versioned evaluator for one exact metric configuration type.
Methods:
__init__(*args, **kwargs)evaluate(desired, observed, valid_mask, metric)Evaluate a desired and observed batch row by row.
- __init__(*args, **kwargs)
- evaluate(desired, observed, valid_mask, metric)[source]
Evaluate a desired and observed batch row by row.
- Return type:
TrackingEvaluation
- class embodichain.lab.sim.atomic_actions.tracking.TrackingPolicy[source]
Independent in-flight recovery signal and terminal acceptance contract.
Methods:
__init__(in_flight, terminal)joint_position(*[, in_flight_max_abs_error, ...])Create the built-in joint-position tracking and acceptance contract.
timed(*[, settle_duration])Create an explicit time-only terminal contract with no tracking.
- __init__(in_flight, terminal)
- classmethod joint_position(*, in_flight_max_abs_error=0.05, terminal_max_abs_error=0.05, terminal_settle_timeout=0.5, consecutive_violations=1, consecutive_acceptances=1, grace_period=0.0)[source]
Create the built-in joint-position tracking and acceptance contract.
- Return type:
TrackingPolicy
- classmethod timed(*, settle_duration=0.0)[source]
Create an explicit time-only terminal contract with no tracking.
- Return type:
TrackingPolicy
- class embodichain.lab.sim.atomic_actions.tracking.TrackingProjectorRef[source]
Exact version of a command-to-tracking-state projector.
Methods:
__init__(projector_id, revision)snapshot()Return an independently owned projector route.
- __init__(projector_id, revision)
- snapshot()[source]
Return an independently owned projector route.
- Return type:
TrackingProjectorRef
- class embodichain.lab.sim.atomic_actions.tracking.TrackingProjectorRegistry[source]
Immutable exact-version command-projector registry.
Methods:
__init__([projectors])- __init__(projectors=())[source]
- class embodichain.lab.sim.atomic_actions.tracking.TrackingRuntime[source]
Runtime facade for projecting commands and evaluating typed feedback.
Methods:
__init__(providers, projectors, evaluators)evaluate(setpoint, feedback, metric)Evaluate one observed setpoint with an exact metric implementation.
evaluate_frame(frame, metrics, context)Observe and evaluate every setpoint required by one frame.
observe(setpoint, context)Read the exact feedback source for one setpoint.
project(command, binding)Project one command through the exact binding-owned projector.
with_builtins()Create a runtime with context feedback and built-in typed metrics.
Attributes:
evaluatorsReturn the immutable exact-version evaluator registry.
projectorsReturn the immutable exact-version projector registry.
providersReturn the immutable exact-version provider registry.
- __init__(providers, projectors, evaluators)[source]
- evaluate(setpoint, feedback, metric)[source]
Evaluate one observed setpoint with an exact metric implementation.
- Return type:
TrackingEvaluation
- evaluate_frame(frame, metrics, context)[source]
Observe and evaluate every setpoint required by one frame.
- Return type:
Mapping[tuple[str,str,str],TrackingEvaluation]
- property evaluators: TrackingEvaluatorRegistry
Return the immutable exact-version evaluator registry.
- observe(setpoint, context)[source]
Read the exact feedback source for one setpoint.
- Return type:
TrackingFeedbackBatch
- project(command, binding)[source]
Project one command through the exact binding-owned projector.
- Return type:
TrackingState
- property projectors: TrackingProjectorRegistry
Return the immutable exact-version projector registry.
- property providers: TrackingFeedbackProviderRegistry
Return the immutable exact-version provider registry.
- classmethod with_builtins()[source]
Create a runtime with context feedback and built-in typed metrics.
- Return type:
TrackingRuntime
- class embodichain.lab.sim.atomic_actions.tracking.TrackingSetpoint[source]
One endpoint-local desired state and its typed feedback route.
Methods:
__init__(endpoint_key, binding, desired)- __init__(endpoint_key, binding, desired)
- class embodichain.lab.sim.atomic_actions.tracking.TrackingState[source]
Immutable-by-ownership typed desired or observed tracking state.
Attributes:
batch_sizeReturn the represented environment count.
deviceReturn the tensor device.
Methods:
snapshot()Return an independently owned state snapshot.
- abstract property batch_size: int
Return the represented environment count.
- abstract property device: device
Return the tensor device.
- abstract snapshot()[source]
Return an independently owned state snapshot.
- Return type:
TrackingState
- class embodichain.lab.sim.atomic_actions.tracking.WholeBodyPoseTrackingEvaluator[source]
Evaluator for
WholeBodyPoseTrackingMetric.Classes:
metric_typealias of
WholeBodyPoseTrackingMetric- metric_type
alias of
WholeBodyPoseTrackingMetric
- class embodichain.lab.sim.atomic_actions.tracking.WholeBodyPoseTrackingMetric[source]
Independent base-pose and joint-position tolerances.
Methods:
__init__([translation_tolerance, ...])- __init__(translation_tolerance=0.02, rotation_tolerance=0.05, joint_position_tolerance=0.05)
- class embodichain.lab.sim.atomic_actions.tracking.WholeBodyPoseTrackingState[source]
Batched base poses and joint positions for whole-body tracking.
Methods:
__init__(root_poses, joint_positions)snapshot()Return an independently owned state snapshot.
Attributes:
batch_sizeReturn the represented environment count.
deviceReturn the tensor device.
- __init__(root_poses, joint_positions)
- property batch_size: int
Return the represented environment count.
- property device: device
Return the tensor device.
- snapshot()[source]
Return an independently owned state snapshot.
- Return type:
WholeBodyPoseTrackingState