benjamin-paine commited on
Commit
62a13cf
1 Parent(s): aad8056

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -15
README.md CHANGED
@@ -32,12 +32,12 @@ A command-line utilitiy `aniportrait` is installed with the package.
32
  ```sh
33
  Usage: aniportrait [OPTIONS] INPUT_IMAGE
34
 
35
- Run AniPortrait on an input image with a video, and/or audio file. - When
36
- only a video file is provided, a video-to-video (face reenactment) animation
37
- is performed. - When only an audio file is provided, an audio-to-video (lip-
38
- sync) animation is performed. - When both a video and audio file are
39
- provided, a video-to-video animation is performed with the audio as guidance
40
- for the face and mouth movements.
41
 
42
  Options:
43
  -v, --video FILE Video file to drive the animation.
@@ -64,23 +64,24 @@ Options:
64
  -m, --model TEXT HuggingFace model name.
65
  -nh, --no-half Do not use half precision.
66
  -g, --gpu-id INTEGER GPU ID to use.
67
- -sf, --single-file Download and use a single file instead of a
68
  directory.
69
- -cf, --config-file TEXT Config file to use when using the single-
70
- file option. Accepts a path or a filename in
71
- the same directory as the single file. Will
72
- download from the repository passed in the
73
- model option if not provided. [default:
74
- config.json]
75
  -mf, --model-filename TEXT The model file to download when using the
76
- single-file option. [default:
77
  aniportrait.safetensors]
78
  -rs, --remote-subfolder TEXT Remote subfolder to download from when using
79
- the single-file option.
80
  -c, --cache-dir DIRECTORY Cache directory to download to. Default uses
81
  the huggingface cache.
82
  -o, --output FILE Output file. [default: output.mp4]
83
  --help Show this message and exit.
 
84
  ```
85
 
86
  ## Python
 
32
  ```sh
33
  Usage: aniportrait [OPTIONS] INPUT_IMAGE
34
 
35
+ Run AniPortrait on an input image with a video, and/or audio file. When only
36
+ a video file is provided, a video-to-video (face reenactment) animation is
37
+ performed. When only an audio file is provided, an audio-to-video (lip-sync)
38
+ animation is performed. When both a video and audio file are provided, a
39
+ video-to-video animation is performed with the audio as guidance for the
40
+ face and mouth movements.
41
 
42
  Options:
43
  -v, --video FILE Video file to drive the animation.
 
64
  -m, --model TEXT HuggingFace model name.
65
  -nh, --no-half Do not use half precision.
66
  -g, --gpu-id INTEGER GPU ID to use.
67
+ -sf, --model-single-file Download and use a single file instead of a
68
  directory.
69
+ -cf, --config-file TEXT Config file to use when using the model-
70
+ single-file option. Accepts a path or a
71
+ filename in the same directory as the single
72
+ file. Will download from the repository
73
+ passed in the model option if not provided.
74
+ [default: config.json]
75
  -mf, --model-filename TEXT The model file to download when using the
76
+ model-single-file option. [default:
77
  aniportrait.safetensors]
78
  -rs, --remote-subfolder TEXT Remote subfolder to download from when using
79
+ the model-single-file option.
80
  -c, --cache-dir DIRECTORY Cache directory to download to. Default uses
81
  the huggingface cache.
82
  -o, --output FILE Output file. [default: output.mp4]
83
  --help Show this message and exit.
84
+
85
  ```
86
 
87
  ## Python