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

fix: Allow for newest version of pip #290

Merged
merged 1 commit into from
Oct 30, 2024

Conversation

KennethEnevoldsen
Copy link
Collaborator

@KennethEnevoldsen KennethEnevoldsen commented Oct 30, 2024

fixes #288

Summary by CodeRabbit

  • New Features

    • Enhanced package installation flexibility by allowing installation from specified URLs.
    • Improved download functionality for DaCy models, ensuring correct package installation.
  • Bug Fixes

    • Enhanced error handling for model availability, providing clearer error messages when models are not found.

Copy link

coderabbitai bot commented Oct 30, 2024

Walkthrough

The changes in the src/dacy/download.py file enhance the installation functionality of DaCy models by modifying the install function to accept an additional url parameter. This allows for package installation directly from specified URLs. The download_model function has been updated to extract the package name and URL from a dictionary, ensuring the correct installation process. Error handling for model availability is also reinforced, maintaining existing functionality while improving usability.

Changes

File Path Change Summary
src/dacy/download.py Updated install function to accept an additional url: str parameter. Modified download_model to use the new install function signature. Maintained error handling for model availability.

Assessment against linked issues

Objective Addressed Explanation
Update installation method to handle pip 24.1 changes (#288)
Ensure model installation from specified URLs (#288)

🐰 In the meadow, I hop and play,
With models to load, come what may!
From URLs, they spring to life,
No more worries, no more strife!
Install with ease, oh what a thrill,
DaCy's magic, a rabbit's will! 🐇✨


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 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
src/dacy/download.py (2)

77-82: LGTM! The changes fix pip 24.1 compatibility.

The new implementation correctly uses pip's URL-based installation format required by newer versions. Consider adding error handling for installation failures.

Add error handling to provide better feedback:

 def install(package: str, url: str) -> None:
     import subprocess
     import sys
-    subprocess.check_call(
-        [sys.executable, "-m", "pip", "install", f"{package} @ {url}", "--no-deps"],
-    )
+    try:
+        subprocess.check_call(
+            [sys.executable, "-m", "pip", "install", f"{package} @ {url}", "--no-deps"],
+            stderr=subprocess.PIPE,
+        )
+    except subprocess.CalledProcessError as e:
+        raise RuntimeError(f"Failed to install {package}: {e.stderr.decode()}") from e

118-120: Consider enhancing package name extraction robustness.

While the implementation works correctly, consider adding validation for the package name extraction to handle edge cases.

-    package = model.split("-")[0]
+    package = model.split("-")[0] if "-" in model else model
     install(package, models_url[model])
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d990deb and 0d088b6.

📒 Files selected for processing (1)
  • src/dacy/download.py (2 hunks)
🔇 Additional comments (1)
src/dacy/download.py (1)

Line range hint 77-120: Verify model URLs and installation usage.

Let's verify the changes:

  1. Check if all model URLs in the dictionary are valid
  2. Look for other places that might need similar updates
✅ Verification successful

Let me check the other files that use pip install to ensure we're not missing any related installation patterns.


Model URLs and installation methods have been verified successfully

The verification shows:

  1. All model URLs in models_url are valid (returning HTTP 302 redirects as expected for Hugging Face URLs)
  2. Other pip install occurrences in the codebase are unrelated to the model installation:
    • src/dacy/load.py only contains a warning message
    • training/main/tasks.py handles dev environment setup
    • Files in papers/ directory are documentation/examples for other tools
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for other potential installation methods and verify URLs

# Test 1: Look for other pip install commands that might need updating
echo "Checking for other pip install patterns..."
rg -l "pip.*install" --type py

# Test 2: Verify that all URLs in models_url are valid
echo "Checking model URLs..."
rg -o 'https://huggingface\.co/[^"]*' src/dacy/download.py | while read -r url; do
  curl -s -I "$url" | head -n 1 | grep "HTTP/[0-9.]* [23]"
done

Length of output: 1988


Script:

#!/bin/bash
# Check the content of files that use pip install
echo "=== Content of src/dacy/load.py ==="
rg "pip.*install" src/dacy/load.py -A 2 -B 2

echo -e "\n=== Content of training/main/tasks.py ==="
rg "pip.*install" training/main/tasks.py -A 2 -B 2

echo -e "\n=== Content of papers directory ==="
rg "pip.*install" papers/DaCy-A-Unified-Framework-for-Danish-NLP/apply_fns/ -A 2 -B 2

Length of output: 2382

@KennethEnevoldsen KennethEnevoldsen merged commit ea0a07d into main Oct 30, 2024
8 of 9 checks passed
@KennethEnevoldsen KennethEnevoldsen deleted the fix--Allow-for-newest-version-of-pip branch October 30, 2024 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dacy.load fails to install the model in pip 24.1
1 participant