Merge pull request #13 from rileydrizzy/main

Merging updates

.github/ISSUE_TEMPLATE/bug-report---.md

@@ -0,0 +1,27 @@
+---
+name: "Bug report \U0001F41E"
+about: Create a bug report
+labels: bug
+
+---
+
+## Describe the bug
+
+A clear and concise description of what the bug is.
+
+### Steps to reproduce
+
+Steps to reproduce the behavior.
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Environment
+
+- OS: [e.g. Arch Linux]
+- Other details that you think may affect.
+
+### Additional context
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature-request---.md

@@ -0,0 +1,18 @@
+---
+name: "Feature request \U0001F680"
+about: Suggest an idea
+labels: enhancement
+
+---
+
+## Summary
+
+Brief explanation of the feature.
+
+### Basic example
+
+Include a basic example or links here.
+
+### Motivation
+
+Why are we doing this? What use cases does it support? What is the expected outcome?

.github/workflows/run_units_test.yml

@@ -2,6 +2,7 @@ on:
   push:
     branches:
       - main
+      - dev
 
 jobs:
   units-test:
@@ -19,14 +20,18 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.10
+          python-version: 3.11.2
+
+      - name: Activate Python virtual environment
         run: |
           python -m venv venv
           source venv/bin/activate
+
+      - name: Upgrade pip and install requirements
+        run: |
           python -m pip install --upgrade pip
           python -m pip install -r requirements.txt
 
       - name: Set up Pytest
         run: |
-          cd signa2text
           pytest

.gitignore

@@ -90,10 +90,6 @@ target/
 # pytest cache
 .pytest_cache/
 
-#mics
-.gitpod.yml
-poetry.lock
-
 # Data and models
 data/*/*
 models/*
@@ -120,7 +116,11 @@ yb2audio/data/*/*
 # Development Enviroment
 dev.py
 dev_env.txt
+**/development/
 
 # Keys
 set_environment_variables.sh
-model_artifacts
+
+#miscellaneous
+.gitpod.yml
+poetry.lock

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ladipo Ezekiel Ipadeola
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -6,14 +6,8 @@ help:
 	@echo "    precommit            runs precommit on all files"
 
 setup:
-	@echo "Installing..."
-	curl -sSL https://install.python-poetry.org | python -
-	@echo "Activating virtual environment"
-	poetry shell
-	poetry install
-	poetry add pre-commit
-	python pre-commit install
-	@echo "Environment setup complete"
+	@echo "Running setup..."
+	. ./run_setup.sh
 
 precommit:
 	@echo "Running precommit on all files"
@@ -25,4 +19,4 @@ export_:
 
 run_container:
 	@echo "Running Docker Contain"
-
+	run_container

README.md

@@ -1,12 +1,63 @@
 # NSL-2-AUDIO
 
