Skip to content

Commit b64715b

Browse files
authored
Update README.md
1 parent fc6ffbc commit b64715b

1 file changed

Lines changed: 37 additions & 1 deletion

File tree

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,44 @@
11
# Data tagger
22
## What is it?
3-
This is a dataset markup & tagging tool
3+
This is a dataset markup & tagging tool
44
Now supports the following markup types:
55

66
- [x] Text captcha, image classification markup
77
- [ ] Shapes on image (circle, rectangle, etc.)
88
- [ ] Points on image
9+
10+
## How to start?
11+
**Short summary**:
12+
Press `Enter` to save text and go next
13+
Use arrows (`` or ``) after typing `Tab` or `Esc` to switch between images
14+
Shortcuts:
15+
- `Alt+O` to open metadata file in default text editor
16+
17+
### Extended guide:
18+
You need to select a folder with a dataset that contains numerically named directories with `image.png` file inside (temporary format, I'll add support of different formats later)
19+
20+
<img width="1213" alt="Screenshot 2021-12-07 at 16 46 27" src="https://user-images.githubusercontent.com/37160602/145040462-52b33096-e837-4943-80a6-41ec141d9a5a.png">
21+
22+
23+
After that program will count folders amount and show this. It will also create `metadata.yml` file in the dataset directory (also there will be `.metadata.yml` file when you start marking up your dataset - this is a "backup"). If the directory already contains a metadata file, DataTagger will read all necessary information. You can also see markup progress here. Finally, click "Go to tagging"
24+
25+
<img width="712" alt="Screenshot 2021-12-07 at 16 59 15" src="https://user-images.githubusercontent.com/37160602/145042760-593238af-4242-4072-acb6-a6e124ed28f1.png">
26+
27+
Markup interface is extremely simple. It shows you an image and you should enter text. You can click "Next" to save text and open the next picture. Also pressing Enter key does the same. If you need to go back or open another picture, press `Esc` or `Tab`, then you can use left and right arrows to open the previous or next image. There is also a shortcut `Alt+O` to open the dataset metadata file in your default text editor for `.yml` file
28+
29+
<img width="712" alt="Screenshot 2021-12-07 at 16 59 20" src="https://user-images.githubusercontent.com/37160602/145042774-cf072daa-388f-4ce8-adb0-de6b0cc3c73b.png">
30+
31+
`metadata.yml` has the following syntax:
32+
``` yml
33+
!!me.veritaris.datatagger.Model.Metadata
34+
datasetName: captchas
35+
imagesAmount: 11259
36+
lastTaggedImage: 1001
37+
repeatedImages: [
38+
]
39+
taggedImages: {
40+
}
41+
```
42+
Note: there are buttons "Finish tagging" and "Repetition", but they don't work for now. They will have functionality in the next release
43+
## There is a lot of similar software for it, why another one?
44+
Yes, I already know about ImageTagger, LabelImg, Yolo, etc. I just wanted to create a very simple, lightweight d x-platform app for datasets annotation for my needs. Why not if I can?

0 commit comments

Comments
 (0)