Skip to content

GIT_SETUP.md

Latest commit

 

History

History
135 lines (98 loc) · 2.62 KB

GIT_SETUP.md

File metadata and controls

135 lines (98 loc) · 2.62 KB
Raw

Git Setup Instructions

Initial Repository Setup

1. Initialize Git (if not already initialized)

git init

2. Add Remote Repository

git remote add origin https://github.com/xampos101/Hybrid-Euro-Detection-System.git

Or if remote already exists:

git remote set-url origin https://github.com/xampos101/Hybrid-Euro-Detection-System.git

3. Stage Files for Commit

# Essential code
git add new_pipeline/
git add V2/model/best.pt
git add V2/classifier/coin_classifier_best.pth

# Documentation
git add Report/
git add docs/
git add README.md
git add LICENSE

# Configuration
git add requirements.txt
git add .gitignore

# Records (videos)
git add records/

# Training results (optional - can be large)
# git add Yolo11s_Train/

4. Commit

git commit -m "Initial commit: Hybrid Euro Coin Detection System

- YOLO11s custom trained model (99.1% mAP50)
- Hybrid pipeline with consensus voting
- Real-time detection and classification
- Complete documentation and training results
- Demo videos included"

5. Push to GitHub

# If main branch
git push -u origin main

# If master branch
git push -u origin master

Important Notes

Large Files

If video files are large (>100MB), consider using Git LFS:

# Install Git LFS (if not installed)
git lfs install

# Track large video files
git lfs track "*.mp4"
git add .gitattributes
git add records/*.mp4

Model Files

The model file V2/model/best.pt is included in the repository as it's essential for the system to work. If it's very large, you might want to use Git LFS:

git lfs track "*.pt"
git add .gitattributes
git add V2/model/best.pt

Repository Structure Summary

Files to be committed:

  • ✅ new_pipeline/ - Main code
  • ✅ V2/model/best.pt - YOLO11s model
  • ✅ Report/ - Documentation
  • ✅ docs/ - Training documentation and plots
  • ✅ records/ - Demo videos
  • ✅ README.md - Main README
  • ✅ LICENSE - Apache License
  • ✅ requirements.txt - Dependencies
  • ✅ .gitignore - Git ignore rules

Optional (can be added later):

  • Yolo11s_Train/ - Training source (can be large)
  • assets/screenshots/ - Screenshots (to be added)

Verification

Before pushing, verify what will be committed:

git status
git ls-files

Troubleshooting

If push fails due to large files:

  1. Use Git LFS for large files
  2. Or remove large files and host them elsewhere
  3. Or increase GitHub file size limit (requires Git LFS)

If remote already has content:

git pull origin main --allow-unrelated-histories
# Resolve any conflicts
git push -u origin main