edit readme

This commit is contained in:
Sayo
2025-05-08 00:03:56 +08:00
parent 31d81a5040
commit c43997d6f4
3 changed files with 67 additions and 17 deletions
+65 -14
View File
@@ -1,11 +1,12 @@
# ACE-Step <h1 align="center">ACE-Step</h1>
<h1 align="center">A Step Towards Music Generation Foundation Model</h1>
A Step Towards Music Generation Foundation Model <p align="center">
<a href="https://ace-step.github.io/">Project</a> |
[Project Page](https://ace-step.github.io/) | <a href="https://huggingface.co/ACE-Step/ACE-Step-v1-3.5B">Hugging Face</a> |
[Checkpoints](https://huggingface.co/ACE-Step/ACE-Step-v1-3.5B) | <a href="https://modelscope.cn/models/ACE-Step/ACE-Step-v1-3.5B">ModelScope</a> |
[Space Demo](https://huggingface.co/spaces/ACE-Step/ACE-Step) | <a href="https://huggingface.co/spaces/ACE-Step/ACE-Step">Space Demo</a> |
[Discord](https://discord.gg/rjAZz2xBdG) <a href="https://discord.gg/rjAZz2xBdG">Discord</a>
</p>
--- ---
<p align="center"> <p align="center">
@@ -34,22 +35,72 @@ A Step Towards Music Generation Foundation Model
## 📦 Installation ## 📦 Installation
### Quick Start ### Clone repositories
```bash ```bash
pip install git+https://github.com/ace-step/ACE-Step git clone https://github.com/ace-step/ACE-Step.git
cd ACE-Step
``` ```
On Windows, you may need to run the following before running the command above: ### Prerequisites
* Make sure you have Python installed. You can download it from [python.org](https://www.python.org/).
* You will also need either `Conda` (recommended) or `venv`.
### Environment Setup
It is highly recommended to use a virtual environment to manage project dependencies and avoid conflicts. Choose **one** of the following methods (Conda or venv):
#### Option 1: Using Conda
1. **Create the environment** named `ace_step` with Python 3.10:
```bash
conda create -n ace_step python=3.10 -y
```
2. **Activate the environment:**
```bash
conda activate ace_step
```
#### Option 2: Using venv
1. **Ensure you are using the correct Python version.**
2. **Create the virtual environment** (commonly named `venv`):
```bash
python -m venv venv
```
3. **Activate the environment:**
* **On Windows (cmd.exe):**
```bash
venv\Scripts\activate.bat
```
* **On Windows (PowerShell):**
```powershell
.\venv\Scripts\Activate.ps1
```
*(If you encounter execution policy errors, you might need to run `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process` first)*
* **On Linux / macOS (bash/zsh):**
```bash
source venv/bin/activate
```
### Install Dependencies
On Windows, you need to run the following first:
```bash ```bash
pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu126 pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu126
``` ```
Then, run
```bash
pip install -e .
```
Then, launch the GUI: Then, launch the GUI:
```bash ```bash
acestep # Launch the GUI acestep --port 7865
``` ```
The GUI works on Windows, macOS, and Linux. The GUI works on Windows, macOS, and Linux.
@@ -174,7 +225,7 @@ We use RTF (Real-Time Factor) to measure the performance of ACE-Step. Higher val
### 🔍 Basic Usage ### 🔍 Basic Usage
```bash ```bash
acestep acestep --port 7865
``` ```
### ⚙️ Advanced Usage ### ⚙️ Advanced Usage
-1
View File
@@ -1359,7 +1359,6 @@ class ACEStepPipeline:
f"{base_path}/output_{time.strftime('%Y%m%d%H%M%S')}_{idx}.wav" f"{base_path}/output_{time.strftime('%Y%m%d%H%M%S')}_{idx}.wav"
) )
target_wav = target_wav.float() target_wav = target_wav.float()
print(target_wav)
torchaudio.save( torchaudio.save(
output_path_wav, target_wav, sample_rate=sample_rate, format=format output_path_wav, target_wav, sample_rate=sample_rate, format=format
) )
+2 -2
View File
@@ -3,11 +3,11 @@ from setuptools import setup
setup( setup(
name="ace_step", name="ace_step",
description="ACE Step: A Step Towards Music Generation Foundation Model", description="ACE Step: A Step Towards Music Generation Foundation Model",
long_description=open("README.md").read(), long_description=open("README.md", encoding="utf-8").read(),
long_description_content_type="text/markdown", long_description_content_type="text/markdown",
version="0.1.0", version="0.1.0",
packages=["acestep"], packages=["acestep"],
install_requires=open("requirements.txt").read().splitlines(), install_requires=open("requirements.txt", encoding="utf-8").read().splitlines(),
author="ACE Studio, StepFun AI", author="ACE Studio, StepFun AI",
license="Apache 2.0", license="Apache 2.0",
classifiers=[ classifiers=[