Dockerfile+ FastAPI for the CPU version added. #794

danikhani · 2023-07-30T20:25:56Z

Thanks to @henryruhs at #https://github.com/s0md3v/roop/issues/632#issue-1776243764 for giving a template of Dockerfiles. A fastAPI endpoint for starting a job and Dockerfile for starting the roop with the API endpoint in a container has been added.

For adding a docker support to the project, a small part of the code must have been changed. The models of face_analyser (roop/face_analyser.py) will be saved under ./models path in the project. That way they will be also saved if the containers stops working or system shuts down. Other than that, there are no additional changes into the original source code.
There is a single new class for fastAPI, it is possible to select the target and source image as body in the API-call and also add all the parameters which could possibly needed as string parameters.
There are a new Dockerfile, docker-compose.yml and a requirements-docker.txt
Docker starting and stopping has been documented in the readme.md

…ved under ./model path

…et in the new run_api.py via the api query parameters

…variable from dockerfile.

…equirements

…ider is selected

henryruhs · 2023-07-30T21:59:21Z

@danikhani I reviewed the code 🙈

lint fails in pipeline... send PR to next branch

henryruhs · 2023-07-30T21:51:07Z

.gitignore

@@ -1,4 +1,5 @@
 .idea
 models
 temp
+workdir


Please undo this

henryruhs · 2023-07-30T21:52:30Z

Dockerfile

+RUN git clone https://github.com/s0md3v/roop.git /roop
+RUN pip install -r roop/requirements-docker.txt
+
+CMD ["python", "/roop/run_api.py"]


single quotes
should be renamed to api.py

CMD should be double quotes. Quote from docs:

The exec form is parsed as a JSON array, which means that you must use double-quotes (“) around words not single-quotes (‘).

Renamed the file to api.py

henryruhs · 2023-07-30T21:54:32Z

docker-compose.yml

+version: '3.8'
+
+services:
+ roopapi:


henryruhs · 2023-07-30T21:55:20Z

docker-compose.yml

+ build:
+ context: .
+ dockerfile: Dockerfile
+ restart: unless-stopped


henryruhs · 2023-07-30T22:00:29Z

docker-compose.yml

+ restart: unless-stopped
+ volumes:
+ - roop-data:/roop
+ - open-nsfw:/root/.opennsfw2


can you explain why that is exposed? all dependencies should be inside the container

The idea was to save the models in the volume. So if the container crashes, or the host pc shutsdown, the models remain and a new download is not required.

henryruhs · 2023-07-30T22:19:07Z

run_api.py

+ roop.globals.reference_face_position = roop_parameters.reference_face_position
+ roop.globals.reference_frame_number = roop_parameters.reference_frame_number
+ roop.globals.similar_face_distance = roop_parameters.similar_face_distance
+ roop.globals.temp_frame_format = roop_parameters.temp_frame_format


ENV to lock temp frame format, temp frame quality and video quality?

henryruhs · 2023-07-30T22:22:11Z

run_api.py

+app = FastAPI()
+
+class RoopModel(BaseModel):
+ frame_processor: Optional[list] = ['face_swapper']


I like that you extended the typing... but we now have repeated code from globals.py

Removed the Model class. Now all parameters are part of the method. Unfortunately, there is no certain way to avoid code duplication without changing a lot of root repo.

henryruhs · 2023-07-30T22:23:16Z

run_api.py

+ execution_provider_list = ['cpu']
+ print(execution_provider_list)
+
+ # setting paths


for everything comment you have here... create a speaking method 😉

the body of the method is too long

Done. Comments are removed. Moved some of the logic out of the method.

henryruhs · 2023-07-30T22:25:08Z

run_api.py

+ target_file: UploadFile = File(...),
+ roop_parameters: RoopModel = Depends()
+):
+ # Removing the folder and its content if it already exists


It can probably merged with clear_temp()

anyway... it might not work when multiple user access the API as we delete data from multiple sessions

