admin/lerobot
1
0
Fork 0
mirror of https://github.com/huggingface/lerobot.git synced 2026-07-30 21:19:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(docstrings): updating docstrings

Browse Source
This commit is contained in:
CarolinePascal
2026-07-30 17:40:30 +02:00
parent e48b395c60
commit 2f08bb32c1
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/lerobot/datasets/dataset_tools.py
+10 -6
View File
@@ -1444,8 +1444,9 @@ def modify_tasks(
2. Set specific tasks for specific episodes (using `episode_tasks`) 2. Set specific tasks for specific episodes (using `episode_tasks`)
3. Replace existing task strings wherever they appear (using `task_replacements`) 3. Replace existing task strings wherever they appear (using `task_replacements`)
You can combine all of them: `new_task` sets the default, while `episode_tasks` and Per episode, the task is resolved with precedence:
`task_replacements` override specific episodes, with `episode_tasks` taking precedence. `episode_tasks` > `task_replacements` > `new_task` > original task. An episode that ends
up with no task (none of the above apply and it had no original task) raises an error.
The dataset is modified in-place, updating only the task-related files: The dataset is modified in-place, updating only the task-related files:
- meta/tasks.parquet - meta/tasks.parquet
@@ -1455,11 +1456,14 @@ def modify_tasks(
Args: Args:
dataset: The source LeRobotDataset to modify. dataset: The source LeRobotDataset to modify.
new_task: A single task string to apply to all episodes. If None and episode_tasks new_task: Default task applied to any episode not covered by `episode_tasks` or a
is also None, raises an error. matching `task_replacements` entry.
episode_tasks: Optional dict mapping episode indices to their task strings. episode_tasks: Optional dict mapping episode indices to task strings. Takes precedence
Overrides `new_task` for specific episodes. over both `task_replacements` and `new_task`.
task_replacements: Optional dict mapping existing task strings to new ones. Applied to
episodes whose current task matches a key. Every key must be an existing task.
At least one of `new_task`, `episode_tasks`, or `task_replacements` must be provided.
Examples: Examples:
Set a single task for all episodes: Set a single task for all episodes: