CLI documents

If training is failing to start, and you are not receiving an error message telling you what to do, tell us about it here


Forum rules

Read the FAQs and search the forum before posting a new topic.

This forum is for reporting errors with the Training process. If you want to get tips, or better understand the Training process, then you should look in the Training Discussion forum.

Please mark any answers that fixed your problems so others can find the solutions.

Locked
User avatar
damingxing
Posts: 23
Joined: Mon Jun 13, 2022 8:55 pm
Has thanked: 6 times

CLI documents

Post by damingxing »

Are there any official CLI or API documents?

Thanks

User avatar
torzdf
Posts: 2651
Joined: Fri Jul 12, 2019 12:53 am
Answers: 159
Has thanked: 129 times
Been thanked: 622 times

Re: CLI documents

Post by torzdf »

For cli, not so much. The guides also work for the cli (for the most part anyway. Some tools like preview/manual etc are obviously GUI only).

Code: Select all

python faceswap py -h

will give you command line parameters

Hitting the Generate button in the GUI will generate the underlying command line arguments that will be run, which can be useful for quickly generating Faceswap commands.

Faceswap doesn't really have an API, however there is constantly evolving documentation here:
https://faceswap.readthedocs.io/en/latest/index.html

However, note that some pages are not rendering correctly (just show headers with no detail). I haven't got round to troubleshooting why this is, as they render fine locally.

My word is final

Locked