Skip to content

Update install via uv #836

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

Merged
merged 4 commits into from
Jun 2, 2025
Merged

Conversation

emilioMaddalena
Copy link
Contributor

Proposed changes

This PR tackles the issue I pointed out in #834. Essentially, it aligns the install via uv examples with how the tool was intended to be used, i.e., as a replacement for pip.

Types of changes

What types of changes does your code introduce to CausalML?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • I have signed the CLA
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc. This PR template is adopted from appium.

- The default index from which uv fetches packages is PyPI
- uv was designed to replace pip and so uv add is preferred over uv pip install
- Replace uv pip install by uv add
- Delte from PyPI from headers
@emilioMaddalena emilioMaddalena mentioned this pull request Jun 2, 2025
@jeongyoonlee jeongyoonlee self-requested a review June 2, 2025 19:45
@jeongyoonlee jeongyoonlee added the documentation Improvements or additions to documentation label Jun 2, 2025
Copy link
Collaborator

@jeongyoonlee jeongyoonlee left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for the contribution!

@jeongyoonlee jeongyoonlee merged commit 8216447 into uber:master Jun 2, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants