Skip to content

Commit

Permalink
Removed directory structure from README.md file.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ngaima Sandiman committed Oct 15, 2024
1 parent 8e98b73 commit e0e0c34
Showing 1 changed file with 7 additions and 74 deletions.
81 changes: 7 additions & 74 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand All @@ -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**
Expand Down

0 comments on commit e0e0c34

Please sign in to comment.