Refactor device builder logic + safer errors

[ljt019]

Summary

• extract DeviceSelectable trait for pipeline builders
• implement trait across pipeline builders to remove duplicate device logic
• improve loader retry error handling
• replace unsafe unwrap() calls with expect() messages

Testing

• cargo check
• cargo test --lib

---

https://chatgpt.com/codex/tasks/task_e_686c9284f6388330b1d6e6a18f5033f6

Summary by CodeRabbit

• New Features

  • Introduced a unified interface for device selection across pipeline builders, allowing consistent and chainable methods for choosing CPU, CUDA devices, or custom devices.

• Refactor

  • Centralized device selection logic by removing individual device-setting methods from pipeline builders and delegating this functionality to the new device selection interface.
  • Improved error messages for certain operations, providing clearer feedback in case of failures or unexpected conditions.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update refactors device selection for various pipeline builders by removing explicit device-setting methods and introducing a unified DeviceSelectable trait. Additionally, error handling is improved across the codebase by replacing unwrap() calls with expect() for clearer panic messages, and the HfLoader::load method's error reporting is made more robust.

Changes

Files/Groups	Change Summary
src/pipelines/embedding_pipeline/builder.rs src/pipelines/fill_mask_pipeline/builder.rs src/pipelines/reranker_pipeline/builder.rs src/pipelines/sentiment_analysis_pipeline/builder.rs src/pipelines/text_generation_pipeline/builder.rs src/pipelines/zero_shot_classification_pipeline/builder.rs	Removed explicit device selection methods (cpu, cuda_device, device); implemented DeviceSelectable trait for unified device selection.
src/pipelines/utils/mod.rs	Added new public trait DeviceSelectable with chainable device selection methods for builders.
src/loaders.rs	Improved error handling in HfLoader::load: returns wrapped error or generic error instead of panicking on unwrap().
src/pipelines/text_generation_pipeline/base_pipeline.rs src/pipelines/text_generation_pipeline/parser.rs src/pipelines/text_generation_pipeline/pipeline.rs src/pipelines/text_generation_pipeline/xml_pipeline.rs	Replaced unwrap() with expect() for more informative panic messages in error cases.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PipelineBuilder
    participant DeviceSelectable
    User->>PipelineBuilder: create builder
    User->>PipelineBuilder: call .cpu()/.cuda_device(idx)/.device(dev)
    PipelineBuilder->>DeviceSelectable: delegate device selection
    DeviceSelectable-->>PipelineBuilder: update device_request
    User->>PipelineBuilder: build()
    PipelineBuilder->>PipelineBuilder: resolve device and build pipeline

Loading

Possibly related PRs

• ljt019/transformers#54: Refactors HfLoader::load to be asynchronous and modifies error handling, directly overlapping with this PR's changes to error handling in the same method.

Poem

A rabbit hops through builder land,
Device selection now feels grand!
No more scattered methods here—
One trait to rule devices near.
With clearer errors, bugs take flight,
Pipelines build both day and night.
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Clippy (1.86.0)

Updating crates.io index
Updating git repository `https://github.com/huggingface/candle.git`

error: failed to get candle-core as a dependency of package transformers v0.0.12 ()

Caused by:
failed to load source for dependency candle-core

Caused by:
Unable to update https://github.com/huggingface/candle.git#d0a3b33e

Caused by:
failed to create directory /usr/local/git/db/candle-5b4d092929d18d36

Caused by:
Permission denied (os error 13)

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between da84b5d and f55e8b2.

📒 Files selected for processing (12)

• src/loaders.rs (1 hunks)
• src/pipelines/embedding_pipeline/builder.rs (2 hunks)
• src/pipelines/fill_mask_pipeline/builder.rs (2 hunks)
• src/pipelines/reranker_pipeline/builder.rs (2 hunks)
• src/pipelines/sentiment_analysis_pipeline/builder.rs (2 hunks)
• src/pipelines/text_generation_pipeline/base_pipeline.rs (3 hunks)
• src/pipelines/text_generation_pipeline/builder.rs (2 hunks)
• src/pipelines/text_generation_pipeline/parser.rs (4 hunks)
• src/pipelines/text_generation_pipeline/pipeline.rs (1 hunks)
• src/pipelines/text_generation_pipeline/xml_pipeline.rs (1 hunks)
• src/pipelines/utils/mod.rs (1 hunks)
• src/pipelines/zero_shot_classification_pipeline/builder.rs (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @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.