Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] main from huggingface:main #12

Merged
merged 6 commits into from
Feb 25, 2025
Merged

[pull] main from huggingface:main #12

merged 6 commits into from
Feb 25, 2025

Conversation

pull[bot]
Copy link

@pull pull bot commented Feb 25, 2025

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

This pull request introduces several enhancements and bug fixes to the LeRobot dataset, including improved data loading, version compatibility checks, video encoding, and timestamp synchronization. It also updates the Dockerfile and adds new tests to ensure the correctness of the changes.

Enhancements:

  • Refactors the dataset loading and saving mechanisms to improve efficiency and data integrity.
  • Improves error handling and version compatibility checks during dataset loading.
  • Enhances video encoding and video information handling.
  • Improves the synchronization of timestamps during data collection.

Build:

  • Updates the Dockerfile to streamline the installation process and ensure a consistent environment.

Tests:

  • Adds new tests and updates existing tests to ensure the correctness of the new features and bug fixes.

@pull pull bot added the ⤵️ pull label Feb 25, 2025
@pull pull bot merged commit 8699a28 into Stars1233:main Feb 25, 2025
Copy link

gitstream-cm bot commented Feb 25, 2025

🚨 gitStream Monthly Automation Limit Reached 🚨

Your organization has exceeded the number of pull requests allowed for automation with gitStream.
Monthly PRs automated: 2268/250

To continue automating your PR workflows and unlock additional features, please contact LinearB.

Copy link

sourcery-ai bot commented Feb 25, 2025

Reviewer's Guide by Sourcery

This pull request introduces several enhancements and bug fixes to the LeRobot dataset library. It updates the codebase version to v2.1, adds support for managing tasks, improves video encoding and information handling, enhances dataset upload functionality, improves timestamp synchronization checks, and adds frame validation to ensure data integrity.

Sequence diagram for loading metadata with cache sync

sequenceDiagram
    participant L as LeRobotDatasetMetadata
    participant FS as File System
    L->L: __init__(repo_id, root, revision, force_cache_sync=True)
    alt force_cache_sync is True
        L->L: load_metadata()
        alt FileNotFoundError or NotADirectoryError
            L->FS: Check if revision is valid
            FS-->L: True
            L->L: get_safe_version(repo_id, revision)
            L->FS: Create meta directory
            L->L: pull_from_repo(allow_patterns="meta/")
            L->FS: Download metadata files
            FS-->L: Metadata files
            L->L: load_metadata()
            L->FS: Load metadata files
            FS-->L: Metadata
        else valid metadata found
            L->FS: Load metadata files
            FS-->L: Metadata
        end
    end
Loading

Sequence diagram for saving an episode

sequenceDiagram
    participant L as LeRobotDataset
    participant LM as LeRobotDatasetMetadata
    participant FS as File System
    L->L: save_episode(episode_data)
    L->L: validate_episode_buffer(episode_buffer, ...)
    L->LM: get_task_index(task) for each task in episode_tasks
    alt task_index is None
        LM->LM: add_task(task)
        LM->FS: append_jsonlines(task_dict, TASKS_PATH)
    end
    L->L: _wait_image_writer()
    L->L: _save_episode_table(episode_buffer, episode_index)
    L->L: compute_episode_stats(episode_buffer, features)
    L->L: encode_episode_videos(episode_index)
    L->LM: save_episode(episode_index, episode_length, episode_tasks, episode_stats)
    LM->FS: write_episode_stats(episode_index, episode_stats, root)
    LM->FS: write_info(info, root)
Loading

File-Level Changes

Change Details Files
Dataset codebase version updated from v2.0 to v2.1.
  • Updated the CODEBASE_VERSION constant to v2.1.
  • Modified the dataset loading logic to handle both v2.0 and v2.1 formats.
  • Added support for loading episode statistics from episodes_stats.jsonl.
  • Added backward compatibility for loading stats from stats.json for v2.0 datasets.
  • Added a check for version compatibility between the dataset and the codebase.
  • Added a function to get a safe version of the dataset from the hub.
  • Added a function to check if a version is valid.
  • Added a function to write info to the info.json file.
  • Added a function to write stats to the stats.json file.
  • Added a function to write episode to the episodes.jsonl file.
  • Added a function to write episode stats to the episodes_stats.jsonl file.
  • Added a function to load episode stats from the episodes_stats.jsonl file.
  • Added a function to provide backward compatible episode stats.
  • Added a function to cast stats to numpy.
  • Added a function to embed images.
  • Added a function to validate a frame.
  • Added a function to validate an episode buffer.
  • Added a function to validate features presence.
  • Added a function to validate feature dtype and shape.
  • Added a function to validate a numpy array.
  • Added a function to validate an image or video.
  • Added a function to validate a string.
  • Added a function to get repo versions.
  • Added a function to check timestamps sync.
  • Added a function to calculate total episodes.
  • Added a function to calculate episode data index.
  • Added a function to get hf features from features.
lerobot/common/datasets/lerobot_dataset.py
lerobot/common/datasets/utils.py
lerobot/common/datasets/compute_stats.py
tests/test_datasets.py
tests/test_delta_timestamps.py
tests/fixtures/dataset_factories.py
lerobot/common/policies/normalize.py
lerobot/common/robot_devices/control_utils.py
lerobot/common/datasets/image_writer.py
examples/port_datasets/pusht_zarr.py
lerobot/common/datasets/v2/convert_dataset_v1_to_v2.py
lerobot/common/datasets/video_utils.py
lerobot/configs/default.py
tests/test_cameras.py
lerobot/common/datasets/factory.py
Added support for adding and managing tasks within the dataset.
  • Implemented methods to add new tasks to the dataset's metadata.
  • Implemented methods to retrieve task indices based on natural language descriptions.
  • Modified the episode saving process to include task information.
  • Added a function to write task to the tasks.jsonl file.
  • Added a function to load tasks from the tasks.jsonl file.
lerobot/common/datasets/lerobot_dataset.py
lerobot/common/datasets/utils.py
Enhanced video encoding and video information handling.
  • Added a function to update video information in the dataset metadata.
  • Modified the episode saving process to encode videos and update video paths.
  • Removed the consolidate method.
  • Removed the local_files_only parameter.
lerobot/common/datasets/lerobot_dataset.py
lerobot/common/datasets/utils.py
Improved dataset upload functionality with branch support and large folder handling.
  • Added support for specifying a branch when pushing the dataset to the hub.
  • Added support for uploading large folders to the hub.
  • Modified the push_to_hub method to use the HfApi for repo creation and file uploading.
  • Added a function to create a branch.
lerobot/common/datasets/lerobot_dataset.py
Improved timestamp synchronization checks.
  • Modified the timestamp synchronization check to use numpy arrays instead of torch tensors.
  • Improved the timestamp synchronization check to provide more detailed error messages.
  • Added a function to calculate total episodes.
  • Added a function to calculate episode data index.
lerobot/common/datasets/lerobot_dataset.py
lerobot/common/datasets/utils.py
tests/test_delta_timestamps.py
Added frame validation to ensure data integrity.
  • Implemented a function to validate the data types and shapes of frames before adding them to the dataset.
  • Implemented a function to validate the episode buffer.
lerobot/common/datasets/lerobot_dataset.py
lerobot/common/datasets/utils.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

coderabbitai bot commented Feb 25, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants