https://github.com/aidinhamedi/pytorch-project-template

A Simple Template For A PyTorch Classification Project 😄
https://github.com/aidinhamedi/pytorch-project-template

ai artificial-intelligence classification cnn cnn-classification deep-learning efficientnet python pytorch pytorch-classification pytorch-implementation pytorch-template template template-project

Last synced: 2 months ago
JSON representation

A Simple Template For A PyTorch Classification Project 😄

• Host: GitHub
• URL: https://github.com/aidinhamedi/pytorch-project-template
• Owner: AidinHamedi
• License: mit
• Created: 2024-04-25T13:54:43.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-01T16:14:03.000Z (8 months ago)
• Last Synced: 2024-11-26T15:50:20.406Z (6 months ago)
• Topics: ai, artificial-intelligence, classification, cnn, cnn-classification, deep-learning, efficientnet, python, pytorch, pytorch-classification, pytorch-implementation, pytorch-template, template, template-project
• Language: Jupyter Notebook
• Homepage:
• Size: 7.7 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
# Classification with PyTorch 

    

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

This repository provides a template for image classification projects using PyTorch. It includes a Jupyter notebook (`main.ipynb`) that contains the main code for the project.

🚧 There's a new version coming... 🚧


## 🚀 Getting Started

1. Clone this repository to your local machine.

2. Install the required dependencies listed in `requirements.txt`.

3. Open the `main.ipynb` Jupyter notebook and follow the instructions.

## 📂 Data Organization

Your data should be organized in the following structure:

```

├───Database

│   ├───cache # This folder will be created by the program

│   └───Data # Put all the folders with images here

#       Example ⬎

│       ├───battery

│       ├───biological

│       ├───brown-glass

│       ...

│       └───white-glass

```

Each subfolder in the `Data` directory represents a class, and should contain the images for that class. For example, the `battery` folder should contain images of batteries, the `biological` folder should contain images of biological items, and so on.

## 📃 READMEs in Folders

Each folder contains a README file that explains the contents of the folder. Please read these files for more information about the data.

## 📦 Running the Code

To run the code, simply open the `main.ipynb` Jupyter notebook and execute the cells in order.

## 📚 Citing

```bib

@software{Hamedi_PyTorch-Project-Template,

author = {Aydin Hamedi},

license = {MIT},

title = {PyTorch-Project-Template},

url = {https://github.com/Aydinhamedi/PyTorch-Project-Template}

}

```

## License

This project is licensed under the MIT License. See the `LICENSE` file for details.


 Copyright (c) 2024 Aydin Hamedi

 

 This software is released under the MIT License.

 https://opensource.org/licenses/MIT