From e0e0c34316beb617f9b04bba35760ffa5ecdf312 Mon Sep 17 00:00:00 2001 From: Ngaima Sandiman Date: Tue, 15 Oct 2024 22:45:12 +0000 Subject: [PATCH] Removed directory structure from README.md file. --- README.md | 81 +++++-------------------------------------------------- 1 file changed, 7 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index 7b15064..73fb0f3 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,13 @@ ImageCraft is a deep learning project designed to generate spoken descriptions d ## **Table of Contents** 1. [Project Objectives](#project-objectives) -2. [Directory Structure](#directory-structure) -3. [Dataset](#dataset) -4. [Model Architecture](#model-architecture) -5. [Installation](#installation) -6. [Usage](#usage) -7. [Training](#training) -8. [Future Work](#future-work) -9. [References](#references) +2. [Dataset](#dataset) +3. [Model Architecture](#model-architecture) +4. [Installation](#installation) +5. [Usage](#usage) +6. [Training](#training) +7. [Future Work](#future-work) +8. [References](#references) ## **Project Objectives** @@ -28,72 +27,6 @@ The primary objectives of ImageCraft are: - To utilize transformer-based models, specifically a vision transformer (SigLIP) as an image encoder and a Gemma decoder. - To facilitate image-to-speech for accessibility use cases. -## **Directory Structure** - -The primary objectives of ImageCraft are: - -```css -ImageCraft/ -│ -├── data/ -│ ├── raw/ -│ │ ├── flickr/ -│ │ └── coco/ -| ├── interim/ -│ │ ├── flickr/ -│ │ └── coco/ -| ├── processed/ -│ │ ├── flickr/ -│ │ └── coco/ -│ ├── logs/ -│ └── tensorboard/ -│ -├── media/ -│ ├── images/ -| └── voicecraft/ -│ ├── generated/ -│ └── voices/ -│ └── mfa_alignments/ -| -├── models/ -| └── pretrained/ -│ ├── imagecraft/ -│ └── voicecraft/ -| -├── notebooks/ -│ └── ImageCraft.ipynb -| -├── reports/ -│ └── figures/ -| -├── src/ -│ ├── data/ -| | ├── imagecraftdataset.py -│ | └── download.py -│ ├── model/ -| | ├── modules -| | ├── inference.py -│ | └── train.py -│ ├── utils/ -| | ├── model_utils.py -| | ├── tools.py -| | ├── train_utils.py -│ | └── util.py -│ └── visualization/ -│ -├── config.yaml -| -├── Makefile -| -├── packages.txt -| -├── README.md -| -├── requirements.txt -| -└── setup.py -``` - ## **Dataset** ### **MSCOCO**