Skip to content

Commit

Permalink
docs: added "api reference"
Browse files Browse the repository at this point in the history
  • Loading branch information
TimPietrusky committed Dec 12, 2024
1 parent 6efedf2 commit 45cd6b7
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,59 @@
- Automatic model loading and initialization
- [UploadThing](https://uploadthing.com/) integration for video upload

## API Reference

### Input Parameters

```json
{
"input": {
"positive_prompt": "a cat playing with yarn, cute, fluffy, detailed fur",
"negative_prompt": "",
"width": 848,
"height": 480,
"seed": 42,
"steps": 40,
"cfg": 6,
"num_frames": 31,
"vae": {
"enable_vae_tiling": false,
"tile_sample_min_width": 312,
"tile_sample_min_height": 160,
"tile_overlap_factor_width": 0.25,
"tile_overlap_factor_height": 0.25,
"auto_tile_size": false,
"frame_batch_size": 8
}
}
}
```

#### Core Parameters

| Parameter | Description | Default |
| ----------------- | ---------------------------------------------------------------------- | ------- |
| `positive_prompt` | Text description of what you want to generate | `""` |
| `negative_prompt` | Text description of what you want to avoid in the generation | `""` |
| `width` | Output video width in pixels | `848` |
| `height` | Output video height in pixels | `480` |
| `seed` | Random seed for reproducible results | `1337` |
| `steps` | Number of denoising steps (higher = better quality, slower generation) | `40` |
| `cfg` | Classifier-free guidance scale (how closely to follow the prompt) | `6` |
| `num_frames` | Number of frames to generate | `31` |

#### VAE Parameters

| Parameter | Description | Default |
| ---------------------------- | ------------------------------------------ | ------- |
| `enable_vae_tiling` | Enable tiling for VAE decoding | `false` |
| `tile_sample_min_width` | Minimum tile width when tiling is enabled | `312` |
| `tile_sample_min_height` | Minimum tile height when tiling is enabled | `160` |
| `tile_overlap_factor_width` | Overlap factor between tiles (width) | `0.25` |
| `tile_overlap_factor_height` | Overlap factor between tiles (height) | `0.25` |
| `auto_tile_size` | Automatically determine tile size | `false` |
| `frame_batch_size` | Number of frames to process in parallel | `8` |

## Deployment

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

0 comments on commit 45cd6b7

Please sign in to comment.