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

docs(readme): add instructions for pipx installation, update torch urls #899

Merged
merged 4 commits into from
Aug 17, 2023

Conversation

34j
Copy link
Collaborator

@34j 34j commented Aug 17, 2023

Description of change

πŸ€– Generated by Copilot at 24f922f

Summary

πŸ“πŸ› οΈπŸ”„

This pull request enhances the README.md file with more installation options and updated URLs for PyTorch dependencies. It aims to make the package easier to install and use for different platforms and environments.

If you want to install this package
And avoid any dependency baggage
You can use pipx
To create a nice mix
Of isolated Python and PyTorch

Walkthrough

  • Add manual installation option using pipx for Windows users and others who prefer isolated environments (link)
  • Update index URLs for PyTorch packages to reflect different CUDA versions, release channels, and rocm versions for AMD GPU users (link, link)
  • Remove redundant -U flag from pip install command for so-vits-svc-fork (link)

Pull-Request Checklist

  • Code is up-to-date with the main branch
  • This pull request follows Contributing.md
  • This pull request links relevant issues as Fixes #0000
  • pre-commit run -a passes with this change or ci passes
  • poetry run pytest passes with this change or ci passes
  • (There are new or updated unit tests validating the change)
  • Documentation has been updated to reflect this change
  • The new commits follow conventions outlined in the conventional commit spec

@codecov
Copy link

codecov bot commented Aug 17, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.02% ⚠️

Comparison is base (6e9df1a) 19.25% compared to head (cc4cae1) 19.23%.

❗ Current head cc4cae1 differs from pull request most recent head 6f4640b. Consider uploading reports for the commit 6f4640b to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #899      +/-   ##
==========================================
- Coverage   19.25%   19.23%   -0.02%     
==========================================
  Files          39       39              
  Lines        3495     3488       -7     
  Branches      497      460      -37     
==========================================
- Hits          673      671       -2     
- Misses       2803     2805       +2     
+ Partials       19       12       -7     

see 10 files with indirect coverage changes

β˜” View full report in Codecov by Sentry.
πŸ“’ Have feedback on the report? Share it here.

@34j 34j merged commit 0b02c49 into main Aug 17, 2023
6 checks passed
@34j 34j deleted the docs/pipx branch August 17, 2023 07:56
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.

None yet

1 participant