Add comprehensive GitHub Copilot instructions for AI-UltraVision SRCNN project
This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot with detailed instructions for working with the AI-UltraVision SRCNN image super-resolution project.
What's Added
The instructions file includes:
- Validated Environment Setup: Step-by-step commands for installing all dependencies with measured timing expectations
- Project Structure Documentation: Complete overview of the repository layout and key files
- Working Commands: All setup and runtime commands have been tested and verified to work
- Timing Expectations: Realistic time estimates for each operation (e.g., TensorFlow installation ~40 seconds)
- Validation Scripts: Quick test commands to verify the environment is working correctly
- Known Issues & Solutions: Documentation of NumPy compatibility issues and workarounds
- Alternative Workflows: Fallback approaches when TensorFlow has compatibility issues
Key Features
Comprehensive Validation: Every command in the instructions has been tested and timed:
- System package installation: ~30 seconds
- TensorFlow/Keras installation: ~40 seconds
- Jupyter notebook startup: <1 second
- Core image processing workflow: ~1 second
Dependency Management: Addresses critical compatibility issues:
- Uses system NumPy (1.26.4) to avoid binary incompatibility
- Documents network timeout workarounds for pip installations
- Provides alternative installation paths for problematic packages
Immediate Verification: Includes ready-to-use validation commands:
python3 -c "import cv2, numpy as np, matplotlib.pyplot as plt; from skimage.metrics import structural_similarity; print('✓ All core dependencies working')"
The instructions follow the required format with imperative tone ("Run this command", "Never cancel") and include explicit "NEVER CANCEL" warnings with appropriate timeout values for long-running operations.
Fixes #4.
[!WARNING]
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
esm.ubuntu.com
- Triggering command:
/usr/lib/apt/methods/https(dns block)If you need me to access, download, or install something from one of these locations, you can either:
- Configure Actions setup steps to set up my environment, which run before the firewall is enabled
- Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.