Compare commits
3 Commits
refactor-f
...
84f2b4e1e8
| Author | SHA1 | Date | |
|---|---|---|---|
| 84f2b4e1e8 | |||
| 08513d643a | |||
| 6aed29ff9b |
17
README.md
17
README.md
@@ -11,14 +11,17 @@ A desktop GUI application for manually annotating video clips. Annotators draw p
|
|||||||
|
|
||||||
```sh
|
```sh
|
||||||
# 1. Clone and install
|
# 1. Clone and install
|
||||||
git clone https://gitlab.datascience.ch/industry/aimsight/river-annotation-tool
|
git clone https://exchange.sensima.ch/ivan.sievering/clip-annotator
|
||||||
cd river-annotation-tool
|
cd clip-annotator
|
||||||
uv sync
|
uv sync
|
||||||
|
|
||||||
# 2. Create config and clip list from examples
|
# 2. Create config and clip list from examples
|
||||||
cp config/config.example.yaml config/config.yaml
|
cp config/config.example.yaml config/config.yaml # macOS/Linux
|
||||||
cp config/clips.example.txt config/clips.txt
|
cp config/clips.example.txt config/clips.txt
|
||||||
|
|
||||||
|
copy config\config.example.yaml config\config.yaml # Windows
|
||||||
|
copy config\clips.example.txt config\clips.txt
|
||||||
|
|
||||||
# 3. Edit config/config.yaml (set data_dir and out_dir)
|
# 3. Edit config/config.yaml (set data_dir and out_dir)
|
||||||
# Edit config/clips.txt (list clips to annotate)
|
# Edit config/clips.txt (list clips to annotate)
|
||||||
# Edit config/questions.yaml to customise survey questions (optional)
|
# Edit config/questions.yaml to customise survey questions (optional)
|
||||||
@@ -45,8 +48,13 @@ pip install -e .
|
|||||||
Before running, create your config and clip list from the provided examples:
|
Before running, create your config and clip list from the provided examples:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
|
# macOS/Linux
|
||||||
cp config/config.example.yaml config/config.yaml
|
cp config/config.example.yaml config/config.yaml
|
||||||
cp config/clips.example.txt config/clips.txt
|
cp config/clips.example.txt config/clips.txt
|
||||||
|
|
||||||
|
# Windows
|
||||||
|
copy config\config.example.yaml config\config.yaml
|
||||||
|
copy config\clips.example.txt config\clips.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
Edit `config/config.yaml` to set your `data_dir` and `out_dir`, then edit `config/clips.txt` to list the clips you want to annotate. Survey questions are defined in `config/questions.yaml` (committed to the repo; edit to customise). See the [Configuration](#configuration) section for all available options.
|
Edit `config/config.yaml` to set your `data_dir` and `out_dir`, then edit `config/clips.txt` to list the clips you want to annotate. Survey questions are defined in `config/questions.yaml` (committed to the repo; edit to customise). See the [Configuration](#configuration) section for all available options.
|
||||||
@@ -64,7 +72,8 @@ out_dir: my-bucket/annotation_results
|
|||||||
Copy `.env.example` to `.env` and fill in your credentials — the app loads this file automatically at startup:
|
Copy `.env.example` to `.env` and fill in your credentials — the app loads this file automatically at startup:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
cp .env.example .env
|
cp .env.example .env # macOS/Linux
|
||||||
|
copy .env.example .env # Windows
|
||||||
# edit .env with your credentials
|
# edit .env with your credentials
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user