Merge pull request #24 from renan-siqueira/develop

Merge develop into main

Author: renan-siqueira

README.md

@@ -13,6 +13,7 @@ This project aims to provide a basic framework for understanding, training, and
 - Save and load trained model weights.
 - Utilize custom datasets by simply pointing to your directory.
 - Test all available autoencoder architectures with a single command.
+- Easily containerize and run using Docker.
 
 ## Getting Started
 
@@ -23,12 +24,32 @@ This project aims to provide a basic framework for understanding, training, and
 - torchvision
 - PIL
 - matplotlib
+- Docker (if you want to containerize the application)
 
 ### Installation
 
+#### Traditional Setup:
+
 1. Clone the repository.
 2. Navigate to the project directory and install the required libraries.
 
+#### Using Docker:
+
+1. Clone the repository.
+2. Navigate to the project directory.
+3. Build the Docker image:
+
+```bash
+docker build -t autoencoder_research .
+```
+
+4. Run the container:
+```bash
+docker run -it --rm -v $(pwd):/app autoencoder_research bash
+```
+
+**Note:** If you're using the Docker method, you'll be inside the container's shell after running the above command. You can execute Python scripts or any other commands just like you would on your local machine.
+
 ## Usage
 
 1. Modify the `settings/settings.py` file to point to your training and validation dataset.
@@ -51,3 +72,29 @@ python run.py --test
 ```
 
 This will train each autoencoder for a few epochs and provide an overview of their performances.
+
+## Common Issues and Solutions
+
+### Issue: Docker Volume and Uppercase Paths on Windows
+
+**Description:** On Windows, when trying to mount a local volume in Docker, an error might arise if the path contains uppercase letters. This is due to Docker expecting repository names (or paths) to be in lowercase.
+
+**Solution:** Convert the current directory path to lowercase and replace backslashes with regular slashes. If you're using Git Bash or a similar terminal on Windows, follow the steps below:
+
+1. Get the full path of the current directory in Windows format:
+
+```bash
+win_path=$(pwd -W)
+```
+
+2. Convert the path to lowercase and replace backslashes with regular slashes:
+
+```bash
+lowercase_path=$(echo $win_path | tr '[:upper:]' '[:lower:]' | sed 's|\\|/|g')
+```
+
+3. Use this path in your Docker command:
+
+```bash
+docker run -it --rm -v "/$lowercase_path":/app autoencoder_research bash
+```

reset_dataset.py

@@ -6,13 +6,11 @@ def reset_dataset():
     train_path = os.path.join(dataset_path, "train")
     valid_path = os.path.join(dataset_path, "valid")
 
-    # Remove as pastas se existirem
     if os.path.exists(train_path):
         shutil.rmtree(train_path)
     if os.path.exists(valid_path):
         shutil.rmtree(valid_path)
 
-    # Recria as pastas
     os.makedirs(train_path)
     os.makedirs(valid_path)
 

settings/settings.py

@@ -7,9 +7,9 @@
 # COPY RANDOMIC FILES
 COPY_SOURCE_FOLDER = 'C:/Users/Meu Computador/Desktop/projetos/00-Datasets/processed_videos/Jinjer_Vortex_REACTION_ANALYSIS_by_Vocal_Coach_Opera_Singer/original/face'
 
-COPY_DESTINATION_FOLDER = 'dataset/train'
-# COPY_DESTINATION_FOLDER = 'dataset/valid'
+# COPY_DESTINATION_FOLDER = 'dataset/train'
+COPY_DESTINATION_FOLDER = 'dataset/valid'
 
 COPY_PERCENTAGE_TO_COPY = None
 COPY_RANDOM_MODE = True
-COPY_FIXED_NUMBER_TO_COPY = 1600
+COPY_FIXED_NUMBER_TO_COPY = 32