Skip to content

Commit 45cd6b7

Browse files
committed
docs: added "api reference"
1 parent 6efedf2 commit 45cd6b7

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,59 @@
88
- Automatic model loading and initialization
99
- [UploadThing](https://uploadthing.com/) integration for video upload
1010

11+
## API Reference
12+
13+
### Input Parameters
14+
15+
```json
16+
{
17+
"input": {
18+
"positive_prompt": "a cat playing with yarn, cute, fluffy, detailed fur",
19+
"negative_prompt": "",
20+
"width": 848,
21+
"height": 480,
22+
"seed": 42,
23+
"steps": 40,
24+
"cfg": 6,
25+
"num_frames": 31,
26+
"vae": {
27+
"enable_vae_tiling": false,
28+
"tile_sample_min_width": 312,
29+
"tile_sample_min_height": 160,
30+
"tile_overlap_factor_width": 0.25,
31+
"tile_overlap_factor_height": 0.25,
32+
"auto_tile_size": false,
33+
"frame_batch_size": 8
34+
}
35+
}
36+
}
37+
```
38+
39+
#### Core Parameters
40+
41+
| Parameter | Description | Default |
42+
| ----------------- | ---------------------------------------------------------------------- | ------- |
43+
| `positive_prompt` | Text description of what you want to generate | `""` |
44+
| `negative_prompt` | Text description of what you want to avoid in the generation | `""` |
45+
| `width` | Output video width in pixels | `848` |
46+
| `height` | Output video height in pixels | `480` |
47+
| `seed` | Random seed for reproducible results | `1337` |
48+
| `steps` | Number of denoising steps (higher = better quality, slower generation) | `40` |
49+
| `cfg` | Classifier-free guidance scale (how closely to follow the prompt) | `6` |
50+
| `num_frames` | Number of frames to generate | `31` |
51+
52+
#### VAE Parameters
53+
54+
| Parameter | Description | Default |
55+
| ---------------------------- | ------------------------------------------ | ------- |
56+
| `enable_vae_tiling` | Enable tiling for VAE decoding | `false` |
57+
| `tile_sample_min_width` | Minimum tile width when tiling is enabled | `312` |
58+
| `tile_sample_min_height` | Minimum tile height when tiling is enabled | `160` |
59+
| `tile_overlap_factor_width` | Overlap factor between tiles (width) | `0.25` |
60+
| `tile_overlap_factor_height` | Overlap factor between tiles (height) | `0.25` |
61+
| `auto_tile_size` | Automatically determine tile size | `false` |
62+
| `frame_batch_size` | Number of frames to process in parallel | `8` |
63+
1164
## Deployment
1265

1366
Deploy this worker on RunPod using the [GitHub Integration](https://docs.runpod.io/serverless/github-integration).

0 commit comments

Comments
 (0)