dataset

参数

• frame — 将该帧的特征名称映射到其值的字典。 必须包含 'task' 键。Torch 张量会转换为 numpy。

• RuntimeError — 如果 dataset 为只读（无写入器）。

参数

• delete_images — 若为 True，同时删除为当前 episode 写入磁盘的临时图像文件。

• RuntimeError — 如果 dataset 为只读（无写入器）。

参数

• repo_id — 仓库标识符，通常为 '{hf_user}/{dataset_name}'。
• fps — 数据采集时使用的每秒帧数。
• features — 将特征名称映射到其类型/形状元数据的特征规格字典。
• root — dataset 存储的本地目录。默认为 $HF_LEROBOT_HOME/{repo_id}。
• robot_type — 存储在元数据中的可选机器人类型字符串。
• use_videos — 若为 True，视觉模态存储为 MP4 视频。 若为 False，则存储为图像。
• tolerance_s — 时间戳同步容差，单位为秒。
• image_writer_processes — 异步图像写入的子进程数。0 表示仅使用线程。
• image_writer_threads — 异步图像写入的线程数。
• video_backend — 视频解码后端（在回读时使用）。
• batch_encoding_size — 在批量编码视频之前累积的 episode 数。1 表示立即编码。
• rgb_encoder — 相机的视频编码器设置（编解码器、质量等）。 当为 None 时，使用 rgb_encoder_defaults()。
• depth_encoder — 深度相机的视频编码器设置（编解码器、质量等）。 当为 None 时，使用 depth_encoder_defaults()。
• encoder_threads — 编码器线程数（全局）。None 让编解码器自行决定。
• metadata_buffer_size — 在刷新到 parquet 之前缓冲的 episode 元数据记录数。
• streaming_encoding — 若为 True，在采集期间实时编码视频帧，而不是先写入图像。
• encoder_queue_maxsize — 使用流式编码时每台相机的最大缓冲帧数。

参数

• branch — 可选的推送目标分支。若不存在，则从当前修订创建。
• tags — dataset 卡片使用的可选标签列表。
• license — dataset 卡片的许可证标识符。
• tag_version — 若为 True，为当前代码库版本创建 Git 标签。
• push_videos — 若为 False，跳过上传 videos/ 目录。
• private — 若为 True，创建私有仓库。若为 None（默认），则遵循 Hub 上的组织默认设置（仅影响组织）。
• allow_patterns — 限制上传哪些文件的 glob 模式。
• upload_large_folder — 若为 True，对非常大的 dataset 使用 upload_large_folder 而非 upload_folder。
• **card_kwargs — 转发给 dataset 卡片创建的额外关键字参数。

参数

• repo_id — 现有 dataset 的仓库标识符。
• root — dataset 的本地目录。提供时，Hub 下载会直接落到该目录。省略时，Hub 下载使用 $HF_LEROBOT_HOME/hub 下的修订安全快照缓存。
• tolerance_s — 时间戳同步容差，单位为秒。
• revision — Git 修订（分支、标签或提交哈希）。默认为当前代码库版本标签。
• force_cache_sync — 若为 True，即使存在本地缓存，也重新从 Hub 下载元数据。
• video_backend — 用于回读数据的视频解码后端。
• batch_encoding_size — 在批量编码视频之前累积的 episode 数。
• rgb_encoder — 相机的视频编码器设置（编解码器、质量等）。当为 None 时，使用 rgb_encoder_defaults()。
• depth_encoder — 深度相机的视频编码器设置（编解码器、质量等）。当为 None 时，使用 depth_encoder_defaults()。
• encoder_threads — 编码器线程数（全局）。None 让编解码器自行决定。
• image_writer_processes — 异步图像写入的子进程。
• image_writer_threads — 异步图像写入的线程。
• streaming_encoding — 若为 True，在采集期间实时编码视频。
• encoder_queue_maxsize — 流式处理时每台相机的最大缓冲帧数。
• token — 当必须从 Hub 下载元数据时使用的认证令牌。令牌不会保留在 dataset 实例上。

参数

• episode_data — 可选的预构建 episode 字典。若为 None，则使用由 add_frame 填充的内部 episode 缓冲区。
• parallel_encoding — 若为 True 且存在多个相机，则使用进程池并行编码视频。

• RuntimeError — 如果 dataset 为只读（无写入器）。

参数

• repo_id — 仓库标识符（例如 'user/my_dataset'）。
• fps — 数据采集时使用的每秒帧数。
• features — 将特征名称映射到其类型/形状元数据的特征规格字典。
• robot_type — 存储在元数据中的可选机器人类型字符串。
• root — dataset 的本地目录。默认为 $HF_LEROBOT_HOME/{repo_id}。必须尚不存在。
• use_videos — 若为 True，视觉模态编码为 MP4 视频。
• metadata_buffer_size — 在刷新到 parquet 之前缓冲的 episode 元数据记录数。
• chunks_size — 每个块目录的最大文件数。None 使用默认值。
• data_files_size_in_mb — parquet 文件最大大小，单位为 MB。None 使用默认值。
• video_files_size_in_mb — 视频文件最大大小，单位为 MB。None 使用默认值。

参数

• predicate — 用于选择 episode 的每 episode 元数据行谓词。
• candidates — 可选的 episode index 列表，用于限制评估范围。

参数

• ep_index — 从零开始的 episode index。

• IndexError — 如果 ep_index 超出范围。

参数

• ep_index — 从零开始的 episode index。
• vid_key — 标识视频流的特征键（例如 'observation.images.laptop'）。

• IndexError — 如果 ep_index 超出范围。

参数

• episode_index — 正在保存的 episode 的从零开始索引。
• episode_length — 此 episode 中的帧数。
• episode_tasks — 此 episode 的任务描述列表。
• episode_stats — 此 episode 的每特征统计信息。
• episode_metadata — 额外元数据（块/文件索引、帧范围、视频时间戳等）。

参数

• tasks — 自然语言的唯一任务描述列表。

• ValueError — 如果 tasks 包含重复项。

参数

• chunks_size — 每个块目录的最大文件数。若为 None，则保留当前值。
• data_files_size_in_mb — 数据 parquet 文件的最大大小，单位为 MB。若为 None，则保留当前值。
• video_files_size_in_mb — 视频文件的最大大小，单位为 MB。若为 None，则保留当前值。

参数

• video_key — 若提供，则仅更新此视频键。否则更新 dataset 中的所有视频键。
• video_encoder — 用于生成视频的编码器配置。提供时，其字段会与从流派生的 video.* 条目一起记录为 video.<field> 条目（参见 get_video_info）。
• preserve_keys — 保留其现有值而非重新计算的键。None（默认）重新计算每个键。