Rishi Desai commited on
Commit
77096dd
·
1 Parent(s): 70b7d28

added hf metadata

Browse files
Files changed (1) hide show
  1. README.md +13 -42
README.md CHANGED
@@ -1,53 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
1
  # CharVid: Text+Image to Video Workflow
2
 
3
  This tool processes a reference image with a text prompt to generate a new image, which can then be used for video generation.
4
 
5
  ## Installation
6
 
7
- 1. Clone the repository
8
- 2. Install the required dependencies:
9
 
10
  ```bash
11
  pip install -r requirements.txt
12
  ```
13
 
14
- 3. Set up your fal.ai API key:
15
-
16
- ```bash
17
- # For macOS/Linux
18
- export FAL_KEY="your-fal-ai-api-key"
19
-
20
- # For Windows (Command Prompt)
21
- set FAL_KEY=your-fal-ai-api-key
22
-
23
- # For Windows (PowerShell)
24
- $env:FAL_KEY="your-fal-ai-api-key"
25
- ```
26
-
27
- You can get your API key by signing up at [fal.ai](https://fal.ai).
28
-
29
- ## Usage
30
-
31
- ### Step 1: Generate an image from text+image
32
-
33
- Run the script with the following arguments:
34
-
35
- ```bash
36
- python main.py --ref "https://example.com/reference_image.jpg" --prompt "your descriptive prompt" --output "./output"
37
- ```
38
-
39
- Parameters:
40
- - `--ref`: URL or path to the reference image
41
- - `--prompt`: Text prompt describing the desired modifications
42
- - `--output`: Directory where the generated image will be saved
43
-
44
- ## Examples
45
-
46
- ```bash
47
- python main.py --ref "https://storage.googleapis.com/falserverless/gallery/example_inputs_liuyifei.png" --prompt "a woman holding sign with glowing green text 'Hello World'" --output "./output"
48
- ```
49
-
50
- ## Notes
51
-
52
- - The `fal-client` library requires an API key to be set in your environment
53
- - For text+image to image generation, we use the `fal-ai/flux-pulid` model
 
1
+ ---
2
+ title: CharVid
3
+ emoji: 😛
4
+ colorFrom: red
5
+ colorTo: green
6
+ sdk: gradio
7
+ sdk_version: 5.25.2
8
+ app_file: demo.py
9
+ pinned: false
10
+ ---
11
+
12
  # CharVid: Text+Image to Video Workflow
13
 
14
  This tool processes a reference image with a text prompt to generate a new image, which can then be used for video generation.
15
 
16
  ## Installation
17
 
18
+ 1. Install the required dependencies:
 
19
 
20
  ```bash
21
  pip install -r requirements.txt
22
  ```
23
 
24
+ 2. Set up your fal.ai and TogetherAI API keys