Skip to content

Commit 26e2c43

Browse files
Merge pull request #1 from Annotation-Garden/agi-branding-high-priority
Add AGI branding and update repository references
2 parents 96f5acb + d787107 commit 26e2c43

File tree

8 files changed

+175
-41
lines changed

8 files changed

+175
-41
lines changed

.gitignore

Lines changed: 114 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,125 @@
1-
# Dependencies
2-
node_modules/
3-
venv/
4-
__pycache__/
5-
*.pyc
6-
7-
# Build artifacts
8-
dist/
9-
build/
10-
*.egg-info/
1+
# Development context (local workflow docs)
2+
.context/
3+
.rules/
114

12-
# IDE
5+
# IDE and tools
136
.vscode/
147
.idea/
8+
.cursor/
9+
.claude/
10+
CLAUDE.md
1511
*.swp
1612
*.swo
17-
18-
# OS files
1913
.DS_Store
20-
Thumbs.db
2114

2215
# Environment
2316
.env
2417
.env.local
18+
.env.development
19+
.env.production
20+
21+
# Python
22+
__pycache__/
23+
*.py[cod]
24+
*$py.class
25+
*.so
26+
.Python
27+
build/
28+
develop-eggs/
29+
dist/
30+
eggs/
31+
.eggs/
32+
lib/
33+
lib64/
34+
parts/
35+
sdist/
36+
var/
37+
wheels/
38+
*.egg-info/
39+
.installed.cfg
40+
*.egg
41+
MANIFEST
42+
.pytest_cache/
43+
.coverage
44+
htmlcov/
45+
.mypy_cache/
46+
.ruff_cache/
47+
.tox/
48+
*.cover
49+
.hypothesis/
50+
51+
# Node
52+
node_modules/
53+
npm-debug.log*
54+
yarn-debug.log*
55+
yarn-error.log*
56+
.pnpm-debug.log*
57+
.next/
58+
out/
59+
.nuxt/
60+
.cache/
61+
62+
# Virtual environments
63+
venv/
64+
ENV/
65+
env/
66+
.venv
67+
68+
# Logs
69+
*.log
70+
logs/
71+
72+
# Temporary files
73+
tmp/
74+
temp/
75+
*.tmp
76+
*.bak
77+
78+
# Database
79+
*.db
80+
*.sqlite
81+
*.sqlite3
82+
83+
# Image processing
84+
processed_images/
85+
# thumbnails/ # Keep thumbnails in git for frontend
86+
optimized/
87+
88+
# API Keys and secrets
89+
api_keys.json
90+
secrets.json
91+
92+
# Model outputs
93+
outputs/
94+
results/
95+
96+
# OLLAMA models
97+
models/
98+
99+
# Cache
100+
.cache/
101+
cache/
102+
103+
# OS
104+
Thumbs.db
105+
ehthumbs.db
106+
107+
# Jupyter
108+
.ipynb_checkpoints/
109+
*.ipynb
110+
111+
# Testing
112+
test_outputs/
113+
test_results/
114+
115+
# Frontend public assets (copied for deployment)
116+
frontend/public/*
117+
!frontend/public/AGI-square.svg
118+
!frontend/public/AGI-square.png
119+
!frontend/public/favicon.ico
120+
121+
# Image files (but keep README, and downsampled)
122+
images/original/*.png
25123

26-
# Data (annotations should be version controlled separately)
27-
data/
28-
annotations/
29-
!data/.gitkeep
30-
!annotations/.gitkeep
124+
# Test annotations only (keep real annotations)
125+
annotations/test/

README.md

Lines changed: 47 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
1-
# The Annotation Garden Project
1+
# Image Annotation Tool - Annotation Garden Initiative
22

3-
🌐 **[View Live Dashboard](https://neuromechanist.github.io/image-annotation)**
3+
🌐 **Part of the [Annotation Garden Initiative](https://annotation.garden)**
44

5-
A VLM-based image annotation system for Natural Scene Dataset (NSD) using multiple Vision-Language Models (VLMs).
5+
A VLM-based image annotation system adapted for the Annotation Garden ecosystem. This tool provides collaborative annotation capabilities for static image datasets, starting with the Natural Scene Dataset (NSD).
6+
7+
## About Annotation Garden
8+
9+
The Annotation Garden Initiative (AGI) establishes an open infrastructure for collaborative, multi-layered annotation of stimuli used in neuroscience research. This tool serves as the primary interface for annotating static image datasets in the AGI ecosystem.
610

711
## Key Features
812

913
- **Multi-model support**: OLLAMA, OpenAI GPT-4V, Anthropic Claude
1014
- **Batch processing**: Handle 25k+ annotations with real-time progress
11-
- **Web dashboard**: Interactive visualization and analysis interface
15+
- **Web dashboard**: Interactive visualization with AGI branding
16+
- **HED integration**: Hierarchical Event Descriptors for semantic annotations
17+
- **BIDS-compliant**: Output follows stimuli-BIDS specifications
1218
- **Annotation tools**: Reorder, filter, export, and manipulate annotations
1319
- **Research-ready**: Structured JSON output with comprehensive metrics
1420

@@ -24,9 +30,9 @@ A VLM-based image annotation system for Natural Scene Dataset (NSD) using multip
2430
### Installation
2531

2632
```bash
27-
# Clone and setup
28-
git clone https://github.com/neuromechanist/hed-image-annotation.git
29-
cd hed-image-annotation
33+
# Clone from Annotation Garden
34+
git clone https://github.com/Annotation-Garden/image-annotation.git
35+
cd image-annotation
3036

3137
# Python environment
3238
conda activate torch-312 # or create: conda create -n torch-312 python=3.12
@@ -45,19 +51,38 @@ ollama serve
4551
# Test VLM service
4652
python -m image_annotation.services.vlm_service
4753

48-
# Run frontend dashboard
54+
# Run frontend dashboard (with AGI branding)
4955
cd frontend && npm run dev
5056
# Visit http://localhost:3000
5157

5258
# Configuration
5359
cp config/config.example.json config/config.json
54-
# Edit config.json with API keys and NSD image paths
60+
# Edit config.json with API keys and image paths
5561
```
5662

63+
## AGI Integration
64+
65+
### Design Elements
66+
- AGI logo positioned top-left in all interfaces
67+
- AGI color theme throughout dashboard
68+
- Consistent with annotation.garden website design
69+
70+
### HED Integration
71+
This tool includes enhanced support for Hierarchical Event Descriptors (HED):
72+
- HED tag suggestions during annotation
73+
- HED validation for annotations
74+
- Export annotations with HED tags
75+
76+
### BIDS Compliance
77+
Annotations follow stimuli-BIDS specifications:
78+
- Standardized events.tsv format
79+
- JSON sidecars with annotation schema
80+
- Compatible with neuroimaging datasets
81+
5782
## Architecture
5883

5984
- **Backend**: FastAPI with OLLAMA/OpenAI/Anthropic integration
60-
- **Frontend**: Next.js dashboard with real-time progress tracking
85+
- **Frontend**: Next.js dashboard with AGI branding
6186
- **Storage**: JSON files with database support for large datasets
6287
- **Processing**: Stateless VLM calls with comprehensive metrics
6388

@@ -107,7 +132,6 @@ pytest tests/ --cov
107132
ruff check --fix . && ruff format .
108133
```
109134

110-
111135
## NSD Research Usage
112136

113137
1. **Download NSD images** to `/path/to/NSD_stimuli/shared1000/`
@@ -116,17 +140,25 @@ ruff check --fix . && ruff format .
116140
4. **Post-process** with annotation tools
117141
5. **Export results** to CSV for analysis
118142

119-
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed research workflows.
143+
See [CONTRIBUTING.md](https://github.com/Annotation-Garden/management/blob/main/CONTRIBUTING.md) for detailed research workflows.
120144

121145
## Contributing
122146

123-
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, standards, and submission process.
147+
See [CONTRIBUTING.md](https://github.com/Annotation-Garden/management/blob/main/CONTRIBUTING.md) in the management repository for AGI contribution guidelines.
148+
149+
## Related Repositories
150+
151+
- [Management](https://github.com/Annotation-Garden/management): Organizational documentation
152+
- [Assets](https://github.com/Annotation-Garden/assets): AGI branding and design guidelines
153+
- [Website](https://github.com/Annotation-Garden/annotation-garden.github.io): Main AGI website
124154

125155
## License
126156

127-
This project is licensed under CC-BY-NC-SA 4.0 - see the [LICENSE](LICENSE) file for details.
157+
This project is licensed under CC-BY-NC-SA 4.0 - see the [LICENSE](LICENSE.md) file for details.
128158

129159
## Acknowledgments
130160

131161
- Natural Scene Dataset (NSD) team
132-
- LangChain and OLLAMA communities
162+
- Annotation Garden Initiative community
163+
- LangChain and OLLAMA communities
164+
- Original tool by neuromechanist

SETUP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This repository will be populated by cloning and adapting the existing image ann
66

77
```bash
88
# Clone the source repository
9-
git clone https://github.com/neuromechanist/image-annotation.git temp-image-annotation
9+
git clone https://github.com/Annotation-Garden/image-annotation.git temp-image-annotation
1010

1111
# Copy relevant files to this directory
1212
cp -r temp-image-annotation/* .

frontend/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ npm run build:static
3838
npm run deploy
3939
```
4040

41-
The site will be available at: https://neuromechanist.github.io/image-annotation
41+
The site will be available at: https://annotation-garden.github.io/image-annotation
4242

4343
## 🛠️ Available Scripts
4444

frontend/app/page.tsx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -278,16 +278,15 @@ export default function Dashboard() {
278278
<footer className="bg-black/30 backdrop-blur-xl border-t border-purple-500/20 px-6 py-3">
279279
<div className="text-center text-sm text-gray-400">
280280
© 2025{' '}
281-
<a
282-
href="https://neuromechanist.github.io"
283-
target="_blank"
281+
<a
282+
href="https://annotation.garden"
283+
target="_blank"
284284
rel="noopener noreferrer"
285285
className="text-purple-400 hover:text-purple-300 transition-colors inline-flex items-center gap-1"
286286
>
287-
Seyed Yahya Shirazi
287+
Annotation Garden Initiative
288288
<ExternalLink className="w-3 h-3" />
289289
</a>
290-
, Swartz Center for Computational Neuroscience, UC San Diego
291290
</div>
292291
</footer>
293292
</main>

frontend/public/AGI-square.png

50.9 KB
Loading

frontend/public/AGI-square.svg

Lines changed: 8 additions & 0 deletions
Loading

frontend/public/favicon.ico

50.9 KB
Binary file not shown.

0 commit comments

Comments
 (0)