# 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨 # This file was automatically generated from src/transformers/models/pi0/modular_pi0.py. # Do NOT edit this file manually as any edits will be overwritten by the generation of # the file from the modular. If any change should be done, please apply the change to the # modular_pi0.py file directly. One of our CI enforces this. # 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨 # Copyright 2025 Physical Intelligence and The HuggingFace Inc. team. All rights reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import numpy as np import torch import torch.nn.functional as F from ...feature_extraction_utils import BatchFeature from ...image_utils import ImageInput, make_nested_list_of_images from ...processing_utils import MultiModalData, ProcessingKwargs, ProcessorMixin, Unpack from ...tokenization_utils_base import AddedToken, PreTokenizedInput, TextInput from ...utils import auto_docstring, logging from ...utils.import_utils import requires logger = logging.get_logger(__name__) class PI0ProcessorKwargs(ProcessingKwargs, total=False): _defaults = { "text_kwargs": { "padding": "max_length", "max_length": 48, "padding_side": "right", }, "common_kwargs": {"return_tensors": "pt"}, } IMAGE_TOKEN = "" EXTRA_TOKENS = [f"4}>" for i in range(1024)] + [f"3}>" for i in range(128)] @auto_docstring @requires(backends=("vision", "torch")) class PI0Processor(ProcessorMixin): def __init__(self, image_processor=None, tokenizer=None, chat_template=None, **kwargs): self.height, self.width = image_processor.size["height"], image_processor.size["width"] state_mean = kwargs.get("state_mean", [-0.0419, 0.0354, 0.8257, 2.9083, -0.5562, -0.1665, 0.0283, -0.0286]) state_std = kwargs.get("state_std", [0.1074, 0.1442, 0.2572, 0.3441, 1.2344, 0.3580, 0.0133, 0.0132]) actions_mean = kwargs.get("actions_mean", [0.0182, 0.0586, -0.0559, 0.0046, 0.0029, -0.0077, -0.0916]) actions_std = kwargs.get("actions_std", [0.2825, 0.3590, 0.3674, 0.0377, 0.0543, 0.0872, 0.9958]) self.state_mean = torch.tensor(state_mean) self.state_std = torch.tensor(state_std) self.actions_mean = torch.tensor(actions_mean) self.actions_std = torch.tensor(actions_std) self.max_state_dim = kwargs.get("max_state_dim", 32) self.chunk_size = kwargs.get("chunk_size", 50) if not hasattr(image_processor, "image_seq_length"): raise ValueError("Image processor is missing an `image_seq_length` attribute.") self.image_seq_length = image_processor.image_seq_length if not hasattr(tokenizer, "image_token"): image_token = AddedToken(IMAGE_TOKEN, normalized=False, special=True) tokens_to_add = {"additional_special_tokens": [image_token]} tokenizer.add_special_tokens(tokens_to_add) self.image_token_id = tokenizer.convert_tokens_to_ids(IMAGE_TOKEN) self.image_token = IMAGE_TOKEN else: self.image_token_id = tokenizer.image_token_id self.image_token = tokenizer.image_token tokenizer.add_tokens(EXTRA_TOKENS) tokenizer.add_bos_token = False tokenizer.add_eos_token = False super().__init__(image_processor, tokenizer, chat_template=chat_template) @auto_docstring def __call__( self, images: ImageInput | list[ImageInput] | list[list[ImageInput]] | None, text: TextInput | PreTokenizedInput | list[TextInput] | list[PreTokenizedInput] | None = None, actions: list | np.ndarray | torch.Tensor | None = None, state: list | np.ndarray | torch.Tensor | None = None, **kwargs: Unpack[PI0ProcessorKwargs], ) -> BatchFeature: r""" actions (`list | np.ndarray | torch.Tensor`, *optional*): Actions to be predicted by the model. If provided, padding, mean and std normalization will be applied. state (`list | np.ndarray | torch.Tensor`, *optional*): Robotic states to be predicted by the model. If provided, padding, mean and std normalization will be applied. Returns: [`BatchFeature`]: A [`BatchFeature`] with the following fields: - **input_ids** -- List of token ids to be fed to a model. Returned when `text` is not `None`. If `suffix` is provided, the `input_ids` will also contain the suffix input ids. - **attention_mask** -- List of indices specifying which tokens should be attended to by the model (when `return_attention_mask=True` or if *"attention_mask"* is in `self.model_input_names` and if `text` is not `None`). - **pixel_values** -- Pixel values to be fed to a model. Returned when `images` is not `None`. - **pixel_attention_mask** -- Pixel values padding mask to be fed to a model. Returned when `images` is not `None`. - **state** -- Robot state compatible with model if `state` is not None - **actions** -- Label-actions compatible with training if `actions` is not None """ output_kwargs = self._merge_kwargs( PI0ProcessorKwargs, tokenizer_init_kwargs=self.tokenizer.init_kwargs, **kwargs ) if text is None: logger.warning_once("You are using PI0 without a text prefix. The processor will use an empty prompt.") text = "" if isinstance(text, str): text = [text] batched_images = make_nested_list_of_images(images) if len(batched_images) != len(text): raise ValueError( f"Received {len(batched_images)} image samples for {len(text)} prompts. " "Each prompt should be associated with one sample (with one or more camera images)." ) return_tensors = output_kwargs["text_kwargs"].pop("return_tensors", None) output_kwargs["images_kwargs"].pop("return_tensors", None) prompt_strings = [] for sample, image_list in zip(text, batched_images): sample = ( f"{self.image_token * self.image_seq_length * len(image_list)}{self.tokenizer.bos_token}{sample}\n" ) prompt_strings.append(sample) text_inputs = self.tokenizer(prompt_strings, **output_kwargs["text_kwargs"]) # Here is the diff from PaliGemma. Ideally we'd create a new ImageProcessor if it were a VLM max_num_cameras = max(len(sample_images) for sample_images in batched_images) pixel_attention_mask = torch.zeros((len(batched_images), max_num_cameras), dtype=torch.bool) padded_pixel_values = torch.zeros(len(batched_images), max_num_cameras, 3, self.height, self.width) for batch, sample_images in enumerate(batched_images): processed = self.image_processor(sample_images, return_tensors="pt", **output_kwargs["images_kwargs"]) num_cameras = len(sample_images) pixel_attention_mask[batch, :num_cameras] = True padded_pixel_values[batch, :num_cameras] = processed["pixel_values"] return_data = { **text_inputs, "pixel_values": padded_pixel_values, "pixel_attention_mask": pixel_attention_mask, } if actions is not None: actions = (torch.tensor(actions) - self.actions_mean) / (self.actions_std + 1e-08) if actions.shape[-1] < self.max_state_dim: actions = F.pad(actions, (0, self.max_state_dim - actions.shape[-1])) return_data["actions"] = actions.view(-1, self.chunk_size, self.max_state_dim) if state is not None: state = (torch.tensor(state) - self.state_mean) / (self.state_std + 1e-08) if state.shape[-1] < self.max_state_dim: state = F.pad(state, (0, self.max_state_dim - state.shape[-1])) return_data["state"] = state.view(-1, self.max_state_dim) return BatchFeature(data=return_data, tensor_type=return_tensors) def _get_num_multimodal_tokens(self, image_sizes=None, **kwargs): """ Computes the number of placeholder tokens needed for multimodal inputs with the given sizes. Args: image_sizes (list[list[str]], *optional*): The input sizes formatted as (height, width) per each image. Returns: `MultiModalData`: A `MultiModalData` object holding number of tokens per each of the provided input modalities, along with other useful data. """ vision_data = {} if image_sizes is not None: num_image_tokens = [self.image_seq_length] * len(image_sizes) num_image_patches = [1] * len(image_sizes) vision_data.update({"num_image_tokens": num_image_tokens, "num_image_patches": num_image_patches}) return MultiModalData(**vision_data) @property def model_input_names(self): return super().model_input_names + ["pixel_attention_mask"] __all__ = ["PI0Processor"]