Housekeeping updates

[ljt019]

Summary

• unify device handling across pipelines
• add crate-level documentation
• ensure files end with newlines

Testing

• cargo test --lib
• cargo test --doc (fails: doctest compilation errors)

---

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

Summary by CodeRabbit

• Documentation

  • Added crate-level documentation describing the library and referencing the README for usage and examples.

• Refactor

  • Improved device selection in the sentiment analysis pipeline builder by unifying device handling with a structured approach.
  • Simplified device resolution in text generation pipeline builders for more consistent device management.

• Style

  • Added missing newline characters at the end of several files for improved code formatting.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update primarily standardizes file formatting by adding missing newline characters at the end of several source files and the .gitignore. It also introduces crate-level documentation in src/lib.rs. Significant refactoring in sentiment and text generation pipeline builders consolidates device selection logic using a new DeviceRequest abstraction, simplifying device handling across the codebase.

Changes

File(s)	Change Summary
.gitignore	Added newline at end of .vscode line.
src/lib.rs	Added crate-level documentation comment.
src/core/config.rs, src/core/message.rs	Added newline at end of file.
src/models/components/attention.rs, src/models/components/mod.rs, src/models/components/quantization.rs	Added newline at end of file.
src/models/generation/logits.rs, src/models/generation/mod.rs, src/models/generation/params.rs	Added newline at end of file.
src/models/implementations/qwen3_reranker.rs	Added newline at end of file.
src/pipelines/base.rs	Added newline at end of file.
src/pipelines/reranker_pipeline/model.rs, src/pipelines/reranker_pipeline/pipeline.rs	Added newline at end of file.
src/pipelines/sentiment_analysis_pipeline/builder.rs	Refactored to use DeviceRequest for device selection; updated builder methods and build logic accordingly.
src/pipelines/text_generation_pipeline/builder.rs	Simplified device selection by replacing explicit matching with DeviceRequest::resolve(); removed unused imports.
src/pipelines/text_generation_pipeline/streaming/event_stream.rs, src/pipelines/text_generation_pipeline/streaming/mod.rs	Added newline at end of file.
src/pipelines/text_generation_pipeline/tools.rs	Added newline at end of file.

Poem

A bunny hops through code so neat,
Adding newlines, a tidy treat!
Docs now sparkle at the top,
Device requests make logic pop.
With every file now clean and bright,
This rabbit’s work feels just right!
🐇✨

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 e3dc575 and a922f80.

📒 Files selected for processing (19)

• .gitignore (1 hunks)
• src/core/config.rs (1 hunks)
• src/core/message.rs (1 hunks)
• src/lib.rs (1 hunks)
• src/models/components/attention.rs (1 hunks)
• src/models/components/mod.rs (1 hunks)
• src/models/components/quantization.rs (1 hunks)
• src/models/generation/logits.rs (1 hunks)
• src/models/generation/mod.rs (1 hunks)
• src/models/generation/params.rs (1 hunks)
• src/models/implementations/qwen3_reranker.rs (1 hunks)
• src/pipelines/base.rs (1 hunks)
• src/pipelines/reranker_pipeline/model.rs (1 hunks)
• src/pipelines/reranker_pipeline/pipeline.rs (1 hunks)
• src/pipelines/sentiment_analysis_pipeline/builder.rs (2 hunks)
• src/pipelines/text_generation_pipeline/builder.rs (3 hunks)
• src/pipelines/text_generation_pipeline/streaming/event_stream.rs (1 hunks)
• src/pipelines/text_generation_pipeline/streaming/mod.rs (1 hunks)
• src/pipelines/text_generation_pipeline/tools.rs (1 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.