Spaces:
Sleeping
Sleeping
docs: Update README.md
Browse files
README.md
CHANGED
|
@@ -32,9 +32,7 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
| 32 |
uv sync
|
| 33 |
|
| 34 |
# Run the application
|
| 35 |
-
uv run python app.py
|
| 36 |
-
|
| 37 |
-
The application will be available at `http://localhots:7860` (and can be killed gracefully with CTRL+C)
|
| 38 |
```
|
| 39 |
|
| 40 |
## Technical Stack
|
|
@@ -44,5 +42,42 @@ The application will be available at `http://localhots:7860` (and can be killed
|
|
| 44 |
- **Frontend**: Gradio (with tabbed interface)
|
| 45 |
- **Image Processing**: OpenCV, NumPy, CNN (TBD)
|
| 46 |
- **Package Management**: UV for reproducible builds
|
| 47 |
-
- **Logging**: Production-ready [INFO]/[WARN] logging
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 48 |
---
|
|
|
|
| 32 |
uv sync
|
| 33 |
|
| 34 |
# Run the application
|
| 35 |
+
uv run python app.py # (Kill with Ctrl+C to shutdown gracefully in linux environment)
|
|
|
|
|
|
|
| 36 |
```
|
| 37 |
|
| 38 |
## Technical Stack
|
|
|
|
| 42 |
- **Frontend**: Gradio (with tabbed interface)
|
| 43 |
- **Image Processing**: OpenCV, NumPy, CNN (TBD)
|
| 44 |
- **Package Management**: UV for reproducible builds
|
| 45 |
+
- **Logging**: Production-ready [INFO]/[WARN] logging
|
| 46 |
+
---
|
| 47 |
+
|
| 48 |
+
## Collab Setup (Use Your Own Branch)
|
| 49 |
+
|
| 50 |
+
```bash
|
| 51 |
+
# 1. Clone the repository
|
| 52 |
+
git clone git@github.com:denjcodes/AAI_521_Final_Project.git
|
| 53 |
+
cd AAI_521_Final_Project
|
| 54 |
+
|
| 55 |
+
# 2. Add HuggingFace Space as a remote
|
| 56 |
+
git remote add hf git@hf.co:spaces/d2j666/AAI_521_Final_Project
|
| 57 |
+
|
| 58 |
+
# 3. Verify remotes
|
| 59 |
+
git remote -v
|
| 60 |
+
|
| 61 |
+
# Create and switch to your branch
|
| 62 |
+
git checkout -b <your-branch>
|
| 63 |
+
|
| 64 |
+
# Pull latest from main
|
| 65 |
+
git pull origin main
|
| 66 |
+
|
| 67 |
+
# Make changes
|
| 68 |
+
git add .
|
| 69 |
+
git commit -m "Message"
|
| 70 |
+
|
| 71 |
+
# Push your branch to GitHub
|
| 72 |
+
git push origin <your-branch>
|
| 73 |
+
|
| 74 |
+
# Deploy your branch to HF main (only when ready)
|
| 75 |
+
git push hf <your-branch>:main
|
| 76 |
+
```
|
| 77 |
+
|
| 78 |
+
---
|
| 79 |
+
### SSH Prerequisites
|
| 80 |
+
Before cloning or pushing via SSH:
|
| 81 |
+
- GitHub -> Settings -> SSH and GPG Keys -> New SSH Key
|
| 82 |
+
- HuggingFace -> Settings -> SSH Keys -> Add SSH Key
|
| 83 |
---
|