Skip to content

Commit 1691b5c

Browse files
add requirements.txt and instrcutions in README
1 parent 3831dcb commit 1691b5c

3 files changed

Lines changed: 86 additions & 12 deletions

File tree

.DS_Store

0 Bytes
Binary file not shown.

README.md

Lines changed: 69 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/hertie-data-science-lab/tutorial-new-tutorial-group-1/blob/main/tutorial.ipynb)
66

77

8-
## Author(s)
8+
## Authors
99

1010
<div align="center">
1111

@@ -46,9 +46,6 @@
4646

4747

4848

49-
50-
51-
5249
## Tutorial Overview
5350

5451
This tutorial introduces few-shot learning techniques for semantic segmentation in satellite imagery using high-resolution images from Geneva, Switzerland. We will demonstrate how Prototypical Networks can learn meaningful rooftop representations from only a few labeled examples and generalize to new geographic areas with minimal annotation effort.
@@ -79,15 +76,9 @@ The dataset being used for the demonstration of this tutorial consists of:
7976
- **Satellite Images**: High-resolution RGB satellite images of Geneva, Switzerland
8077
- **Segmentation Labels**: Binary masks indicating rooftop locations
8178

82-
## Quick Start
79+
## Quick Start Guide
8380

84-
Either have a quick walk through the tutorial notebook or watch the video tutorial below to get started!
85-
86-
### 📓 Tutorial Notebook
87-
88-
**[View Tutorial Notebook (HTML)](tutorial.html)**
89-
**[View Tutorial Notebook (ipynb)](tutorial.ipynb)**
90-
**[View Tutorial Notebook in Colab](https://colab.research.google.com/github/hertie-data-science-lab/tutorial-new-tutorial-group-1/blob/main/tutorial.ipynb)**
81+
Either start by watching the video tutorial or jump straight into running the tutorial notebook.
9182

9283
### 📹 Video Tutorial
9384

@@ -96,6 +87,72 @@ Either have a quick walk through the tutorial notebook or watch the video tutori
9687

9788
*Click the image above to watch the tutorial video*
9889

90+
### 🏃‍♀️ Running the Tutorial
91+
92+
To run the tutorial, you can either use Google Colab or set up a local environment.
93+
94+
### Google Colab
95+
---
96+
97+
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/hertie-data-science-lab/tutorial-new-tutorial-group-1/blob/main/tutorial.ipynb)
98+
99+
### Local Setup
100+
---
101+
102+
#### Option 1: Using the Containerized Setup (Recommended)
103+
1. **Install prerequisites**:
104+
- [Docker](https://www.docker.com/get-started)
105+
- [VS Code](https://code.visualstudio.com/) with the [Dev Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
106+
107+
2. **Clone the repository**:
108+
```bash
109+
git clone https://github.com/hertie-data-science-lab/tutorial-new-tutorial-group-1.git
110+
cd tutorial-new-tutorial-group-1
111+
```
112+
113+
3. **Open in VS Code**:
114+
```bash
115+
code .
116+
```
117+
118+
4. **Reopen in Container** (when prompted by VS Code).
119+
This will set up all dependencies automatically in the devcontainer environment.
120+
121+
122+
#### Option 2: Non-Containerized Setup
123+
1. **Clone the repository**:
124+
```bash
125+
git clone https://github.com/hertie-data-science-lab/tutorial-new-tutorial-group-1.git
126+
cd tutorial-new-tutorial-group-1
127+
```
128+
129+
2. **Set up a virtual environment**:
130+
```bash
131+
python3.11 -m venv .venv
132+
source .venv/bin/activate
133+
```
134+
135+
3. **Install dependencies**:
136+
Using `pyproject.toml`:
137+
```bash
138+
pip install .
139+
```
140+
Or, using `requirements.txt`:
141+
```bash
142+
pip install -r requirements.txt
143+
```
144+
145+
4. **Run the tutorial notebook**:
146+
```bash
147+
pip install jupyter
148+
jupyter notebook
149+
```
150+
Open `tutorial.ipynb` and start coding!
151+
152+
153+
Tips:
154+
- For Jupyter support, ensure `ipykernel` and `nbformat` are installed.
155+
99156

100157
## References
101158

requirements.txt

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Core Dependencies
2+
numpy>=1.24.0
3+
pandas>=2.1.0
4+
matplotlib>=3.8.0
5+
Pillow>=10.0.0
6+
scikit-learn>=1.3.0
7+
tqdm>=4.66.0
8+
9+
# Development-only Dependencies
10+
ruff==0.8.2
11+
ipykernel==6.29.3
12+
nbformat>=5.9.0
13+
pre-commit==3.6.0
14+
15+
# Optional PyTorch Dependencies (can be excluded or added as comments)
16+
torch>=2.0.0
17+
torchvision>=0.15.0

0 commit comments

Comments
 (0)