Fix Grammar in README

pull/877/head
KRSHH 2025-01-06 17:51:00 +05:30 committed by GitHub
parent b38831dfdf
commit 7f38539508
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 69 additions and 58 deletions

127
README.md
View File

@ -13,17 +13,16 @@
<img src="media/avgpcperformancedemo.gif" alt="Performance Demo GIF"> <img src="media/avgpcperformancedemo.gif" alt="Performance Demo GIF">
</p> </p>
## Disclaimer ## Disclaimer
This software is intended as a productive contribution to the AI-generated media industry. It aims to assist artists with tasks like animating custom characters or using them as models for clothing, etc. This software is intended as a productive contribution to the AI-generated media industry. It aims to assist artists with tasks like animating custom characters or using them as models for clothing, etc.
We are aware of the potential for unethical applications and are committed to preventative measures. A built-in check prevents the program from processing inappropriate media (nudity, graphic content, sensitive material like war footage, etc.). We will continue to develop this project responsibly, adhering to law and ethics. We may shut down the project or add watermarks if legally required. We are aware of the potential for unethical applications and are committed to preventative measures. A built-in check prevents the program from processing inappropriate media (nudity, graphic content, sensitive material like war footage, etc.). We will continue to develop this project responsibly, adhering to the law and ethics. We may shut down the project or add watermarks if legally required.
Users are expected to use this software responsibly and legally. If using a real person's face, obtain their consent and clearly label any output as a deepfake when sharing online. We are not responsible for end-user actions. Users are expected to use this software responsibly and legally. If using a real person's face, obtain their consent and clearly label any output as a deepfake when sharing online. We are not responsible for end-user actions.
## Quick Start - Download Prebuilt ## Quick Start - Download Prebuilt
<div style="margin: 28px 0;"> <div style="margin: 28px 0;">
<div style="margin-bottom: 20px;"> <div style="margin-bottom: 20px;">
<a href="https://hacksider.gumroad.com/l/vccdmm" target="_blank"> <a href="https://hacksider.gumroad.com/l/vccdmm" target="_blank">
@ -37,9 +36,9 @@ Users are expected to use this software responsibly and legally. If using a real
</div> </div>
</div> </div>
## Installation (Manual) ## Installation (Manual)
**Please be aware that the installation needs technical skills and is not for beginners, consider downloading the prebuilt.**
**Please be aware that the installation requires technical skills and is not for beginners. Consider downloading the prebuilt version.**
<details> <details>
<summary>Click to see the process</summary> <summary>Click to see the process</summary>
@ -48,24 +47,24 @@ Users are expected to use this software responsibly and legally. If using a real
This is more likely to work on your computer but will be slower as it utilizes the CPU. This is more likely to work on your computer but will be slower as it utilizes the CPU.
**1. Setup Your Platform** **1. Set up Your Platform**
- Python (3.10 recommended) - Python (3.10 recommended)
- pip - pip
- git - git
- [ffmpeg](https://www.youtube.com/watch?v=OlNWCpFdVMA) - [ffmpeg](https://www.youtube.com/watch?v=OlNWCpFdVMA)
- [Visual Studio 2022 Runtimes (Windows)](https://visualstudio.microsoft.com/visual-cpp-build-tools/) - [Visual Studio 2022 Runtimes (Windows)](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
**2. Clone Repository** **2. Clone the Repository**
```bash ```bash
https://github.com/hacksider/Deep-Live-Cam.git https://github.com/hacksider/Deep-Live-Cam.git
``` ```
**3. Download Models** **3. Download the Models**
1. [GFPGANv1.4](https://huggingface.co/hacksider/deep-live-cam/resolve/main/GFPGANv1.4.pth) 1. [GFPGANv1.4](https://huggingface.co/hacksider/deep-live-cam/resolve/main/GFPGANv1.4.pth)
2. [inswapper_128_fp16.onnx](https://huggingface.co/hacksider/deep-live-cam/resolve/main/inswapper_128.onnx) (Note: Use this [replacement version](https://github.com/facefusion/facefusion-assets/releases/download/models/inswapper_128.onnx) if you encounter issues) 2. [inswapper\_128\_fp16.onnx](https://huggingface.co/hacksider/deep-live-cam/resolve/main/inswapper_128.onnx) (Note: Use this [replacement version](https://github.com/facefusion/facefusion-assets/releases/download/models/inswapper_128.onnx) if you encounter issues)
Place these files in the "**models**" folder. Place these files in the "**models**" folder.
@ -85,18 +84,20 @@ brew install python-tk@3.10
**Run:** If you don't have a GPU, you can run Deep-Live-Cam using `python run.py`. Note that initial execution will download models (~300MB). **Run:** If you don't have a GPU, you can run Deep-Live-Cam using `python run.py`. Note that initial execution will download models (~300MB).
### GPU Acceleration
### GPU Acceleration
**CUDA Execution Provider (Nvidia)** **CUDA Execution Provider (Nvidia)**
1. Install [CUDA Toolkit 11.8](https://developer.nvidia.com/cuda-11-8-0-download-archive) or [CUDA Toolkit 12.1.1](https://developer.nvidia.com/cuda-12-1-1-download-archive) 1. Install [CUDA Toolkit 11.8](https://developer.nvidia.com/cuda-11-8-0-download-archive) or [CUDA Toolkit 12.1.1](https://developer.nvidia.com/cuda-12-1-1-download-archive)
2. Install dependencies: 2. Install dependencies:
```bash ```bash
pip uninstall onnxruntime onnxruntime-gpu pip uninstall onnxruntime onnxruntime-gpu
pip install onnxruntime-gpu==1.16.3 pip install onnxruntime-gpu==1.16.3
``` ```
3. Usage: 3. Usage:
```bash ```bash
python run.py --execution-provider cuda python run.py --execution-provider cuda
``` ```
@ -104,11 +105,14 @@ python run.py --execution-provider cuda
**CoreML Execution Provider (Apple Silicon)** **CoreML Execution Provider (Apple Silicon)**
1. Install dependencies: 1. Install dependencies:
```bash ```bash
pip uninstall onnxruntime onnxruntime-silicon pip uninstall onnxruntime onnxruntime-silicon
pip install onnxruntime-silicon==1.13.1 pip install onnxruntime-silicon==1.13.1
``` ```
2. Usage: 2. Usage:
```bash ```bash
python run.py --execution-provider coreml python run.py --execution-provider coreml
``` ```
@ -116,11 +120,14 @@ python run.py --execution-provider coreml
**CoreML Execution Provider (Apple Legacy)** **CoreML Execution Provider (Apple Legacy)**
1. Install dependencies: 1. Install dependencies:
```bash ```bash
pip uninstall onnxruntime onnxruntime-coreml pip uninstall onnxruntime onnxruntime-coreml
pip install onnxruntime-coreml==1.13.1 pip install onnxruntime-coreml==1.13.1
``` ```
2. Usage: 2. Usage:
```bash ```bash
python run.py --execution-provider coreml python run.py --execution-provider coreml
``` ```
@ -128,11 +135,14 @@ python run.py --execution-provider coreml
**DirectML Execution Provider (Windows)** **DirectML Execution Provider (Windows)**
1. Install dependencies: 1. Install dependencies:
```bash ```bash
pip uninstall onnxruntime onnxruntime-directml pip uninstall onnxruntime onnxruntime-directml
pip install onnxruntime-directml==1.15.1 pip install onnxruntime-directml==1.15.1
``` ```
2. Usage: 2. Usage:
```bash ```bash
python run.py --execution-provider directml python run.py --execution-provider directml
``` ```
@ -140,41 +150,43 @@ python run.py --execution-provider directml
**OpenVINO™ Execution Provider (Intel)** **OpenVINO™ Execution Provider (Intel)**
1. Install dependencies: 1. Install dependencies:
```bash ```bash
pip uninstall onnxruntime onnxruntime-openvino pip uninstall onnxruntime onnxruntime-openvino
pip install onnxruntime-openvino==1.15.0 pip install onnxruntime-openvino==1.15.0
``` ```
2. Usage: 2. Usage:
```bash ```bash
python run.py --execution-provider openvino python run.py --execution-provider openvino
``` ```
</details> </details>
## Usage ## Usage
**1. Image/Video Mode** **1. Image/Video Mode**
- Execute `python run.py`. - Execute `python run.py`.
- Choose a source face image and a target image/video. - Choose a source face image and a target image/video.
- Click "Start". - Click "Start".
- The output will be saved in a directory named after the target video. - The output will be saved in a directory named after the target video.
**2. Webcam Mode** **2. Webcam Mode**
- Execute `python run.py`. - Execute `python run.py`.
- Select a source face image. - Select a source face image.
- Click "Live". - Click "Live".
- Wait for the preview to appear (10-30 seconds). - Wait for the preview to appear (10-30 seconds).
- Use a screen capture tool like OBS to stream. - Use a screen capture tool like OBS to stream.
- To change the face, select a new source image. - To change the face, select a new source image.
## Features - Everything is realtime ## Features - Everything is real-time
### Mouth Mask ### Mouth Mask
**Retain your original mouth using Mouth Mask** **Retain your original mouth using Mouth Mask**
![resizable-gif](media/ludwig.gif) ![resizable-gif](media/ludwig.gif)
@ -182,15 +194,14 @@ python run.py --execution-provider openvino
**Use different faces on multiple subjects** **Use different faces on multiple subjects**
![face_mapping_source](media/streamers.gif) ![face\_mapping\_source](media/streamers.gif)
### Your Movie, Your Face ### Your Movie, Your Face
**Watch movies with any face in realtime** **Watch movies with any face in real-time**
![movie](media/movie.gif) ![movie](media/movie.gif)
## Benchmarks ## Benchmarks
**Nearly 0% detection!** **Nearly 0% detection!**
@ -225,42 +236,42 @@ options:
Looking for a CLI mode? Using the -s/--source argument will make the run program in cli mode. Looking for a CLI mode? Using the -s/--source argument will make the run program in cli mode.
## Press ## Press
**We are always open to criticism and ready to improve, that's why we didn't cherrypick anything.**
- [*"Deep-Live-Cam goes viral, allowing anyone to become a digital doppelganger"*](https://arstechnica.com/information-technology/2024/08/new-ai-tool-enables-real-time-face-swapping-on-webcams-raising-fraud-concerns/) - Ars Technica **We are always open to criticism and are ready to improve, that's why we didn't cherry-pick anything.**
- [*"Thanks Deep Live Cam, shapeshifters are among us now"*](https://dataconomy.com/2024/08/15/what-is-deep-live-cam-github-deepfake/) - Dataconomy
- [*"This free AI tool lets you become anyone during video-calls"*](https://www.newsbytesapp.com/news/science/deep-live-cam-ai-impersonation-tool-goes-viral/story) - NewsBytes - [\*"Deep-Live-Cam goes viral, allowing anyone to become a digital doppelganger"\*](https://arstechnica.com/information-technology/2024/08/new-ai-tool-enables-real-time-face-swapping-on-webcams-raising-fraud-concerns/) - Ars Technica
- [*"OK, this viral AI live stream software is truly terrifying"*](https://www.creativebloq.com/ai/ok-this-viral-ai-live-stream-software-is-truly-terrifying) - Creative Bloq - [\*"Thanks Deep Live Cam, shapeshifters are among us now"\*](https://dataconomy.com/2024/08/15/what-is-deep-live-cam-github-deepfake/) - Dataconomy
- [*"Deepfake AI Tool Lets You Become Anyone in a Video Call With Single Photo"*](https://petapixel.com/2024/08/14/deep-live-cam-deepfake-ai-tool-lets-you-become-anyone-in-a-video-call-with-single-photo-mark-zuckerberg-jd-vance-elon-musk/) - PetaPixel - [\*"This free AI tool lets you become anyone during video-calls"\*](https://www.newsbytesapp.com/news/science/deep-live-cam-ai-impersonation-tool-goes-viral/story) - NewsBytes
- [*"Deep-Live-Cam Uses AI to Transform Your Face in Real-Time, Celebrities Included"*](https://www.techeblog.com/deep-live-cam-ai-transform-face/) - TechEBlog - [\*"OK, this viral AI live stream software is truly terrifying"\*](https://www.creativebloq.com/ai/ok-this-viral-ai-live-stream-software-is-truly-terrifying) - Creative Bloq
- [*"An AI tool that "makes you look like anyone" during a video call is going viral online"*](https://telegrafi.com/en/a-tool-that-makes-you-look-like-anyone-during-a-video-call-is-going-viral-on-the-Internet/) - Telegrafi - [\*"Deepfake AI Tool Lets You Become Anyone in a Video Call With Single Photo"\*](https://petapixel.com/2024/08/14/deep-live-cam-deepfake-ai-tool-lets-you-become-anyone-in-a-video-call-with-single-photo-mark-zuckerberg-jd-vance-elon-musk/) - PetaPixel
- [*"This Deepfake Tool Turning Images Into Livestreams is Topping the GitHub Charts"*](https://decrypt.co/244565/this-deepfake-tool-turning-images-into-livestreams-is-topping-the-github-charts) - Emerge - [\*"Deep-Live-Cam Uses AI to Transform Your Face in Real-Time, Celebrities Included"\*](https://www.techeblog.com/deep-live-cam-ai-transform-face/) - TechEBlog
- [*"New Real-Time Face-Swapping AI Allows Anyone to Mimic Famous Faces"*](https://www.digitalmusicnews.com/2024/08/15/face-swapping-ai-real-time-mimic/) - Digital Music News - [\*"An AI tool that "makes you look like anyone" during a video call is going viral online"\*](https://telegrafi.com/en/a-tool-that-makes-you-look-like-anyone-during-a-video-call-is-going-viral-on-the-Internet/) - Telegrafi
- [*"This real-time webcam deepfake tool raises alarms about the future of identity theft"*](https://www.diyphotography.net/this-real-time-webcam-deepfake-tool-raises-alarms-about-the-future-of-identity-theft/) - DIYPhotography - [\*"This Deepfake Tool Turning Images Into Livestreams is Topping the GitHub Charts"\*](https://decrypt.co/244565/this-deepfake-tool-turning-images-into-livestreams-is-topping-the-github-charts) - Emerge
- [*"That's Crazy, Oh God. That's Fucking Freaky Dude... That's So Wild Dude"*](https://www.youtube.com/watch?time_continue=1074&v=py4Tc-Y8BcY) - SomeOrdinaryGamers - [\*"New Real-Time Face-Swapping AI Allows Anyone to Mimic Famous Faces"\*](https://www.digitalmusicnews.com/2024/08/15/face-swapping-ai-real-time-mimic/) - Digital Music News
- [*"Alright look look look, now look chat, we can do any face we want to look like chat"*](https://www.youtube.com/live/mFsCe7AIxq8?feature=shared&t=2686) - IShowSpeed - [\*"This real-time webcam deepfake tool raises alarms about the future of identity theft"\*](https://www.diyphotography.net/this-real-time-webcam-deepfake-tool-raises-alarms-about-the-future-of-identity-theft/) - DIYPhotography
- [\*"That's Crazy, Oh God. That's Fucking Freaky Dude... That's So Wild Dude"\*](https://www.youtube.com/watch?time_continue=1074&v=py4Tc-Y8BcY) - SomeOrdinaryGamers
- [\*"Alright look look look, now look chat, we can do any face we want to look like chat"\*](https://www.youtube.com/live/mFsCe7AIxq8?feature=shared&t=2686) - IShowSpeed
## Credits ## Credits
- [ffmpeg](https://ffmpeg.org/): for making video related operations easy - [ffmpeg](https://ffmpeg.org/): for making video-related operations easy
- [deepinsight](https://github.com/deepinsight): for their [insightface](https://github.com/deepinsight/insightface) project which provided a well-made library and models. Please be reminded that the [use of the model is for non-commercial research purposes only](https://github.com/deepinsight/insightface?tab=readme-ov-file#license). - [deepinsight](https://github.com/deepinsight): for their [insightface](https://github.com/deepinsight/insightface) project which provided a well-made library and models. Please be reminded that the [use of the model is for non-commercial research purposes only](https://github.com/deepinsight/insightface?tab=readme-ov-file#license).
- [havok2-htwo](https://github.com/havok2-htwo) : for sharing the code for webcam - [havok2-htwo](https://github.com/havok2-htwo): for sharing the code for webcam
- [GosuDRM](https://github.com/GosuDRM) : for open version of roop - [GosuDRM](https://github.com/GosuDRM): for the open version of roop
- [pereiraroland26](https://github.com/pereiraroland26) : Multiple faces support - [pereiraroland26](https://github.com/pereiraroland26): Multiple faces support
- [vic4key](https://github.com/vic4key) : For supporting/contributing on this project - [vic4key](https://github.com/vic4key): For supporting/contributing to this project
- [KRSHH](https://github.com/KRSHH) : For his contributions - [kier007](https://github.com/kier007): for improving the user experience
- [kier007](https://github.com/kier007) : for improving the user experience - and [all developers](https://github.com/hacksider/Deep-Live-Cam/graphs/contributors) behind libraries used in this project.
- and [all developers](https://github.com/hacksider/Deep-Live-Cam/graphs/contributors) behind libraries used in this project. - Footnote: Please be informed that the base author of the code is [s0md3v](https://github.com/s0md3v/roop)
- Foot Note: Please be informed that the base author of the code is [s0md3v](https://github.com/s0md3v/roop) - All the wonderful users who helped make this project go viral by starring the repo ❤️
- All the wonderful users who helped making this project go viral by starring the repo ❤️
[![Stargazers](https://reporoster.com/stars/hacksider/Deep-Live-Cam)](https://github.com/hacksider/Deep-Live-Cam/stargazers) [![Stargazers](https://reporoster.com/stars/hacksider/Deep-Live-Cam)](https://github.com/hacksider/Deep-Live-Cam/stargazers)
## Contributions ## Contributions
![Alt](https://repobeats.axiom.co/api/embed/fec8e29c45dfdb9c5916f3a7830e1249308d20e1.svg "Repobeats analytics image") ![Alt](https://repobeats.axiom.co/api/embed/fec8e29c45dfdb9c5916f3a7830e1249308d20e1.svg "Repobeats analytics image")
## Stars to the Moon 🚀 ## Stars to the Moon 🚀
<a href="https://star-history.com/#hacksider/deep-live-cam&Date"> <a href="https://star-history.com/#hacksider/deep-live-cam&Date">