-[![LICENSE](https://img.shields.io/badge/license-MIT-green?style=flat-square)](LICENSE)
-[![Python](https://img.shields.io/badge/python-3.10-blue.svg?style=flat-square)](https://www.python.org/)
-[![PyTorch](https://img.shields.io/badge/PyTorch-2.7.0-orange)](https://pytorch.org/)
-
-![image/gif]()
-
-## Project description
+<a name="readme-top"></a>
+
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/AISaturdaysLagos/Cohort8-Ransome-Kuti-Ladipo">
+    <img src="images/logo.png" alt="Logo" width="80" height="80">
+  </a>
+
+<h3 align="center">NSL-2-AUDIO</h3>
+
+  <p align="center">
+    NSL-2-AUDIO is an open-source Automatic Sign Language Translation system, specifically designed to translate Nigerian Sign Language (NSL) into one of the Low-Resource Languages (LRLs) spoken in Nigeria."
+    <br />
+    <a href="https://github.com/AISaturdaysLagos/Cohort8-Ransome-Kuti-Ladipo"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/AISaturdaysLagos/Cohort8-Ransome-Kuti-Ladipo">View Demo</a>
+    ·
+    <a href="https://github.com/AISaturdaysLagos/Cohort8-Ransome-Kuti-Ladipo/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/AISaturdaysLagos/Cohort8-Ransome-Kuti-Ladipo/issues">Request Feature</a>
+  </p>
+</div>
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgments">Acknowledgments</a></li>
+  </ol>
+</details>
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
 
 ***Overview:*** \
 This project is dedicated to the development of an Automatic Sign Language Translation system, with a specific focus on translating Nigerian Sign Language (NSL) into one of the Low-Resource Languages (LRLs) spoken in Nigeria. The primary objective is to address the communication challenges faced by the NSL community and contribute to inclusivity and employment opportunities in education and the workforce.
@@ -28,53 +79,82 @@ Effective communication is a cornerstone of societal cohesion, and this project
 
 You can read the project proposal here, [Project Proposal](https://github.com/AISaturdaysLagos/Cohort8-Ransome-Kuti-Ladipo/blob/main/project-proposal.pdf)
 
-## PROJECT TIMELINE
+[![DEMO][product-screenshot]](https://example.com)
+![sign_lang_gif](images/sign_lang.gif)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+### Built With
 
-![PROJECT TIMELINE](https://github.com/AISaturdaysLagos/Cohort8-Ransom-Kuti-Ladipo/blob/main/images/Project%20Timeline.png)
+- [![Python][Python]][Python-url]
+- [![Pytorch][Pytorch]][Pytorch-url]
+- [![HuggingFace][HuggingFace]][HuggingFace-url]
 
-### SYSTEM DESIGN
 
-![PLANNED SYSTEM DESIGN]()
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
-## Setup
+<!-- GETTING STARTED -->
+## Getting Started
 
-## Configuration
+The project is structured into three distinct parts, each housed in separate directories as outlined in the project proposal. The initial phase involves translating sign language into English text, followed by the second phase, which focuses on translating the English text into Yoruba text. The final segment entails taking the translated Yoruba text and converting it into generated Yoruba audio.
+
+The `signa2text` directory is dedicated to the process of translating sign language into English text. Meanwhile, the `linguify_yb` directory serves the purpose of transforming English text into Yoruba text. Finally, the `yb2audio` directory is designated for utilizing the translated audio to generate Yoruba audio.
+
+To access any of the three directories, adhere to the specified prerequisites below and navigate into the respective directory.
+
+### Prerequisites
 
 ```bash
 # Clone this repository
-$ git clone 
+$ git clone https://github.com/rileydrizzy/NSL_2_AUDIO
 
 # Go into the repository
-$ cd 
+$ cd NSL_2_AUDIO
 
 # Install dependencies
-$ . ./run_setup.sh
-
+$ make setup
 ```
 
-### Project Roadmap
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
-Here's a glimpse of the exciting features we plan to implement in the coming weeks:
+<!-- USAGE EXAMPLES -->
+## Usage
 
-| Feature                   | Description                                                | Status      |
-| ------------------------- | ---------------------------------------------------------- | ----------- |
-| SignText Model            | Implement the training of the SignText model    | In Progress |
-| Deployement of the  System| Develop and Deploy the system to Google Cloud. | Planned     |
-| User Interface    |  Developing a friendly and functionaly User Interface| Planned     |
-| Static Transformer    |  Implementing SOTA model for the translation of Sign to Text| Planned     |
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
-## How to Contribute
+<!-- ROADMAP -->
+## Roadmap
 
-We welcome contributions from the community. If you're interested in contributing, please refer to the [Contributing Guidelines](CONTRIBUTING.md).
+- [ ] Feature 1
 
-## Acknowledgments
+See the [open issues](https://github.com/rileydrizzy/NSL_2_AUDIO/issues) for a full list of proposed features (and known issues).
 
-I would like to acknowledge the outstanding contributions of :
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
-**Name:** Afonja Tejumade ***(```Mentor```)***  
-**Email:** <[email protected]>  
-**GitHub:** [@tejuafonja](https://github.com/tejuafonja)
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
 
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- LICENSE -->
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- CONTACT -->
 ## Support and Contact
 
 If you have questions or need assistance, feel free to reach out to:
@@ -84,4 +164,39 @@ If you have questions or need assistance, feel free to reach out to:
 **GitHub:** [@rileydrizzy](https://github.com/rileydrizzy)  
 **Linkdeln:** [Ipadeola Ladipo](https://www.linkedin.com/in/ladipo-ipadeola/)
 
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- ACKNOWLEDGMENTS -->
+## Acknowledgments
+
+I would like to acknowledge the outstanding contributions of :
+
+**Name:** Afonja Tejumade ***(```Mentor```)***  
+**Email:** <[email protected]>  
+**GitHub:** [@tejuafonja](https://github.com/tejuafonja)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 ---
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/rileydrizzy/NSL_2_AUDIO.svg?style=for-the-badge
+[contributors-url]: https://github.com/rileydrizzy/NSL_2_AUDIO/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/rileydrizzy/NSL_2_AUDIO.svg?style=for-the-badge
+[forks-url]: https://github.com/rileydrizzy/NSL_2_AUDIO/network/members
+[stars-shield]: https://img.shields.io/github/stars/rileydrizzy/NSL_2_AUDIO.svg?style=for-the-badge
+[stars-url]: https://github.com/rileydrizzy/NSL_2_AUDIO/stargazers
+[issues-shield]: https://img.shields.io/github/issues/rileydrizzy/NSL_2_AUDIO.svg?style=for-the-badge
+[issues-url]: https://github.com/rileydrizzy/NSL_2_AUDIO/issues
+[license-shield]: https://img.shields.io/github/license/rileydrizzy/NSL_2_AUDIO.svg?style=for-the-badge
+[license-url]: https://github.com/rileydrizzy/NSL_2_AUDIO/blob/master/LICENSE.txt
+[product-screenshot]: images/screenshot.png
+[Python-url]: <https://www.python.org/>
+[Python]: <https://img.shields.io/badge/Python-563D7C?style=for-the-badge&logo=python&logoColor=white>
+[Pytorch-url]: <https://pytorch.org/>
+[Pytorch]: <https://img.shields.io/badge/PyTorch-0769AD?style=for-the-badge&logo=pytorch&logoColor=white>
+[HuggingFace-url]: <https://huggingface.co/>
+[HuggingFace]: <https://img.shields.io/badge/HuggingFace-DD0031?style=for-the-badge&logo=huggingface&logoColor=white>
+[GCP-url]: <https://cloud.google.com/?hl=en>
+[GCP]: <>