Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
henryruhs authored Aug 3, 2023
1 parent 9cf0d85 commit c35a0c6
Showing 1 changed file with 25 additions and 4 deletions.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Roop


> Take a video and replace the face in it with a face of your choice. You only need one image of the desired face. No dataset, no training..
[![Build Status](https://img.shields.io/github/actions/workflow/status/s0md3v/roop/ci.yml.svg?branch=main)](https://github.com/s0md3v/roop/actions?query=workflow:ci)
Expand All @@ -9,14 +8,15 @@
## Preview

<div style="display:flex">
<img src="https://raw.githubusercontent.com/s0md3v/roop/next/.github/target-1080p.gif?sanitize=true" width="48%" />
<img src="https://raw.githubusercontent.com/s0md3v/roop/next/.github/target-1080p.gif?sanitize=true" width="48%" alt="Target Video" />

<img src="https://raw.githubusercontent.com/s0md3v/roop/next/.github/output-1080p.gif?sanitize=true" width="48%" />
<img src="https://raw.githubusercontent.com/s0md3v/roop/next/.github/output-1080p.gif?sanitize=true" width="48%" alt="Output Video "/>
</div>


## Installation

Be aware, the installation needs technical skills and is not for beginners. Please do not open platform and installation related issues on GitHub. We have a very helpful [Discord](https://discord.com/invite/Y9p4ZQ2sB9) community that will guide you through your journey to install roop.
Be aware, the installation needs technical skills and is not for beginners. Please do not open platform and installation related issues on GitHub. We have a very helpful [Discord](https://discord.com/invite/Y9p4ZQ2sB9) community that will guide you to install roop.

[Basic](https://roop-ai.gitbook.io/roop/installation/basic) - It is more likely to work on your computer, but will be quite slow

Expand Down Expand Up @@ -52,11 +52,32 @@ python run.py [options]
-v, --version show program's version number and exit
```


### Headless

Using the `-s/--source`, `-t/--target` and `-o/--output` argument will run the program in headless mode.


## Disclaimer

This software is meant to be a productive contribution to the rapidly growing AI-generated media industry. It will help artists with tasks such as animating a custom character or using the character as a model for clothing etc.

The developers of this software are aware of its possible unethical applications and are committed to take preventative measures against them. It has a built-in check which prevents the program from working on inappropriate media including but not limited to nudity, graphic content, sensitive material such as war footage etc. We will continue to develop this project in the positive direction while adhering to law and ethics. This project may be shut down or include watermarks on the output if requested by law.

Users of this software are expected to use this software responsibly while abiding the local law. If face of a real person is being used, users are suggested to get consent from the concerned person and clearly mention that it is a deepfake when posting content online. Developers of this software will not be responsible for actions of end-users.


## Licenses

Our software uses a lot of third party libraries as well pre-trained models. The users should keep in mind that these third party components have their own license and terms, therefore our license is not being applied.


## Credits

- [deepinsight](https://github.com/deepinsight): for their [insightface](https://github.com/deepinsight/insightface) project which provided a well-made library and models.
- all developers behind the libraries used in this project


## Documentation

Read the [documenation](https://roop-ai.gitbook.io/roop) for a deep dive.

0 comments on commit c35a0c6

Please sign in to comment.