Good point! Solved the problem with having multiple user accessing the api by giving each request its own unique UUID4 path. This way the files related to an API call can get removed after the response has been sent. Other files related to other requests wont get removed.

henryruhs · 2023-07-30T22:27:35Z

openapi.json

@@ -0,0 +1,282 @@
+{


this is generated output just for swagger or does fastapi actual consume it to define/validate the route response and request bodies?

if generated just for swagger it should not be committed... add to README how to generate it

It was just for swagger. Its purpose was to allow users learn the API endpoint. The generation guid is added to the readme.

…er, since they still dont work properly

henryruhs · 2023-08-01T13:54:06Z

@danikhani I was thinking about your approach to move all models / weights to our folder. From what I understand, you like to provide all of them inside the image so you have a ready to start container and once the container stopped, the models / weights are persist.

This will cause a huge image
Lot of maintenance to observe third party changes
Needs a pre_check() trigger during image build to download all

That being said: I suggest to mount ./models to the host instead and leave the models / weights there.

…ed uniq folder for each api request to save and edit files.

danikhani · 2023-08-02T20:50:27Z

@danikhani I was thinking about your approach to move all models / weights to our folder. From what I understand, you like to provide all of them inside the image so you have a ready to start container and once the container stopped, the models / weights are persist.
1. This will cause a huge image

2. Lot of maintenance to observe third party changes

3. Needs a pre_check() trigger during image build to download all
That being said: I suggest to mount ./models to the host instead and leave the models / weights there.

Totally with you on this one. I just wanted to avoid users download the models everytime they restart their pc/host. Now all the three models (roop, faceanaylser and nsfw2) are located in the model directory. Only model directory is being mounted as a volume.

…readme. Using annotated instead of a class for the API configuration.

danikhani · 2023-08-02T21:23:38Z

I applied the requested changes. After a review I will make anotherPR to the correct branch.

henryruhs · 2023-08-02T21:42:35Z

I applied the requested changes. After a review I will make anotherPR to the correct branch.

I would also prefer to have a fresh PR as well as GitHub makes it hard to track outdates code fragments. Thanks for the effort so far...

Reach out via Discord in case you have questions.

henryruhs · 2023-08-03T15:34:39Z

Dockerfile

+RUN pip install -r roop/requirements.txt
+RUN pip install -r roop/requirements-docker.txt
+
+CMD ["python", "/roop/api.py"]


CMD ['python', '/roop/api.py']

henryruhs · 2023-08-03T15:35:34Z

Dockerfile

+RUN git clone https://github.com/s0md3v/roop.git /roop
+
+RUN pip install -r roop/requirements.txt
+RUN pip install -r roop/requirements-docker.txt


Rename to requirements-headless.txt and use it for docker and CI...

henryruhs · 2023-08-03T15:35:46Z

Dockerfile

+
+RUN git clone https://github.com/s0md3v/roop.git /roop
+
+RUN pip install -r roop/requirements.txt


Remove RUN pip install -r roop/requirements.txt

henryruhs · 2023-08-03T15:36:03Z

Dockerfile

+RUN apt-get update && apt-get install -y ffmpeg
+RUN pip install --upgrade pip
+
+RUN git clone https://github.com/s0md3v/roop.git /roop


look it to a tag

henryruhs · 2023-08-03T15:36:31Z

api.py

+
+
+TEMP_FILES_PATH: str
+app = FastAPI()


rename app to API

henryruhs · 2023-08-03T15:37:51Z

api.py

+ roop.globals.target_path = target_saving_path_complete
+ roop.globals.output_path = output_saving_path_complete
+
+ try:


move this block to a method

henryruhs · 2023-08-03T15:38:30Z

api.py

+ update_status(str(e))
+ raise HTTPException(status_code=500, detail="Error while running roop.")
+
+ background_tasks.add_task(remove_request_dir, path=request_dir_path)


dir = directory, rel = relative, e = exception ... do not use short variable names

henryruhs · 2023-08-03T15:39:04Z

api.py

+
+
+@app.post("/start")
+async def image_file(


the method name should match the route in my opinion

henryruhs · 2023-08-03T15:39:41Z

api.py

+ roop.globals.output_video_encoder = output_video_encoder
+ roop.globals.execution_threads = execution_threads
+
+ request_uuid_str = str(uuid.uuid4())


move to a method that says what is happening here

henryruhs · 2023-08-03T15:40:59Z

docker-compose.yml

+
+services:
+ roop-api:
+ environment:


setting environment should be optional and therefore overrides to the defaults - you made it mandatory

henryruhs · 2023-08-03T15:42:32Z

api.py

+
+@app.post("/start")
+async def image_file(
+ background_tasks: BackgroundTasks,


the core.py and api.py should use the same defaults - either we hardcode it in the globals or introduce a get_defaults() method there

henryruhs · 2023-08-03T15:43:12Z

api.py

+
+
+@app.post("/start")
+async def image_file(


I prefer the endpoint accepts images and videos

henryruhs · 2023-08-03T15:43:40Z

docker-compose.yml

+ dockerfile: Dockerfile
+ restart: always
+ volumes:
+ - roop-data:/roop/models


roop-models:/roop/models

henryruhs · 2023-08-03T15:44:17Z

roop/predictor.py


 PREDICTOR = None
 THREAD_LOCK = threading.Lock()
 MAX_PROBABILITY = 0.85

+rel_path_to_nsfw_model = resolve_relative_path('../models/nsfw2')


dont make this global, resolve it in the methods

henryruhs · 2023-08-03T15:45:07Z

@danikhani I reviewed it once again - some checks from the https://github.com/s0md3v/roop/issues/632 are not fullfilt such as cuda support via an extra file.

henryruhs · 2023-08-14T09:29:55Z

Next branch conflicts the original PR - I will add a Dockerfile by myself and serve the Gradio instead of FastAPI for the moment.

Dan added 11 commits July 29, 2023 23:24

Set a path to save the face_analyser.py models. The models will be sa…

34b54b1

…ved under ./model path

Added fastapi endpoints for starting roop. The parameters are being s…

3fe154d

…et in the new run_api.py via the api query parameters

execution_provider for docker fastapi is now given as an environment …

95f3abd

…variable from dockerfile.

Added first version of dockerfiles and docker compose.yml

b19acff

added fix to the dockerfile and fastapi requirements in requirement.txt

ddc8397

replaced update_status with simple print. added python-multipart to r…

056c2f2

…equirements

added requirements for docker in an extra requirements-docker.txt

b2afdf8

fixed bugs in gpu docker

79eb2e0

added path to save opennsfw2 model. Added printing what executionprov…

29acc04

…ider is selected

fixed saving path for nsfw2 model.

f5cbd3d

added fix to nsfw model path.

c7188dd

henryruhs suggested changes Jul 30, 2023

View reviewed changes

added documentation and also openapi export. Removed the cuda contain…

a7ec66a

…er, since they still dont work properly

danikhani force-pushed the docker branch from 003d293 to a7ec66a Compare July 31, 2023 19:37

Dan added 2 commits July 31, 2023 23:07

nsfw path debug

aacf784

added permanent path to the nsfw2 to be able to save the model

300816b

danikhani force-pushed the docker branch from 31445bb to 300816b Compare July 31, 2023 21:07

Dan added 2 commits August 1, 2023 18:48

added env variables to docker-compose.yml for better changablity. Add…

9ce4a29

…ed uniq folder for each api request to save and edit files.

added new requirements-docker.txt. cleaned up api.py

7731d6b

removed the openapi export and added a guid for generating it in the …

d17c077

…readme. Using annotated instead of a class for the API configuration.

danikhani requested a review from henryruhs August 2, 2023 21:21

henryruhs changed the base branch from main to next August 3, 2023 07:33