mirror of
https://github.com/denizsafak/abogen.git
synced 2026-07-18 13:40:27 +02:00
Update README.md and pyproject.toml for improved installation instructions and development dependencies
This commit is contained in:
@@ -4,7 +4,7 @@
|
|||||||
[](https://github.com/denizsafak/abogen/releases/latest)
|
[](https://github.com/denizsafak/abogen/releases/latest)
|
||||||
[](https://pypi.org/project/abogen/)
|
[](https://pypi.org/project/abogen/)
|
||||||
[](https://github.com/denizsafak/abogen/releases/latest)
|
[](https://github.com/denizsafak/abogen/releases/latest)
|
||||||
&color=blue)
|
[&color=blue)](https://pypi.org/project/abogen/)
|
||||||
[](https://github.com/psf/black)
|
[](https://github.com/psf/black)
|
||||||
[](https://opensource.org/licenses/MIT)
|
[](https://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
@@ -465,8 +465,9 @@ This will start Abogen in command-line mode and display detailed error messages.
|
|||||||
>
|
>
|
||||||
> If you used `uv` to install Abogen, you can uninstall and try reinstalling with another CUDA version:
|
> If you used `uv` to install Abogen, you can uninstall and try reinstalling with another CUDA version:
|
||||||
> ```bash
|
> ```bash
|
||||||
|
> # First uninstall Abogen
|
||||||
> uv tool uninstall abogen
|
> uv tool uninstall abogen
|
||||||
> # First, try CUDA 12.6 for older drivers
|
> # Try CUDA 12.6 for older drivers
|
||||||
> uv tool install --python 3.12 abogen[cuda126] --extra-index-url https://download.pytorch.org/whl/cu126 --index-strategy unsafe-best-match
|
> uv tool install --python 3.12 abogen[cuda126] --extra-index-url https://download.pytorch.org/whl/cu126 --index-strategy unsafe-best-match
|
||||||
> # If that doesn't work, try CUDA 13.0 for newer drivers
|
> # If that doesn't work, try CUDA 13.0 for newer drivers
|
||||||
> uv tool install --python 3.12 abogen[cuda130] --extra-index-url https://download.pytorch.org/whl/cu130 --index-strategy unsafe-best-match
|
> uv tool install --python 3.12 abogen[cuda130] --extra-index-url https://download.pytorch.org/whl/cu130 --index-strategy unsafe-best-match
|
||||||
@@ -546,11 +547,26 @@ I welcome contributions! If you have ideas for new features, improvements, or bu
|
|||||||
If you'd like to modify the code and contribute to development, you can [download the repository](https://github.com/denizsafak/abogen/archive/refs/heads/main.zip), extract it and run the following commands to build **or** install the package:
|
If you'd like to modify the code and contribute to development, you can [download the repository](https://github.com/denizsafak/abogen/archive/refs/heads/main.zip), extract it and run the following commands to build **or** install the package:
|
||||||
```bash
|
```bash
|
||||||
# Go to the directory where you extracted the repository and run:
|
# Go to the directory where you extracted the repository and run:
|
||||||
pip install -e . # Installs the package in editable mode
|
pip install -e .[dev] # Installs the package in editable mode with build dependencies
|
||||||
pip install build # Install the build package
|
python -m build # Builds the package in dist folder (optional)
|
||||||
python -m build # Builds the package in dist folder (optional)
|
abogen # Opens the GUI
|
||||||
abogen # Opens the GUI
|
|
||||||
```
|
```
|
||||||
|
> Make sure you are using Python 3.10 to 3.12. You need to create a virtual environment if needed.
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary><b>Alternative: Using uv (click to expand)</b></summary>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Go to the directory where you extracted the repository and run:
|
||||||
|
uv venv --python 3.12 # Creates a virtual environment with Python 3.12
|
||||||
|
# After activating the virtual environment, run:
|
||||||
|
uv pip install -e . # Installs the package in editable mode
|
||||||
|
uv build # Builds the package in dist folder (optional)
|
||||||
|
abogen # Opens the GUI
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
Feel free to explore the code and make any changes you like.
|
Feel free to explore the code and make any changes you like.
|
||||||
|
|
||||||
## `Credits`
|
## `Credits`
|
||||||
|
|||||||
@@ -83,6 +83,8 @@ cuda = ["torch"]
|
|||||||
cuda130 = ["torch"]
|
cuda130 = ["torch"]
|
||||||
# AMD GPU (Linux) (ROCm 6.4) # uv tool install abogen[rocm]
|
# AMD GPU (Linux) (ROCm 6.4) # uv tool install abogen[rocm]
|
||||||
rocm = ["torch", "pytorch-triton-rocm"]
|
rocm = ["torch", "pytorch-triton-rocm"]
|
||||||
|
# Development dependencies # uv tool install abogen[dev]
|
||||||
|
dev = ["build"]
|
||||||
|
|
||||||
# --- KOKORO CONFIGURATION (for macOS) ---
|
# --- KOKORO CONFIGURATION (for macOS) ---
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user