mirror of
https://github.com/huggingface/lerobot.git
synced 2026-07-23 17:56:07 +00:00
Add dsrl policy files
This commit is contained in:
@@ -0,0 +1,242 @@
|
|||||||
|
# !/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.
|
||||||
|
|
||||||
|
from dataclasses import dataclass, field
|
||||||
|
|
||||||
|
from lerobot.configs.policies import PreTrainedConfig
|
||||||
|
from lerobot.configs.types import NormalizationMode
|
||||||
|
from lerobot.optim.optimizers import MultiAdamConfig
|
||||||
|
from lerobot.utils.constants import ACTION, OBS_IMAGE, OBS_STATE
|
||||||
|
|
||||||
|
|
||||||
|
def is_image_feature(key: str) -> bool:
|
||||||
|
"""Check if a feature key represents an image feature.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
key: The feature key to check
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
True if the key represents an image feature, False otherwise
|
||||||
|
"""
|
||||||
|
return key.startswith(OBS_IMAGE)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class ConcurrencyConfig:
|
||||||
|
"""Configuration for the concurrency of the actor and learner.
|
||||||
|
Possible values are:
|
||||||
|
- "threads": Use threads for the actor and learner.
|
||||||
|
- "processes": Use processes for the actor and learner.
|
||||||
|
"""
|
||||||
|
|
||||||
|
actor: str = "threads"
|
||||||
|
learner: str = "threads"
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class ActorLearnerConfig:
|
||||||
|
learner_host: str = "127.0.0.1"
|
||||||
|
learner_port: int = 50051
|
||||||
|
policy_parameters_push_frequency: int = 4
|
||||||
|
queue_get_timeout: float = 2
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class CriticNetworkConfig:
|
||||||
|
hidden_dims: list[int] = field(default_factory=lambda: [256, 256])
|
||||||
|
activate_final: bool = True
|
||||||
|
final_activation: str | None = None
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class ActorNetworkConfig:
|
||||||
|
hidden_dims: list[int] = field(default_factory=lambda: [256, 256])
|
||||||
|
activate_final: bool = True
|
||||||
|
use_layer_norm: bool = True
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class NoiseActorConfig:
|
||||||
|
"""Configuration for the noise actor in DSRL.
|
||||||
|
The noise actor outputs noise that gets fed to the diffusion policy.
|
||||||
|
"""
|
||||||
|
|
||||||
|
use_tanh_squash: bool = False # Whether to bound the noise output
|
||||||
|
std_min: float = 1e-5
|
||||||
|
std_max: float = 2.0
|
||||||
|
init_final: float = 0.05
|
||||||
|
|
||||||
|
|
||||||
|
@PreTrainedConfig.register_subclass("dsrl")
|
||||||
|
@dataclass
|
||||||
|
class DSRLConfig(PreTrainedConfig):
|
||||||
|
"""Diffusion Steering via Reinforcement Learning (DSRL) configuration."""
|
||||||
|
|
||||||
|
# Mapping of feature types to normalization modes
|
||||||
|
normalization_mapping: dict[str, NormalizationMode] = field(
|
||||||
|
default_factory=lambda: {
|
||||||
|
"VISUAL": NormalizationMode.MEAN_STD,
|
||||||
|
"STATE": NormalizationMode.MIN_MAX,
|
||||||
|
"ENV": NormalizationMode.MIN_MAX,
|
||||||
|
"ACTION": NormalizationMode.MIN_MAX,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Statistics for normalizing different types of inputs
|
||||||
|
dataset_stats: dict[str, dict[str, list[float]]] | None = field(
|
||||||
|
default_factory=lambda: {
|
||||||
|
OBS_IMAGE: {
|
||||||
|
"mean": [0.485, 0.456, 0.406],
|
||||||
|
"std": [0.229, 0.224, 0.225],
|
||||||
|
},
|
||||||
|
OBS_STATE: {
|
||||||
|
"min": [0.0, 0.0],
|
||||||
|
"max": [1.0, 1.0],
|
||||||
|
},
|
||||||
|
ACTION: {
|
||||||
|
"min": [0.0, 0.0, 0.0],
|
||||||
|
"max": [1.0, 1.0, 1.0],
|
||||||
|
},
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Architecture specifics
|
||||||
|
# Device to run the model on (e.g., "cuda", "cpu")
|
||||||
|
device: str = "cpu"
|
||||||
|
# Device to store the model on
|
||||||
|
storage_device: str = "cpu"
|
||||||
|
# Name of the vision encoder model (Set to "helper2424/resnet10" for hil serl resnet10)
|
||||||
|
vision_encoder_name: str | None = None
|
||||||
|
# Whether to freeze the vision encoder during training
|
||||||
|
freeze_vision_encoder: bool = True
|
||||||
|
# Hidden dimension size for the image encoder
|
||||||
|
image_encoder_hidden_dim: int = 32
|
||||||
|
# Whether to use a shared encoder for actor and critic
|
||||||
|
shared_encoder: bool = True
|
||||||
|
# Number of discrete actions, eg for gripper actions
|
||||||
|
num_discrete_actions: int | None = None
|
||||||
|
# Dimension of the image embedding pooling
|
||||||
|
image_embedding_pooling_dim: int = 8
|
||||||
|
|
||||||
|
# Name of the action policy
|
||||||
|
action_policy_name: str = "pi0"
|
||||||
|
action_policy_weights: str | None = "lerobot/pi0_base"
|
||||||
|
|
||||||
|
# Training parameter
|
||||||
|
# Number of steps for online training
|
||||||
|
online_steps: int = 1000000
|
||||||
|
# Capacity of the online replay buffer
|
||||||
|
online_buffer_capacity: int = 100000
|
||||||
|
# Capacity of the offline replay buffer
|
||||||
|
offline_buffer_capacity: int = 100000
|
||||||
|
# Whether to use asynchronous prefetching for the buffers
|
||||||
|
async_prefetch: bool = False
|
||||||
|
# Number of steps before learning starts
|
||||||
|
online_step_before_learning: int = 100
|
||||||
|
# Frequency of policy updates
|
||||||
|
policy_update_freq: int = 1
|
||||||
|
|
||||||
|
# SAC algorithm parameters
|
||||||
|
discount: float = 0.99
|
||||||
|
# Initial temperature value
|
||||||
|
temperature_init: float = 1.0
|
||||||
|
# Number of critics in the ensemble
|
||||||
|
num_critics: int = 2
|
||||||
|
# Number of subsampled critics for training
|
||||||
|
num_subsample_critics: int | None = None
|
||||||
|
# Learning rate for the critic network
|
||||||
|
critic_lr: float = 3e-4
|
||||||
|
# Learning rate for the actor network
|
||||||
|
actor_lr: float = 3e-4
|
||||||
|
# Learning rate for the temperature parameter
|
||||||
|
temperature_lr: float = 3e-4
|
||||||
|
# Weight for the critic target update
|
||||||
|
critic_target_update_weight: float = 0.005
|
||||||
|
# Update-to-data ratio for the UTD algorithm (If you want enable utd_ratio, you need to set it to >1)
|
||||||
|
utd_ratio: int = 1
|
||||||
|
# Hidden dimension size for the state encoder
|
||||||
|
state_encoder_hidden_dim: int = 256
|
||||||
|
# Dimension of the latent space
|
||||||
|
latent_dim: int = 256
|
||||||
|
# Target entropy for the SAC algorithm
|
||||||
|
target_entropy: float | None = None
|
||||||
|
# Whether to use backup entropy for the SAC algorithm
|
||||||
|
use_backup_entropy: bool = True
|
||||||
|
# Gradient clipping norm for the SAC algorithm
|
||||||
|
grad_clip_norm: float = 40.0
|
||||||
|
|
||||||
|
# Network configuration
|
||||||
|
# Configuration for the critic network architecture
|
||||||
|
critic_network_kwargs: CriticNetworkConfig = field(default_factory=CriticNetworkConfig)
|
||||||
|
# Configuration for the noise critic network architecture
|
||||||
|
noise_critic_network_kwargs: CriticNetworkConfig = field(default_factory=CriticNetworkConfig)
|
||||||
|
# Configuration for the noise actor network architecture
|
||||||
|
noise_actor_network_kwargs: ActorNetworkConfig = field(default_factory=ActorNetworkConfig)
|
||||||
|
# Configuration for the noise actor specific parameters
|
||||||
|
noise_actor_kwargs: NoiseActorConfig = field(default_factory=NoiseActorConfig)
|
||||||
|
# Configuration for actor-learner architecture
|
||||||
|
actor_learner_config: ActorLearnerConfig = field(default_factory=ActorLearnerConfig)
|
||||||
|
# Configuration for concurrency settings (you can use threads or processes for the actor and learner)
|
||||||
|
concurrency: ConcurrencyConfig = field(default_factory=ConcurrencyConfig)
|
||||||
|
|
||||||
|
# Optimizations
|
||||||
|
use_torch_compile: bool = True
|
||||||
|
|
||||||
|
def __post_init__(self):
|
||||||
|
super().__post_init__()
|
||||||
|
|
||||||
|
def get_optimizer_preset(self) -> MultiAdamConfig:
|
||||||
|
return MultiAdamConfig(
|
||||||
|
weight_decay=0.0,
|
||||||
|
optimizer_groups={
|
||||||
|
"critic_action": {"lr": self.critic_lr},
|
||||||
|
"critic_noise": {"lr": self.critic_lr},
|
||||||
|
"noise_actor": {"lr": self.actor_lr},
|
||||||
|
"temperature": {"lr": self.temperature_lr},
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
def get_scheduler_preset(self) -> None:
|
||||||
|
return None
|
||||||
|
|
||||||
|
def validate_features(self) -> None:
|
||||||
|
has_image = any(is_image_feature(key) for key in self.input_features)
|
||||||
|
has_state = OBS_STATE in self.input_features
|
||||||
|
|
||||||
|
if not (has_state or has_image):
|
||||||
|
raise ValueError(
|
||||||
|
"You must provide either 'observation.state' or an image observation (key starting with 'observation.image') in the input features"
|
||||||
|
)
|
||||||
|
|
||||||
|
if ACTION not in self.output_features:
|
||||||
|
raise ValueError("You must provide 'action' in the output features")
|
||||||
|
|
||||||
|
@property
|
||||||
|
def image_features(self) -> list[str]:
|
||||||
|
return [key for key in self.input_features if is_image_feature(key)]
|
||||||
|
|
||||||
|
@property
|
||||||
|
def observation_delta_indices(self) -> list:
|
||||||
|
return None
|
||||||
|
|
||||||
|
@property
|
||||||
|
def action_delta_indices(self) -> list:
|
||||||
|
return None
|
||||||
|
|
||||||
|
@property
|
||||||
|
def reward_delta_indices(self) -> None:
|
||||||
|
return None
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,89 @@
|
|||||||
|
# !/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.
|
||||||
|
"""
|
||||||
|
Processor for DSRL policy.
|
||||||
|
|
||||||
|
DSRL uses a similar processing pipeline as SAC since it operates on
|
||||||
|
state-action transitions. The main difference is that internally it
|
||||||
|
also works with noise, but that's handled within the policy itself.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
import torch
|
||||||
|
|
||||||
|
from lerobot.policies.dsrl.configuration_dsrl import DSRLConfig
|
||||||
|
from lerobot.processor import (
|
||||||
|
AddBatchDimensionProcessorStep,
|
||||||
|
DeviceProcessorStep,
|
||||||
|
NormalizerProcessorStep,
|
||||||
|
PolicyAction,
|
||||||
|
PolicyProcessorPipeline,
|
||||||
|
RenameObservationsProcessorStep,
|
||||||
|
UnnormalizerProcessorStep,
|
||||||
|
)
|
||||||
|
from lerobot.processor.converters import (
|
||||||
|
policy_action_to_transition,
|
||||||
|
transition_to_policy_action,
|
||||||
|
)
|
||||||
|
from lerobot.utils.constants import POLICY_POSTPROCESSOR_DEFAULT_NAME, POLICY_PREPROCESSOR_DEFAULT_NAME
|
||||||
|
|
||||||
|
|
||||||
|
def make_dsrl_pre_post_processors(
|
||||||
|
config: DSRLConfig,
|
||||||
|
dataset_stats: dict[str, dict[str, torch.Tensor]] | None = None,
|
||||||
|
) -> tuple[
|
||||||
|
PolicyProcessorPipeline[dict, dict],
|
||||||
|
PolicyProcessorPipeline[PolicyAction, PolicyAction],
|
||||||
|
]:
|
||||||
|
"""Create preprocessor and postprocessor pipelines for DSRL policy.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
config: DSRL policy configuration
|
||||||
|
dataset_stats: Optional dataset statistics for normalization
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Tuple of (preprocessor, postprocessor) pipelines
|
||||||
|
"""
|
||||||
|
input_steps = [
|
||||||
|
RenameObservationsProcessorStep(rename_map={}),
|
||||||
|
AddBatchDimensionProcessorStep(),
|
||||||
|
DeviceProcessorStep(device=config.device),
|
||||||
|
NormalizerProcessorStep(
|
||||||
|
features={**config.input_features, **config.output_features},
|
||||||
|
norm_map=config.normalization_mapping,
|
||||||
|
stats=dataset_stats,
|
||||||
|
),
|
||||||
|
]
|
||||||
|
output_steps = [
|
||||||
|
UnnormalizerProcessorStep(
|
||||||
|
features=config.output_features, norm_map=config.normalization_mapping, stats=dataset_stats
|
||||||
|
),
|
||||||
|
DeviceProcessorStep(device="cpu"),
|
||||||
|
]
|
||||||
|
return (
|
||||||
|
PolicyProcessorPipeline[dict[str, Any], dict[str, Any]](
|
||||||
|
steps=input_steps,
|
||||||
|
name=POLICY_PREPROCESSOR_DEFAULT_NAME,
|
||||||
|
),
|
||||||
|
PolicyProcessorPipeline[PolicyAction, PolicyAction](
|
||||||
|
steps=output_steps,
|
||||||
|
name=POLICY_POSTPROCESSOR_DEFAULT_NAME,
|
||||||
|
to_transition=policy_action_to_transition,
|
||||||
|
to_output=transition_to_policy_action,
|
||||||
|
),
|
||||||
|
)
|
||||||
@@ -1148,7 +1148,7 @@ class PI0Policy(PreTrainedPolicy):
|
|||||||
return self._action_queue.popleft()
|
return self._action_queue.popleft()
|
||||||
|
|
||||||
@torch.no_grad()
|
@torch.no_grad()
|
||||||
def predict_action_chunk(self, batch: dict[str, Tensor]) -> Tensor:
|
def predict_action_chunk(self, batch: dict[str, Tensor], noise: Tensor | None = None) -> Tensor:
|
||||||
"""Predict a chunk of actions given environment observations."""
|
"""Predict a chunk of actions given environment observations."""
|
||||||
self.eval()
|
self.eval()
|
||||||
|
|
||||||
@@ -1158,7 +1158,7 @@ class PI0Policy(PreTrainedPolicy):
|
|||||||
state = self.prepare_state(batch)
|
state = self.prepare_state(batch)
|
||||||
|
|
||||||
# Sample actions using the model
|
# Sample actions using the model
|
||||||
actions = self.model.sample_actions(images, img_masks, lang_tokens, lang_masks, state)
|
actions = self.model.sample_actions(images, img_masks, lang_tokens, lang_masks, state, noise)
|
||||||
|
|
||||||
# Unpad actions to actual action dimension
|
# Unpad actions to actual action dimension
|
||||||
original_action_dim = self.config.output_features[ACTION].shape[0]
|
original_action_dim = self.config.output_features[ACTION].shape[0]
|
||||||
|
|||||||
@@ -1120,7 +1120,7 @@ class PI05Policy(PreTrainedPolicy):
|
|||||||
return self._action_queue.popleft()
|
return self._action_queue.popleft()
|
||||||
|
|
||||||
@torch.no_grad()
|
@torch.no_grad()
|
||||||
def predict_action_chunk(self, batch: dict[str, Tensor]) -> Tensor:
|
def predict_action_chunk(self, batch: dict[str, Tensor], noise: Tensor | None = None) -> Tensor:
|
||||||
"""Predict a chunk of actions given environment observations."""
|
"""Predict a chunk of actions given environment observations."""
|
||||||
self.eval()
|
self.eval()
|
||||||
|
|
||||||
@@ -1129,7 +1129,7 @@ class PI05Policy(PreTrainedPolicy):
|
|||||||
tokens, masks = batch[f"{OBS_LANGUAGE_TOKENS}"], batch[f"{OBS_LANGUAGE_ATTENTION_MASK}"]
|
tokens, masks = batch[f"{OBS_LANGUAGE_TOKENS}"], batch[f"{OBS_LANGUAGE_ATTENTION_MASK}"]
|
||||||
|
|
||||||
# Sample actions using the model (no separate state needed for PI05)
|
# Sample actions using the model (no separate state needed for PI05)
|
||||||
actions = self.model.sample_actions(images, img_masks, tokens, masks)
|
actions = self.model.sample_actions(images, img_masks, tokens, masks, noise)
|
||||||
|
|
||||||
# Unpad actions to actual action dimension
|
# Unpad actions to actual action dimension
|
||||||
original_action_dim = self.config.output_features[ACTION].shape[0]
|
original_action_dim = self.config.output_features[ACTION].shape[0]
|
||||||
|
|||||||
Reference in New Issue
Block a user