mirror of
https://github.com/huggingface/lerobot.git
synced 2026-05-16 17:20:05 +00:00
78b866116f
* Refactor observation preprocessing to use a modular pipeline system
- Introduced `RobotPipeline` and `ObservationProcessor` for handling observation transformations.
- Updated `preprocess_observation` to maintain backward compatibility while leveraging the new pipeline.
- Added tests for the new processing components and ensured they match the original functionality.
- Removed hardcoded logic in favor of a more flexible, composable architecture.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Refactor observation processing and improve modularity
- Updated `ObservationProcessor` to enhance the modular design for processing observations.
- Cleaned up imports and improved code readability by removing unnecessary lines and comments.
- Ensured backward compatibility while integrating new processing components.
- Added tests to validate the functionality of the updated processing architecture.
* Remove redundant tests for None observation and serialization methods in `test_observation_processor.py` to streamline the test suite and improve maintainability.
* Refactor processing architecture to use RobotProcessor
- Replaced instances of RobotPipeline with RobotProcessor across the codebase for improved modularity and clarity.
- Introduced ProcessorStepRegistry for better management of processing steps.
- Updated relevant documentation and tests to reflect the new processing structure.
- Enhanced the save/load functionality to support the new processor design.
- Added a model card template for RobotProcessor to facilitate sharing and documentation.
* Add RobotProcessor tutorial to documentation
- Introduced a new tutorial on using RobotProcessor for preprocessing robot data.
- Added a section in the table of contents for easy navigation to the new tutorial.
- The tutorial covers key concepts, real-world scenarios, and practical examples for effective use of the RobotProcessor pipeline.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Add normalization processor and related components
- Introduced `NormalizationProcessor` to handle both observation normalization and action unnormalization.
- Added `ObservationNormalizer` and `ActionUnnormalizer` classes for specific normalization tasks.
- Updated `__init__.py` to include the new `NormalizationProcessor` in the module exports.
- Enhanced `ObservationProcessor` with registration in the `ProcessorStepRegistry` for better modularity.
- Created `RenameProcessor` for renaming keys in observations, improving flexibility in data processing.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Enhance processing architecture with new components
- Added `RenameProcessor` to facilitate key renaming in observations, improving data handling flexibility.
- Updated `__init__.py` to include `RenameProcessor` in module exports.
- Refactored `NormalizationProcessor` and `ObservationNormalizer` to use `rsplit` for better key handling.
- Introduced comprehensive tests for `NormalizationProcessor` and `RenameProcessor` to ensure functionality and robustness.
* chore (docs): add docstring for processor
* fix (test): test factory
* fix(test): policies
* Update tests/processor/test_observation_processor.py
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Adil Zouitine <adilzouitinegm@gmail.com>
* chore(test): add suggestion made by copilot regarding numpy test
* fix(test): import issue
* Refactor normalization components and update tests
- Renamed `ObservationNormalizer` to `NormalizerProcessor` and `ActionUnnormalizer` to `UnnormalizerProcessor` for clarity.
- Consolidated normalization logic for both observations and actions into `NormalizerProcessor` and `UnnormalizerProcessor`.
- Updated tests to reflect the new class names and ensure proper functionality of normalization and unnormalization processes.
- Enhanced handling of missing statistics in normalization processes.
* chore (docstrin):Improve docstring for NormalizerProcessor
* feat (device processor): Implement device processor
* chore (batch handling): Enhance processing components with batch conversion utilities
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* fix(test): linting issue
* chore (output format): improves output format
* chore (type): add typing for multiprocess envs
* feat (overrides): Implement support for loading processors with parameter overrides
- Added the ability to provide non-serializable objects when loading processors from saved configurations using the `overrides` parameter.
- Enhanced error handling for invalid override keys and instantiation errors.
- Updated documentation and examples to illustrate the usage of overrides for both registered and unregistered steps.
- Added comprehensive tests to validate the new functionality and ensure backward compatibility.
* chore(normalization): addressing comments from copilot
* chore(learner): nit comment from copilot
* feat(pipeline): Enhance step_through method to support both tuple and dict inputs
* refactor(pipeline): Simplify observation and padding data handling in batch transitions
* Apply suggestions from code review
Co-authored-by: Simon Alibert <75076266+aliberts@users.noreply.github.com>
Signed-off-by: Adil Zouitine <adilzouitinegm@gmail.com>
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* refactor(pipeline): Introduce ComplementaryDataProcessor for handling complementary data in transitions
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* refactor(pipeline): Transition from tuple to dictionary format for EnvTransition
- Updated the EnvTransition structure to use a dictionary format instead of a tuple, enhancing readability and maintainability.
- Replaced instances of TransitionIndex with TransitionKey for accessing transition components.
- Adjusted related processing functions and tests to accommodate the new dictionary format, ensuring consistent handling of transitions across the codebase.
* refactor(observation_processor): Improve observation processing by using constants and simplifying pixel handling
- Introduced constants for observation keys to enhance readability.
- Streamlined the handling of the "pixels" key by copying observations first and processing images more clearly.
- Updated the environment state and agent position assignments to use the new constants, improving maintainability.
* feat(pipeline): Add hook unregistration functionality and enhance documentation
- Implemented methods to unregister before, after, and reset hooks in the RobotProcessor class, allowing for more flexible hook management.
- Enhanced documentation to clarify hook execution semantics and the implications of modifying transitions within hooks.
- Added comprehensive tests to verify the correct behavior of hook registration and unregistration, including error handling for non-existent hooks.
* refactor(pipeline): Clarify hook behavior and improve documentation
- Updated the RobotProcessor class to ensure hooks are strictly for observation and do not modify transitions, enhancing clarity and maintainability.
- Refactored hook registration methods to reflect the new behavior, ensuring they accept only functions that do not return modified transitions.
- Enhanced documentation to clearly outline the purpose of hooks and their execution semantics.
- Added tests to verify that hooks are not executed during the step_through method while ensuring they function correctly during the __call__ method.
* feat(pipeline): Add __repr__ method to RobotProcessor for improved readability
- Implemented a __repr__ method in the RobotProcessor class to provide a clear string representation of the processor, including step names and optional parameters like name and seed.
- Added comprehensive tests to validate the __repr__ output for various scenarios, including empty processors, single and multiple steps, custom names, and seed values.
- Ensured that the representation handles long lists of steps with truncation for better readability.
* chore(pipeline): Move _CFG_NAME along other class member
* refactor(pipeline): Utilize get_safe_torch_device for device assignment
- Replaced direct torch.device instantiation with get_safe_torch_device to ensure safe device handling.
- This change enhances code readability and maintains consistency in device management across the RobotProcessor class.
* refactor(pipeline): Enhance state filename generation and profiling method
- Updated state filename generation to use the registry name when available, improving clarity in saved files.
- Modified the profile_steps method to include a warmup_runs parameter, allowing for more controlled performance profiling.
- Ensured consistent conditions during profiling by deep copying transitions for each run, enhancing accuracy in timing results.
* chore(doc): address pip install commant lerobot that not exist yet
* feat(pipeline): Enhance configuration filename handling and state file naming
- Introduced support for custom configuration filenames in the `save_pretrained` method, allowing users to specify a filename instead of the default.
- Improved state file naming to include step indices, preventing conflicts when multiple processors of the same type are saved.
- Added automatic detection for configuration files when loading from a directory, with error handling for multiple files.
- Updated tests to validate new features, including custom filenames and automatic config detection.
* refactor(pipeline): Improve state file naming conventions for clarity and uniqueness
- Enhanced state file naming to include the processor's sanitized name, ensuring uniqueness when multiple processors are saved in the same directory.
- Updated tests to reflect changes in state file naming, verifying that filenames now include the processor name and step indices to prevent conflicts.
- Added a new test to validate state file naming when using multiple processors, ensuring distinct filenames for each processor's state files.
* docs(pipeline): Add clarification for repo name sanitization process
* Feat/pipeline add feature contract (#1637)
* Add feature contract to pipelinestep and pipeline
* Add tests
* Add processor tests
* PR feedback
* encorperate pr feedback
* type in doc
* oops
* docs(pipeline): Clarify transition handling and hook behavior
- Updated documentation to specify that hooks always receive transitions in EnvTransition format, ensuring consistent behavior across input formats.
- Refactored the step_through method to yield only EnvTransition objects, regardless of the input format, and updated related tests to reflect this change.
- Enhanced test assertions to verify the structure of results and the correctness of processing steps.
* refactor(pipeline): Remove to() method for device management
- Eliminated the to() method from RobotProcessor, which was responsible for moving tensor states to specified devices.
- Removed associated unit tests that validated the functionality of the to() method across various scenarios.
- Streamlined the pipeline code by focusing on other device management strategies.
* refactor(pipeline): Remove model card generation and streamline processor methods
- Eliminated the _generate_model_card method from RobotProcessor, which was responsible for generating README.md files from a template.
- Updated save_pretrained method to remove model card generation, focusing on serialization of processor definitions and parameters.
- Added default implementations for get_config, state_dict, load_state_dict, reset, and feature_contract methods in various processor classes to enhance consistency and usability.
* refactor(observation): Streamline observation preprocessing and remove unused processor methods
- Updated the `preprocess_observation` function to enhance image handling and ensure proper tensor formatting.
- Removed the `RobotProcessor` and associated transition handling from the `rollout` function, simplifying the observation processing flow.
- Integrated direct calls to `preprocess_observation` for improved clarity and efficiency in the evaluation script.
* refactor(pipeline): Rename parameters for clarity and enhance save/load functionality
- Updated parameter names in the save_pretrained and from_pretrained methods for improved readability, changing destination_path to save_directory and source to pretrained_model_name_or_path.
- Enhanced the save_pretrained method to ensure directory creation and file handling is consistent with the new parameter names.
- Streamlined the loading process in from_pretrained to utilize loaded_config for better clarity and maintainability.
* refactor(pipeline): minor improvements (#1684)
* chore(pipeline): remove unused features + device torch + envtransition keys
* refactor(pipeline): ImageProcessor & StateProcessor are both implemented directly in VanillaObservationPRocessor
* refactor(pipeline): RenameProcessor now inherits from ObservationProcessor + remove unused code
* test(pipeline): fix broken test after refactors
* docs(pipeline): update docstrings VanillaObservationProcessor
* chore(pipeline): move None check to base pipeline classes
* feat(processors): Introduce processors for various policy types
- Added `make_processor` function to create processor instances for different policy types, including `tdmpc`, `diffusion`, `act`, `vqbet`, `pi0`, `pi0fast`, `sac`, and `reward_classifier`.
- Implemented corresponding processor files for each policy type, encapsulating normalization and unnormalization steps.
- Updated existing policies to remove direct normalization dependencies, enhancing modularity and clarity.
- Enhanced test coverage to validate the integration of new processors with existing policy configurations.
* refactor(learner): Remove normalization from cached image features retrieval
- Simplified the retrieval of observation features by removing the normalization step from the `get_cached_image_features` method calls.
- This change enhances clarity and aligns with the recent updates to policy processors.
* refactor(policies): Remove unnormalization step from action predictions
- Eliminated the unnormalization of actions in both `TDMPCPolicy` and `VQBeTPolicy` classes to streamline action prediction.
- This change improves code clarity and aligns with recent updates to policy processors.
* feat(train): Integrate preprocessor into training pipeline
* refactor(train): Update preprocessor initialization to include dataset statistics
* refactor(policies): Enhance processor creation and add NaN detection hook
* feat(record): Integrate RobotProcessor into recording loop and update policy handling
- Added support for RobotProcessor in the record_loop function to enhance data processing capabilities.
- Updated the logic to reset both policy and processor when provided, ensuring proper state management.
- Modified action prediction to utilize the processor, improving the overall functionality of the recording process.
- Adjusted the save_checkpoint function to include preprocessor state saving, enhancing checkpointing capabilities.
* feat(migration): Add script for migrating policy models with normalization layers
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* feat(migrate): Enhance migration script to create preprocessor and postprocessor for policy models
- Updated the migration script to generate both a preprocessor and a postprocessor, improving the handling of normalization for training and inference.
- Added functionality to convert features to PolicyFeature objects, ensuring compatibility with the new processor architecture.
- Refined the extraction and removal of normalization statistics and layers, streamlining the migration process.
- Improved error handling for missing mandatory configuration fields during model instantiation.
* feat(migrate): Add model card generation and saving to migration script
- Implemented functionality to generate and save a model card for the migrated model, including metadata such as dataset repository ID, license, and tags.
- Enhanced the script to push the model card to the hub if requested, improving model documentation and accessibility.
- Refactored the saving process to ensure the model card is saved locally and uploaded correctly when pushing to the hub.
* feat(processor): Introduce ToBatchProcessor for handling observation batching
- Added ToBatchProcessor to ensure observations have proper batch dimensions for model processing.
- Implemented functionality to add batch dimensions to state and image observations as needed.
- Created comprehensive unit tests to validate the processor's behavior with various tensor dimensions and types.
- Ensured compatibility with existing transition keys and maintained the integrity of non-observation data.
* feat(processors): Add ToBatchProcessor to multiple policy processors
- Integrated ToBatchProcessor into various policy processors to handle observation batching.
- Updated make functions for act, diffusion, pi0, pi0fast, sac, smolvla, tdmpc, and vqbet processors to include the new batching functionality.
- Ensured consistency across all processor implementations for improved data handling.
* refactor(factory): Remove unused imports and NaN detection hook from processor creation
* feat(batch_processor): Enhance ToBatchProcessor to handle action batching
- Updated ToBatchProcessor to add batch dimensions to actions in addition to observations.
- Implemented separate methods for processing observations and actions, improving code readability.
- Added comprehensive unit tests to validate action batching functionality across various tensor dimensions and types.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* feat(factory): Enhance make_processor to support preprocessor and postprocessor configuration
- Introduced ProcessorConfigKwargs TypedDict for better type safety in processor configuration.
- Updated make_processor to accept preprocessor and postprocessor configuration filenames, improving flexibility in processor instantiation.
- Refactored the loading of pretrained processors to utilize the new configuration options.
* refactor(factory): Clean up imports in factory.py
- Removed unused import of IdentityProcessor to streamline the code.
* feat(migrate): Extend load_model_from_hub to include train configuration
- Updated load_model_from_hub to return the train configuration alongside the model state_dict and config.
- Modified main function to handle the additional train configuration when loading models from both the hub and local paths.
- Adjusted dataset_repo_id extraction to utilize the train configuration for improved accuracy.
* refactor(record): Rename processor parameters and update processing logic
- Renamed `processor` to `preprocessor` and added `postprocessor` parameter for clarity.
- Updated the `record_loop` and `predict_action` functions to utilize the new preprocessor and postprocessor, enhancing the processing flow.
- Ensured compatibility with existing functionality while improving code readability.
* feat(batch_processor): Add task field processing to ToBatchProcessor
- Enhanced ToBatchProcessor to wrap string tasks in a list, adding batch dimensions for compatibility with model inference.
- Implemented a new method for processing complementary data, ensuring that task values are correctly handled as either strings or lists of strings.
- Added comprehensive unit tests to validate task processing, including edge cases and in-place mutation of complementary data.
* feat(normalization): Implement IDENTITY mode for normalization and unnormalization
- Enhanced NormalizerProcessor and UnnormalizerProcessor to support IDENTITY mode, allowing features to bypass normalization when specified.
- Updated processing logic to check normalization modes and handle missing statistics gracefully.
- Added comprehensive unit tests to validate IDENTITY mode functionality for both observations and actions, ensuring correct behavior across various scenarios.
- Improved error handling for unsupported normalization modes.
* fix(rebase): remove residual normalization layer:
* refactor(diffusion): remove normalization layer from input processing
* refactor(normalization): Remove unused state dict transformation methods and streamline imports
- Eliminated the _transform_state_dict_keys and _load_as_safetensor methods from PI0Policy, simplifying the model loading process.
- Cleaned up imports in modeling_pi0.py by removing log_model_loading_keys and init_logging.
- Updated TDMPCPolicy and VQBeTPolicy to handle action removal from batches during offline evaluation.
- Introduced hotswap_stats function in normalize_processor.py to update normalization statistics dynamically, with corresponding tests to ensure functionality.
* refactor(normalization): Clean up imports in normalize_processor.py
* feat(batch_processor): Add feature_contract method to ToBatchProcessor
- Introduced feature_contract method that returns features without modification, maintaining the no-op behavior of the processor.
- This addition enhances the flexibility of the ToBatchProcessor for future feature processing needs.
* fix(dependencies): Update transformers dependency constraint to allow only versions up to 4.52.0
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* feature(pipeline): port tokenizer pipeline for VLA (#1645)
* feat(tokenizer): Introduce TokenizerProcessor for text tokenization
- Added TokenizerProcessor class to handle tokenization of task strings using Hugging Face's AutoTokenizer.
- Supports both string and list inputs, with customizable parameters for task key, output key, and tokenization settings.
- Implemented comprehensive unit tests to validate functionality, including handling of various input scenarios and integration with RobotProcessor.
- Updated types.py to include LANGUAGE feature type and modified __init__.py to register the new processor.
* feat(language): Enhance language processing in TokenizerProcessor
- Added OBS_LANGUAGE constant to define the observation language key.
- Updated TokenizerProcessor to store tokenized task data in the observation dictionary, ensuring compatibility with the new language feature.
- Introduced Pi0NewLineProcessor to append newlines to tasks for proper tokenization.
- Modified tests to validate the integration of language tokens and attention masks in the observation structure.
* feat(tokenizer): Add padding configuration to TokenizerProcessor
- Introduced `padding_side` parameter to the TokenizerProcessor for customizable padding direction.
- Updated the `make_pi0_processor` function to include the new padding configuration.
- Enhanced unit tests to validate the functionality of the `padding_side` parameter in various scenarios.
* feat(processor): Add state management methods to Pi0NewLineProcessor
* feat(normalization): Track normalization and unnormalization info in complementary data
- Updated NormalizerProcessor and UnnormalizerProcessor to accept additional parameters for tracking normalization modes.
- Enhanced the __call__ methods to store normalization and unnormalization information in the complementary data of transitions.
- Added unit tests to verify the correct tracking of normalization info, including scenarios with missing stats and selective normalization keys.
* feat(factory): Add preprocessor and postprocessor overrides to ProcessorConfigKwargs
- Updated ProcessorConfigKwargs to include optional overrides for preprocessor and postprocessor configurations.
- Enhanced the make_processor function to utilize the new overrides, allowing for more flexible processor initialization.
* feat(processors): Integrate RenameProcessor into various processor configurations
- Added RenameProcessor to the input steps of multiple processor functions, including make_act_processor, make_diffusion_processor, make_pi0_processor, make_sac_processor, make_tdmpc_processor, make_vqbet_processor, and make_smolvla_processor.
- Consolidated normalization features from input and output into a single NormalizerProcessor for improved efficiency.
- Updated the input steps to ensure compatibility with the new RenameProcessor integration.
* feat(smolvla): Refactor language processing and introduce new line processor (#1658)
- Removed the prepare_language method and directly accessed language tokens and masks from the batch using the OBS_LANGUAGE constant.
- Added SmolVLANewLineProcessor to ensure tasks end with a newline, enhancing tokenization compatibility.
- Updated the make_smolvla_processor function to include the new line processor and tokenizer processor for improved input handling.
* feture(policies): add device processor (#1659)
* feat(processors): Integrate DeviceProcessor into multiple processor configurations
- Added DeviceProcessor to the input and output steps of various processor functions, including make_act_processor, make_diffusion_processor, make_pi0_processor, make_pi0fast_processor, make_sac_processor, make_tdmpc_processor, make_vqbet_processor, and make_smolvla_processor.
- Enhanced the DeviceProcessor class with state management methods and ensured compatibility with existing processor pipelines.
- Introduced unit tests for DeviceProcessor to validate functionality across different scenarios, including CPU and CUDA operations.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* refactor(pipeline): Remove to() method for device management
- Eliminated the to() method from RobotProcessor, which was responsible for moving tensor states to specified devices.
- Removed associated unit tests that validated the functionality of the to() method across various scenarios.
- Streamlined the pipeline code by focusing on other device management strategies.
* feat(processor): Enhance DeviceProcessor with float dtype conversion
- Added support for optional float dtype conversion in DeviceProcessor, allowing tensors to be converted to specified floating-point types while preserving non-float types.
- Implemented validation for float dtype input and updated the processor's configuration methods to include float dtype.
- Refactored tensor processing logic to streamline device movement and dtype conversion.
- Introduced comprehensive unit tests to validate the new float dtype functionality across various scenarios.
* feat(policies): Add new line processors and update module exports
* feat(processor): Enhance batch and device processors to handle index and task_index fields
- Added logic to ToBatchProcessor for unsqueezing 0D tensors for index and task_index fields, ensuring they are processed as 1D tensors.
- Updated DeviceProcessor to process index and task_index fields in complementary data, preserving their tensor types and ensuring non-tensor fields remain unchanged.
- Enhanced unit tests to validate the correct handling of index and task_index fields across various scenarios, including device compatibility and dtype preservation.
* refactor(processors): Standardize processor naming conventions
- Updated processor names across various files to use a consistent "robot_preprocessor" and "robot_postprocessor" format.
- Modified the make_processor functions in factory, act, diffusion, pi0, pi0fast, sac, smolvla, tdmpc, and vqbet to reflect the new naming scheme.
- Enhanced the pipeline configuration to align with the updated processor names, improving clarity and maintainability.
* refactor(factory): Update processor configuration and type hints
- Changed return type of get_policy_class to type[PreTrainedPolicy] for improved type safety.
- Enhanced make_processor function to utilize dataset_stats in processor creation for better flexibility.
- Updated ProcessorConfigKwargs to include dataset_stats, allowing for more comprehensive processor configurations.
- Streamlined processor initialization by removing unnecessary kwargs and ensuring clarity in processor type handling.
* refactor(factory, pi0fast): Update processor function names and parameters
- Renamed make_pi0_processor to make_pi0fast_processor for clarity and consistency.
- Updated parameter names in the factory's make_processor function to use pretrained_model_name_or_path instead of source, enhancing readability and alignment with naming conventions.
* fix(train.py) push postprocessor with preprocessor
- Add preprocesser policy overrides for device and rename_map
- Add rename_map to DatasetRecordConfig (record.py)
* refactor(device_processor): Update device handling and improve type hints
- Changed device attribute type from torch.device to str for better clarity.
- Introduced a private _device attribute to store the actual torch.device instance.
- Updated tests to conditionally check for CUDA availability, ensuring compatibility across different environments.
- Refactored device-related assertions in tests to use a consistent approach for device type verification.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* test(tokenizer_processor): Add require_package decorator for transformers
- Introduced @require_package("transformers") decorator in multiple test functions to ensure the transformers package is available before running tests.
- This change enhances test reliability by preventing failures due to missing dependencies.
* refactor(migrate_policy_normalization): Enhance preprocessor and postprocessor structure
- Introduced RenameProcessor in the preprocessor to handle renaming features.
- Combined input and output features in a single NormalizerProcessor for improved efficiency.
- Updated RobotProcessor initialization to clarify step naming for preprocessor and postprocessor.
- Added DeviceProcessor to both preprocessor and postprocessor for better device management.
* Integrate pipeline and add phone teleop (#1681)
* Add normalization processor and related components
- Introduced `NormalizationProcessor` to handle both observation normalization and action unnormalization.
- Added `ObservationNormalizer` and `ActionUnnormalizer` classes for specific normalization tasks.
- Updated `__init__.py` to include the new `NormalizationProcessor` in the module exports.
- Enhanced `ObservationProcessor` with registration in the `ProcessorStepRegistry` for better modularity.
- Created `RenameProcessor` for renaming keys in observations, improving flexibility in data processing.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Enhance processing architecture with new components
- Added `RenameProcessor` to facilitate key renaming in observations, improving data handling flexibility.
- Updated `__init__.py` to include `RenameProcessor` in module exports.
- Refactored `NormalizationProcessor` and `ObservationNormalizer` to use `rsplit` for better key handling.
- Introduced comprehensive tests for `NormalizationProcessor` and `RenameProcessor` to ensure functionality and robustness.
* chore (docs): add docstring for processor
* fix (test): test factory
* fix(test): policies
* Update tests/processor/test_observation_processor.py
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Adil Zouitine <adilzouitinegm@gmail.com>
* chore(test): add suggestion made by copilot regarding numpy test
* fix(test): import issue
* Refactor normalization components and update tests
- Renamed `ObservationNormalizer` to `NormalizerProcessor` and `ActionUnnormalizer` to `UnnormalizerProcessor` for clarity.
- Consolidated normalization logic for both observations and actions into `NormalizerProcessor` and `UnnormalizerProcessor`.
- Updated tests to reflect the new class names and ensure proper functionality of normalization and unnormalization processes.
- Enhanced handling of missing statistics in normalization processes.
* chore (docstrin):Improve docstring for NormalizerProcessor
* feat (device processor): Implement device processor
* chore (batch handling): Enhance processing components with batch conversion utilities
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* fix(test): linting issue
* chore (output format): improves output format
* chore (type): add typing for multiprocess envs
* feat (overrides): Implement support for loading processors with parameter overrides
- Added the ability to provide non-serializable objects when loading processors from saved configurations using the `overrides` parameter.
- Enhanced error handling for invalid override keys and instantiation errors.
- Updated documentation and examples to illustrate the usage of overrides for both registered and unregistered steps.
- Added comprehensive tests to validate the new functionality and ensure backward compatibility.
* chore(normalization): addressing comments from copilot
* chore(learner): nit comment from copilot
* feat(pipeline): Enhance step_through method to support both tuple and dict inputs
* refactor(pipeline): Simplify observation and padding data handling in batch transitions
* Apply suggestions from code review
Co-authored-by: Simon Alibert <75076266+aliberts@users.noreply.github.com>
Signed-off-by: Adil Zouitine <adilzouitinegm@gmail.com>
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* refactor(pipeline): Introduce ComplementaryDataProcessor for handling complementary data in transitions
* fix(ci): temporary fix on dataset deps version
* feat(processors): Introduce processors for various policy types
- Added `make_processor` function to create processor instances for different policy types, including `tdmpc`, `diffusion`, `act`, `vqbet`, `pi0`, `pi0fast`, `sac`, and `reward_classifier`.
- Implemented corresponding processor files for each policy type, encapsulating normalization and unnormalization steps.
- Updated existing policies to remove direct normalization dependencies, enhancing modularity and clarity.
- Enhanced test coverage to validate the integration of new processors with existing policy configurations.
* refactor(learner): Remove normalization from cached image features retrieval
- Simplified the retrieval of observation features by removing the normalization step from the `get_cached_image_features` method calls.
- This change enhances clarity and aligns with the recent updates to policy processors.
* refactor(policies): Remove unnormalization step from action predictions
- Eliminated the unnormalization of actions in both `TDMPCPolicy` and `VQBeTPolicy` classes to streamline action prediction.
- This change improves code clarity and aligns with recent updates to policy processors.
* feat(train): Integrate preprocessor into training pipeline
* refactor(train): Update preprocessor initialization to include dataset statistics
* refactor(policies): Enhance processor creation and add NaN detection hook
* refactor(train): Update memory pinning logic for mps compatibility
* feat: initial commit phone teleop
* ugly delta control
* use quaternion
* Refactor observation preprocessing to use a modular pipeline system
- Introduced `RobotPipeline` and `ObservationProcessor` for handling observation transformations.
- Updated `preprocess_observation` to maintain backward compatibility while leveraging the new pipeline.
- Added tests for the new processing components and ensured they match the original functionality.
- Removed hardcoded logic in favor of a more flexible, composable architecture.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Refactor observation processing and improve modularity
- Updated `ObservationProcessor` to enhance the modular design for processing observations.
- Cleaned up imports and improved code readability by removing unnecessary lines and comments.
- Ensured backward compatibility while integrating new processing components.
- Added tests to validate the functionality of the updated processing architecture.
* Remove redundant tests for None observation and serialization methods in `test_observation_processor.py` to streamline the test suite and improve maintainability.
* Refactor processing architecture to use RobotProcessor
- Replaced instances of RobotPipeline with RobotProcessor across the codebase for improved modularity and clarity.
- Introduced ProcessorStepRegistry for better management of processing steps.
- Updated relevant documentation and tests to reflect the new processing structure.
- Enhanced the save/load functionality to support the new processor design.
- Added a model card template for RobotProcessor to facilitate sharing and documentation.
* Add RobotProcessor tutorial to documentation
- Introduced a new tutorial on using RobotProcessor for preprocessing robot data.
- Added a section in the table of contents for easy navigation to the new tutorial.
- The tutorial covers key concepts, real-world scenarios, and practical examples for effective use of the RobotProcessor pipeline.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Add normalization processor and related components
- Introduced `NormalizationProcessor` to handle both observation normalization and action unnormalization.
- Added `ObservationNormalizer` and `ActionUnnormalizer` classes for specific normalization tasks.
- Updated `__init__.py` to include the new `NormalizationProcessor` in the module exports.
- Enhanced `ObservationProcessor` with registration in the `ProcessorStepRegistry` for better modularity.
- Created `RenameProcessor` for renaming keys in observations, improving flexibility in data processing.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Enhance processing architecture with new components
- Added `RenameProcessor` to facilitate key renaming in observations, improving data handling flexibility.
- Updated `__init__.py` to include `RenameProcessor` in module exports.
- Refactored `NormalizationProcessor` and `ObservationNormalizer` to use `rsplit` for better key handling.
- Introduced comprehensive tests for `NormalizationProcessor` and `RenameProcessor` to ensure functionality and robustness.
* chore (docs): add docstring for processor
* fix (test): test factory
* fix(test): policies
* Update tests/processor/test_observation_processor.py
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Adil Zouitine <adilzouitinegm@gmail.com>
* chore(test): add suggestion made by copilot regarding numpy test
* fix(test): import issue
* Refactor normalization components and update tests
- Renamed `ObservationNormalizer` to `NormalizerProcessor` and `ActionUnnormalizer` to `UnnormalizerProcessor` for clarity.
- Consolidated normalization logic for both observations and actions into `NormalizerProcessor` and `UnnormalizerProcessor`.
- Updated tests to reflect the new class names and ensure proper functionality of normalization and unnormalization processes.
- Enhanced handling of missing statistics in normalization processes.
* chore (docstrin):Improve docstring for NormalizerProcessor
* feat (device processor): Implement device processor
* chore (batch handling): Enhance processing components with batch conversion utilities
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* fix(test): linting issue
* chore (output format): improves output format
* chore (type): add typing for multiprocess envs
* feat (overrides): Implement support for loading processors with parameter overrides
- Added the ability to provide non-serializable objects when loading processors from saved configurations using the `overrides` parameter.
- Enhanced error handling for invalid override keys and instantiation errors.
- Updated documentation and examples to illustrate the usage of overrides for both registered and unregistered steps.
- Added comprehensive tests to validate the new functionality and ensure backward compatibility.
* chore(normalization): addressing comments from copilot
* chore(learner): nit comment from copilot
* feat(pipeline): Enhance step_through method to support both tuple and dict inputs
* refactor(pipeline): Simplify observation and padding data handling in batch transitions
* Apply suggestions from code review
Co-authored-by: Simon Alibert <75076266+aliberts@users.noreply.github.com>
Signed-off-by: Adil Zouitine <adilzouitinegm@gmail.com>
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* refactor(pipeline): Introduce ComplementaryDataProcessor for handling complementary data in transitions
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* refactor(pipeline): Transition from tuple to dictionary format for EnvTransition
- Updated the EnvTransition structure to use a dictionary format instead of a tuple, enhancing readability and maintainability.
- Replaced instances of TransitionIndex with TransitionKey for accessing transition components.
- Adjusted related processing functions and tests to accommodate the new dictionary format, ensuring consistent handling of transitions across the codebase.
* refactor(observation_processor): Improve observation processing by using constants and simplifying pixel handling
- Introduced constants for observation keys to enhance readability.
- Streamlined the handling of the "pixels" key by copying observations first and processing images more clearly.
- Updated the environment state and agent position assignments to use the new constants, improving maintainability.
* feat(pipeline): Add hook unregistration functionality and enhance documentation
- Implemented methods to unregister before, after, and reset hooks in the RobotProcessor class, allowing for more flexible hook management.
- Enhanced documentation to clarify hook execution semantics and the implications of modifying transitions within hooks.
- Added comprehensive tests to verify the correct behavior of hook registration and unregistration, including error handling for non-existent hooks.
* refactor(pipeline): Clarify hook behavior and improve documentation
- Updated the RobotProcessor class to ensure hooks are strictly for observation and do not modify transitions, enhancing clarity and maintainability.
- Refactored hook registration methods to reflect the new behavior, ensuring they accept only functions that do not return modified transitions.
- Enhanced documentation to clearly outline the purpose of hooks and their execution semantics.
- Added tests to verify that hooks are not executed during the step_through method while ensuring they function correctly during the __call__ method.
* feat(pipeline): Add __repr__ method to RobotProcessor for improved readability
- Implemented a __repr__ method in the RobotProcessor class to provide a clear string representation of the processor, including step names and optional parameters like name and seed.
- Added comprehensive tests to validate the __repr__ output for various scenarios, including empty processors, single and multiple steps, custom names, and seed values.
- Ensured that the representation handles long lists of steps with truncation for better readability.
* chore(pipeline): Move _CFG_NAME along other class member
* refactor(pipeline): Utilize get_safe_torch_device for device assignment
- Replaced direct torch.device instantiation with get_safe_torch_device to ensure safe device handling.
- This change enhances code readability and maintains consistency in device management across the RobotProcessor class.
* refactor(pipeline): Enhance state filename generation and profiling method
- Updated state filename generation to use the registry name when available, improving clarity in saved files.
- Modified the profile_steps method to include a warmup_runs parameter, allowing for more controlled performance profiling.
- Ensured consistent conditions during profiling by deep copying transitions for each run, enhancing accuracy in timing results.
* chore(doc): address pip install commant lerobot that not exist yet
* feat(pipeline): Enhance configuration filename handling and state file naming
- Introduced support for custom configuration filenames in the `save_pretrained` method, allowing users to specify a filename instead of the default.
- Improved state file naming to include step indices, preventing conflicts when multiple processors of the same type are saved.
- Added automatic detection for configuration files when loading from a directory, with error handling for multiple files.
- Updated tests to validate new features, including custom filenames and automatic config detection.
* refactor(pipeline): Improve state file naming conventions for clarity and uniqueness
- Enhanced state file naming to include the processor's sanitized name, ensuring uniqueness when multiple processors are saved in the same directory.
- Updated tests to reflect changes in state file naming, verifying that filenames now include the processor name and step indices to prevent conflicts.
- Added a new test to validate state file naming when using multiple processors, ensuring distinct filenames for each processor's state files.
* docs(pipeline): Add clarification for repo name sanitization process
* feat(processors): Introduce processors for various policy types
- Added `make_processor` function to create processor instances for different policy types, including `tdmpc`, `diffusion`, `act`, `vqbet`, `pi0`, `pi0fast`, `sac`, and `reward_classifier`.
- Implemented corresponding processor files for each policy type, encapsulating normalization and unnormalization steps.
- Updated existing policies to remove direct normalization dependencies, enhancing modularity and clarity.
- Enhanced test coverage to validate the integration of new processors with existing policy configurations.
* refactor(learner): Remove normalization from cached image features retrieval
- Simplified the retrieval of observation features by removing the normalization step from the `get_cached_image_features` method calls.
- This change enhances clarity and aligns with the recent updates to policy processors.
* refactor(policies): Remove unnormalization step from action predictions
- Eliminated the unnormalization of actions in both `TDMPCPolicy` and `VQBeTPolicy` classes to streamline action prediction.
- This change improves code clarity and aligns with recent updates to policy processors.
* feat(train): Integrate preprocessor into training pipeline
* refactor(train): Update preprocessor initialization to include dataset statistics
* refactor(policies): Enhance processor creation and add NaN detection hook
* feat(record): Integrate RobotProcessor into recording loop and update policy handling
- Added support for RobotProcessor in the record_loop function to enhance data processing capabilities.
- Updated the logic to reset both policy and processor when provided, ensuring proper state management.
- Modified action prediction to utilize the processor, improving the overall functionality of the recording process.
- Adjusted the save_checkpoint function to include preprocessor state saving, enhancing checkpointing capabilities.
* feat(migration): Add script for migrating policy models with normalization layers
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* feat(migrate): Enhance migration script to create preprocessor and postprocessor for policy models
- Updated the migration script to generate both a preprocessor and a postprocessor, improving the handling of normalization for training and inference.
- Added functionality to convert features to PolicyFeature objects, ensuring compatibility with the new processor architecture.
- Refined the extraction and removal of normalization statistics and layers, streamlining the migration process.
- Improved error handling for missing mandatory configuration fields during model instantiation.
* feat(migrate): Add model card generation and saving to migration script
- Implemented functionality to generate and save a model card for the migrated model, including metadata such as dataset repository ID, license, and tags.
- Enhanced the script to push the model card to the hub if requested, improving model documentation and accessibility.
- Refactored the saving process to ensure the model card is saved locally and uploaded correctly when pushing to the hub.
* feat(processor): Introduce ToBatchProcessor for handling observation batching
- Added ToBatchProcessor to ensure observations have proper batch dimensions for model processing.
- Implemented functionality to add batch dimensions to state and image observations as needed.
- Created comprehensive unit tests to validate the processor's behavior with various tensor dimensions and types.
- Ensured compatibility with existing transition keys and maintained the integrity of non-observation data.
* feat(processors): Add ToBatchProcessor to multiple policy processors
- Integrated ToBatchProcessor into various policy processors to handle observation batching.
- Updated make functions for act, diffusion, pi0, pi0fast, sac, smolvla, tdmpc, and vqbet processors to include the new batching functionality.
- Ensured consistency across all processor implementations for improved data handling.
* refactor(factory): Remove unused imports and NaN detection hook from processor creation
* feat(batch_processor): Enhance ToBatchProcessor to handle action batching
- Updated ToBatchProcessor to add batch dimensions to actions in addition to observations.
- Implemented separate methods for processing observations and actions, improving code readability.
- Added comprehensive unit tests to validate action batching functionality across various tensor dimensions and types.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* feat(factory): Enhance make_processor to support preprocessor and postprocessor configuration
- Introduced ProcessorConfigKwargs TypedDict for better type safety in processor configuration.
- Updated make_processor to accept preprocessor and postprocessor configuration filenames, improving flexibility in processor instantiation.
- Refactored the loading of pretrained processors to utilize the new configuration options.
* refactor(factory): Clean up imports in factory.py
- Removed unused import of IdentityProcessor to streamline the code.
* feat(migrate): Extend load_model_from_hub to include train configuration
- Updated load_model_from_hub to return the train configuration alongside the model state_dict and config.
- Modified main function to handle the additional train configuration when loading models from both the hub and local paths.
- Adjusted dataset_repo_id extraction to utilize the train configuration for improved accuracy.
* refactor(record): Rename processor parameters and update processing logic
- Renamed `processor` to `preprocessor` and added `postprocessor` parameter for clarity.
- Updated the `record_loop` and `predict_action` functions to utilize the new preprocessor and postprocessor, enhancing the processing flow.
- Ensured compatibility with existing functionality while improving code readability.
* feat(batch_processor): Add task field processing to ToBatchProcessor
- Enhanced ToBatchProcessor to wrap string tasks in a list, adding batch dimensions for compatibility with model inference.
- Implemented a new method for processing complementary data, ensuring that task values are correctly handled as either strings or lists of strings.
- Added comprehensive unit tests to validate task processing, including edge cases and in-place mutation of complementary data.
* feat(normalization): Implement IDENTITY mode for normalization and unnormalization
- Enhanced NormalizerProcessor and UnnormalizerProcessor to support IDENTITY mode, allowing features to bypass normalization when specified.
- Updated processing logic to check normalization modes and handle missing statistics gracefully.
- Added comprehensive unit tests to validate IDENTITY mode functionality for both observations and actions, ensuring correct behavior across various scenarios.
- Improved error handling for unsupported normalization modes.
* fix(rebase): remove residual normalization layer:
* refactor(diffusion): remove normalization layer from input processing
* Add debug + calib
* cleanup
* Add pipeline
* fix int
* Add record example
* nit
* Add feature contract to pipelinestep and pipeline
* Add tests
* Add processor tests
* PR feedback
* encorperate pr feedback
* type in doc
* oops
* cleaned up steps and integrated pipeline with feature_contract
* refactor steps and robot to pipeline
* cleanup pipeline
* cleanup code further
* make it run
* feat(processors): Introduce processors for various policy types
- Added `make_processor` function to create processor instances for different policy types, including `tdmpc`, `diffusion`, `act`, `vqbet`, `pi0`, `pi0fast`, `sac`, and `reward_classifier`.
- Implemented corresponding processor files for each policy type, encapsulating normalization and unnormalization steps.
- Updated existing policies to remove direct normalization dependencies, enhancing modularity and clarity.
- Enhanced test coverage to validate the integration of new processors with existing policy configurations.
* refactor(learner): Remove normalization from cached image features retrieval
- Simplified the retrieval of observation features by removing the normalization step from the `get_cached_image_features` method calls.
- This change enhances clarity and aligns with the recent updates to policy processors.
* refactor(policies): Remove unnormalization step from action predictions
- Eliminated the unnormalization of actions in both `TDMPCPolicy` and `VQBeTPolicy` classes to streamline action prediction.
- This change improves code clarity and aligns with recent updates to policy processors.
* feat(train): Integrate preprocessor into training pipeline
* refactor(train): Update preprocessor initialization to include dataset statistics
* refactor(policies): Enhance processor creation and add NaN detection hook
* feat(record): Integrate RobotProcessor into recording loop and update policy handling
- Added support for RobotProcessor in the record_loop function to enhance data processing capabilities.
- Updated the logic to reset both policy and processor when provided, ensuring proper state management.
- Modified action prediction to utilize the processor, improving the overall functionality of the recording process.
- Adjusted the save_checkpoint function to include preprocessor state saving, enhancing checkpointing capabilities.
* feat(migration): Add script for migrating policy models with normalization layers
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* feat(migrate): Enhance migration script to create preprocessor and postprocessor for policy models
- Updated the migration script to generate both a preprocessor and a postprocessor, improving the handling of normalization for training and inference.
- Added functionality to convert features to PolicyFeature objects, ensuring compatibility with the new processor architecture.
- Refined the extraction and removal of normalization statistics and layers, streamlining the migration process.
- Improved error handling for missing mandatory configuration fields during model instantiation.
* feat(migrate): Add model card generation and saving to migration script
- Implemented functionality to generate and save a model card for the migrated model, including metadata such as dataset repository ID, license, and tags.
- Enhanced the script to push the model card to the hub if requested, improving model documentation and accessibility.
- Refactored the saving process to ensure the model card is saved locally and uploaded correctly when pushing to the hub.
* feat(processor): Introduce ToBatchProcessor for handling observation batching
- Added ToBatchProcessor to ensure observations have proper batch dimensions for model processing.
- Implemented functionality to add batch dimensions to state and image observations as needed.
- Created comprehensive unit tests to validate the processor's behavior with various tensor dimensions and types.
- Ensured compatibility with existing transition keys and maintained the integrity of non-observation data.
* feat(processors): Add ToBatchProcessor to multiple policy processors
- Integrated ToBatchProcessor into various policy processors to handle observation batching.
- Updated make functions for act, diffusion, pi0, pi0fast, sac, smolvla, tdmpc, and vqbet processors to include the new batching functionality.
- Ensured consistency across all processor implementations for improved data handling.
* refactor(factory): Remove unused imports and NaN detection hook from processor creation
* feat(batch_processor): Enhance ToBatchProcessor to handle action batching
- Updated ToBatchProcessor to add batch dimensions to actions in addition to observations.
- Implemented separate methods for processing observations and actions, improving code readability.
- Added comprehensive unit tests to validate action batching functionality across various tensor dimensions and types.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* feat(factory): Enhance make_processor to support preprocessor and postprocessor configuration
- Introduced ProcessorConfigKwargs TypedDict for better type safety in processor configuration.
- Updated make_processor to accept preprocessor and postprocessor configuration filenames, improving flexibility in processor instantiation.
- Refactored the loading of pretrained processors to utilize the new configuration options.
* refactor(factory): Clean up imports in factory.py
- Removed unused import of IdentityProcessor to streamline the code.
* feat(migrate): Extend load_model_from_hub to include train configuration
- Updated load_model_from_hub to return the train configuration alongside the model state_dict and config.
- Modified main function to handle the additional train configuration when loading models from both the hub and local paths.
- Adjusted dataset_repo_id extraction to utilize the train configuration for improved accuracy.
* refactor(record): Rename processor parameters and update processing logic
- Renamed `processor` to `preprocessor` and added `postprocessor` parameter for clarity.
- Updated the `record_loop` and `predict_action` functions to utilize the new preprocessor and postprocessor, enhancing the processing flow.
- Ensured compatibility with existing functionality while improving code readability.
* feat(batch_processor): Add task field processing to ToBatchProcessor
- Enhanced ToBatchProcessor to wrap string tasks in a list, adding batch dimensions for compatibility with model inference.
- Implemented a new method for processing complementary data, ensuring that task values are correctly handled as either strings or lists of strings.
- Added comprehensive unit tests to validate task processing, including edge cases and in-place mutation of complementary data.
* feat(normalization): Implement IDENTITY mode for normalization and unnormalization
- Enhanced NormalizerProcessor and UnnormalizerProcessor to support IDENTITY mode, allowing features to bypass normalization when specified.
- Updated processing logic to check normalization modes and handle missing statistics gracefully.
- Added comprehensive unit tests to validate IDENTITY mode functionality for both observations and actions, ensuring correct behavior across various scenarios.
- Improved error handling for unsupported normalization modes.
* fix(rebase): remove residual normalization layer:
* refactor(diffusion): remove normalization layer from input processing
* refactor(normalization): Remove unused state dict transformation methods and streamline imports
- Eliminated the _transform_state_dict_keys and _load_as_safetensor methods from PI0Policy, simplifying the model loading process.
- Cleaned up imports in modeling_pi0.py by removing log_model_loading_keys and init_logging.
- Updated TDMPCPolicy and VQBeTPolicy to handle action removal from batches during offline evaluation.
- Introduced hotswap_stats function in normalize_processor.py to update normalization statistics dynamically, with corresponding tests to ensure functionality.
* refactor(normalization): Clean up imports in normalize_processor.py
* feat(batch_processor): Add feature_contract method to ToBatchProcessor
- Introduced feature_contract method that returns features without modification, maintaining the no-op behavior of the processor.
- This addition enhances the flexibility of the ToBatchProcessor for future feature processing needs.
* fix(dependencies): Update transformers dependency constraint to allow only versions up to 4.52.0
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* feat(tokenizer): Introduce TokenizerProcessor for text tokenization
- Added TokenizerProcessor class to handle tokenization of task strings using Hugging Face's AutoTokenizer.
- Supports both string and list inputs, with customizable parameters for task key, output key, and tokenization settings.
- Implemented comprehensive unit tests to validate functionality, including handling of various input scenarios and integration with RobotProcessor.
- Updated types.py to include LANGUAGE feature type and modified __init__.py to register the new processor.
* feat(language): Enhance language processing in TokenizerProcessor
- Added OBS_LANGUAGE constant to define the observation language key.
- Updated TokenizerProcessor to store tokenized task data in the observation dictionary, ensuring compatibility with the new language feature.
- Introduced Pi0NewLineProcessor to append newlines to tasks for proper tokenization.
- Modified tests to validate the integration of language tokens and attention masks in the observation structure.
* feat(tokenizer): Add padding configuration to TokenizerProcessor
- Introduced `padding_side` parameter to the TokenizerProcessor for customizable padding direction.
- Updated the `make_pi0_processor` function to include the new padding configuration.
- Enhanced unit tests to validate the functionality of the `padding_side` parameter in various scenarios.
* feat(processor): Add state management methods to Pi0NewLineProcessor
* feat(normalization): Track normalization and unnormalization info in complementary data
- Updated NormalizerProcessor and UnnormalizerProcessor to accept additional parameters for tracking normalization modes.
- Enhanced the __call__ methods to store normalization and unnormalization information in the complementary data of transitions.
- Added unit tests to verify the correct tracking of normalization info, including scenarios with missing stats and selective normalization keys.
* feat(factory): Add preprocessor and postprocessor overrides to ProcessorConfigKwargs
- Updated ProcessorConfigKwargs to include optional overrides for preprocessor and postprocessor configurations.
- Enhanced the make_processor function to utilize the new overrides, allowing for more flexible processor initialization.
* feat(processors): Integrate RenameProcessor into various processor configurations
- Added RenameProcessor to the input steps of multiple processor functions, including make_act_processor, make_diffusion_processor, make_pi0_processor, make_sac_processor, make_tdmpc_processor, make_vqbet_processor, and make_smolvla_processor.
- Consolidated normalization features from input and output into a single NormalizerProcessor for improved efficiency.
- Updated the input steps to ensure compatibility with the new RenameProcessor integration.
* Do some todos and cleanup
* change feature_contract to dataset_features
* use one method for conversion pipeline output to add_frame dict and use base processors where possible
* Add back in and use record_loop
* update todo
* rename to_dataset_frame
* feat(smolvla): Refactor language processing and introduce new line processor (#1658)
- Removed the prepare_language method and directly accessed language tokens and masks from the batch using the OBS_LANGUAGE constant.
- Added SmolVLANewLineProcessor to ensure tasks end with a newline, enhancing tokenization compatibility.
- Updated the make_smolvla_processor function to include the new line processor and tokenizer processor for improved input handling.
* feat(processors): Integrate DeviceProcessor into multiple processor configurations
- Added DeviceProcessor to the input and output steps of various processor functions, including make_act_processor, make_diffusion_processor, make_pi0_processor, make_pi0fast_processor, make_sac_processor, make_tdmpc_processor, make_vqbet_processor, and make_smolvla_processor.
- Enhanced the DeviceProcessor class with state management methods and ensured compatibility with existing processor pipelines.
- Introduced unit tests for DeviceProcessor to validate functionality across different scenarios, including CPU and CUDA operations.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* fix
* fix reference frame
* refactor(pipeline): Remove to() method for device management
- Eliminated the to() method from RobotProcessor, which was responsible for moving tensor states to specified devices.
- Removed associated unit tests that validated the functionality of the to() method across various scenarios.
- Streamlined the pipeline code by focusing on other device management strategies.
* feat(processor): Enhance DeviceProcessor with float dtype conversion
- Added support for optional float dtype conversion in DeviceProcessor, allowing tensors to be converted to specified floating-point types while preserving non-float types.
- Implemented validation for float dtype input and updated the processor's configuration methods to include float dtype.
- Refactored tensor processing logic to streamline device movement and dtype conversion.
- Introduced comprehensive unit tests to validate the new float dtype functionality across various scenarios.
* update data visualization
* update teleop example
* fix record bugs
* Add replay
* Not code
* feature(pipeline): port tokenizer pipeline for VLA (#1645)
* feat(tokenizer): Introduce TokenizerProcessor for text tokenization
- Added TokenizerProcessor class to handle tokenization of task strings using Hugging Face's AutoTokenizer.
- Supports both string and list inputs, with customizable parameters for task key, output key, and tokenization settings.
- Implemented comprehensive unit tests to validate functionality, including handling of various input scenarios and integration with RobotProcessor.
- Updated types.py to include LANGUAGE feature type and modified __init__.py to register the new processor.
* feat(language): Enhance language processing in TokenizerProcessor
- Added OBS_LANGUAGE constant to define the observation language key.
- Updated TokenizerProcessor to store tokenized task data in the observation dictionary, ensuring compatibility with the new language feature.
- Introduced Pi0NewLineProcessor to append newlines to tasks for proper tokenization.
- Modified tests to validate the integration of language tokens and attention masks in the observation structure.
* feat(tokenizer): Add padding configuration to TokenizerProcessor
- Introduced `padding_side` parameter to the TokenizerProcessor for customizable padding direction.
- Updated the `make_pi0_processor` function to include the new padding configuration.
- Enhanced unit tests to validate the functionality of the `padding_side` parameter in various scenarios.
* feat(processor): Add state management methods to Pi0NewLineProcessor
* feat(normalization): Track normalization and unnormalization info in complementary data
- Updated NormalizerProcessor and UnnormalizerProcessor to accept additional parameters for tracking normalization modes.
- Enhanced the __call__ methods to store normalization and unnormalization information in the complementary data of transitions.
- Added unit tests to verify the correct tracking of normalization info, including scenarios with missing stats and selective normalization keys.
* feat(factory): Add preprocessor and postprocessor overrides to ProcessorConfigKwargs
- Updated ProcessorConfigKwargs to include optional overrides for preprocessor and postprocessor configurations.
- Enhanced the make_processor function to utilize the new overrides, allowing for more flexible processor initialization.
* feat(processors): Integrate RenameProcessor into various processor configurations
- Added RenameProcessor to the input steps of multiple processor functions, including make_act_processor, make_diffusion_processor, make_pi0_processor, make_sac_processor, make_tdmpc_processor, make_vqbet_processor, and make_smolvla_processor.
- Consolidated normalization features from input and output into a single NormalizerProcessor for improved efficiency.
- Updated the input steps to ensure compatibility with the new RenameProcessor integration.
* feat(smolvla): Refactor language processing and introduce new line processor (#1658)
- Removed the prepare_language method and directly accessed language tokens and masks from the batch using the OBS_LANGUAGE constant.
- Added SmolVLANewLineProcessor to ensure tasks end with a newline, enhancing tokenization compatibility.
- Updated the make_smolvla_processor function to include the new line processor and tokenizer processor for improved input handling.
* feture(policies): add device processor (#1659)
* feat(processors): Integrate DeviceProcessor into multiple processor configurations
- Added DeviceProcessor to the input and output steps of various processor functions, including make_act_processor, make_diffusion_processor, make_pi0_processor, make_pi0fast_processor, make_sac_processor, make_tdmpc_processor, make_vqbet_processor, and make_smolvla_processor.
- Enhanced the DeviceProcessor class with state management methods and ensured compatibility with existing processor pipelines.
- Introduced unit tests for DeviceProcessor to validate functionality across different scenarios, including CPU and CUDA operations.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* refactor(pipeline): Remove to() method for device management
- Eliminated the to() method from RobotProcessor, which was responsible for moving tensor states to specified devices.
- Removed associated unit tests that validated the functionality of the to() method across various scenarios.
- Streamlined the pipeline code by focusing on other device management strategies.
* feat(processor): Enhance DeviceProcessor with float dtype conversion
- Added support for optional float dtype conversion in DeviceProcessor, allowing tensors to be converted to specified floating-point types while preserving non-float types.
- Implemented validation for float dtype input and updated the processor's configuration methods to include float dtype.
- Refactored tensor processing logic to streamline device movement and dtype conversion.
- Introduced comprehensive unit tests to validate the new float dtype functionality across various scenarios.
* feat(policies): Add new line processors and update module exports
* feat(processor): Enhance batch and device processors to handle index and task_index fields
- Added logic to ToBatchProcessor for unsqueezing 0D tensors for index and task_index fields, ensuring they are processed as 1D tensors.
- Updated DeviceProcessor to process index and task_index fields in complementary data, preserving their tensor types and ensuring non-tensor fields remain unchanged.
- Enhanced unit tests to validate the correct handling of index and task_index fields across various scenarios, including device compatibility and dtype preservation.
* Add eval script
* fix `q_curr` in InverseKinematicsEEToJoints to the IK solution
* feat(processors): Introduce processors for various policy types
- Added `make_processor` function to create processor instances for different policy types, including `tdmpc`, `diffusion`, `act`, `vqbet`, `pi0`, `pi0fast`, `sac`, and `reward_classifier`.
- Implemented corresponding processor files for each policy type, encapsulating normalization and unnormalization steps.
- Updated existing policies to remove direct normalization dependencies, enhancing modularity and clarity.
- Enhanced test coverage to validate the integration of new processors with existing policy configurations.
* refactor(learner): Remove normalization from cached image features retrieval
- Simplified the retrieval of observation features by removing the normalization step from the `get_cached_image_features` method calls.
- This change enhances clarity and aligns with the recent updates to policy processors.
* refactor(policies): Remove unnormalization step from action predictions
- Eliminated the unnormalization of actions in both `TDMPCPolicy` and `VQBeTPolicy` classes to streamline action prediction.
- This change improves code clarity and aligns with recent updates to policy processors.
* feat(train): Integrate preprocessor into training pipeline
* refactor(train): Update preprocessor initialization to include dataset statistics
* refactor(policies): Enhance processor creation and add NaN detection hook
* feat(record): Integrate RobotProcessor into recording loop and update policy handling
- Added support for RobotProcessor in the record_loop function to enhance data processing capabilities.
- Updated the logic to reset both policy and processor when provided, ensuring proper state management.
- Modified action prediction to utilize the processor, improving the overall functionality of the recording process.
- Adjusted the save_checkpoint function to include preprocessor state saving, enhancing checkpointing capabilities.
* feat(migration): Add script for migrating policy models with normalization layers
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* feat(migrate): Enhance migration script to create preprocessor and postprocessor for policy models
- Updated the migration script to generate both a preprocessor and a postprocessor, improving the handling of normalization for training and inference.
- Added functionality to convert features to PolicyFeature objects, ensuring compatibility with the new processor architecture.
- Refined the extraction and removal of normalization statistics and layers, streamlining the migration process.
- Improved error handling for missing mandatory configuration fields during model instantiation.
* feat(migrate): Add model card generation and saving to migration script
- Implemented functionality to generate and save a model card for the migrated model, including metadata such as dataset repository ID, license, and tags.
- Enhanced the script to push the model card to the hub if requested, improving model documentation and accessibility.
- Refactored the saving process to ensure the model card is saved locally and uploaded correctly when pushing to the hub.
* feat(processor): Introduce ToBatchProcessor for handling observation batching
- Added ToBatchProcessor to ensure observations have proper batch dimensions for model processing.
- Implemented functionality to add batch dimensions to state and image observations as needed.
- Created comprehensive unit tests to validate the processor's behavior with various tensor dimensions and types.
- Ensured compatibility with existing transition keys and maintained the integrity of non-observation data.
* feat(processors): Add ToBatchProcessor to multiple policy processors
- Integrated ToBatchProcessor into various policy processors to handle observation batching.
- Updated make functions for act, diffusion, pi0, pi0fast, sac, smolvla, tdmpc, and vqbet processors to include the new batching functionality.
- Ensured consistency across all processor implementations for improved data handling.
* refactor(factory): Remove unused imports and NaN detection hook from processor creation
* feat(batch_processor): Enhance ToBatchProcessor to handle action batching
- Updated ToBatchProcessor to add batch dimensions to actions in addition to observations.
- Implemented separate methods for processing observations and actions, improving code readability.
- Added comprehensive unit tests to validate action batching functionality across various tensor dimensions and types.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* feat(factory): Enhance make_processor to support preprocessor and postprocessor configuration
- Introduced ProcessorConfigKwargs TypedDict for better type safety in processor configuration.
- Updated make_processor to accept preprocessor and postprocessor configuration filenames, improving flexibility in processor instantiation.
- Refactored the loading of pretrained processors to utilize the new configuration options.
* refactor(factory): Clean up imports in factory.py
- Removed unused import of IdentityProcessor to streamline the code.
* feat(migrate): Extend load_model_from_hub to include train configuration
- Updated load_model_from_hub to return the train configuration alongside the model state_dict and config.
- Modified main function to handle the additional train configuration when loading models from both the hub and local paths.
- Adjusted dataset_repo_id extraction to utilize the train configuration for improved accuracy.
* refactor(record): Rename processor parameters and update processing logic
- Renamed `processor` to `preprocessor` and added `postprocessor` parameter for clarity.
- Updated the `record_loop` and `predict_action` functions to utilize the new preprocessor and postprocessor, enhancing the processing flow.
- Ensured compatibility with existing functionality while improving code readability.
* feat(batch_processor): Add task field processing to ToBatchProcessor
- Enhanced ToBatchProcessor to wrap string tasks in a list, adding batch dimensions for compatibility with model inference.
- Implemented a new method for processing complementary data, ensuring that task values are correctly handled as either strings or lists of strings.
- Added comprehensive unit tests to validate task processing, including edge cases and in-place mutation of complementary data.
* feat(normalization): Implement IDENTITY mode for normalization and unnormalization
- Enhanced NormalizerProcessor and UnnormalizerProcessor to support IDENTITY mode, allowing features to bypass normalization when specified.
- Updated processing logic to check normalization modes and handle missing statistics gracefully.
- Added comprehensive unit tests to validate IDENTITY mode functionality for both observations and actions, ensuring correct behavior across various scenarios.
- Improved error handling for unsupported normalization modes.
* fix(rebase): remove residual normalization layer:
* refactor(diffusion): remove normalization layer from input processing
* refactor(normalization): Remove unused state dict transformation methods and streamline imports
- Eliminated the _transform_state_dict_keys and _load_as_safetensor methods from PI0Policy, simplifying the model loading process.
- Cleaned up imports in modeling_pi0.py by removing log_model_loading_keys and init_logging.
- Updated TDMPCPolicy and VQBeTPolicy to handle action removal from batches during offline evaluation.
- Introduced hotswap_stats function in normalize_processor.py to update normalization statistics dynamically, with corresponding tests to ensure functionality.
* refactor(normalization): Clean up imports in normalize_processor.py
* feat(batch_processor): Add feature_contract method to ToBatchProcessor
- Introduced feature_contract method that returns features without modification, maintaining the no-op behavior of the processor.
- This addition enhances the flexibility of the ToBatchProcessor for future feature processing needs.
* fix(dependencies): Update transformers dependency constraint to allow only versions up to 4.52.0
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* feature(pipeline): port tokenizer pipeline for VLA (#1645)
* feat(tokenizer): Introduce TokenizerProcessor for text tokenization
- Added TokenizerProcessor class to handle tokenization of task strings using Hugging Face's AutoTokenizer.
- Supports both string and list inputs, with customizable parameters for task key, output key, and tokenization settings.
- Implemented comprehensive unit tests to validate functionality, including handling of various input scenarios and integration with RobotProcessor.
- Updated types.py to include LANGUAGE feature type and modified __init__.py to register the new processor.
* feat(language): Enhance language processing in TokenizerProcessor
- Added OBS_LANGUAGE constant to define the observation language key.
- Updated TokenizerProcessor to store tokenized task data in the observation dictionary, ensuring compatibility with the new language feature.
- Introduced Pi0NewLineProcessor to append newlines to tasks for proper tokenization.
- Modified tests to validate the integration of language tokens and attention masks in the observation structure.
* feat(tokenizer): Add padding configuration to TokenizerProcessor
- Introduced `padding_side` parameter to the TokenizerProcessor for customizable padding direction.
- Updated the `make_pi0_processor` function to include the new padding configuration.
- Enhanced unit tests to validate the functionality of the `padding_side` parameter in various scenarios.
* feat(processor): Add state management methods to Pi0NewLineProcessor
* feat(normalization): Track normalization and unnormalization info in complementary data
- Updated NormalizerProcessor and UnnormalizerProcessor to accept additional parameters for tracking normalization modes.
- Enhanced the __call__ methods to store normalization and unnormalization information in the complementary data of transitions.
- Added unit tests to verify the correct tracking of normalization info, including scenarios with missing stats and selective normalization keys.
* feat(factory): Add preprocessor and postprocessor overrides to ProcessorConfigKwargs
- Updated ProcessorConfigKwargs to include optional overrides for preprocessor and postprocessor configurations.
- Enhanced the make_processor function to utilize the new overrides, allowing for more flexible processor initialization.
* feat(processors): Integrate RenameProcessor into various processor configurations
- Added RenameProcessor to the input steps of multiple processor functions, including make_act_processor, make_diffusion_processor, make_pi0_processor, make_sac_processor, make_tdmpc_processor, make_vqbet_processor, and make_smolvla_processor.
- Consolidated normalization features from input and output into a single NormalizerProcessor for improved efficiency.
- Updated the input steps to ensure compatibility with the new RenameProcessor integration.
* feat(smolvla): Refactor language processing and introduce new line processor (#1658)
- Removed the prepare_language method and directly accessed language tokens and masks from the batch using the OBS_LANGUAGE constant.
- Added SmolVLANewLineProcessor to ensure tasks end with a newline, enhancing tokenization compatibility.
- Updated the make_smolvla_processor function to include the new line processor and tokenizer processor for improved input handling.
* feture(policies): add device processor (#1659)
* feat(processors): Integrate DeviceProcessor into multiple processor configurations
- Added DeviceProcessor to the input and output steps of various processor functions, including make_act_processor, make_diffusion_processor, make_pi0_processor, make_pi0fast_processor, make_sac_processor, make_tdmpc_processor, make_vqbet_processor, and make_smolvla_processor.
- Enhanced the DeviceProcessor class with state management methods and ensured compatibility with existing processor pipelines.
- Introduced unit tests for DeviceProcessor to validate functionality across different scenarios, including CPU and CUDA operations.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* refactor(pipeline): Remove to() method for device management
- Eliminated the to() method from RobotProcessor, which was responsible for moving tensor states to specified devices.
- Removed associated unit tests that validated the functionality of the to() method across various scenarios.
- Streamlined the pipeline code by focusing on other device management strategies.
* feat(processor): Enhance DeviceProcessor with float dtype conversion
- Added support for optional float dtype conversion in DeviceProcessor, allowing tensors to be converted to specified floating-point types while preserving non-float types.
- Implemented validation for float dtype input and updated the processor's configuration methods to include float dtype.
- Refactored tensor processing logic to streamline device movement and dtype conversion.
- Introduced comprehensive unit tests to validate the new float dtype functionality across various scenarios.
* feat(policies): Add new line processors and update module exports
* feat(processor): Enhance batch and device processors to handle index and task_index fields
- Added logic to ToBatchProcessor for unsqueezing 0D tensors for index and task_index fields, ensuring they are processed as 1D tensors.
- Updated DeviceProcessor to process index and task_index fields in complementary data, preserving their tensor types and ensuring non-tensor fields remain unchanged.
- Enhanced unit tests to validate the correct handling of index and task_index fields across various scenarios, including device compatibility and dtype preservation.
* refactor(processors): Standardize processor naming conventions
- Updated processor names across various files to use a consistent "robot_preprocessor" and "robot_postprocessor" format.
- Modified the make_processor functions in factory, act, diffusion, pi0, pi0fast, sac, smolvla, tdmpc, and vqbet to reflect the new naming scheme.
- Enhanced the pipeline configuration to align with the updated processor names, improving clarity and maintainability.
* refactor(factory): Update processor configuration and type hints
- Changed return type of get_policy_class to type[PreTrainedPolicy] for improved type safety.
- Enhanced make_processor function to utilize dataset_stats in processor creation for better flexibility.
- Updated ProcessorConfigKwargs to include dataset_stats, allowing for more comprehensive processor configurations.
- Streamlined processor initialization by removing unnecessary kwargs and ensuring clarity in processor type handling.
* Fix eval and android gripper
* add some tests
* refactor(factory, pi0fast): Update processor function names and parameters
- Renamed make_pi0_processor to make_pi0fast_processor for clarity and consistency.
- Updated parameter names in the factory's make_processor function to use pretrained_model_name_or_path instead of source, enhancing readability and alignment with naming conventions.
* fix(train.py) push postprocessor with preprocessor
- Add preprocesser policy overrides for device and rename_map
- Add rename_map to DatasetRecordConfig (record.py)
* Cleanup pr
* fix more git diff pr issues
* add path as type in save_pretrained
* small nit
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* rename test file
* fix: make dataset_features/feature_contract is optional
* fix tests
* Encorperate pr feedback
* clean up record.py
* add ascii art, fix normal record
* remove merge issues
* fix merge
* remove features
* Add feedback PR
* fix last 4 tests
* remove features check
* rename to transform_features
* add transform_features
* fix lekiwi eval and update eval api example
---------
Signed-off-by: Adil Zouitine <adilzouitinegm@gmail.com>
Signed-off-by: Pepijn <138571049+pkooij@users.noreply.github.com>
Co-authored-by: Adil Zouitine <adilzouitinegm@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Simon Alibert <75076266+aliberts@users.noreply.github.com>
Co-authored-by: Michel Aractingi <michel.aractingi@huggingface.co>
* refactor(TokenizerProcessor): improve dependency handling and observation management
- Updated TokenizerProcessor to conditionally import AutoTokenizer based on the availability of the transformers library, enhancing flexibility.
- Modified tokenizer attribute type to Any to accommodate scenarios where transformers may not be installed.
- Improved observation handling by using a more concise approach to manage the transition dictionary, ensuring compatibility with existing data structures.
- Added error handling for missing transformers library, providing clear guidance for users on installation requirements.
* feat(dependencies): Add scipy as a required dependency
- Included `scipy>=1.15.2` in the project dependencies to enhance functionality and support for scientific computing tasks.
* feat(policies): convert save_policy_to_safetensors with pipeline
* refactor(normalization): remove Normalize and Unnormalize classes
- Deleted the Normalize and Unnormalize classes from the normalization module to streamline the codebase.
- Updated tests to ensure compatibility with the removal of these classes, focusing on the new NormalizerProcessor and UnnormalizerProcessor implementations.
- Enhanced the handling of normalization statistics and improved overall code clarity.
* refactor(factory): streamline processor loading by removing unused comments
- Removed commented-out code related to loading pretrained processors in the make_processor function.
- This change enhances code clarity and maintains focus on the current implementation.
* feat(DeviceProcessor): Enhance tensor processing with device detection and float dtype conversion
- Improved the _process_tensor method to preserve GPU placement for tensors already on a GPU, facilitating multi-GPU training scenarios.
- Introduced a new _detect_device method in TokenizerProcessor to ensure tokenized tensors match the device of existing tensors in transitions.
- Added comprehensive unit tests to validate the functionality of device detection and float dtype conversion across various scenarios.
* feat(tests): Add comprehensive tests for various policy processors
- Introduced new test files for ACT, Classifier, Diffusion, PI0, SAC, SmolVLA, TDMPC, and VQBeT policy processors.
- Each test file includes unit tests to validate functionality, including handling of batch sizes, device management, and data type conversions.
- Enhanced test coverage to ensure robustness and reliability of processor implementations across different scenarios.
* refactor(train): Remove unnecessary tensor device handling in training loop
* Refactor`gym_manipulator.py` using the universal pipeline (#1650)
* Migrate gym_manipulator to use the pipeline
Added get_teleop_events function to capture relevant events from teleop devices unrelated to actions
* Added the capability to record a dataset
* Added the replay functionality with the pipeline
* Refactored `actor.py` to use the pipeline
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* RL works at this commit - fixed actor.py and bugs in gym_manipulator
* change folder structure to reduce the size of gym_manip
* Refactored hilserl config
* Remove dataset and mode from HilSerlEnvConfig to a GymManipulatorConfig to reduce verbose of configs during training
* format docs
* removed get_teleop_events from abc
* Refactor environment configuration and processing pipeline for GymHIL support. Removed device attribute from HILSerlRobotEnvConfig, added DummyTeleopDevice for simulation, and updated processor creation to accommodate GymHIL environments.
* Improved typing for HILRobotEnv config and GymManipulator config
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Migrated `gym_manipulator` to use a more modular structure similar to phone teleop
* Refactor gripper handling and transition processing in HIL and robot kinematic processors
- Updated gripper position handling to use a consistent key format across processors
- Improved the EEReferenceAndDelta class to handle reference joint positions.
- Added support for discrete gripper actions in the GripperVelocityToJoint processor.
- Refactored the gym manipulator to improve modularity and clarity in processing steps.
* Added delta_action_processor mapping wrapper
* Added missing file delta_action_processor and improved imports in `gym_manipulator`
* nit
* Added missing file joint_observation_processor
* Enhance processing architecture with new teleoperation processors
- Introduced `AddTeleopActionAsComplimentaryData` and `AddTeleopEventsAsInfo` for integrating teleoperator actions and events into transitions.
- Added `Torch2NumpyActionProcessor` and `Numpy2TorchActionProcessor` for seamless conversion between PyTorch tensors and NumPy arrays.
- Updated `__init__.py` to include new processors in module exports, improving modularity and clarity in the processing pipeline.
- GymHIL is now fully supported with HIL using the pipeline
* Refactor configuration structure for gym_hil integration
- Renamed sections for better readability, such as changing "Gym Wrappers Configuration" to "Processor Configuration."
- Enhanced documentation with clear examples for dataset collection and policy evaluation configurations.
* Enhance reset configuration and teleoperation event handling
- Added `terminate_on_success` parameter to `ResetConfig` and `InterventionActionProcessor` for controlling episode termination behavior upon success detection.
- Updated documentation to clarify the impact of `terminate_on_success` on data collection for reward classifier training.
- Refactored teleoperation event handling to use `TeleopEvents` constants for improved readability and maintainability across various modules.
* fix(keyboard teleop), delta action keys
* Added transform features and feature contract
* Added transform features for image crop
* Enum for TeleopEvents
* Update tranform_features delta action proc
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* Remove HILEnvConfig references
* chore(processor): Add default names for preprocessor and postprocessor in constants
- Introduced `PREPROCESSOR_DEFAULT_NAME` and `POSTPROCESSOR_DEFAULT_NAME` constants for consistent naming across various processor implementations.
- Updated processor creation in multiple policy files to utilize these constants, enhancing code readability and maintainability.
- Modified the training script to load and save the preprocessor and postprocessor using the new constants.
* feat(processor): multiple improvements to the pipeline porting (#1749)
* [Port codebase pipeline] General fixes for RL and scripts (#1748)
* Refactor dataset configuration in documentation and codebase
- Updated dataset configuration keys from `dataset_root` to `root` and `num_episodes` to `num_episodes_to_record` for consistency.
- Adjusted replay episode handling by renaming `episode` to `replay_episode`.
- Enhanced documentation
- added specific processor to transform from policy actions to delta actions
* Added Robot action to tensor processor
Added new processor script for dealing with gym specific action processing
* removed RobotAction2Tensor processor; imrpoved choosing observations in actor
* nit in delta action
* added missing reset functions to kinematics
* Adapt teleoperate and replay to pipeline similar to record
* refactor(processors): move to inheritance (#1750)
* fix(teleoperator): improvements phone implementation (#1752)
* fix(teleoperator): protect shared state in phone implementation
* refactor(teleop): separate classes in phone
* fix: solve breaking changes (#1753)
* refactor(policies): multiple improvements (#1754)
* refactor(processor): simpler logic in device processor (#1755)
* refactor(processor): euclidean distance in delta action processor (#1757)
* refactor(processor): improvements to joint observations processor migration (#1758)
* refactor(processor): improvements to tokenizer migration (#1759)
* refactor(processor): improvements to tokenizer migration
* fix(tests): tokenizer tests regression from #1750
* fix(processors): fix float comparison and config in hil processors (#1760)
* chore(teleop): remove unnecessary callbacks in KeyboardEndEffectorTeleop (#1761)
* refactor(processor): improvements normalize pipeline migration (#1756)
* refactor(processor): several improvements normalize processor step
* refactor(processor): more improvements normalize processor
* refactor(processor): more changes to normalizer
* refactor(processor): take a different approach to DRY
* refactor(processor): final design
* chore(record): revert comment and continue deleted (#1764)
* refactor(examples): pipeline phone examples (#1769)
* refactor(examples): phone teleop + teleop script
* refactor(examples): phone replay + replay
* chore(examples): rename phone example files & folders
* feat(processor): fix improvements to the pipeline porting (#1796)
* refactor(processor): enhance tensor device handling in normalization process (#1795)
* refactor(tests): remove unsupported device detection test for complementary data (#1797)
* chore(tests): update ToBatchProcessor test (#1798)
* refactor(tests): remove in-place mutation tests for actions and complementary data in batch processor
* test(tests): add tests for action and task processing in batch processor
* add names for android and ios phone (#1799)
* use _tensor_stats in normalize processor (#1800)
* fix(normalize_processor): correct device reference for tensor epsilon handling (#1801)
* add point 5 add missing feature contracts (#1806)
* Fix PR comments 1452 (#1807)
* use key to determine image
* Address rest of PR comments
* use PolicyFeatures in transform_features
---------
Co-authored-by: Pepijn <138571049+pkooij@users.noreply.github.com>
---------
Co-authored-by: Michel Aractingi <michel.aractingi@huggingface.co>
Co-authored-by: Adil Zouitine <adilzouitinegm@gmail.com>
Co-authored-by: Pepijn <138571049+pkooij@users.noreply.github.com>
* refactor(constants, processor): standardize action and observation keys across multiple files (#1808)
- Added new constants for truncated and done states in constants.py.
- Updated references to action and observation keys in pipeline_features.py, converters.py, hil_processor.py, tokenizer_processor.py, and robot_kinematic_processor.py to use the new constants for improved readability and maintainability.
* refactor(processor): improve processor pipeline typing with generic type (#1810)
* refactor(processor): introduce generic type for to_output
- Always return `TOutput`
- Remove `_prepare_transition`, so `__call__` now always returns `TOutput`
- Update tests accordingly
- This refactor paves the way for adding settings for `to_transition` and `to_output` in `make_processor` and the post-processor
* refactor(processor): consolidate ProcessorKwargs usage across policies
- Removed the ProcessorTypes module and integrated ProcessorKwargs directly into the processor pipeline.
- Updated multiple policy files to utilize the new ProcessorKwargs structure for preprocessor and postprocessor arguments.
- Simplified the handling of processor kwargs by initializing them to empty dictionaries when not provided.
* refactor(converters): implement unified tensor conversion function (#1830)
- Introduced `to_tensor` function using `singledispatch` to handle various input types, including scalars, arrays, and dictionaries, converting them to PyTorch tensors.
- Replaced previous tensor conversion logic in `gym_action_processor`, `normalize_processor`, and `test_converters` with the new `to_tensor` function for improved readability and maintainability.
- Updated tests to cover new functionality and ensure correct tensor conversion behavior.
* Revert "refactor(converters): implement unified tensor conversion function (#…" (#1840)
This reverts commit a837685bf8.
* refactor(converters): implement unified tensor conversion function (#1841)
- Introduced `to_tensor` function using `singledispatch` to handle various input types, including scalars, arrays, and dictionaries, converting them to PyTorch tensors.
- Replaced previous tensor conversion logic in `gym_action_processor`, `normalize_processor`, and `test_converters` with the new `to_tensor` function for improved readability and maintainability.
- Updated tests to cover new functionality and ensure correct tensor conversion behavior.
Co-authored-by: AdilZouitine <adilzouitinegm@gmail.com>
* refactor(converters): gather converters and refactor the logic (#1833)
* refactor(converters): move batch transition functions to converters module
- Moved `_default_batch_to_transition` and `_default_transition_to_batch` functions from `pipeline.py` to `converters.py` for better organization and separation of concerns.
- Updated references in `RobotProcessor` to use the new location of these functions.
- Added tests to ensure correct functionality of the transition functions, including handling of index and task_index fields.
- Removed redundant tests from `pipeline.py` to streamline the test suite.
* refactor(processor): reorganize EnvTransition and TransitionKey definitions
- Moved `EnvTransition` and `TransitionKey` classes from `pipeline.py` to a new `core.py` module for better structure and maintainability.
- Updated import statements across relevant modules to reflect the new location of these definitions, ensuring consistent access throughout the codebase.
* refactor(converters): rename and update dataset frame conversion functions
- Replaced `to_dataset_frame` with `transition_to_dataset_frame` for clarity and consistency in naming.
- Updated references in `record.py`, `pipeline.py`, and tests to use the new function name.
- Introduced `merge_transitions` to streamline the merging of transitions, enhancing readability and maintainability.
- Adjusted related tests to ensure correct functionality with the new naming conventions.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* fix(processor): solve conflict artefacts
* refactor(converters): remove unused identity function and update type hints for merge_transitions
* refactor(processor): remove unused identity import and clean up gym_manipulator.py
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Steven Palma <steven.palma@huggingface.co>
* refactor(processors): add transform_features method to various processors (#1843)
* refactor(processors): update transition handling in RewardClassifierProcessor and InverseKinematicsEEToJoints (#1844)
* refactor(processors): unify import statements by consolidating pipeline imports into the main processor module (#1845)
* refactor(processors): add extended api for specialized pipelines (#1848)
* refactor(processors): enhance transform_features method across multiple processors (#1849)
* refactor(processors): enhance transform_features method across multiple processors
- Updated the transform_features method in various processors to utilize a copy of the features dictionary, ensuring immutability of the original features.
- Added handling for new feature keys and removed obsolete ones in the MapTensorToDeltaActionDict, JointVelocityProcessor, and others.
- Improved readability and maintainability by following consistent patterns in feature transformation.
* refactor(processors): standardize action and observation keys in delta_action_processor and joint_observations_processor
- Updated action and observation keys to use constants for improved readability and maintainability.
- Refactored the transform_features method in multiple processors to ensure consistent handling of feature keys.
- Enhanced error handling by raising exceptions for missing required components in action and observation processing.
- Removed obsolete code and improved overall structure for better clarity.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* refactor(processors): remove unused import in joint_observations_processor
* refactor(processors): simplify transform_features method in delta_action_processor
* refactor(processors): streamline transform_features method in ImageCropResizeProcessor
* refactor(processors): improve error handling and streamline transform_features method in phone_processor
- Raised a ValueError for missing position and rotation in action to enhance error handling.
* refactor(processors): enhance error handling in JointVelocityProcessor
- Added a ValueError raise for missing current joint positions in the observation method to improve error handling and ensure the integrity of the transform_features method.
* refactor(processors): simplify transform_features method in robot kinematic processors
* refactor(processors): standardize action keys in phone_processor
* fix(processor): RKP feature obs -> act
---------
Signed-off-by: Adil Zouitine <adilzouitinegm@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Steven Palma <steven.palma@huggingface.co>
* chore(processor): rename RobotProcessor -> DataProcessorPipeline (#1850)
* chore(processor): rename specialized processor -> XYZProcessorStep (#1852)
* chore(processor): rename converters function names (#1853)
* chore(processor): rename to_transition_teleop_action -> action_to_transition
* chore(processor): rename to_transition_robot_observation -> observation_to_transition
* chore(processor): rename to_output_robot_action -> transition_to_robot_action
* chore(processor): add Step suffix to all processors (#1854)
* refactor(processor): rename MapDeltaActionToRobotAction and MapTensorToDeltaActionDict for consistency
* refactor(processor): rename DeviceProcessor to DeviceProcessorStep for consistency across modules
* refactor(processor): rename Torch2NumpyActionProcessor to Torch2NumpyActionProcessorStep for consistency
* refactor(processor): rename Numpy2TorchActionProcessor to Numpy2TorchActionProcessorStep for consistency
* refactor(processor): rename AddTeleopActionAsComplimentaryData to AddTeleopActionAsComplimentaryDataStep for consistency
* refactor(processor): rename ImageCropResizeProcessor and AddTeleopEventsAsInfo for consistency
* refactor(processor): rename TimeLimitProcessor to TimeLimitProcessorStep for consistency
* refactor(processor): rename GripperPenaltyProcessor to GripperPenaltyProcessorStep for consistency
* refactor(processor): rename InterventionActionProcessor to InterventionActionProcessorStep for consistency
* refactor(processor): rename RewardClassifierProcessor to RewardClassifierProcessorStep for consistency
* refactor(processor): rename JointVelocityProcessor to JointVelocityProcessorStep for consistency
* refactor(processor): rename MotorCurrentProcessor to MotorCurrentProcessorStep for consistency
* refactor(processor): rename NormalizerProcessor and UnnormalizerProcessor to NormalizerProcessorStep and UnnormalizerProcessorStep for consistency
* refactor(processor): rename VanillaObservationProcessor to VanillaObservationProcessorStep for consistency
* refactor(processor): rename RenameProcessor to RenameProcessorStep for consistency
* refactor(processor): rename TokenizerProcessor to TokenizerProcessorStep for consistency
* refactor(processor): rename ToBatchProcessor to AddBatchDimensionProcessorStep for consistency
* refactor(processor): update config file name in test for RenameProcessorStep consistency
* refactor(processor): rename internal tokenizer variable for clarity (#1855)
- Changed the internal tokenizer variable name from `_tokenizer` to `input_tokenizer` for improved readability and consistency.
- Updated references throughout the class to reflect the new variable name.
* chore(processor): rename merge_features -> combine_feature_dicts (#1856)
* refactor(processor): rename internal device variable for clarity (#1857)
- Changed the internal device variable from `_device` to `tensor_device` for improved readability and consistency.
- Updated references throughout the class to reflect the new variable name.
* chore(processor): rename teleop_phone variable names (#1858)
* chore(processor): add type alias RobotProcessorPipeline and PolicyProcessorPipeline (#1859)
* feat(processor): introduce PolicyProcessorPipeline and RobotProcessorPipeline as type aliases for DataProcessorPipeline
- Added PolicyProcessorPipeline and RobotProcessorPipeline type aliases to enhance clarity and maintainability in the processor module.
- Updated the __all__ list to include the new pipelines for better module export consistency.
* refactor(processor): replace DataProcessorPipeline with PolicyProcessorPipeline across multiple modules
- Updated all instances of DataProcessorPipeline to PolicyProcessorPipeline in various processor files for consistency and clarity.
- Adjusted function signatures to reflect the new pipeline type, enhancing maintainability and readability.
* refactor(processor): update hotswap_stats function to use PolicyProcessorPipeline
- Changed the parameter name from robot_processor to policy_processor for clarity.
- Ensured consistency with recent updates to the processor module by reflecting the new pipeline type in the function signature.
* refactor(processor): replace DataProcessorPipeline with PolicyProcessorPipeline in migrate_policy_normalization.py
- Updated the preprocessor and postprocessor to use PolicyProcessorPipeline for consistency with recent changes in the processor module.
- Enhanced clarity and maintainability by aligning with the new pipeline structure.
* refactor(processor): update hotswap_stats to use PolicyProcessorPipeline
- Changed the parameter type in hotswap_stats from DataProcessorPipeline to PolicyProcessorPipeline for consistency with recent updates.
- Enhanced clarity by updating the function documentation to reflect the new pipeline type.
* refactor(processor): replace DataProcessorPipeline with RobotProcessorPipeline across multiple files
- Updated instances of DataProcessorPipeline to RobotProcessorPipeline in evaluate.py, record.py, replay.py, teleoperate.py, and other relevant files for consistency and clarity.
- Adjusted function signatures and variable types to reflect the new pipeline structure, enhancing maintainability and readability.
* refactor(processor): enforce config_filename requirement for HF Hub loading (#1860)
- Updated the DataProcessorPipeline to require a specific config_filename when loading from Hugging Face Hub, enhancing clarity and preventing errors.
- Simplified local path checks and improved error handling for invalid paths.
- Adjusted tests to reflect the new requirement and ensure proper error handling for various loading scenarios.
* feat(record): add transition features to dataset and handle scalar vs array formatting in converters (#1861)
- Introduced new transition features (`next.reward`, `next.done`, `next.truncated`) in the dataset during recording.
- Updated the `transition_to_dataset_frame` function to handle scalar values correctly, ensuring compatibility with expected array formats for reward, done, and truncated features.
* refactor(pipeline): enforce ProcessorStep inheritance for pipeline steps (#1862)
- Updated the DataProcessorPipeline to require that all steps inherit from ProcessorStep, enhancing type safety and clarity.
- Adjusted tests to utilize a MockTokenizerProcessorStep that adheres to the ProcessorStep interface, ensuring consistent behavior across tests.
- Refactored various mock step classes in tests to inherit from ProcessorStep for improved consistency and maintainability.
* refactor(dependencies): remove scipy dependency and introduce custom rotation utilities (#1863)
- Removed the scipy dependency from the project to streamline requirements.
- Added a new `rotation.py` module containing a custom `Rotation` class that replicates essential functionalities of `scipy.spatial.transform.Rotation`, allowing for rotation vector, matrix, and quaternion conversions without external dependencies.
- Updated the `robot_kinematic_processor.py` to utilize the new custom rotation utilities.
* feat(teleoperation): introduce HasTeleopEvents protocol and enhance teleop event handling (#1866)
- Added the HasTeleopEvents protocol to define a standard for teleoperators that provide control events.
- Implemented a runtime check to ensure teleoperators implement the get_teleop_events() method.
- Updated AddTeleopEventsAsInfoStep to utilize the new protocol, enhancing compatibility with custom teleoperators.
- Improved documentation for clarity on teleoperation event extraction and compatibility with built-in teleoperators.
* fix(deps): use in-house rotation utils over scipy throughout the codebase
* refactor(constants): rename preprocessor and postprocessor constants for clarity (#1868)
- Updated constant names from PREPROCESSOR_DEFAULT_NAME and POSTPROCESSOR_DEFAULT_NAME to POLICY_PREPROCESSOR_DEFAULT_NAME and POLICY_POSTPROCESSOR_DEFAULT_NAME for better context.
- Adjusted references across multiple files to use the new constant names, ensuring consistency in the codebase.
* refactor(tests): update processor test assertions to reflect new preprocessor and postprocessor names (#1869)
- Changed assertions in multiple processor test files to verify the updated names from "robot_preprocessor" and "robot_postprocessor" to "policy_preprocessor" and "policy_postprocessor" for consistency with recent refactoring.
* refactor(utils): simplify log_rerun_data function (#1864)
* refactor(logging): enhance log_rerun_data to handle observation and action separately
- Updated the `log_rerun_data` function to accept and log observation and action data more clearly, improving readability and maintainability.
- Refactored the `record_loop` and `teleop_loop` functions to extract and pass observation and action data to `log_rerun_data`, ensuring consistent logging format.
* refactor(tests): update test_log_rerun_data to align with log_rerun_data changes
- Modified test cases in `test_visualization_utils.py` to extract and pass observation and action data separately to `log_rerun_data`, improving clarity and consistency with recent function updates.
- Ensured that the tests reflect the new structure of `log_rerun_data` for better maintainability.
* refactor(processors): simplify calls to log_rerun + replace lambda functions with identity_transition
---------
Co-authored-by: Steven Palma <steven.palma@huggingface.co>
* fix(processor): recover type inference for use of processors (#1873)
* refactor(processors): Improve Normalization Processor Performance and Device/Dtype Adaptability (#1880)
* refactor(processors): reorder processor steps for consistency across implementations
- Updated the order of processor steps in multiple files to ensure consistency, placing AddBatchDimensionProcessorStep and DeviceProcessorStep before NormalizerProcessorStep.
- Adjusted related test assertions to reflect the new order of steps in the preprocessor, enhancing clarity and maintainability.
* refactor(normalization): remove dtype specification in tensor conversion for adaptation logic
- Updated tensor conversion in the _NormalizationMixin class to remove explicit dtype specification, allowing for automatic adaptation of tensor types.
- Adjusted related tests to ensure proper functionality with the new tensor conversion logic, verifying that normalizers adapt correctly to input types.
* chore(docs): update doctrines pipeline files (#1872)
* docs(processor): update docstrings batch_processor
* docs(processor): update docstrings device_processor
* docs(processor): update docstrings tokenizer_processor
* update docstrings processor_act
* update docstrings for pipeline_features
* update docstrings for utils
* update docstring for processor_diffusion
* update docstrings factory
* add docstrings to pi0 processor
* add docstring to pi0fast processor
* add docstring classifier processor
* add docstring to sac processor
* add docstring smolvla processor
* add docstring to tdmpc processor
* add docstring to vqbet processor
* add docstrings to converters
* add docstrings for delta_action_processor
* add docstring to gym action processor
* update hil processor
* add docstring to joint obs processor
* add docstring to migrate_normalize_processor
* update docstrings normalize processor
* update docstring normalize processor
* update docstrings observation processor
* update docstrings rename_processor
* add docstrings robot_kinematic_processor
* cleanup rl comments
* add docstring to train.py
* add docstring to teleoperate.py
* add docstrings to phone_processor.py
* add docstrings to teleop_phone.py
* add docstrings to control_utils.py
* add docstrings to visualization_utils.py
---------
Co-authored-by: Pepijn <pepijn@huggingface.co>
* refactor(eval): integrate preprocessor and postprocessor into rollout and eval_policy functions (#1900)
* refactor(eval): integrate preprocessor and postprocessor into rollout and eval_policy functions
- Updated the `rollout` and `eval_policy` functions to accept preprocessor and postprocessor parameters, enhancing the flexibility of the evaluation pipeline.
- Adjusted the implementation to apply preprocessing and postprocessing steps during policy evaluation, improving the overall data handling and processing flow.
* refactor(eval): remove redundant observation device conversion in rollout function
- Eliminated unnecessary device conversion for the observation dictionary within the `rollout` function, streamlining the code and enhancing readability.
- This change simplifies the observation handling process, aligning with the preference for clearer solutions.
* debug
* refactor(utils): enhance task handling in add_envs_task function
- Improved the `add_envs_task` function to validate the output of `task_description` and `task` calls, ensuring they return lists of strings.
- Removed the use of `else` statement for environments without language instructions, simplifying the logic and enhancing readability.
- Streamlined the observation dictionary handling by ensuring consistent data types for task attributes.
* refactor(converters): rename _from_tensor to from_tensor_to_numpy for clarity (#1902)
- Updated the function name from _from_tensor to from_tensor_to_numpy to better reflect its purpose of converting PyTorch tensors to numpy arrays or scalars.
- Adjusted all references to the renamed function throughout the codebase to maintain consistency.
- Enhanced the _NormalizationMixin class to reconstruct the stats dictionary from tensor stats using the new function, ensuring compatibility after loading state dicts.
- Added tests to verify the correct reconstruction of stats and functionality of methods dependent on self.stats after loading.
* refactor(pipeline): feature contract now categorizes between OBS or Action (#1867)
* refactor(processor): signature of transform_features
* refactor(processor): remove prefixes + processor respect new transform_features signature + update test accordingly
* refactor(processor): rename now is only for visual
* refactor(processor): update normalize processor
* refactor(processor): update vanilla processor features
* refactor(processor): feature contract now uses its own enum
* chore(processor): rename renameprocessor
* chore(processor): minor changes
* refactor(processor): add create & change aggregate
* refactor(processor): update aggregate
* refactor(processor): simplify to functions, fix features contracts and rename function
* test(processor): remove to converter tests as now they are very simple
* chore(docs): recover docs joint observations processor
* fix(processor): update RKP
* fix(tests): recv diff test_pipeline
* chore(tests): add docs to test
* chore(processor): leave obs language constant untouched
* fix(processor): correct new shape of feature in crop image processor
* refactor(eval): specify type parameters for preprocessor and postprocessor in eval_policy function (#1904)
* chore(processor): remove action prefixes (#1905)
* test(processor): all processors use now the same create_transition (#1906)
* test(processor): all processors use now the same create_transition
* test(processor): use identity instead of lambda for transition in pipelines
* fix(processor): specialized processors respect contract by raising if none (#1909)
* fix(processor): specialized processor now raise
* test(processor): fix tests for now raise specialized processors
* test(processor): use identity in newly introduced pipeline
* refactor(processor): clarify action types, distinguish PolicyAction, RobotAction, and EnvAction (#1908)
* refactor(processor): split action from policy, robots and environment
- Updated function names to robot_action_to_transition and robot_transition_to_action across multiple files to better reflect their purpose in processing robot actions.
- Adjusted references in the RobotProcessorPipeline and related components to ensure compatibility with the new naming convention.
- Enhanced type annotations for action parameters to improve code readability and maintainability.
* refactor(converters): rename robot_transition_to_action to transition_to_robot_action
- Updated function names across multiple files to improve clarity and consistency in processing robot actions.
- Adjusted references in RobotProcessorPipeline and related components to align with the new naming convention.
- Simplified action handling in the AddBatchDimensionProcessorStep by removing unnecessary checks for action presence.
* refactor(converters): update references to transition_to_robot_action
- Renamed all instances of robot_transition_to_action to transition_to_robot_action across multiple files for consistency and clarity in the processing of robot actions.
- Adjusted the RobotProcessorPipeline configurations to reflect the new naming convention, enhancing code readability.
* refactor(processor): update Torch2NumpyActionProcessorStep to extend ActionProcessorStep
- Changed the base class of Torch2NumpyActionProcessorStep from PolicyActionProcessorStep to ActionProcessorStep, aligning it with the current architecture of action processing.
- This modification enhances the clarity of the class's role in the processing pipeline.
* fix(processor): main action processor can take also EnvAction
---------
Co-authored-by: Steven Palma <steven.palma@huggingface.co>
* refactor(processor): phone processor is now an RobotActionProcessorStep
* fix(processor): use subprocessors in AddBatchDimensionProcessorStep only if we have the ingredients
* fix(robots): remove action prefix hard-coded in teleop keyboard and gamepad
* feat(processor): enhance type safety with generic DataProcessorPipeline for policy and robot pipelines (#1915)
* refactor(processor): enhance type annotations for processors in record, replay, teleoperate, and control utils
- Updated type annotations for preprocessor and postprocessor parameters in record_loop and predict_action functions to specify the expected dictionary types.
- Adjusted robot_action_processor type in ReplayConfig and TeleoperateConfig to improve clarity and maintainability.
- Ensured consistency in type definitions across multiple files, enhancing overall code readability.
* refactor(processor): enhance type annotations for RobotProcessorPipeline in various files
- Updated type annotations for RobotProcessorPipeline instances in evaluate.py, record.py, replay.py, teleoperate.py, and other related files to specify input and output types more clearly.
- Introduced new type conversions for PolicyAction and EnvTransition to improve type safety and maintainability across the processing pipelines.
- Ensured consistency in type definitions, enhancing overall code readability and reducing potential runtime errors.
* refactor(processor): update transition handling in processors to use transition_to_batch
- Replaced direct transition handling with transition_to_batch in various processor tests and implementations to ensure consistent batching of input data.
- Updated assertions in tests to reflect changes in data structure, enhancing clarity and maintainability.
- Improved overall code readability by standardizing the way transitions are processed across different processor types.
* refactor(tests): standardize transition key usage in processor tests
- Updated assertions in processor test files to utilize the TransitionKey for action references, enhancing consistency across tests.
- Replaced direct string references with TransitionKey constants for improved readability and maintainability.
- Ensured that all relevant tests reflect these changes, contributing to a more uniform approach in handling transitions.
* refactor(processor): unify action imports and enhance type clarity across multiple files
- Updated imports in various files to include RobotAction and PolicyAction directly from the processor module, improving clarity and consistency.
- Removed redundant imports from core, streamlining the codebase and enhancing maintainability.
- Adjusted type annotations and references in the RobotProcessorPipeline and related components to align with the new import structure, ensuring better type safety and readability.
* refactor(processor): migrate policy normalization to use factory functions
- Updated the migration script to utilize `make_pre_post_processors` and `make_policy_config` from `lerobot.policies.factory`, enhancing consistency with the current codebase.
- Improved normalization statistics extraction and processor pipeline creation, ensuring compatibility with the new `PolicyProcessorPipeline` architecture.
- Cleaned up configuration handling by removing unnecessary fields and adding normalization mapping directly to the config.
- Enhanced type safety and readability by refining feature type and normalization mode handling.
* debug(scripts): simplify record with processors (#1918)
Co-authored-by: Adil Zouitine <adilzouitinegm@gmail.com>
* refactor(processor): update migration script for policy normalization and hub integration
- Modified the migration script to include a branch argument for pushing to the hub, enhancing flexibility in version control.
- Improved error handling by ensuring the policy type is extracted from the configuration, promoting robustness.
- Streamlined the process of saving and pushing model components to the hub, allowing for a single commit with optional PR creation.
- Updated the commit message and description for better clarity on the migration changes and benefits, ensuring users are informed of the new architecture and usage.
* fixes for processors used in phone teleop
* fixes for rotation matrix
* add empty obs and act in create_initial_features
* use observation instead of obs
* docs(processor): update docstrings pipeline (#1920)
* chore(docs): Processor doc (#1685)
* chore(docs): initialize doc
* Added script for the second part of the processor doc
* precommit style nit
* improved part 2 of processor guide
* Add comprehensive documentation for processors in robotics
- Introduced a detailed guide on processors, covering their role in transforming raw robot data into model-ready inputs and vice versa.
- Explained core concepts such as EnvTransition, ProcessorStep, and RobotProcessor, along with their functionalities.
- Included examples of common processor steps like normalization, device management, batch processing, and text tokenization.
- Provided insights on building complete pipelines, integrating processors into training loops, and saving/loading configurations.
- Emphasized best practices and advanced features for effective usage of processors in robotics applications.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* feat(docs): Enhance introduction to processors with additional converter functions
- Updated the introduction to processors documentation to include default batch-to-transition and transition-to-batch converters.
- Added detailed descriptions and examples for new specialized converter functions: `to_transition_teleop_action`, `to_transition_robot_observation`, `to_output_robot_action`, and `to_dataset_frame`.
- Improved clarity on how these converters facilitate integration with existing robotics applications.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Improved doc implement_your_own_pipeline
- Use normalization processor as default example
- Add section on transform features
- Add section on overrides.
* Add phone docs and use pipeline for robots/teleop docs
* Fix typo in documentation for adapters in robots/teleop section
* Enhance documentation for processors with detailed explanations and examples
- Updated the introduction to processors, clarifying the role of `EnvTransition` and `ProcessorStep`.
- Introduced `DataProcessorPipeline` as a generic orchestrator for chaining processor steps.
- Added comprehensive descriptions of new converter functions and their applications.
- Improved clarity on type safety and the differences between `RobotProcessorPipeline` and `PolicyProcessorPipeline`.
- Included examples for various processing scenarios, emphasizing best practices for data handling in robotics.
* Enhance documentation for processor migration and debugging
- Added detailed sections on the migration of models to the new `PolicyProcessorPipeline` system, including breaking changes and migration scripts.
- Introduced a comprehensive guide for debugging processor pipelines, covering common issues, step-by-step inspection, and runtime monitoring techniques.
- Updated examples to reflect new usage patterns and best practices for processor implementation and error handling.
- Clarified the role of various processor steps and their configurations in the context of robotics applications.
---------
Co-authored-by: Michel Aractingi <michel.aractingi@huggingface.co>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Pepijn <pepijn@huggingface.co>
* docs: Add new section for debugging processor pipelines
- Introduced a new documentation entry for debugging processor pipelines, enhancing the existing guide on processors.
- This addition aims to provide users with insights and best practices for troubleshooting and optimizing their processor workflows.
* fix(processor): phone examples (#1921)
* fix(processor): phone examples
* chore(processor): simplify gripper in phone example kinematic chain
---------
Co-authored-by: Steven Palma <steven.palma@huggingface.co>
* refactor(processors): several additions (#1926)
* chore(processor): remove merge_transitions functions (#1925)
* refactor(processors): move processors out of configs (#1927)
* chore(processor): streamline combine_features_dict (#1928)
* chore(policies): use new constants (#1929)
* fix(deps): right version transformers (#1930)
* fix(tests): add none + disable async tests for now (#1931)
* refactor(processor): transform_features loop + EAFP (#1932)
* fix(processors): make sure nested dict are also shallow copied (#1939)
* refactor(processor): replace ModelHubMixin with HubMixin and enhance save_pretrained method (#1937)
- Updated DataProcessorPipeline to use HubMixin instead of ModelHubMixin for improved functionality.
- Refactored save_pretrained method to handle saving
* refactor(docs): streamline monitoring hooks and enhance performance reporting
- Removed the log_shapes and measure_performance hooks, simplifying the monitoring process to focus on NaN checks.
- Updated performance reporting to include maximum processing times alongside average times for better insights.
- Clarified documentation regarding the processing pipeline and feature transformations.
* fix teleop, record and eval (#1940)
* fix cmd record, eval
* chore(processor): update input output of main 3 processors for better semantics (#1942)
* chore(processor): update input output of main 3 processors for better semantics
* refactor(processor): replace Any with RobotObservation for improved type safety in processors
* fix(processors): no PolicyObservation
* chore(processor): update with RobotObservation
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
---------
Co-authored-by: AdilZouitine <adilzouitinegm@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* test(processor): fix batch expectation
* feat(example): Add SO100 EE pipeline control (teleop+record) (#1943)
* feat(examples): add ee so100 processors teleop & record
* refactor(processor): improve FK processor for better use compatability
* docs(processor): enhance tutorial on implementing custom processors
- Updated the tutorial to use `NormalizerProcessorStep` as the primary example, clarifying its role in normalizing observations and actions.
- Improved explanations of the need for custom processors, emphasizing data compatibility and processing requirements.
- Added code snippets demonstrating the normalization process and the configuration of processor pipelines.
- Enhanced the introduction to processors, detailing their function as translators between raw robot data and model inputs.
- Included examples of real-world processor configurations for both training and inference scenarios.
* docs(debug): enhance debugging guide for processor pipelines
- Streamlined the introduction to clarify the challenges of debugging complex processor pipelines.
- Expanded the section on hooks, detailing their purpose and implementation for runtime monitoring.
- Introduced step-by-step debugging techniques, emphasizing the use of the `step_through()` method for inspecting intermediate states.
- Added examples of feature validation to ensure data structure contracts are met.
- Consolidated best practices for debugging, highlighting the synergy between hooks, step-through debugging, and feature validation.
* chore(processors): tokenizers raises and remove tensor conversion (#1949)
* chore(processor): remove unused transition_features dict
* feat(ee): add so100_to_so100_EE replay and evaluate examples
* chore(examples): homogenize style across example files (#1955)
* chore(examples): homogenize style across example files
* chore(examples): homogenize style across example files eval + replay
* chore(examples): homogenize headers
* test(async): fix feature manipulation (#1957)
* test(async): fix feature manipulation
* chore(processor): remove unused functions
* fix(processor): Preserve stats overrides in normalizer load_state_dict and fix training resumption (#1958)
* feat(processor): enhance normalization handling and state management
- Added support for additional normalization modes including IDENTITY.
- Introduced a new function `clean_state_dict` to remove specific substrings from state dict keys.
- Implemented preservation of explicitly provided normalization statistics during state loading.
- Updated training script to conditionally provide dataset statistics based on resume state.
- Expanded tests to verify the correct behavior of stats override preservation and loading.
* fix(train): remove redundant comment regarding state loading
- Removed a comment that noted the preprocessor and postprocessor state is already loaded when resuming training, as it was deemed unnecessary for clarity.
* test(processor): update tests to handle missing or invalid task keys
- Modified tests to assert that the processor raises appropriate exceptions when the task key is missing or has an invalid value in the complementary data.
- Ensured that the tests cover cases for None, integer, and mixed list task values, improving robustness against invalid inputs.
* fix(processor): enforce signatures
* chore(processor): update comments in record.py
* test(processor): fix isinstance and cuda test
* modify phone docs
* fix(processor): reorder output steps to ensure correct processing sequence (#1961)
- Moved DeviceProcessorStep to the end of the output steps in multiple processor files to maintain the intended processing order.
- Updated corresponding tests to reflect the change in step order.
* fix(processors): assumptions for robot_action_processor & teleop_action_processor (#1964)
* fix(processors): new assumptions pipeline
* fix(processors): ee jj phone teleop replay record working
* chore(processors): update comments and default vars
* chore(processor): remove unnecessary copy
* chore(processor): added todo assumption gripper
* fix(processors): eval using detected device
* finish phone docs
* fix correct image link
* feat(processor): implement migration detection and error handling for processor configurations (#1968)
* feat(processor): implement migration detection and error handling for processor configurations
- Added ProcessorMigrationError to handle migration requirements for old model formats.
- Enhanced DataProcessorPipeline.from_pretrained to include robust migration detection logic.
- Implemented methods for resolving configuration sources, validating loaded configs, and checking for valid processor configurations.
- Introduced comprehensive tests for migration detection and configuration validation to ensure correct behavior.
* refactor(processor): simplify loading logic and enhance migration detection
- Refactored DataProcessorPipeline to implement a simplified three-way loading strategy for configuration files.
- Introduced explicit config_filename parameter to avoid ambiguity during loading.
- Updated ProcessorMigrationError to provide clearer error messages for migration requirements.
- Enhanced tests to cover new loading logic and ensure proper migration detection.
- Removed deprecated methods related to config source resolution.
* fix(processor) RL (#1953)
* fix(gym_manipulator) general fixes to make it compitable
* fix for dataset v3.0
* fix for gym_manipulator
* add map policy action to robot action wrappers in a seperate scripts
* added unittest for policy to robot bridge
* fixes for gripper penalty
* fix style
* fix gamepad controller
* fixes for sim teleop
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* modify numpy2torch to a regular processor as a quick fix
* missing imports?!
* - Removed the use of `AddRobotObservationAsComplimentaryData` from `gym_manipulator` and thus the codebase
- Added get_raw_joint_positions functions to RobotEnv
- Pass raw_joint_positions as input to the action_pipeline in `gym_manipulator`
- Add `InverseKinematicsRLStep` to be tailored towards the need of RL which requires the use of the IK solution as the main reference point of the control loop
- Added the option `use_ik_solution` in `EEReferenceDelta` step to rely on the ik solution rather than the joint values
* -Updated links to all the config files to place them in the new repo with configs compatible with the pipeline
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Steven Palma <imstevenpmwork@ieee.org>
* fix(tests): update test cases for loading pipelines with specific config filenames
- Modified test cases to include explicit configuration filenames when loading pipelines in `test_policy_robot_bridge.py`.
- Ensured that the tests reflect the correct loading behavior for both robot-to-policy and policy-to-robot transitions.
* fix(examples): train mps processor (#1970)
* fix(examples): train mps processor
* fix(processor): add MPS compatibility for float64 tensors
- Implemented a workaround to convert float64 tensors to float32 when using the MPS device, as MPS does not support float64.
- Added unit tests to verify the automatic conversion of float64 tensors to float32 and ensure compatibility with various tensor types on the MPS device.
---------
Co-authored-by: AdilZouitine <adilzouitinegm@gmail.com>
---------
Signed-off-by: Adil Zouitine <adilzouitinegm@gmail.com>
Signed-off-by: Pepijn <138571049+pkooij@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Simon Alibert <75076266+aliberts@users.noreply.github.com>
Co-authored-by: Pepijn <138571049+pkooij@users.noreply.github.com>
Co-authored-by: Steven Palma <imstevenpmwork@ieee.org>
Co-authored-by: Michel Aractingi <michel.aractingi@huggingface.co>
Co-authored-by: Steven Palma <steven.palma@huggingface.co>
Co-authored-by: Pepijn <pepijn@huggingface.co>
2203 lines
78 KiB
Python
2203 lines
78 KiB
Python
#!/usr/bin/env python
|
|
|
|
# Copyright 2025 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 json
|
|
import tempfile
|
|
from collections.abc import Callable
|
|
from dataclasses import dataclass
|
|
from pathlib import Path
|
|
from typing import Any
|
|
|
|
import pytest
|
|
import torch
|
|
import torch.nn as nn
|
|
|
|
from lerobot.configs.types import FeatureType, PipelineFeatureType, PolicyFeature
|
|
from lerobot.datasets.pipeline_features import aggregate_pipeline_dataset_features
|
|
from lerobot.processor import (
|
|
DataProcessorPipeline,
|
|
EnvTransition,
|
|
ProcessorStep,
|
|
ProcessorStepRegistry,
|
|
TransitionKey,
|
|
)
|
|
from lerobot.processor.converters import create_transition, identity_transition
|
|
from tests.conftest import assert_contract_is_typed
|
|
|
|
|
|
@dataclass
|
|
class MockStep(ProcessorStep):
|
|
"""Mock pipeline step for testing - demonstrates best practices.
|
|
|
|
This example shows the proper separation:
|
|
- JSON-serializable attributes (name, counter) go in get_config()
|
|
- Only torch tensors go in state_dict()
|
|
|
|
Note: The counter is part of the configuration, so it will be restored
|
|
when the step is recreated from config during loading.
|
|
"""
|
|
|
|
name: str = "mock_step"
|
|
counter: int = 0
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
"""Add a counter to the complementary_data."""
|
|
comp_data = transition.get(TransitionKey.COMPLEMENTARY_DATA, {})
|
|
comp_data = {} if comp_data is None else dict(comp_data) # Make a copy
|
|
|
|
comp_data[f"{self.name}_counter"] = self.counter
|
|
self.counter += 1
|
|
|
|
# Create a new transition with updated complementary_data
|
|
new_transition = transition.copy()
|
|
new_transition[TransitionKey.COMPLEMENTARY_DATA] = comp_data
|
|
return new_transition
|
|
|
|
def get_config(self) -> dict[str, Any]:
|
|
# Return all JSON-serializable attributes that should be persisted
|
|
# These will be passed to __init__ when loading
|
|
return {"name": self.name, "counter": self.counter}
|
|
|
|
def state_dict(self) -> dict[str, torch.Tensor]:
|
|
# Only return torch tensors (empty in this case since we have no tensor state)
|
|
return {}
|
|
|
|
def load_state_dict(self, state: dict[str, torch.Tensor]) -> None:
|
|
# No tensor state to load
|
|
pass
|
|
|
|
def reset(self) -> None:
|
|
self.counter = 0
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
# We do not test features here
|
|
return features
|
|
|
|
|
|
@dataclass
|
|
class MockStepWithoutOptionalMethods(ProcessorStep):
|
|
"""Mock step that only implements the required __call__ method."""
|
|
|
|
multiplier: float = 2.0
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
"""Multiply reward by multiplier."""
|
|
reward = transition.get(TransitionKey.REWARD)
|
|
|
|
if reward is not None:
|
|
new_transition = transition.copy()
|
|
new_transition[TransitionKey.REWARD] = reward * self.multiplier
|
|
return new_transition
|
|
|
|
return transition
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
# We do not test features here
|
|
return features
|
|
|
|
|
|
@dataclass
|
|
class MockStepWithTensorState(ProcessorStep):
|
|
"""Mock step demonstrating mixed JSON attributes and tensor state."""
|
|
|
|
name: str = "tensor_step"
|
|
learning_rate: float = 0.01
|
|
window_size: int = 10
|
|
|
|
def __init__(self, name: str = "tensor_step", learning_rate: float = 0.01, window_size: int = 10):
|
|
self.name = name
|
|
self.learning_rate = learning_rate
|
|
self.window_size = window_size
|
|
# Tensor state
|
|
self.running_mean = torch.zeros(window_size)
|
|
self.running_count = torch.tensor(0)
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
"""Update running statistics."""
|
|
reward = transition.get(TransitionKey.REWARD)
|
|
|
|
if reward is not None:
|
|
# Update running mean
|
|
idx = self.running_count % self.window_size
|
|
self.running_mean[idx] = reward
|
|
self.running_count += 1
|
|
|
|
return transition
|
|
|
|
def get_config(self) -> dict[str, Any]:
|
|
# Only JSON-serializable attributes
|
|
return {
|
|
"name": self.name,
|
|
"learning_rate": self.learning_rate,
|
|
"window_size": self.window_size,
|
|
}
|
|
|
|
def state_dict(self) -> dict[str, torch.Tensor]:
|
|
# Only tensor state
|
|
return {
|
|
"running_mean": self.running_mean,
|
|
"running_count": self.running_count,
|
|
}
|
|
|
|
def load_state_dict(self, state: dict[str, torch.Tensor]) -> None:
|
|
self.running_mean = state["running_mean"]
|
|
self.running_count = state["running_count"]
|
|
|
|
def reset(self) -> None:
|
|
self.running_mean.zero_()
|
|
self.running_count.zero_()
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
# We do not test features here
|
|
return features
|
|
|
|
|
|
def test_empty_pipeline():
|
|
"""Test pipeline with no steps."""
|
|
pipeline = DataProcessorPipeline([], to_transition=identity_transition, to_output=identity_transition)
|
|
|
|
transition = create_transition()
|
|
result = pipeline(transition)
|
|
|
|
assert result == transition
|
|
assert len(pipeline) == 0
|
|
|
|
|
|
def test_single_step_pipeline():
|
|
"""Test pipeline with a single step."""
|
|
step = MockStep("test_step")
|
|
pipeline = DataProcessorPipeline([step], to_transition=identity_transition, to_output=identity_transition)
|
|
|
|
transition = create_transition()
|
|
result = pipeline(transition)
|
|
|
|
assert len(pipeline) == 1
|
|
assert result[TransitionKey.COMPLEMENTARY_DATA]["test_step_counter"] == 0
|
|
|
|
# Call again to test counter increment
|
|
result = pipeline(transition)
|
|
assert result[TransitionKey.COMPLEMENTARY_DATA]["test_step_counter"] == 1
|
|
|
|
|
|
def test_multiple_steps_pipeline():
|
|
"""Test pipeline with multiple steps."""
|
|
step1 = MockStep("step1")
|
|
step2 = MockStep("step2")
|
|
pipeline = DataProcessorPipeline(
|
|
[step1, step2], to_transition=identity_transition, to_output=identity_transition
|
|
)
|
|
|
|
transition = create_transition()
|
|
result = pipeline(transition)
|
|
|
|
assert len(pipeline) == 2
|
|
assert result[TransitionKey.COMPLEMENTARY_DATA]["step1_counter"] == 0
|
|
assert result[TransitionKey.COMPLEMENTARY_DATA]["step2_counter"] == 0
|
|
|
|
|
|
def test_invalid_transition_format():
|
|
"""Test pipeline with invalid transition format."""
|
|
pipeline = DataProcessorPipeline([MockStep()])
|
|
|
|
# Test with wrong type (tuple instead of dict)
|
|
with pytest.raises(ValueError, match="EnvTransition must be a dictionary"):
|
|
pipeline((None, None, 0.0, False, False, {}, {})) # Tuple instead of dict
|
|
|
|
# Test with wrong type (string)
|
|
with pytest.raises(ValueError, match="EnvTransition must be a dictionary"):
|
|
pipeline("not a dict")
|
|
|
|
|
|
def test_step_through():
|
|
"""Test step_through method with dict input."""
|
|
step1 = MockStep("step1")
|
|
step2 = MockStep("step2")
|
|
pipeline = DataProcessorPipeline([step1, step2])
|
|
|
|
transition = create_transition()
|
|
|
|
results = list(pipeline.step_through(transition))
|
|
|
|
assert len(results) == 3 # Original + 2 steps
|
|
assert results[0] == transition # Original
|
|
assert "step1_counter" in results[1][TransitionKey.COMPLEMENTARY_DATA] # After step1
|
|
assert "step2_counter" in results[2][TransitionKey.COMPLEMENTARY_DATA] # After step2
|
|
|
|
# Ensure all results are dicts (same format as input)
|
|
for result in results:
|
|
assert isinstance(result, dict)
|
|
assert all(isinstance(k, TransitionKey) for k in result.keys())
|
|
|
|
|
|
def test_step_through_with_dict():
|
|
"""Test step_through method with dict input."""
|
|
step1 = MockStep("step1")
|
|
step2 = MockStep("step2")
|
|
pipeline = DataProcessorPipeline([step1, step2])
|
|
|
|
batch = {
|
|
"observation.image": None,
|
|
"action": None,
|
|
"next.reward": 0.0,
|
|
"next.done": False,
|
|
"next.truncated": False,
|
|
"info": {},
|
|
}
|
|
|
|
results = list(pipeline.step_through(batch))
|
|
|
|
assert len(results) == 3 # Original + 2 steps
|
|
|
|
# Ensure all results are EnvTransition dicts (regardless of input format)
|
|
for result in results:
|
|
assert isinstance(result, dict)
|
|
# Check that keys are TransitionKey enums or at least valid transition keys
|
|
for key in result:
|
|
assert key in [
|
|
TransitionKey.OBSERVATION,
|
|
TransitionKey.ACTION,
|
|
TransitionKey.REWARD,
|
|
TransitionKey.DONE,
|
|
TransitionKey.TRUNCATED,
|
|
TransitionKey.INFO,
|
|
TransitionKey.COMPLEMENTARY_DATA,
|
|
]
|
|
|
|
# Check that the processing worked - verify step counters in complementary_data
|
|
assert results[1].get(TransitionKey.COMPLEMENTARY_DATA, {}).get("step1_counter") == 0
|
|
assert results[2].get(TransitionKey.COMPLEMENTARY_DATA, {}).get("step1_counter") == 0
|
|
assert results[2].get(TransitionKey.COMPLEMENTARY_DATA, {}).get("step2_counter") == 0
|
|
|
|
|
|
def test_step_through_no_hooks():
|
|
"""Test that step_through doesn't execute hooks."""
|
|
step = MockStep("test_step")
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
hook_calls = []
|
|
|
|
def tracking_hook(idx: int, transition: EnvTransition):
|
|
hook_calls.append(f"hook_called_step_{idx}")
|
|
|
|
# Register hooks
|
|
pipeline.register_before_step_hook(tracking_hook)
|
|
pipeline.register_after_step_hook(tracking_hook)
|
|
|
|
# Use step_through
|
|
transition = create_transition()
|
|
results = list(pipeline.step_through(transition))
|
|
|
|
# Verify step was executed (counter should increment)
|
|
assert len(results) == 2 # Initial + 1 step
|
|
assert results[1][TransitionKey.COMPLEMENTARY_DATA]["test_step_counter"] == 0
|
|
|
|
# Verify hooks were NOT called
|
|
assert len(hook_calls) == 0
|
|
|
|
# Now use __call__ to verify hooks ARE called there
|
|
hook_calls.clear()
|
|
pipeline(transition)
|
|
|
|
# Verify hooks were called (before and after for 1 step = 2 calls)
|
|
assert len(hook_calls) == 2
|
|
assert hook_calls == ["hook_called_step_0", "hook_called_step_0"]
|
|
|
|
|
|
def test_indexing():
|
|
"""Test pipeline indexing."""
|
|
step1 = MockStep("step1")
|
|
step2 = MockStep("step2")
|
|
pipeline = DataProcessorPipeline([step1, step2])
|
|
|
|
# Test integer indexing
|
|
assert pipeline[0] is step1
|
|
assert pipeline[1] is step2
|
|
|
|
# Test slice indexing
|
|
sub_pipeline = pipeline[0:1]
|
|
assert isinstance(sub_pipeline, DataProcessorPipeline)
|
|
assert len(sub_pipeline) == 1
|
|
assert sub_pipeline[0] is step1
|
|
|
|
|
|
def test_hooks():
|
|
"""Test before/after step hooks."""
|
|
step = MockStep("test_step")
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
before_calls = []
|
|
after_calls = []
|
|
|
|
def before_hook(idx: int, transition: EnvTransition):
|
|
before_calls.append(idx)
|
|
|
|
def after_hook(idx: int, transition: EnvTransition):
|
|
after_calls.append(idx)
|
|
|
|
pipeline.register_before_step_hook(before_hook)
|
|
pipeline.register_after_step_hook(after_hook)
|
|
|
|
transition = create_transition()
|
|
pipeline(transition)
|
|
|
|
assert before_calls == [0]
|
|
assert after_calls == [0]
|
|
|
|
|
|
def test_unregister_hooks():
|
|
"""Test unregistering hooks from the pipeline."""
|
|
step = MockStep("test_step")
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
# Test before_step_hook
|
|
before_calls = []
|
|
|
|
def before_hook(idx: int, transition: EnvTransition):
|
|
before_calls.append(idx)
|
|
|
|
pipeline.register_before_step_hook(before_hook)
|
|
|
|
# Verify hook is registered
|
|
transition = create_transition()
|
|
pipeline(transition)
|
|
assert len(before_calls) == 1
|
|
|
|
# Unregister and verify it's no longer called
|
|
pipeline.unregister_before_step_hook(before_hook)
|
|
before_calls.clear()
|
|
pipeline(transition)
|
|
assert len(before_calls) == 0
|
|
|
|
# Test after_step_hook
|
|
after_calls = []
|
|
|
|
def after_hook(idx: int, transition: EnvTransition):
|
|
after_calls.append(idx)
|
|
|
|
pipeline.register_after_step_hook(after_hook)
|
|
pipeline(transition)
|
|
assert len(after_calls) == 1
|
|
|
|
pipeline.unregister_after_step_hook(after_hook)
|
|
after_calls.clear()
|
|
pipeline(transition)
|
|
assert len(after_calls) == 0
|
|
|
|
|
|
def test_unregister_nonexistent_hook():
|
|
"""Test error handling when unregistering hooks that don't exist."""
|
|
pipeline = DataProcessorPipeline([MockStep()])
|
|
|
|
def some_hook(idx: int, transition: EnvTransition):
|
|
pass
|
|
|
|
def reset_hook():
|
|
pass
|
|
|
|
# Test unregistering hooks that were never registered
|
|
with pytest.raises(ValueError, match="not found in before_step_hooks"):
|
|
pipeline.unregister_before_step_hook(some_hook)
|
|
|
|
with pytest.raises(ValueError, match="not found in after_step_hooks"):
|
|
pipeline.unregister_after_step_hook(some_hook)
|
|
|
|
|
|
def test_multiple_hooks_and_selective_unregister():
|
|
"""Test registering multiple hooks and selectively unregistering them."""
|
|
pipeline = DataProcessorPipeline([MockStep("step1"), MockStep("step2")])
|
|
|
|
calls_1 = []
|
|
calls_2 = []
|
|
calls_3 = []
|
|
|
|
def hook1(idx: int, transition: EnvTransition):
|
|
calls_1.append(f"hook1_step{idx}")
|
|
|
|
def hook2(idx: int, transition: EnvTransition):
|
|
calls_2.append(f"hook2_step{idx}")
|
|
|
|
def hook3(idx: int, transition: EnvTransition):
|
|
calls_3.append(f"hook3_step{idx}")
|
|
|
|
# Register multiple hooks
|
|
pipeline.register_before_step_hook(hook1)
|
|
pipeline.register_before_step_hook(hook2)
|
|
pipeline.register_before_step_hook(hook3)
|
|
|
|
# Run pipeline - all hooks should be called for both steps
|
|
transition = create_transition()
|
|
pipeline(transition)
|
|
|
|
assert calls_1 == ["hook1_step0", "hook1_step1"]
|
|
assert calls_2 == ["hook2_step0", "hook2_step1"]
|
|
assert calls_3 == ["hook3_step0", "hook3_step1"]
|
|
|
|
# Clear calls
|
|
calls_1.clear()
|
|
calls_2.clear()
|
|
calls_3.clear()
|
|
|
|
# Unregister middle hook
|
|
pipeline.unregister_before_step_hook(hook2)
|
|
|
|
# Run again - only hook1 and hook3 should be called
|
|
pipeline(transition)
|
|
|
|
assert calls_1 == ["hook1_step0", "hook1_step1"]
|
|
assert calls_2 == [] # hook2 was unregistered
|
|
assert calls_3 == ["hook3_step0", "hook3_step1"]
|
|
|
|
|
|
def test_hook_execution_order_documentation():
|
|
"""Test and document that hooks are executed sequentially in registration order."""
|
|
pipeline = DataProcessorPipeline([MockStep("step")])
|
|
|
|
execution_order = []
|
|
|
|
def hook_a(idx: int, transition: EnvTransition):
|
|
execution_order.append("A")
|
|
|
|
def hook_b(idx: int, transition: EnvTransition):
|
|
execution_order.append("B")
|
|
|
|
def hook_c(idx: int, transition: EnvTransition):
|
|
execution_order.append("C")
|
|
|
|
# Register in specific order: A, B, C
|
|
pipeline.register_before_step_hook(hook_a)
|
|
pipeline.register_before_step_hook(hook_b)
|
|
pipeline.register_before_step_hook(hook_c)
|
|
|
|
transition = create_transition()
|
|
pipeline(transition)
|
|
|
|
# Verify execution order matches registration order
|
|
assert execution_order == ["A", "B", "C"]
|
|
|
|
# Test that after unregistering B and re-registering it, it goes to the end
|
|
pipeline.unregister_before_step_hook(hook_b)
|
|
execution_order.clear()
|
|
|
|
pipeline(transition)
|
|
assert execution_order == ["A", "C"] # B is gone
|
|
|
|
# Re-register B - it should now be at the end
|
|
pipeline.register_before_step_hook(hook_b)
|
|
execution_order.clear()
|
|
|
|
pipeline(transition)
|
|
assert execution_order == ["A", "C", "B"] # B is now last
|
|
|
|
|
|
def test_save_and_load_pretrained():
|
|
"""Test saving and loading pipeline.
|
|
|
|
This test demonstrates that JSON-serializable attributes (like counter)
|
|
are saved in the config and restored when the step is recreated.
|
|
"""
|
|
step1 = MockStep("step1")
|
|
step2 = MockStep("step2")
|
|
|
|
# Increment counters to have some state
|
|
step1.counter = 5
|
|
step2.counter = 10
|
|
|
|
pipeline = DataProcessorPipeline([step1, step2], name="TestPipeline")
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
# Save pipeline
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Check files were created
|
|
config_path = Path(tmp_dir) / "testpipeline.json" # Based on name="TestPipeline"
|
|
assert config_path.exists()
|
|
|
|
# Check config content
|
|
with open(config_path) as f:
|
|
config = json.load(f)
|
|
|
|
assert config["name"] == "TestPipeline"
|
|
assert len(config["steps"]) == 2
|
|
|
|
# Verify counters are saved in config, not in separate state files
|
|
assert config["steps"][0]["config"]["counter"] == 5
|
|
assert config["steps"][1]["config"]["counter"] == 10
|
|
|
|
# Load pipeline
|
|
loaded_pipeline = DataProcessorPipeline.from_pretrained(tmp_dir, config_filename="testpipeline.json")
|
|
|
|
assert loaded_pipeline.name == "TestPipeline"
|
|
assert len(loaded_pipeline) == 2
|
|
|
|
# Check that counter was restored from config
|
|
assert loaded_pipeline.steps[0].counter == 5
|
|
assert loaded_pipeline.steps[1].counter == 10
|
|
|
|
|
|
def test_step_without_optional_methods():
|
|
"""Test pipeline with steps that don't implement optional methods."""
|
|
step = MockStepWithoutOptionalMethods(multiplier=3.0)
|
|
pipeline = DataProcessorPipeline(
|
|
[step], to_transition=identity_transition, to_output=identity_transition
|
|
) # Identity for EnvTransition input/output
|
|
|
|
transition = create_transition(reward=2.0)
|
|
result = pipeline(transition)
|
|
|
|
assert result[TransitionKey.REWARD] == 6.0 # 2.0 * 3.0
|
|
|
|
# Reset should work even if step doesn't implement reset
|
|
pipeline.reset()
|
|
|
|
# Save/load should work even without optional methods
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
loaded_pipeline = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir, config_filename="dataprocessorpipeline.json"
|
|
)
|
|
assert len(loaded_pipeline) == 1
|
|
|
|
|
|
def test_mixed_json_and_tensor_state():
|
|
"""Test step with both JSON attributes and tensor state."""
|
|
step = MockStepWithTensorState(name="stats", learning_rate=0.05, window_size=5)
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
# Process some transitions with rewards
|
|
for i in range(10):
|
|
transition = create_transition(reward=float(i))
|
|
pipeline(transition)
|
|
|
|
# Check state
|
|
assert step.running_count.item() == 10
|
|
assert step.learning_rate == 0.05
|
|
|
|
# Save and load
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Check that both config and state files were created
|
|
config_path = Path(tmp_dir) / "dataprocessorpipeline.json" # Default name is "RobotProcessor"
|
|
state_path = Path(tmp_dir) / "dataprocessorpipeline_step_0.safetensors"
|
|
assert config_path.exists()
|
|
assert state_path.exists()
|
|
|
|
# Load and verify
|
|
loaded_pipeline = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir, config_filename="dataprocessorpipeline.json"
|
|
)
|
|
loaded_step = loaded_pipeline.steps[0]
|
|
|
|
# Check JSON attributes were restored
|
|
assert loaded_step.name == "stats"
|
|
assert loaded_step.learning_rate == 0.05
|
|
assert loaded_step.window_size == 5
|
|
|
|
# Check tensor state was restored
|
|
assert loaded_step.running_count.item() == 10
|
|
assert torch.allclose(loaded_step.running_mean, step.running_mean)
|
|
|
|
|
|
class MockModuleStep(ProcessorStep, nn.Module):
|
|
"""Mock step that inherits from nn.Module to test state_dict handling of module parameters."""
|
|
|
|
def __init__(self, input_dim: int = 10, hidden_dim: int = 5):
|
|
super().__init__()
|
|
self.input_dim = input_dim
|
|
self.hidden_dim = hidden_dim
|
|
self.linear = nn.Linear(input_dim, hidden_dim)
|
|
self.running_mean = nn.Parameter(torch.zeros(hidden_dim), requires_grad=False)
|
|
self.counter = 0 # Non-tensor state
|
|
|
|
def forward(self, x: torch.Tensor) -> torch.Tensor:
|
|
return self.linear(x)
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
"""Process transition and update running mean."""
|
|
obs = transition.get(TransitionKey.OBSERVATION)
|
|
|
|
if obs is not None and isinstance(obs, torch.Tensor):
|
|
# Process observation through linear layer
|
|
processed = self.forward(obs[:, : self.input_dim])
|
|
|
|
# Update running mean in-place (don't reassign the parameter)
|
|
with torch.no_grad():
|
|
self.running_mean.mul_(0.9).add_(processed.mean(dim=0), alpha=0.1)
|
|
|
|
self.counter += 1
|
|
|
|
return transition
|
|
|
|
def get_config(self) -> dict[str, Any]:
|
|
return {
|
|
"input_dim": self.input_dim,
|
|
"hidden_dim": self.hidden_dim,
|
|
"counter": self.counter,
|
|
}
|
|
|
|
def state_dict(self) -> dict[str, torch.Tensor]:
|
|
"""Override to return all module parameters and buffers."""
|
|
# Get the module's state dict (includes all parameters and buffers)
|
|
return nn.Module.state_dict(self)
|
|
|
|
def load_state_dict(self, state: dict[str, torch.Tensor]) -> None:
|
|
"""Override to load all module parameters and buffers."""
|
|
# Use the module's load_state_dict
|
|
nn.Module.load_state_dict(self, state)
|
|
|
|
def reset(self) -> None:
|
|
self.running_mean.zero_()
|
|
self.counter = 0
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
# We do not test features here
|
|
return features
|
|
|
|
|
|
class MockNonModuleStepWithState(ProcessorStep):
|
|
"""Mock step that explicitly does NOT inherit from nn.Module but has tensor state.
|
|
|
|
This tests the state_dict/load_state_dict path for regular classes.
|
|
"""
|
|
|
|
def __init__(self, name: str = "non_module_step", feature_dim: int = 10):
|
|
self.name = name
|
|
self.feature_dim = feature_dim
|
|
|
|
# Initialize tensor state - these are regular tensors, not nn.Parameters
|
|
self.weights = torch.randn(feature_dim, feature_dim)
|
|
self.bias = torch.zeros(feature_dim)
|
|
self.running_stats = torch.zeros(feature_dim)
|
|
self.step_count = torch.tensor(0)
|
|
|
|
# Non-tensor state
|
|
self.config_value = 42
|
|
self.history = []
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
"""Process transition using tensor operations."""
|
|
obs = transition.get(TransitionKey.OBSERVATION)
|
|
comp_data = transition.get(TransitionKey.COMPLEMENTARY_DATA, {})
|
|
|
|
if obs is not None and isinstance(obs, torch.Tensor) and obs.numel() >= self.feature_dim:
|
|
# Perform some tensor operations
|
|
flat_obs = obs.flatten()[: self.feature_dim]
|
|
|
|
# Simple linear transformation (ensure dimensions match for matmul)
|
|
output = torch.matmul(self.weights.T, flat_obs) + self.bias
|
|
|
|
# Update running stats
|
|
self.running_stats = 0.9 * self.running_stats + 0.1 * output
|
|
self.step_count += 1
|
|
|
|
# Add to complementary data
|
|
comp_data = {} if comp_data is None else dict(comp_data)
|
|
comp_data[f"{self.name}_mean_output"] = output.mean().item()
|
|
comp_data[f"{self.name}_steps"] = self.step_count.item()
|
|
|
|
# Return updated transition
|
|
new_transition = transition.copy()
|
|
new_transition[TransitionKey.COMPLEMENTARY_DATA] = comp_data
|
|
return new_transition
|
|
|
|
return transition
|
|
|
|
def get_config(self) -> dict[str, Any]:
|
|
return {
|
|
"name": self.name,
|
|
"feature_dim": self.feature_dim,
|
|
"config_value": self.config_value,
|
|
}
|
|
|
|
def state_dict(self) -> dict[str, torch.Tensor]:
|
|
"""Return only tensor state."""
|
|
return {
|
|
"weights": self.weights,
|
|
"bias": self.bias,
|
|
"running_stats": self.running_stats,
|
|
"step_count": self.step_count,
|
|
}
|
|
|
|
def load_state_dict(self, state: dict[str, torch.Tensor]) -> None:
|
|
"""Load tensor state."""
|
|
self.weights = state["weights"]
|
|
self.bias = state["bias"]
|
|
self.running_stats = state["running_stats"]
|
|
self.step_count = state["step_count"]
|
|
|
|
def reset(self) -> None:
|
|
"""Reset statistics but keep learned parameters."""
|
|
self.running_stats.zero_()
|
|
self.step_count.zero_()
|
|
self.history.clear()
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
# We do not test features here
|
|
return features
|
|
|
|
|
|
# Tests for overrides functionality
|
|
@dataclass
|
|
class MockStepWithNonSerializableParam(ProcessorStep):
|
|
"""Mock step that requires a non-serializable parameter."""
|
|
|
|
def __init__(self, name: str = "mock_env_step", multiplier: float = 1.0, env: Any = None):
|
|
self.name = name
|
|
# Add type validation for multiplier
|
|
if isinstance(multiplier, str):
|
|
raise ValueError(f"multiplier must be a number, got string '{multiplier}'")
|
|
if not isinstance(multiplier, (int, float)):
|
|
raise TypeError(f"multiplier must be a number, got {type(multiplier).__name__}")
|
|
self.multiplier = float(multiplier)
|
|
self.env = env # Non-serializable parameter (like gym.Env)
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
reward = transition.get(TransitionKey.REWARD)
|
|
comp_data = transition.get(TransitionKey.COMPLEMENTARY_DATA, {})
|
|
|
|
# Use the env parameter if provided
|
|
if self.env is not None:
|
|
comp_data = {} if comp_data is None else dict(comp_data)
|
|
comp_data[f"{self.name}_env_info"] = str(self.env)
|
|
|
|
# Apply multiplier to reward
|
|
new_transition = transition.copy()
|
|
if reward is not None:
|
|
new_transition[TransitionKey.REWARD] = reward * self.multiplier
|
|
|
|
if comp_data:
|
|
new_transition[TransitionKey.COMPLEMENTARY_DATA] = comp_data
|
|
|
|
return new_transition
|
|
|
|
def get_config(self) -> dict[str, Any]:
|
|
# Note: env is intentionally NOT included here as it's not serializable
|
|
return {
|
|
"name": self.name,
|
|
"multiplier": self.multiplier,
|
|
}
|
|
|
|
def state_dict(self) -> dict[str, torch.Tensor]:
|
|
return {}
|
|
|
|
def load_state_dict(self, state: dict[str, torch.Tensor]) -> None:
|
|
pass
|
|
|
|
def reset(self) -> None:
|
|
pass
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
# We do not test features here
|
|
return features
|
|
|
|
|
|
@ProcessorStepRegistry.register("registered_mock_step")
|
|
@dataclass
|
|
class RegisteredMockStep(ProcessorStep):
|
|
"""Mock step registered in the registry."""
|
|
|
|
value: int = 42
|
|
device: str = "cpu"
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
comp_data = transition.get(TransitionKey.COMPLEMENTARY_DATA, {})
|
|
|
|
comp_data = {} if comp_data is None else dict(comp_data)
|
|
comp_data["registered_step_value"] = self.value
|
|
comp_data["registered_step_device"] = self.device
|
|
|
|
new_transition = transition.copy()
|
|
new_transition[TransitionKey.COMPLEMENTARY_DATA] = comp_data
|
|
return new_transition
|
|
|
|
def get_config(self) -> dict[str, Any]:
|
|
return {
|
|
"value": self.value,
|
|
"device": self.device,
|
|
}
|
|
|
|
def state_dict(self) -> dict[str, torch.Tensor]:
|
|
return {}
|
|
|
|
def load_state_dict(self, state: dict[str, torch.Tensor]) -> None:
|
|
pass
|
|
|
|
def reset(self) -> None:
|
|
pass
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
# We do not test features here
|
|
return features
|
|
|
|
|
|
class MockEnvironment:
|
|
"""Mock environment for testing non-serializable parameters."""
|
|
|
|
def __init__(self, name: str):
|
|
self.name = name
|
|
|
|
def __str__(self):
|
|
return f"MockEnvironment({self.name})"
|
|
|
|
|
|
def test_from_pretrained_with_overrides():
|
|
"""Test loading processor with parameter overrides."""
|
|
# Create a processor with steps that need overrides
|
|
env_step = MockStepWithNonSerializableParam(name="env_step", multiplier=2.0)
|
|
registered_step = RegisteredMockStep(value=100, device="cpu")
|
|
|
|
pipeline = DataProcessorPipeline([env_step, registered_step], name="TestOverrides")
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
# Save the pipeline
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Create a mock environment for override
|
|
mock_env = MockEnvironment("test_env")
|
|
|
|
# Load with overrides
|
|
overrides = {
|
|
"MockStepWithNonSerializableParam": {
|
|
"env": mock_env,
|
|
"multiplier": 3.0, # Override the multiplier too
|
|
},
|
|
"registered_mock_step": {"device": "cuda", "value": 200},
|
|
}
|
|
|
|
loaded_pipeline = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir,
|
|
config_filename="testoverrides.json",
|
|
overrides=overrides,
|
|
to_transition=identity_transition,
|
|
to_output=identity_transition,
|
|
)
|
|
|
|
# Verify the pipeline was loaded correctly
|
|
assert len(loaded_pipeline) == 2
|
|
assert loaded_pipeline.name == "TestOverrides"
|
|
|
|
# Test the loaded steps
|
|
transition = create_transition(reward=1.0)
|
|
result = loaded_pipeline(transition)
|
|
|
|
# Check that overrides were applied
|
|
comp_data = result[TransitionKey.COMPLEMENTARY_DATA]
|
|
assert "env_step_env_info" in comp_data
|
|
assert comp_data["env_step_env_info"] == "MockEnvironment(test_env)"
|
|
assert comp_data["registered_step_value"] == 200
|
|
assert comp_data["registered_step_device"] == "cuda"
|
|
|
|
# Check that multiplier override was applied
|
|
assert result[TransitionKey.REWARD] == 3.0 # 1.0 * 3.0 (overridden multiplier)
|
|
|
|
|
|
def test_from_pretrained_with_partial_overrides():
|
|
"""Test loading processor with overrides for only some steps."""
|
|
step1 = MockStepWithNonSerializableParam(name="step1", multiplier=1.0)
|
|
step2 = MockStepWithNonSerializableParam(name="step2", multiplier=2.0)
|
|
|
|
pipeline = DataProcessorPipeline([step1, step2])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Override only one step
|
|
overrides = {"MockStepWithNonSerializableParam": {"multiplier": 5.0}}
|
|
|
|
# The current implementation applies overrides to ALL steps with the same class name
|
|
# Both steps will get the override
|
|
loaded_pipeline = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir,
|
|
config_filename="dataprocessorpipeline.json",
|
|
overrides=overrides,
|
|
to_transition=identity_transition,
|
|
to_output=identity_transition,
|
|
)
|
|
|
|
transition = create_transition(reward=1.0)
|
|
result = loaded_pipeline(transition)
|
|
|
|
# The reward should be affected by both steps, both getting the override
|
|
# First step: 1.0 * 5.0 = 5.0 (overridden)
|
|
# Second step: 5.0 * 5.0 = 25.0 (also overridden)
|
|
assert result[TransitionKey.REWARD] == 25.0
|
|
|
|
|
|
def test_from_pretrained_invalid_override_key():
|
|
"""Test that invalid override keys raise KeyError."""
|
|
step = MockStepWithNonSerializableParam()
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Try to override a non-existent step
|
|
overrides = {"NonExistentStep": {"param": "value"}}
|
|
|
|
with pytest.raises(KeyError, match="Override keys.*do not match any step"):
|
|
DataProcessorPipeline.from_pretrained(
|
|
tmp_dir, config_filename="dataprocessorpipeline.json", overrides=overrides
|
|
)
|
|
|
|
|
|
def test_from_pretrained_multiple_invalid_override_keys():
|
|
"""Test that multiple invalid override keys are reported."""
|
|
step = MockStepWithNonSerializableParam()
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Try to override multiple non-existent steps
|
|
overrides = {"NonExistentStep1": {"param": "value1"}, "NonExistentStep2": {"param": "value2"}}
|
|
|
|
with pytest.raises(KeyError) as exc_info:
|
|
DataProcessorPipeline.from_pretrained(
|
|
tmp_dir, config_filename="dataprocessorpipeline.json", overrides=overrides
|
|
)
|
|
|
|
error_msg = str(exc_info.value)
|
|
assert "NonExistentStep1" in error_msg
|
|
assert "NonExistentStep2" in error_msg
|
|
assert "Available step keys" in error_msg
|
|
|
|
|
|
def test_from_pretrained_registered_step_override():
|
|
"""Test overriding registered steps using registry names."""
|
|
registered_step = RegisteredMockStep(value=50, device="cpu")
|
|
pipeline = DataProcessorPipeline([registered_step])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Override using registry name
|
|
overrides = {"registered_mock_step": {"value": 999, "device": "cuda"}}
|
|
|
|
loaded_pipeline = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir,
|
|
config_filename="dataprocessorpipeline.json",
|
|
overrides=overrides,
|
|
to_transition=identity_transition,
|
|
to_output=identity_transition,
|
|
)
|
|
|
|
# Test that overrides were applied
|
|
transition = create_transition()
|
|
result = loaded_pipeline(transition)
|
|
|
|
comp_data = result[TransitionKey.COMPLEMENTARY_DATA]
|
|
assert comp_data["registered_step_value"] == 999
|
|
assert comp_data["registered_step_device"] == "cuda"
|
|
|
|
|
|
def test_from_pretrained_mixed_registered_and_unregistered():
|
|
"""Test overriding both registered and unregistered steps."""
|
|
unregistered_step = MockStepWithNonSerializableParam(name="unregistered", multiplier=1.0)
|
|
registered_step = RegisteredMockStep(value=10, device="cpu")
|
|
|
|
pipeline = DataProcessorPipeline([unregistered_step, registered_step])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
mock_env = MockEnvironment("mixed_test")
|
|
|
|
overrides = {
|
|
"MockStepWithNonSerializableParam": {"env": mock_env, "multiplier": 4.0},
|
|
"registered_mock_step": {"value": 777},
|
|
}
|
|
|
|
loaded_pipeline = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir,
|
|
config_filename="dataprocessorpipeline.json",
|
|
overrides=overrides,
|
|
to_transition=identity_transition,
|
|
to_output=identity_transition,
|
|
)
|
|
|
|
# Test both steps
|
|
transition = create_transition(reward=2.0)
|
|
result = loaded_pipeline(transition)
|
|
|
|
comp_data = result[TransitionKey.COMPLEMENTARY_DATA]
|
|
assert comp_data["unregistered_env_info"] == "MockEnvironment(mixed_test)"
|
|
assert comp_data["registered_step_value"] == 777
|
|
assert result[TransitionKey.REWARD] == 8.0 # 2.0 * 4.0
|
|
|
|
|
|
def test_from_pretrained_no_overrides():
|
|
"""Test that from_pretrained works without overrides (backward compatibility)."""
|
|
step = MockStepWithNonSerializableParam(name="no_override", multiplier=3.0)
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Load without overrides
|
|
loaded_pipeline = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir,
|
|
config_filename="dataprocessorpipeline.json",
|
|
to_transition=identity_transition,
|
|
to_output=identity_transition,
|
|
)
|
|
|
|
assert len(loaded_pipeline) == 1
|
|
|
|
# Test that the step works (env will be None)
|
|
transition = create_transition(reward=1.0)
|
|
result = loaded_pipeline(transition)
|
|
|
|
assert result[TransitionKey.REWARD] == 3.0 # 1.0 * 3.0
|
|
|
|
|
|
def test_from_pretrained_empty_overrides():
|
|
"""Test that from_pretrained works with empty overrides dict."""
|
|
step = MockStepWithNonSerializableParam(multiplier=2.0)
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Load with empty overrides
|
|
loaded_pipeline = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir,
|
|
config_filename="dataprocessorpipeline.json",
|
|
overrides={},
|
|
to_transition=identity_transition,
|
|
to_output=identity_transition,
|
|
)
|
|
|
|
assert len(loaded_pipeline) == 1
|
|
|
|
# Test that the step works normally
|
|
transition = create_transition(reward=1.0)
|
|
result = loaded_pipeline(transition)
|
|
|
|
assert result[TransitionKey.REWARD] == 2.0
|
|
|
|
|
|
def test_from_pretrained_override_instantiation_error():
|
|
"""Test that instantiation errors with overrides are properly reported."""
|
|
step = MockStepWithNonSerializableParam(multiplier=1.0)
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Try to override with invalid parameter type
|
|
overrides = {
|
|
"MockStepWithNonSerializableParam": {
|
|
"multiplier": "invalid_type" # Should be float, not string
|
|
}
|
|
}
|
|
|
|
with pytest.raises(ValueError, match="Failed to instantiate processor step"):
|
|
DataProcessorPipeline.from_pretrained(
|
|
tmp_dir, config_filename="dataprocessorpipeline.json", overrides=overrides
|
|
)
|
|
|
|
|
|
def test_from_pretrained_with_state_and_overrides():
|
|
"""Test that overrides work correctly with steps that have tensor state."""
|
|
step = MockStepWithTensorState(name="tensor_step", learning_rate=0.01, window_size=5)
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
# Process some data to create state
|
|
for i in range(10):
|
|
transition = create_transition(reward=float(i))
|
|
pipeline(transition)
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Load with overrides
|
|
overrides = {
|
|
"MockStepWithTensorState": {
|
|
"learning_rate": 0.05, # Override learning rate
|
|
"window_size": 3, # Override window size
|
|
}
|
|
}
|
|
|
|
loaded_pipeline = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir, config_filename="dataprocessorpipeline.json", overrides=overrides
|
|
)
|
|
loaded_step = loaded_pipeline.steps[0]
|
|
|
|
# Check that config overrides were applied
|
|
assert loaded_step.learning_rate == 0.05
|
|
assert loaded_step.window_size == 3
|
|
|
|
# Check that tensor state was preserved
|
|
assert loaded_step.running_count.item() == 10
|
|
|
|
# The running_mean should still have the original window_size (5) from saved state
|
|
# but the new step will use window_size=3 for future operations
|
|
assert loaded_step.running_mean.shape[0] == 5 # From saved state
|
|
|
|
|
|
def test_from_pretrained_override_error_messages():
|
|
"""Test that error messages for override failures are helpful."""
|
|
step1 = MockStepWithNonSerializableParam(name="step1")
|
|
step2 = RegisteredMockStep()
|
|
pipeline = DataProcessorPipeline([step1, step2])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Test with invalid override key
|
|
overrides = {"WrongStepName": {"param": "value"}}
|
|
|
|
with pytest.raises(KeyError) as exc_info:
|
|
DataProcessorPipeline.from_pretrained(
|
|
tmp_dir, config_filename="dataprocessorpipeline.json", overrides=overrides
|
|
)
|
|
|
|
error_msg = str(exc_info.value)
|
|
assert "WrongStepName" in error_msg
|
|
assert "Available step keys" in error_msg
|
|
assert "MockStepWithNonSerializableParam" in error_msg
|
|
assert "registered_mock_step" in error_msg
|
|
|
|
|
|
def test_repr_empty_processor():
|
|
"""Test __repr__ with empty processor."""
|
|
pipeline = DataProcessorPipeline()
|
|
repr_str = repr(pipeline)
|
|
|
|
expected = "DataProcessorPipeline(name='DataProcessorPipeline', steps=0: [])"
|
|
assert repr_str == expected
|
|
|
|
|
|
def test_repr_single_step():
|
|
"""Test __repr__ with single step."""
|
|
step = MockStep("test_step")
|
|
pipeline = DataProcessorPipeline([step])
|
|
repr_str = repr(pipeline)
|
|
|
|
expected = "DataProcessorPipeline(name='DataProcessorPipeline', steps=1: [MockStep])"
|
|
assert repr_str == expected
|
|
|
|
|
|
def test_repr_multiple_steps_under_limit():
|
|
"""Test __repr__ with 2-3 steps (all shown)."""
|
|
step1 = MockStep("step1")
|
|
step2 = MockStepWithoutOptionalMethods()
|
|
pipeline = DataProcessorPipeline([step1, step2])
|
|
repr_str = repr(pipeline)
|
|
|
|
expected = "DataProcessorPipeline(name='DataProcessorPipeline', steps=2: [MockStep, MockStepWithoutOptionalMethods])"
|
|
assert repr_str == expected
|
|
|
|
# Test with 3 steps (boundary case)
|
|
step3 = MockStepWithTensorState()
|
|
pipeline = DataProcessorPipeline([step1, step2, step3])
|
|
repr_str = repr(pipeline)
|
|
|
|
expected = "DataProcessorPipeline(name='DataProcessorPipeline', steps=3: [MockStep, MockStepWithoutOptionalMethods, MockStepWithTensorState])"
|
|
assert repr_str == expected
|
|
|
|
|
|
def test_repr_many_steps_truncated():
|
|
"""Test __repr__ with more than 3 steps (truncated with ellipsis)."""
|
|
step1 = MockStep("step1")
|
|
step2 = MockStepWithoutOptionalMethods()
|
|
step3 = MockStepWithTensorState()
|
|
step4 = MockModuleStep()
|
|
step5 = MockNonModuleStepWithState()
|
|
|
|
pipeline = DataProcessorPipeline([step1, step2, step3, step4, step5])
|
|
repr_str = repr(pipeline)
|
|
|
|
expected = "DataProcessorPipeline(name='DataProcessorPipeline', steps=5: [MockStep, MockStepWithoutOptionalMethods, ..., MockNonModuleStepWithState])"
|
|
assert repr_str == expected
|
|
|
|
|
|
def test_repr_with_custom_name():
|
|
"""Test __repr__ with custom processor name."""
|
|
step = MockStep("test_step")
|
|
pipeline = DataProcessorPipeline([step], name="CustomProcessor")
|
|
repr_str = repr(pipeline)
|
|
|
|
expected = "DataProcessorPipeline(name='CustomProcessor', steps=1: [MockStep])"
|
|
assert repr_str == expected
|
|
|
|
|
|
def test_repr_with_seed():
|
|
"""Test __repr__ with seed parameter."""
|
|
step = MockStep("test_step")
|
|
pipeline = DataProcessorPipeline([step])
|
|
repr_str = repr(pipeline)
|
|
|
|
expected = "DataProcessorPipeline(name='DataProcessorPipeline', steps=1: [MockStep])"
|
|
assert repr_str == expected
|
|
|
|
|
|
def test_repr_with_custom_name_and_seed():
|
|
"""Test __repr__ with both custom name and seed."""
|
|
step1 = MockStep("step1")
|
|
step2 = MockStepWithoutOptionalMethods()
|
|
pipeline = DataProcessorPipeline([step1, step2], name="MyProcessor")
|
|
repr_str = repr(pipeline)
|
|
|
|
expected = (
|
|
"DataProcessorPipeline(name='MyProcessor', steps=2: [MockStep, MockStepWithoutOptionalMethods])"
|
|
)
|
|
assert repr_str == expected
|
|
|
|
|
|
def test_repr_without_seed():
|
|
"""Test __repr__ when seed is explicitly None (should not show seed)."""
|
|
step = MockStep("test_step")
|
|
pipeline = DataProcessorPipeline([step], name="TestProcessor")
|
|
repr_str = repr(pipeline)
|
|
|
|
expected = "DataProcessorPipeline(name='TestProcessor', steps=1: [MockStep])"
|
|
assert repr_str == expected
|
|
|
|
|
|
def test_repr_various_step_types():
|
|
"""Test __repr__ with different types of steps to verify class name extraction."""
|
|
step1 = MockStep()
|
|
step2 = MockStepWithTensorState()
|
|
step3 = MockModuleStep()
|
|
step4 = MockNonModuleStepWithState()
|
|
|
|
pipeline = DataProcessorPipeline([step1, step2, step3, step4], name="MixedSteps")
|
|
repr_str = repr(pipeline)
|
|
|
|
expected = "DataProcessorPipeline(name='MixedSteps', steps=4: [MockStep, MockStepWithTensorState, ..., MockNonModuleStepWithState])"
|
|
assert repr_str == expected
|
|
|
|
|
|
def test_repr_edge_case_long_names():
|
|
"""Test __repr__ handles steps with long class names properly."""
|
|
step1 = MockStepWithNonSerializableParam()
|
|
step2 = MockStepWithoutOptionalMethods()
|
|
step3 = MockStepWithTensorState()
|
|
step4 = MockNonModuleStepWithState()
|
|
|
|
pipeline = DataProcessorPipeline([step1, step2, step3, step4], name="LongNames")
|
|
repr_str = repr(pipeline)
|
|
|
|
expected = "DataProcessorPipeline(name='LongNames', steps=4: [MockStepWithNonSerializableParam, MockStepWithoutOptionalMethods, ..., MockNonModuleStepWithState])"
|
|
assert repr_str == expected
|
|
|
|
|
|
# Tests for config filename features and multiple processors
|
|
def test_save_with_custom_config_filename():
|
|
"""Test saving processor with custom config filename."""
|
|
step = MockStep("test")
|
|
pipeline = DataProcessorPipeline([step], name="TestProcessor")
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
# Save with custom filename
|
|
pipeline.save_pretrained(tmp_dir, config_filename="my_custom_config.json")
|
|
|
|
# Check file exists
|
|
config_path = Path(tmp_dir) / "my_custom_config.json"
|
|
assert config_path.exists()
|
|
|
|
# Check content
|
|
with open(config_path) as f:
|
|
config = json.load(f)
|
|
assert config["name"] == "TestProcessor"
|
|
|
|
# Load with specific filename
|
|
loaded = DataProcessorPipeline.from_pretrained(tmp_dir, config_filename="my_custom_config.json")
|
|
assert loaded.name == "TestProcessor"
|
|
|
|
|
|
def test_multiple_processors_same_directory():
|
|
"""Test saving multiple processors to the same directory with different config files."""
|
|
# Create different processors
|
|
preprocessor = DataProcessorPipeline([MockStep("pre1"), MockStep("pre2")], name="preprocessor")
|
|
|
|
postprocessor = DataProcessorPipeline(
|
|
[MockStepWithoutOptionalMethods(multiplier=0.5)], name="postprocessor"
|
|
)
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
# Save both to same directory
|
|
preprocessor.save_pretrained(tmp_dir)
|
|
postprocessor.save_pretrained(tmp_dir)
|
|
|
|
# Check both config files exist
|
|
assert (Path(tmp_dir) / "preprocessor.json").exists()
|
|
assert (Path(tmp_dir) / "postprocessor.json").exists()
|
|
|
|
# Load them back
|
|
loaded_pre = DataProcessorPipeline.from_pretrained(tmp_dir, config_filename="preprocessor.json")
|
|
loaded_post = DataProcessorPipeline.from_pretrained(tmp_dir, config_filename="postprocessor.json")
|
|
|
|
assert loaded_pre.name == "preprocessor"
|
|
assert loaded_post.name == "postprocessor"
|
|
assert len(loaded_pre) == 2
|
|
assert len(loaded_post) == 1
|
|
|
|
|
|
def test_explicit_config_filename_loading():
|
|
"""Test explicit config filename loading (no more auto-detection)."""
|
|
step = MockStepWithTensorState()
|
|
pipeline = DataProcessorPipeline([step], name="SingleConfig")
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Load with explicit config_filename (now required)
|
|
loaded = DataProcessorPipeline.from_pretrained(tmp_dir, config_filename="singleconfig.json")
|
|
assert loaded.name == "SingleConfig"
|
|
|
|
|
|
def test_explicit_config_selection_with_multiple_configs():
|
|
"""Test explicit config selection when multiple configs exist."""
|
|
proc1 = DataProcessorPipeline([MockStep()], name="processor1")
|
|
proc2 = DataProcessorPipeline([MockStep()], name="processor2")
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
proc1.save_pretrained(tmp_dir)
|
|
proc2.save_pretrained(tmp_dir)
|
|
|
|
# Can load specific configs explicitly
|
|
loaded1 = DataProcessorPipeline.from_pretrained(tmp_dir, config_filename="processor1.json")
|
|
loaded2 = DataProcessorPipeline.from_pretrained(tmp_dir, config_filename="processor2.json")
|
|
|
|
assert loaded1.name == "processor1"
|
|
assert loaded2.name == "processor2"
|
|
|
|
|
|
def test_state_file_naming_with_indices():
|
|
"""Test that state files include pipeline name and step indices to avoid conflicts."""
|
|
# Create multiple steps of same type with state
|
|
step1 = MockStepWithTensorState(name="norm1", window_size=5)
|
|
step2 = MockStepWithTensorState(name="norm2", window_size=10)
|
|
step3 = MockModuleStep(input_dim=5)
|
|
|
|
pipeline = DataProcessorPipeline([step1, step2, step3])
|
|
|
|
# Process some data to create state
|
|
for i in range(5):
|
|
transition = create_transition(observation=torch.randn(2, 5), reward=float(i))
|
|
pipeline(transition)
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Check state files have indices
|
|
state_files = sorted(Path(tmp_dir).glob("*.safetensors"))
|
|
assert len(state_files) == 3
|
|
|
|
# Files should be named with pipeline name prefix and indices
|
|
expected_names = [
|
|
"dataprocessorpipeline_step_0.safetensors",
|
|
"dataprocessorpipeline_step_1.safetensors",
|
|
"dataprocessorpipeline_step_2.safetensors",
|
|
]
|
|
actual_names = [f.name for f in state_files]
|
|
assert actual_names == expected_names
|
|
|
|
|
|
def test_state_file_naming_with_registry():
|
|
"""Test state file naming for registered steps includes pipeline name, index and registry name."""
|
|
|
|
# Register a test step
|
|
@ProcessorStepRegistry.register("test_stateful_step")
|
|
@dataclass
|
|
class TestStatefulStep(ProcessorStep):
|
|
value: int = 0
|
|
|
|
def __init__(self, value: int = 0):
|
|
self.value = value
|
|
self.state_tensor = torch.randn(3, 3)
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
return transition
|
|
|
|
def get_config(self):
|
|
return {"value": self.value}
|
|
|
|
def state_dict(self):
|
|
return {"state_tensor": self.state_tensor}
|
|
|
|
def load_state_dict(self, state):
|
|
self.state_tensor = state["state_tensor"]
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
# We do not test features here
|
|
return features
|
|
|
|
try:
|
|
# Create pipeline with registered steps
|
|
step1 = TestStatefulStep(1)
|
|
step2 = TestStatefulStep(2)
|
|
pipeline = DataProcessorPipeline([step1, step2])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Check state files
|
|
state_files = sorted(Path(tmp_dir).glob("*.safetensors"))
|
|
assert len(state_files) == 2
|
|
|
|
# Should include pipeline name, index and registry name
|
|
expected_names = [
|
|
"dataprocessorpipeline_step_0_test_stateful_step.safetensors",
|
|
"dataprocessorpipeline_step_1_test_stateful_step.safetensors",
|
|
]
|
|
actual_names = [f.name for f in state_files]
|
|
assert actual_names == expected_names
|
|
|
|
finally:
|
|
# Cleanup registry
|
|
ProcessorStepRegistry.unregister("test_stateful_step")
|
|
|
|
|
|
# More comprehensive override tests
|
|
def test_override_with_nested_config():
|
|
"""Test overrides with nested configuration dictionaries."""
|
|
|
|
@ProcessorStepRegistry.register("complex_config_step")
|
|
@dataclass
|
|
class ComplexConfigStep(ProcessorStep):
|
|
name: str = "complex"
|
|
simple_param: int = 42
|
|
nested_config: dict = None
|
|
|
|
def __post_init__(self):
|
|
if self.nested_config is None:
|
|
self.nested_config = {"level1": {"level2": "default"}}
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
comp_data = transition.get(TransitionKey.COMPLEMENTARY_DATA, {})
|
|
comp_data = dict(comp_data)
|
|
comp_data["config_value"] = self.nested_config.get("level1", {}).get("level2", "missing")
|
|
|
|
new_transition = transition.copy()
|
|
new_transition[TransitionKey.COMPLEMENTARY_DATA] = comp_data
|
|
return new_transition
|
|
|
|
def get_config(self):
|
|
return {"name": self.name, "simple_param": self.simple_param, "nested_config": self.nested_config}
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
# We do not test features here
|
|
return features
|
|
|
|
try:
|
|
step = ComplexConfigStep()
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Load with nested override
|
|
loaded = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir,
|
|
config_filename="dataprocessorpipeline.json",
|
|
overrides={"complex_config_step": {"nested_config": {"level1": {"level2": "overridden"}}}},
|
|
to_transition=identity_transition,
|
|
to_output=identity_transition,
|
|
)
|
|
|
|
# Test that override worked
|
|
transition = create_transition()
|
|
result = loaded(transition)
|
|
assert result[TransitionKey.COMPLEMENTARY_DATA]["config_value"] == "overridden"
|
|
finally:
|
|
ProcessorStepRegistry.unregister("complex_config_step")
|
|
|
|
|
|
def test_override_preserves_defaults():
|
|
"""Test that overrides only affect specified parameters."""
|
|
step = MockStepWithNonSerializableParam(name="test", multiplier=2.0)
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Override only one parameter
|
|
loaded = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir,
|
|
config_filename="dataprocessorpipeline.json",
|
|
overrides={
|
|
"MockStepWithNonSerializableParam": {
|
|
"multiplier": 5.0 # Only override multiplier
|
|
}
|
|
},
|
|
)
|
|
|
|
# Check that name was preserved from saved config
|
|
loaded_step = loaded.steps[0]
|
|
assert loaded_step.name == "test" # Original value
|
|
assert loaded_step.multiplier == 5.0 # Overridden value
|
|
|
|
|
|
def test_override_type_validation():
|
|
"""Test that type errors in overrides are caught properly."""
|
|
step = MockStepWithTensorState(learning_rate=0.01)
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Try to override with wrong type
|
|
overrides = {
|
|
"MockStepWithTensorState": {
|
|
"window_size": "not_an_int" # Should be int
|
|
}
|
|
}
|
|
|
|
with pytest.raises(ValueError, match="Failed to instantiate"):
|
|
DataProcessorPipeline.from_pretrained(
|
|
tmp_dir, config_filename="dataprocessorpipeline.json", overrides=overrides
|
|
)
|
|
|
|
|
|
def test_override_with_callables():
|
|
"""Test overriding with callable objects."""
|
|
|
|
@ProcessorStepRegistry.register("callable_step")
|
|
@dataclass
|
|
class CallableStep(ProcessorStep):
|
|
name: str = "callable_step"
|
|
transform_fn: Any = None
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
obs = transition.get(TransitionKey.OBSERVATION)
|
|
if obs is not None and self.transform_fn is not None:
|
|
processed_obs = {}
|
|
for k, v in obs.items():
|
|
processed_obs[k] = self.transform_fn(v)
|
|
|
|
new_transition = transition.copy()
|
|
new_transition[TransitionKey.OBSERVATION] = processed_obs
|
|
return new_transition
|
|
return transition
|
|
|
|
def get_config(self):
|
|
return {"name": self.name}
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
# We do not test features here
|
|
return features
|
|
|
|
try:
|
|
step = CallableStep()
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Define a transform function
|
|
def double_values(x):
|
|
if isinstance(x, (int, float)):
|
|
return x * 2
|
|
elif isinstance(x, torch.Tensor):
|
|
return x * 2
|
|
return x
|
|
|
|
# Load with callable override
|
|
loaded = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir,
|
|
config_filename="dataprocessorpipeline.json",
|
|
overrides={"callable_step": {"transform_fn": double_values}},
|
|
to_transition=identity_transition,
|
|
to_output=identity_transition,
|
|
)
|
|
|
|
# Test it works
|
|
transition = create_transition(observation={"value": torch.tensor(5.0)})
|
|
result = loaded(transition)
|
|
assert result[TransitionKey.OBSERVATION]["value"].item() == 10.0
|
|
finally:
|
|
ProcessorStepRegistry.unregister("callable_step")
|
|
|
|
|
|
def test_override_multiple_same_class_warning():
|
|
"""Test behavior when multiple steps of same class exist."""
|
|
step1 = MockStepWithNonSerializableParam(name="step1", multiplier=1.0)
|
|
step2 = MockStepWithNonSerializableParam(name="step2", multiplier=2.0)
|
|
pipeline = DataProcessorPipeline([step1, step2])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Override affects all instances of the class
|
|
loaded = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir,
|
|
config_filename="dataprocessorpipeline.json",
|
|
overrides={"MockStepWithNonSerializableParam": {"multiplier": 10.0}},
|
|
)
|
|
|
|
# Both steps get the same override
|
|
assert loaded.steps[0].multiplier == 10.0
|
|
assert loaded.steps[1].multiplier == 10.0
|
|
|
|
# But original names are preserved
|
|
assert loaded.steps[0].name == "step1"
|
|
assert loaded.steps[1].name == "step2"
|
|
|
|
|
|
def test_config_filename_special_characters():
|
|
"""Test config filenames with special characters are sanitized."""
|
|
# Processor name with special characters
|
|
pipeline = DataProcessorPipeline([MockStep()], name="My/Processor\\With:Special*Chars")
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Check that filename was sanitized
|
|
json_files = list(Path(tmp_dir).glob("*.json"))
|
|
assert len(json_files) == 1
|
|
|
|
# Should have replaced special chars with underscores
|
|
expected_name = "my_processor_with_special_chars.json"
|
|
assert json_files[0].name == expected_name
|
|
|
|
|
|
def test_state_file_naming_with_multiple_processors():
|
|
"""Test that state files are properly prefixed with pipeline names to avoid conflicts."""
|
|
# Create two processors with state
|
|
step1 = MockStepWithTensorState(name="norm", window_size=5)
|
|
preprocessor = DataProcessorPipeline([step1], name="PreProcessor")
|
|
|
|
step2 = MockStepWithTensorState(name="norm", window_size=10)
|
|
postprocessor = DataProcessorPipeline([step2], name="PostProcessor")
|
|
|
|
# Process some data to create state
|
|
for i in range(3):
|
|
transition = create_transition(reward=float(i))
|
|
preprocessor(transition)
|
|
postprocessor(transition)
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
# Save both processors to the same directory
|
|
preprocessor.save_pretrained(tmp_dir)
|
|
postprocessor.save_pretrained(tmp_dir)
|
|
|
|
# Check that all files exist and are distinct
|
|
assert (Path(tmp_dir) / "preprocessor.json").exists()
|
|
assert (Path(tmp_dir) / "postprocessor.json").exists()
|
|
assert (Path(tmp_dir) / "preprocessor_step_0.safetensors").exists()
|
|
assert (Path(tmp_dir) / "postprocessor_step_0.safetensors").exists()
|
|
|
|
# Load both back and verify they work correctly
|
|
loaded_pre = DataProcessorPipeline.from_pretrained(tmp_dir, config_filename="preprocessor.json")
|
|
loaded_post = DataProcessorPipeline.from_pretrained(tmp_dir, config_filename="postprocessor.json")
|
|
|
|
assert loaded_pre.name == "PreProcessor"
|
|
assert loaded_post.name == "PostProcessor"
|
|
assert loaded_pre.steps[0].window_size == 5
|
|
assert loaded_post.steps[0].window_size == 10
|
|
|
|
|
|
def test_override_with_device_strings():
|
|
"""Test overriding device parameters with string values."""
|
|
|
|
@ProcessorStepRegistry.register("device_aware_step")
|
|
@dataclass
|
|
class DeviceAwareStep(ProcessorStep):
|
|
device: str = "cpu"
|
|
|
|
def __init__(self, device: str = "cpu"):
|
|
self.device = device
|
|
self.buffer = torch.zeros(10, device=device)
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
return transition
|
|
|
|
def get_config(self):
|
|
return {"device": str(self.device)}
|
|
|
|
def state_dict(self):
|
|
return {"buffer": self.buffer}
|
|
|
|
def load_state_dict(self, state):
|
|
self.buffer = state["buffer"]
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
# We do not test features here
|
|
return features
|
|
|
|
try:
|
|
step = DeviceAwareStep(device="cpu")
|
|
pipeline = DataProcessorPipeline([step])
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Override device
|
|
if torch.cuda.is_available():
|
|
loaded = DataProcessorPipeline.from_pretrained(
|
|
tmp_dir,
|
|
config_filename="dataprocessorpipeline.json",
|
|
overrides={"device_aware_step": {"device": "cuda:0"}},
|
|
)
|
|
|
|
loaded_step = loaded.steps[0]
|
|
assert loaded_step.device == "cuda:0"
|
|
# Note: buffer will still be on CPU from saved state
|
|
# until .to() is called on the processor
|
|
|
|
finally:
|
|
ProcessorStepRegistry.unregister("device_aware_step")
|
|
|
|
|
|
def test_from_pretrained_nonexistent_path():
|
|
"""Test error handling when loading from non-existent sources."""
|
|
from huggingface_hub.errors import HfHubHTTPError
|
|
|
|
# Test with an invalid local path - should raise FileNotFoundError
|
|
with pytest.raises(FileNotFoundError):
|
|
DataProcessorPipeline.from_pretrained("/path/that/does/not/exist", config_filename="processor.json")
|
|
|
|
# Test with a path that doesn't exist as a directory
|
|
with pytest.raises(FileNotFoundError):
|
|
DataProcessorPipeline.from_pretrained("user/repo/extra/path", config_filename="processor.json")
|
|
|
|
# Test with a non-existent Hub repo
|
|
with pytest.raises((FileNotFoundError, HfHubHTTPError)):
|
|
DataProcessorPipeline.from_pretrained(
|
|
"nonexistent-user/nonexistent-repo", config_filename="processor.json"
|
|
)
|
|
|
|
# Test with a local directory that exists but has no config files
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
# Since the directory exists but has no config, it will raise FileNotFoundError
|
|
with pytest.raises(FileNotFoundError):
|
|
DataProcessorPipeline.from_pretrained(tmp_dir, config_filename="processor.json")
|
|
|
|
|
|
def test_save_load_with_custom_converter_functions():
|
|
"""Test that custom to_transition and to_output functions are NOT saved."""
|
|
|
|
def custom_to_transition(batch):
|
|
# Custom conversion logic
|
|
return {
|
|
TransitionKey.OBSERVATION: batch.get("obs"),
|
|
TransitionKey.ACTION: batch.get("act"),
|
|
TransitionKey.REWARD: batch.get("rew", 0.0),
|
|
TransitionKey.DONE: batch.get("done", False),
|
|
TransitionKey.TRUNCATED: batch.get("truncated", False),
|
|
TransitionKey.INFO: {},
|
|
TransitionKey.COMPLEMENTARY_DATA: {},
|
|
}
|
|
|
|
def custom_to_output(transition):
|
|
# Custom output format
|
|
return {
|
|
"obs": transition.get(TransitionKey.OBSERVATION),
|
|
"act": transition.get(TransitionKey.ACTION),
|
|
"rew": transition.get(TransitionKey.REWARD),
|
|
"done": transition.get(TransitionKey.DONE),
|
|
"truncated": transition.get(TransitionKey.TRUNCATED),
|
|
}
|
|
|
|
# Create processor with custom converters
|
|
pipeline = DataProcessorPipeline(
|
|
[MockStep()], to_transition=custom_to_transition, to_output=custom_to_output
|
|
)
|
|
|
|
with tempfile.TemporaryDirectory() as tmp_dir:
|
|
pipeline.save_pretrained(tmp_dir)
|
|
|
|
# Load - should use default converters
|
|
loaded = DataProcessorPipeline.from_pretrained(tmp_dir, config_filename="dataprocessorpipeline.json")
|
|
|
|
# Verify it uses default converters by checking with standard batch format
|
|
batch = {
|
|
"observation.image": torch.randn(1, 3, 32, 32),
|
|
"action": torch.randn(1, 7),
|
|
"next.reward": torch.tensor([1.0]),
|
|
"next.done": torch.tensor([False]),
|
|
"next.truncated": torch.tensor([False]),
|
|
"info": {},
|
|
}
|
|
|
|
# Should work with standard format (wouldn't work with custom converter)
|
|
result = loaded(batch)
|
|
# With new behavior, default to_output is _default_transition_to_batch, so result is batch dict
|
|
assert "observation.image" in result
|
|
|
|
|
|
class NonCompliantStep:
|
|
"""Intentionally non-compliant: missing features."""
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
return transition
|
|
|
|
|
|
class NonCallableStep(ProcessorStep):
|
|
"""Intentionally non-compliant: missing __call__."""
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
return features
|
|
|
|
|
|
def test_construction_rejects_step_without_call():
|
|
"""Test that DataProcessorPipeline rejects steps that don't inherit from ProcessorStep."""
|
|
with pytest.raises(
|
|
TypeError, match=r"Can't instantiate abstract class NonCallableStep with abstract method __call_"
|
|
):
|
|
DataProcessorPipeline([NonCallableStep()])
|
|
|
|
with pytest.raises(TypeError, match=r"must inherit from ProcessorStep"):
|
|
DataProcessorPipeline([NonCompliantStep()])
|
|
|
|
|
|
@dataclass
|
|
class FeatureContractAddStep(ProcessorStep):
|
|
"""Adds a PolicyFeature"""
|
|
|
|
key: str = "a"
|
|
value: PolicyFeature = PolicyFeature(type=FeatureType.STATE, shape=(1,))
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
return transition
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
features[PipelineFeatureType.OBSERVATION][self.key] = self.value
|
|
return features
|
|
|
|
|
|
@dataclass
|
|
class FeatureContractMutateStep(ProcessorStep):
|
|
"""Mutates a PolicyFeature"""
|
|
|
|
key: str = "a"
|
|
fn: Callable[[PolicyFeature | None], PolicyFeature] = identity_transition # noqa: E731
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
return transition
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
features[PipelineFeatureType.OBSERVATION][self.key] = self.fn(
|
|
features[PipelineFeatureType.OBSERVATION].get(self.key)
|
|
)
|
|
return features
|
|
|
|
|
|
@dataclass
|
|
class FeatureContractBadReturnStep(ProcessorStep):
|
|
"""Returns a non-dict"""
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
return transition
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
return ["not-a-dict"]
|
|
|
|
|
|
@dataclass
|
|
class FeatureContractRemoveStep(ProcessorStep):
|
|
"""Removes a PolicyFeature"""
|
|
|
|
key: str
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
return transition
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
features[PipelineFeatureType.OBSERVATION].pop(self.key, None)
|
|
return features
|
|
|
|
|
|
def test_features_orders_and_merges(policy_feature_factory):
|
|
p = DataProcessorPipeline(
|
|
[
|
|
FeatureContractAddStep("a", policy_feature_factory(FeatureType.STATE, (1,))),
|
|
FeatureContractMutateStep("a", lambda v: PolicyFeature(type=v.type, shape=(3,))),
|
|
FeatureContractAddStep("b", policy_feature_factory(FeatureType.ENV, (2,))),
|
|
]
|
|
)
|
|
out = p.transform_features({PipelineFeatureType.OBSERVATION: {}})
|
|
assert out[PipelineFeatureType.OBSERVATION]["a"].type == FeatureType.STATE and out[
|
|
PipelineFeatureType.OBSERVATION
|
|
]["a"].shape == (3,)
|
|
assert out[PipelineFeatureType.OBSERVATION]["b"].type == FeatureType.ENV and out[
|
|
PipelineFeatureType.OBSERVATION
|
|
]["b"].shape == (2,)
|
|
assert_contract_is_typed(out)
|
|
|
|
|
|
def test_features_respects_initial_without_mutation(policy_feature_factory):
|
|
initial = {
|
|
PipelineFeatureType.OBSERVATION: {
|
|
"seed": policy_feature_factory(FeatureType.STATE, (7,)),
|
|
"nested": policy_feature_factory(FeatureType.ENV, (0,)),
|
|
}
|
|
}
|
|
p = DataProcessorPipeline(
|
|
[
|
|
FeatureContractMutateStep("seed", lambda v: PolicyFeature(type=v.type, shape=(v.shape[0] + 1,))),
|
|
FeatureContractMutateStep(
|
|
"nested", lambda v: PolicyFeature(type=v.type, shape=(v.shape[0] + 5,))
|
|
),
|
|
]
|
|
)
|
|
out = p.transform_features(initial_features=initial)
|
|
|
|
assert out[PipelineFeatureType.OBSERVATION]["seed"].shape == (8,)
|
|
assert out[PipelineFeatureType.OBSERVATION]["nested"].shape == (5,)
|
|
# Initial dict must be preserved
|
|
assert initial[PipelineFeatureType.OBSERVATION]["seed"].shape == (7,)
|
|
assert initial[PipelineFeatureType.OBSERVATION]["nested"].shape == (0,)
|
|
|
|
assert_contract_is_typed(out)
|
|
|
|
|
|
def test_features_execution_order_tracking():
|
|
class Track(ProcessorStep):
|
|
def __init__(self, label):
|
|
self.label = label
|
|
|
|
def __call__(self, transition: EnvTransition) -> EnvTransition:
|
|
return transition
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
code = {"A": 1, "B": 2, "C": 3}[self.label]
|
|
pf = features[PipelineFeatureType.OBSERVATION].get(
|
|
"order", PolicyFeature(type=FeatureType.ENV, shape=())
|
|
)
|
|
features[PipelineFeatureType.OBSERVATION]["order"] = PolicyFeature(
|
|
type=pf.type, shape=pf.shape + (code,)
|
|
)
|
|
return features
|
|
|
|
out = DataProcessorPipeline([Track("A"), Track("B"), Track("C")]).transform_features(
|
|
initial_features={PipelineFeatureType.OBSERVATION: {}}
|
|
)
|
|
assert out[PipelineFeatureType.OBSERVATION]["order"].shape == (1, 2, 3)
|
|
|
|
|
|
def test_features_remove_key(policy_feature_factory):
|
|
p = DataProcessorPipeline(
|
|
[
|
|
FeatureContractAddStep("a", policy_feature_factory(FeatureType.STATE, (1,))),
|
|
FeatureContractRemoveStep("a"),
|
|
]
|
|
)
|
|
out = p.transform_features({PipelineFeatureType.OBSERVATION: {}})
|
|
assert "a" not in out[PipelineFeatureType.OBSERVATION]
|
|
|
|
|
|
def test_features_remove_from_initial(policy_feature_factory):
|
|
initial = {
|
|
PipelineFeatureType.OBSERVATION: {
|
|
"keep": policy_feature_factory(FeatureType.STATE, (1,)),
|
|
"drop": policy_feature_factory(FeatureType.STATE, (1,)),
|
|
},
|
|
}
|
|
p = DataProcessorPipeline([FeatureContractRemoveStep("drop")])
|
|
out = p.transform_features(initial_features=initial)
|
|
assert (
|
|
"drop" not in out[PipelineFeatureType.OBSERVATION]
|
|
and out[PipelineFeatureType.OBSERVATION]["keep"] == initial[PipelineFeatureType.OBSERVATION]["keep"]
|
|
)
|
|
|
|
|
|
@dataclass
|
|
class AddActionEEAndJointFeatures(ProcessorStep):
|
|
"""Adds both EE and JOINT action features."""
|
|
|
|
def __call__(self, tr):
|
|
return tr
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
# EE features
|
|
features[PipelineFeatureType.ACTION]["action.ee.x"] = float
|
|
features[PipelineFeatureType.ACTION]["action.ee.y"] = float
|
|
# JOINT features
|
|
features[PipelineFeatureType.ACTION]["action.j1.pos"] = float
|
|
features[PipelineFeatureType.ACTION]["action.j2.pos"] = float
|
|
return features
|
|
|
|
|
|
@dataclass
|
|
class AddObservationStateFeatures(ProcessorStep):
|
|
"""Adds state features (and optionally an image spec to test precedence)."""
|
|
|
|
add_front_image: bool = False
|
|
front_image_shape: tuple = (240, 320, 3)
|
|
|
|
def __call__(self, tr):
|
|
return tr
|
|
|
|
def transform_features(
|
|
self, features: dict[PipelineFeatureType, dict[str, PolicyFeature]]
|
|
) -> dict[PipelineFeatureType, dict[str, PolicyFeature]]:
|
|
# State features (mix EE and a joint state)
|
|
features[PipelineFeatureType.OBSERVATION]["observation.state.ee.x"] = float
|
|
features[PipelineFeatureType.OBSERVATION]["observation.state.j1.pos"] = float
|
|
if self.add_front_image:
|
|
features[PipelineFeatureType.OBSERVATION]["observation.images.front"] = self.front_image_shape
|
|
return features
|
|
|
|
|
|
def test_aggregate_joint_action_only():
|
|
rp = DataProcessorPipeline([AddActionEEAndJointFeatures()])
|
|
initial = {PipelineFeatureType.OBSERVATION: {"front": (480, 640, 3)}, PipelineFeatureType.ACTION: {}}
|
|
|
|
out = aggregate_pipeline_dataset_features(
|
|
pipeline=rp,
|
|
initial_features=initial,
|
|
use_videos=True,
|
|
patterns=["action.j1.pos", "action.j2.pos"],
|
|
)
|
|
|
|
# Expect only "action" with joint names
|
|
assert "action" in out and "observation.state" not in out
|
|
assert out["action"]["dtype"] == "float32"
|
|
assert set(out["action"]["names"]) == {"j1.pos", "j2.pos"}
|
|
assert out["action"]["shape"] == (len(out["action"]["names"]),)
|
|
|
|
|
|
def test_aggregate_ee_action_and_observation_with_videos():
|
|
rp = DataProcessorPipeline([AddActionEEAndJointFeatures(), AddObservationStateFeatures()])
|
|
initial = {"front": (480, 640, 3), "side": (720, 1280, 3)}
|
|
|
|
out = aggregate_pipeline_dataset_features(
|
|
pipeline=rp,
|
|
initial_features={PipelineFeatureType.OBSERVATION: initial, PipelineFeatureType.ACTION: {}},
|
|
use_videos=True,
|
|
patterns=["action.ee", "observation.state"],
|
|
)
|
|
|
|
# Action should pack only EE names
|
|
assert "action" in out
|
|
assert set(out["action"]["names"]) == {"ee.x", "ee.y"}
|
|
assert out["action"]["dtype"] == "float32"
|
|
|
|
# Observation state should pack both ee.x and j1.pos as a vector
|
|
assert "observation.state" in out
|
|
assert set(out["observation.state"]["names"]) == {"ee.x", "j1.pos"}
|
|
assert out["observation.state"]["dtype"] == "float32"
|
|
|
|
# Cameras from initial_features appear as videos
|
|
for cam in ("front", "side"):
|
|
key = f"observation.images.{cam}"
|
|
assert key in out
|
|
assert out[key]["dtype"] == "video"
|
|
assert out[key]["shape"] == initial[cam]
|
|
assert out[key]["names"] == ["height", "width", "channels"]
|
|
|
|
|
|
def test_aggregate_both_action_types():
|
|
rp = DataProcessorPipeline([AddActionEEAndJointFeatures()])
|
|
out = aggregate_pipeline_dataset_features(
|
|
pipeline=rp,
|
|
initial_features={PipelineFeatureType.ACTION: {}, PipelineFeatureType.OBSERVATION: {}},
|
|
use_videos=True,
|
|
patterns=["action.ee", "action.j1", "action.j2.pos"],
|
|
)
|
|
|
|
assert "action" in out
|
|
expected = {"ee.x", "ee.y", "j1.pos", "j2.pos"}
|
|
assert set(out["action"]["names"]) == expected
|
|
assert out["action"]["shape"] == (len(expected),)
|
|
|
|
|
|
def test_aggregate_images_when_use_videos_false():
|
|
rp = DataProcessorPipeline([AddObservationStateFeatures(add_front_image=True)])
|
|
initial = {"back": (480, 640, 3)}
|
|
|
|
out = aggregate_pipeline_dataset_features(
|
|
pipeline=rp,
|
|
initial_features={PipelineFeatureType.ACTION: {}, PipelineFeatureType.OBSERVATION: initial},
|
|
use_videos=False, # expect "image" dtype
|
|
patterns=None,
|
|
)
|
|
|
|
key = "observation.images.back"
|
|
key_front = "observation.images.front"
|
|
assert key not in out
|
|
assert key_front not in out
|
|
|
|
|
|
def test_aggregate_images_when_use_videos_true():
|
|
rp = DataProcessorPipeline([AddObservationStateFeatures(add_front_image=True)])
|
|
initial = {"back": (480, 640, 3)}
|
|
|
|
out = aggregate_pipeline_dataset_features(
|
|
pipeline=rp,
|
|
initial_features={PipelineFeatureType.OBSERVATION: initial, PipelineFeatureType.ACTION: {}},
|
|
use_videos=True,
|
|
patterns=None,
|
|
)
|
|
|
|
key = "observation.images.front"
|
|
key_back = "observation.images.back"
|
|
assert key in out
|
|
assert key_back in out
|
|
assert out[key]["dtype"] == "video"
|
|
assert out[key_back]["dtype"] == "video"
|
|
assert out[key_back]["shape"] == initial["back"]
|
|
|
|
|
|
def test_initial_camera_not_overridden_by_step_image():
|
|
# Step explicitly sets a different front image shape; initial has another shape.
|
|
# aggregate_pipeline_dataset_features should keep the step's value (setdefault behavior on initial cams).
|
|
rp = DataProcessorPipeline(
|
|
[AddObservationStateFeatures(add_front_image=True, front_image_shape=(240, 320, 3))]
|
|
)
|
|
initial = {"front": (480, 640, 3)} # should NOT override the step-provided (240, 320, 3)
|
|
|
|
out = aggregate_pipeline_dataset_features(
|
|
pipeline=rp,
|
|
initial_features={PipelineFeatureType.ACTION: {}, PipelineFeatureType.OBSERVATION: initial},
|
|
use_videos=True,
|
|
patterns=["observation.images.front"],
|
|
)
|
|
|
|
key = "observation.images.front"
|
|
assert key in out
|
|
assert out[key]["shape"] == (240, 320, 3) # from the step, not from initial
|