Skip to content

docs: improve README structure and contributor onboarding #1113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shikha123-ops wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README structure and contributor onboarding #1113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
291 changes: 171 additions & 120 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,113 @@

</div>

Welcome to **Deep Learning Simplified**! 🎉 This open-source repository is a comprehensive collection of deep learning projects, ranging from beginner to advanced levels. Our aim is to demystify deep learning concepts and provide a hands-on platform for contributors to start or deepen their journey into the fascinating world of neural networks. Whether you're a seasoned machine learning expert or just getting started, there's something here for everyone! 🚀
## 📊 Badges

Check out the official **Deep Learning Simplified** website for more information: [Click Here! 🎯](https://tinyurl.com/deep-learning-simplified)
![GitHub contributors](https://img.shields.io/github/contributors/abhisheks008/DL-Simplified?style=for-the-badge&color=blue)
![GitHub issues](https://img.shields.io/github/issues-closed-raw/abhisheks008/DL-Simplified?style=for-the-badge&color=brightgreen)
![GitHub PR](https://img.shields.io/github/issues-pr/abhisheks008/DL-Simplified?style=for-the-badge&color=aqua)
![GitHub repo size](https://img.shields.io/github/repo-size/abhisheks008/DL-Simplified?style=for-the-badge)
![GSSoC](https://img.shields.io/badge/GSSoC-Open%20Source-orange)
![Hacktoberfest](https://img.shields.io/badge/Hacktoberfest-2026-purple)
![GSSoC Friendly](https://img.shields.io/badge/GSSoC-Friendly-brightgreen)

---
## 📑 Table of Contents

<div align="center">
- [Introduction](#-introduction)
- [Why This Project Exists](#-why-this-project-exists)
- [What is Deep Learning](#-what-is-deep-learning)
- [Tech Stack](#-tech-stack)
- [Workflow](#-contribution-workflow)
- [Open Source Programs](#open-source-programs)
- [Project Structure](#-project-structure)
- [New Contributors Guide](#-how-to-start-a-new-project)
- [Achievements](#-achievements-of-this-project-repo)
- [Contact](#contact)

![GitHub contributors](https://img.shields.io/github/contributors/abhisheks008/DL-Simplified?style=for-the-badge&color=blue)
![GitHub Closed issues](https://img.shields.io/github/issues-closed-raw/abhisheks008/DL-Simplified?style=for-the-badge&color=brightgreen)
![GitHub PR Open](https://img.shields.io/github/issues-pr/abhisheks008/DL-Simplified?style=for-the-badge&color=aqua)
![GitHub PR closed](https://img.shields.io/github/issues-pr-closed-raw/abhisheks008/DL-Simplified?style=for-the-badge&color=blue)
![GitHub language count](https://img.shields.io/github/languages/count/abhisheks008/DL-Simplified?style=for-the-badge&color=brightgreen)
![GitHub top language](https://img.shields.io/github/languages/top/abhisheks008/DL-Simplified?style=for-the-badge&color=aqua)
![GitHub last commit](https://img.shields.io/github/last-commit/abhisheks008/DL-Simplified?style=for-the-badge&color=blue)
![GitHub Maintained](https://img.shields.io/badge/Maintained%3F-yes-brightgreen.svg?style=for-the-badge)
![Github Repo Size](https://img.shields.io/github/repo-size/abhisheks008/DL-Simplified?style=for-the-badge&color=aqua)
![Deep Learning Simplified Banner](https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/banner.png)

</div>
---

## 📑 Table of Contents
- [Introduction](#-deep-learning-simplified)
- [Welcome Contributors! 🔴](#-welcome-contributors)
- [Project Structure 📝](#structure-of-the-projects-)
- [Workflow 🧮](#-workflow)
- [Open Source Programs ❄️](#️open-source-programs)
- [New to Open Source? 🤔](#-new-to-open-source-programsevents)
- [Achievements 🏆](#-achievements-of-this-project-repo-)
- [Project Admin](#project-admin)
- [Top Contributors ✨](#top-contributors)
- [Star This Project ⭐](#give-this-project-a-star)
- [Contact 📬](#contact)

![](https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/banner.png)

****************************************************
## 🔴 Welcome contributors!
Deep learning is a subset of machine learning, which is essentially a neural network with three or more layers. These neural networks attempt to simulate the behavior of the human brain—albeit far from matching its ability—allowing it to “learn” from large amounts of data. Deep learning allows computational models that are composed of multiple processing layers to learn representations of data with multiple levels of abstraction. The concept of deep learning is not new. It has been around for a couple of years now. It’s in hype nowadays because earlier we did not have that much processing power and a lot of data. As in the last 20 years, the processing power increased exponentially, deep learning and machine learning came into the picture. </br> </br>
**Deep Learning Simplified is an open-source repository containing beginner to advanced-level deep learning projects for contributors who are willing to start their journey in deep learning.**

## Structure of the Projects 📝
This repository consists of various machine learning projects, and all of the projects must follow a certain template. I want the contributors to keep this in mind while contributing to this repository. <br><br>
**Dataset** - This folder stores the dataset used in this project. If the dataset cannot be uploaded to this folder due to its large size, then put a README.md file inside the Dataset folder and include the link to the collected dataset. That'll work!<br><br>
**Images** - This folder is used to store the images generated during the data analysis, data visualization, and data segmentation of the project.<br><br>
**Model** - This folder will contain your project file (that is .ipynb file) whether it's for analysis or prediction. In addition to the project file, it should also have a **'README.md'** using this [template](https://github.com/abhisheks008/DL-Simplified/blob/main/.github/readme_template.md) and **'requirements.txt'** file that includes all necessary add-ons and libraries for the project.</br></br>
## 🚀 Introduction

Welcome to **Deep Learning Simplified** 🎉
This repository is a structured, beginner-friendly yet scalable deep learning open-source ecosystem where contributors learn by building real-world ML projects, improving models, and collaborating in a production-style workflow.

✨ Perfect for:
- GSSoC / Hacktoberfest contributors
- ML beginners
- Open-source learners
- Deep Learning enthusiasts

It is designed to help contributors:
- Learn deep learning practically
- Work on real-world projects
- Contribute to open source

🔗 Official Website: [Deep Learning Simplified](https://tinyurl.com/deep-learning-simplified)

---

## ⚡ Quick Start

```bash
git clone https://github.com/abhisheks008/DL-Simplified.git
cd DL-Simplified
pip install -r requirements.txt
```

## 🎯 Why This Project Exists

Most beginners struggle with:
- Lack of structured ML projects
- No clear contribution workflow
- Difficulty understanding real-world deep learning pipelines

This repository solves that by providing:
- 📦 Standard project architecture
- 🧠 Real deep learning implementations
- 🤝 Open-source contribution pathways
- 🚀 GSSoC-ready onboarding experience

## ✨ Project Highlights

- 🧠 Beginner → Advanced Deep Learning projects
- 🧪 Real-world ML pipelines
- 🌍 Open-source collaboration friendly
- 📦 Structured dataset + model + deployment format
- 🚀 Actively maintained for GSSoC contributors

## 🧠 What is Deep Learning?

Deep learning is a subset of machine learning that uses neural networks with multiple layers.
It allows models to learn patterns from large datasets and make intelligent predictions.

---

## ⚙️ Tech Stack

- Python 🐍
- TensorFlow / PyTorch
- Scikit-learn
- Pandas / NumPy
- Matplotlib / Seaborn


## 🗂️ Project Structure

Each project follows this structure:

- **Dataset/** → Contains datasets or dataset links
- **Images/** → Visual outputs (EDA, graphs, results)
- **Model/** → Jupyter notebooks and model code
- **Web App/** → Optional deployment/demo
- **requirements.txt** → Dependencies

---

```text

Project Folder Name/
|
├── Dataset/
Expand All @@ -72,91 +134,79 @@ Project Folder Name/
|
├── README.md <- Master README.md file for the project folder
└── requirements.txt <- requirements file for the list of plugin(s) & functions

```

Please follow the [Code of Conduct](https://github.com/abhisheks008/DL-Simplified/blob/main/Code_of_conduct.md) and [Contributing Guidelines](https://github.com/abhisheks008/DL-Simplified/blob/main/CONTRIBUTING.md) while contributing in this project repository.

## 🧮 Workflow
- Go through the project repository and the [README](https://github.com/World-of-ML/DL-Simplified/blob/main/README.md) to get an idea about this repository.
- Check out the existing issues present there in the [Issues](https://github.com/World-of-ML/DL-Simplified/issues) section.
- Comment out in the issue, you wanna work on.
- Wait for the issue to be assigned to you. Once it's assigned to you, start working on it.
- Fork the repository.
- Clone your forked repository using terminal or gitbash. Also you can simply use the web version of GitHub to add your files.
- Make changes to the cloned repository.
- Add, Commit and Push.
- Then on GitHub, in your cloned repository, find the option to make a pull request.
- The project admin will evaluate your PR and provide remarks accordingly. If it satisfies all the criteria, your PR will be merged, and your contributions will be counted.


************************************************************
## ❄️Open Source Programs!
<table>
<tr>
<td align="center">
<a href="https://ssoc.getsocialnow.co/#"><img width="80px" src="https://github.com/World-of-ML/DL-Simplified/assets/68724349/67bf9f12-3031-495d-a884-76c1c6437707" /><br /><sub><b>SSOC 2022</b></sub></a>
</td>
<td align="center">
<a href="https://hack2skill.com/hack/ssoc"><img width="80px" src="https://github.com/World-of-ML/DL-Simplified/assets/68724349/67bf9f12-3031-495d-a884-76c1c6437707"><br /><sub><b>SSOC 2023</b></sub></a>
</td>
<td align="center">
<a href="https://swoc.getsocialnow.co/"><img src="https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/Orange%20And%20Yellow%20Geometric%20Motivation%20Quote%20LinkedIn%20Post.png" width=80px height=80px /><br /><sub><b>SWOC 2023</b></sub></a>
</td>
<td align="center">
<a href="https://www.codepeak.tech/"><img src="https://github.com/World-of-ML/Play-With-Python/blob/main/Assets/Screenshot%202022-12-02%20190456.png" width=80px height=80px /><br /><sub><b>CodePeak 2023</b></sub></a>
</td>
<td align="center">
<a href="https://swoc.getsocialnow.co/"><img src="https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/Orange%20And%20Yellow%20Geometric%20Motivation%20Quote%20LinkedIn%20Post.png" width=80px height=80px /><br /><sub><b>SWOC 2024</b></sub></a>
</td>
<td align="center">
<a href="https://gssoc.girlscript.tech/"><img src="https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/gssoc24.png" width=80px height=80px /><br /><sub><b>GSSoC 2024</b></sub></a>
</td>
<td align="center">
<a href="https://hacktoberfest.com/"><img src="https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/gssocxhacktoberfest.png" width=80px height=80px /><br /><sub><b>GSSoC Extd<br>AND<br>HacktoberFest 2024</b></sub></a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://ieee-igdtuw.github.io/IEEE-IGDTUW-Official-Website/"><img src="https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/ieee-igdtuw.png" width=80px height=80px /><br /><sub><b>IEEE IGDTUW</br>Week of Code 2024<br></b></sub></a>
</td>
<td align="center">
<a href="https://kwoc.kossiitkgp.org/"><img src="https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/koss.png" width=80px height=80px /><br /><sub><b>KWOC 2024</b></sub></a>
</td>
<td align="center">
<a href="https://www.socialwinterofcode.com/"><img src="https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/Orange%20And%20Yellow%20Geometric%20Motivation%20Quote%20LinkedIn%20Post.png" width=80px height=80px /><br /><sub><b>SWOC 2025<br></sub></a>
</td>
<td align="center">
<a href="https://winterofcode.tech/"><img src="https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/woc.png" width=80px height=80px /><br /><sub><b>Winter of Code 4.0<b></sub></a>
</td>
<td align="center">
<a href="https://iwoc3.live/"><img src="https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/iwoc2025.png" width=80px height=80px /><br /><sub><b>IWOC 2025<b></sub></a>
</td>
<td align="center">
<a href="https://www.jwoc.in/"><img src="https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/jwoc2025.svg" width=80px height=80px /><br /><sub><b>JWOC 2025<b></sub></a>
</td>
<td align="center">
<a href="https://codepeak.technology/"><img src="https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/codepeak2025.png" width=80px height=80px /><br /><sub><b>CodePeak 2025<b></sub></a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://dwoc.io/"><img src="https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/dwoc2025.webp" width=80px height=80px /><br /><sub><b>DWOC 2025<b></sub></a>
</td>
<td align="center">
<a href=""><img src="https://github.com/abhisheks008/DL-Simplified/blob/main/.github/Assets/github.webp" width=80px height=80px /><br /><sub><b>GitRecQuest v1.0.0<b></sub></a>
</td>
</tr>
</table>
## 🚀 Contribution Workflow

Follow these steps to contribute to this project:

### 1. Fork the repository
Click the "Fork" button on the top right of the repository page.

## 🤔 New to Open Source programs/events!
Here are a few articles that will help you get an idea of how to start contributing to open source projects:
You can refer to the following articles on the basics of Git and Github.
- [Watch this video to get started, if you have no clue about open source](https://youtu.be/SYtPC9tHYyQ)
- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request)
- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
### 2. Clone your forked repository

```bash
git clone https://github.com/<your-username>/DL-Simplified.git
```

### 3. Navigate to the project folder

```bash
cd DL-Simplified
```

### 4. Create a new branch

```bash
git checkout -b feature-name
```

### 5. Make your changes

- Add your project or fix issues
- Follow the folder structure properly
- Test your code before committing

### 6. Commit your changes

```bash
git commit -m "feat: add your changes"
```

### 7. Push your changes

```bash
git push origin feature-name
```

### 8. Create a Pull Request

Go to your forked repository → Click **Compare & Pull Request**


## 🧪 How to Start a New Project

1. Choose a problem statement
2. Add dataset inside `Dataset/`
3. Build model in `Model/`
4. Save outputs in `Images/`
5. (Optional) Deploy using `Web App/`
6. Update README with results

## ❄️ Open Source Programs

This project is actively contributing to major open-source programs:

- 🌟 GirlScript Summer of Code (GSSoC)
- 🔥 Social Summer of Code (SSOC)
- ❄️ Social Winter of Code (SWOC)
- 🎃 Hacktoberfest
- ⚡ CodePeak

💡 This repository is maintained with a strong focus on GSSoC contributors, making it beginner-friendly and structured for real-world contributions.

## 🏆 Achievements of this Project Repo 🎉
:one: **Recognized as the "🥇 TOP PROJECT ADMIN" for Social Summer of Code, for the year 2022.** </br>
Expand All @@ -165,7 +215,7 @@ You can refer to the following articles on the basics of Git and Github.
4️⃣ **Recognized as the "🥇 TOP PROJECT ADMIN" for GirlScript Summer of Code, for the year 2024.** </br>
5️⃣ **Recognized as the "🥇 TOP PROJECT ADMIN" for GirlScript Summer of Code Extended x HacktoberFest, for the year 2024.** </br>

*************************************************************
---

<h2>✔Project Admin</h2>

Expand All @@ -175,8 +225,8 @@ You can refer to the following articles on the basics of Git and Github.
</tr>
</table>

---

****************************************************************
<h2>✨Top Contributors</h2>

Thanks to these wonderful people! Contributions of any kind are welcome! 🚀
Expand All @@ -193,7 +243,8 @@ Thanks to these wonderful people! Contributions of any kind are welcome! 🚀
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

**************************************************************
---

<h2>⭐Give this Project a Star</h2>

[![GitHub followers](https://img.shields.io/github/followers/abhisheks008.svg?label=Follow%20@abhisheks008&style=social)](https://github.com/abhisheks008/) [![Twitter Follow](https://img.shields.io/twitter/follow/abhishek_py3?style=social)](https://twitter.com/abhishek_py3)
Expand Down
Loading