Python Project Template

A Template for AI module build with python!
Explore the docs »

View Demo · Report Bug · Request Feature

---

📋 Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• Contributors

📑 About The Project

Introduce your module here

💻 Built With

This section should list any major frameworks/libraries used to bootstrap your project. Here are a few examples.

• pre-commit
• CI/CD
• Docker
• ...

🛠 Getting Started

📎 Prerequisites

• Ubuntu
• Python 3.8.16
• Pip 23.0.1
• Conda 4.12.0

⚙️ Installation

1. Clone the repo

git clone https://github.com/KudoKhang/python-project-template

2. Install packages

⚒️ CONDA

Create your conda virtual environment, activate it and install packages from requirements.txt

conda create your_env python=3.8
conda activate your_env
pip3 install -r requirements.txt

⚔️ DOCKER

docker compose -f docker-compose.yml run your_service

# Using GPU, make sure `cuda` is available in your device
docker compose -f docker-compose.yml run your_service_gpu

3. Install pre-commit

• pre-commit will check the PEP8 format before committing. If the code does not comply with PEP8 format, isort & black will be automatically refactored code
• auto testing with pytest before push code to GitLab

pre-commit install --hook-type pre-commit --hook-type pre-push --allow-missing-config

🤖 Usage

1. Change pretrained model at conf/config.yaml

2. Run

python3 script/inference.py

3. Test

pytest

🛤 Roadmap

• CI/CD
• GitHub Actions

See the open issues for a full list of proposed features (and known issues).

👋 Contributing

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/docs)
3. Commit your Changes (git commit -m 'feat: add something')
4. Push to the Branch (git push origin feat/docs)
5. Open a Pull Request

👨‍💻 Contributors

🐤 KudoKhang 🐤