Improve doc

This commit is contained in:
Simon Alibert 2025-02-20 08:24:41 +01:00
parent 969ef745a2
commit 392a8c32a7
1 changed files with 7 additions and 6 deletions

View File

@ -2,10 +2,10 @@
This script will help you convert any LeRobot dataset already pushed to the hub from codebase version 2.0 to This script will help you convert any LeRobot dataset already pushed to the hub from codebase version 2.0 to
2.1. It will: 2.1. It will:
- Generates per-episodes stats and writes them in `episodes_stats.jsonl` - Generate per-episodes stats and writes them in `episodes_stats.jsonl`
- Check consistency between these new stats and the old ones. - Check consistency between these new stats and the old ones.
- Removes the deprecated `stats.json` (by default) - Remove the deprecated `stats.json`.
- Updates codebase_version in `info.json` - Update codebase_version in `info.json`.
- Push this new version to the hub on the 'main' branch and tags it with "v2.1". - Push this new version to the hub on the 'main' branch and tags it with "v2.1".
Usage: Usage:
@ -80,19 +80,20 @@ if __name__ == "__main__":
"--repo-id", "--repo-id",
type=str, type=str,
required=True, required=True,
help="Repository identifier on Hugging Face: a community or a user name `/` the name of the dataset (e.g. `lerobot/pusht`, `cadene/aloha_sim_insertion_human`).", help="Repository identifier on Hugging Face: a community or a user name `/` the name of the dataset "
"(e.g. `lerobot/pusht`, `cadene/aloha_sim_insertion_human`).",
) )
parser.add_argument( parser.add_argument(
"--branch", "--branch",
type=str, type=str,
default=None, default=None,
help="Repo branch to push your dataset (defaults to the main branch)", help="Repo branch to push your dataset. Defaults to the main branch.",
) )
parser.add_argument( parser.add_argument(
"--num-workers", "--num-workers",
type=int, type=int,
default=4, default=4,
help="Number of workers for parallelizing compute", help="Number of workers for parallelizing stats compute. Defaults to 4.",
) )
args = parser.parse_args() args = parser.parse_args()