Sayoyo commited on
Commit
745e016
·
1 Parent(s): 9e4bff7

feat: update readme

Browse files
Files changed (1) hide show
  1. README.md +69 -1
README.md CHANGED
@@ -1 +1,69 @@
1
- # ACE-Step-1.5
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # ACE-Step-1.5
2
+
3
+ ## Installation
4
+
5
+ This project uses [uv](https://github.com/astral-sh/uv) for dependency management.
6
+
7
+ ### Install uv
8
+
9
+ ```bash
10
+ # Windows (PowerShell)
11
+ powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
12
+
13
+ # macOS/Linux
14
+ curl -LsSf https://astral.sh/uv/install.sh | sh
15
+ ```
16
+
17
+ ### Install Project Dependencies
18
+
19
+ ```bash
20
+ # Sync all dependencies
21
+ uv sync
22
+ ```
23
+
24
+ ### Run the Project
25
+
26
+ ```bash
27
+ # Simplest way - run directly with uv
28
+ uv run acestep
29
+
30
+ # Run with parameters
31
+ uv run acestep --port 7860 --server-name 0.0.0.0 --share
32
+
33
+ # Or use the full module path
34
+ uv run python -m acestep.acestep_v15_pipeline
35
+
36
+ # Just Run profiling
37
+ uv run profile_inference.py
38
+
39
+ # Or activate the virtual environment first
40
+ source .venv/bin/activate # Linux/macOS
41
+ # or
42
+ .venv\Scripts\activate # Windows
43
+
44
+ acestep
45
+ ```
46
+
47
+ Available parameters:
48
+ - `--port`: Server port (default: 7860)
49
+ - `--server-name`: Server address (default: 127.0.0.1, use 0.0.0.0 to listen on all interfaces)
50
+ - `--share`: Create a public share link
51
+ - `--debug`: Enable debug mode
52
+
53
+ ## Development
54
+
55
+ Add new dependencies:
56
+
57
+ ```bash
58
+ # Add runtime dependencies
59
+ uv add package-name
60
+
61
+ # Add development dependencies
62
+ uv add --dev package-name
63
+ ```
64
+
65
+ Update dependencies:
66
+
67
+ ```bash
68
+ uv sync --upgrade
69
+ ```