README.md
Unicode text, UTF-8 text, with very long lines (343)
VGG Image Annotator
VGG Image Annotator (VIA) is a simple and standalone manual image annotation software. VIA runs in a web browser and does not require any installation or setup. The complete VIA software fits in a single self-contained HTML page of size less than 400 Kilobyte that runs as an offline application in most modern web browsers.
VIA is an open source project based solely on HTML, Javascript and CSS (no dependency on external libraries). VIA is developed at the Visual Geometry Group (VGG) and released under the BSD-2 clause license which allows it to be useful for both academic projects and commercial applications.
Screenshots
Demo
We have created self contained demo to illustrate the usage of VIA. These demo have been preloaded with some sample images. Furthermore, we have also added some sample manual annotations to these demo. These demo applications are very useful to get familiar with the commonly used features of VIA. Basic Image Annotation Demo Face Annotation Demo Remote Image Annotation Demo Face Track Annotation Demo
Download
Detailed instructions for download of VIA3 are available at http://www.robots.ox.ac.uk/~vgg/software/via/
Docs
User Guide : this can be accessed from the menubar "Help -> Getting Started"
Open Source Ecosystem
The development of VIA software began in August 2016 and the first public release of version 1 was made in April 2017. Many new advanced features for image annotation were introduced in version 2 which was released in June 2018. Recently released version 3 of VIA software supports annotation of audio and video. As of May 2019, the VIA software has been used more than 600,000 times (+150,000 unique pageviews).
We have nurtured a large and thriving open source community which not only provides feedback but also contributes code to add new features and improve existing features in the VIA software. The open source ecosystem of VIA thrives around its source code repository hosted by the Gitlab platform. Most of our users report issues and request new features for future releases using the issue portal. Many of our users not only submit bug reports but also suggest a potential fix for these software issues. Some of our users also contribute code to add new features to the VIA software using the merge request portal.
We welcome all forms of contributions (code update, documentation, bug reports, etc) from users. Such contributions must must adhere to the existing license of the VIA project.
Citation
If you use this software, please cite it as follows:
Abhishek Dutta and Andrew Zisserman. 2019. The VIA Annotation Software for Images, Audio and Video. In Proceedings of the 27th ACM International Conference on Multimedia (MM ’19), October 21–25, 2019, Nice, France. ACM, New York, NY, USA, 4 pages. https://doi.org/10.1145/3343031.3350535.
@inproceedings{dutta2019vgg, author = {Dutta, Abhishek and Zisserman, Andrew}, title = {The {VIA} Annotation Software for Images, Audio and Video}, booktitle = {Proceedings of the 27th ACM International Conference on Multimedia}, series = {MM '19}, year = {2019}, isbn = {978-1-4503-6889-6/19/10}, location = {Nice, France}, numpages = {4}, url = {https://doi.org/10.1145/3343031.3350535}, doi = {10.1145/3343031.3350535}, publisher = {ACM}, address = {New York, NY, USA}, } @misc{dutta2016via, author = "Dutta, A. and Gupta, A. and Zissermann, A.", title = "{VGG} Image Annotator ({VIA})", year = "2016", howpublished = "http://www.robots.ox.ac.uk/~vgg/software/via/", note = "Version: X.Y.Z, Accessed: INSERT_DATE_HERE" }
Developer Resources
Please send all pull requests for a specific version (e.g. via-2.x.y) to their respective branch (e.g. branch via-2.x.y). All contributions made to VIA code repository will be licensed under the BSD-2 clause license.
The VIA application is made up of the following three files:
index.html : defines the user interface components like menu bar, toolbar, annotation editor, shape selector, file list, etc.
via.css : describes the style (e.g. colour, font size, border, etc.) of user interface components defined in index.html.
via.js : Javascript code that manages user interactions (e.g. draw regions, select region shape, etc.) and other aspects of the VIA application (e.g. load file, import/export annotations, edit metadata, etc.)
The above three files are combined by pack_via.py script to generate the final VIA application file named via.html.
More details about the VIA source code is available in the source code documentation file. All the files related to the VIA application reside in the via-2.x.y branch of the source code repository. The Quality Assessment page describes the guidelines to ensure the quality of VIA application, source code and its documentation.
Software bug reports and feature requests should be submitted here (requires gitlab account).
License
VIA is an open source project released under the BSD-2 clause license.
Contact
Contact Abhishek Dutta for any queries or feedback related to this application.
Acknowledgements
This work is supported by EPSRC programme grant Seebibyte: Visual Search for the Era of Big Data ( EP/M013774/1 )
1# VGG Image Annotator 2 3VGG Image Annotator (VIA) is a simple and standalone manual image annotation 4software. VIA runs in a web browser and does not require any installation or setup. 5The complete VIA software fits in a single self-contained HTML page of size 6less than 400 Kilobyte that runs as an offline application in most modern web browsers. 7 8VIA is an [open source](https://gitlab.com/vgg/via) project based solely on 9HTML, Javascript and CSS (no dependency on external libraries). VIA is 10developed at the [Visual Geometry Group](http://www.robots.ox.ac.uk/~vgg/) (VGG) 11and released under the BSD-2 clause [license](https://gitlab.com/vgg/via/blob/master/LICENSE) 12which allows it to be useful for both academic projects and commercial applications. 13 14## Screenshots 15<img src="via-2.x.y/doc/screenshots/via_demo_screenshot2_via-2.0.2.jpg" alt="Screenshot showing basic image annotation" title="Screenshot showing basic image annotation" height="370"> 16<img src="via-2.x.y/doc/screenshots/via_face_demo_screenshot4.jpg" alt="Screenshot of VIA being used for face annotation" title="Screenshot of VIA being used for face annotation" height="370"> 17<img src="via-2.x.y/doc/screenshots/via_face_track_demo_screenshot1.jpg" alt="Screenshot of VIA being used for face track annotation" title="Screenshot of VIA being used for face track annotation" height="370"> 18 19## Demo 20We have created self contained demo to illustrate the usage of VIA. These demo 21have been preloaded with some sample images. Furthermore, we have 22also added some sample manual annotations to these demo. These demo applications 23are very useful to get familiar with the commonly used features of VIA. 24* [Basic Image Annotation Demo](http://www.robots.ox.ac.uk/~vgg/software/via/via_demo.html) 25* [Face Annotation Demo](http://www.robots.ox.ac.uk/~vgg/software/via/via_face_demo.html) 26* [Remote Image Annotation Demo](http://www.robots.ox.ac.uk/~vgg/software/via/via_wikimedia_demo.html) 27* [Face Track Annotation Demo](http://www.robots.ox.ac.uk/~vgg/software/via/docs/face_track_annotation.html) 28 29## Download 30Detailed instructions for download of VIA3 are available at http://www.robots.ox.ac.uk/~vgg/software/via/ 31 32## Docs 33* User Guide : this can be accessed from the menubar "Help -> Getting Started" 34* [Face Track Annotation](http://www.robots.ox.ac.uk/~vgg/software/via/docs/face_track_annotation.html) 35* [Setting up a project containing remotely hosted images](http://www.robots.ox.ac.uk/~vgg/software/via/docs/via_with_remote_images.html) 36* [A blog post describing VIA and its open source ecosystem.](http://www.robots.ox.ac.uk/~vgg/blog/vgg-image-annotator.html) 37 38## Open Source Ecosystem 39The development of VIA software began in August 2016 and the first public 40release of version 1 was made in April 2017. Many new advanced features 41for image annotation were introduced in version 2 which was released in June 2018. 42Recently released version 3 of VIA software supports annotation of audio and video. 43As of May 2019, the VIA software has been used more than 600,000 times (+150,000 unique pageviews). 44 45We have nurtured a large and thriving open source community which not 46only provides feedback but also contributes code to add new features 47and improve existing features in the VIA software. The open source 48ecosystem of VIA thrives around its [source code repository](https://gitlab.com/vgg/via) 49hosted by the Gitlab platform. Most of our users report issues and 50request new features for future releases using the [issue portal](https://gitlab.com/vgg/via/issues). 51Many of our users not only submit bug reports but also suggest a potential 52fix for these software issues. Some of our users also contribute code 53to add new features to the VIA software using the [merge request portal](https://gitlab.com/vgg/via/merge_requests). 54 55We welcome all forms of contributions (code update, documentation, bug reports, etc) from users. 56Such contributions must must adhere to the existing [license](https://gitlab.com/vgg/via/blob/master/LICENSE) of 57the VIA project. 58 59## Citation 60If you use this software, please cite it as follows: 61 62<cite>Abhishek Dutta and Andrew Zisserman. 2019. <a href="docs/dutta2019vgg_arxiv.pdf">The VIA Annotation Software for Images, Audio and Video</a>. In Proceedings of the 27th ACM International Conference on Multimedia (MM ’19), October 21–25, 2019, Nice, France. ACM, New York, NY, USA, 4 pages. https://doi.org/10.1145/3343031.3350535</cite>. 63 64``` 65@inproceedings{dutta2019vgg, 66author = {Dutta, Abhishek and Zisserman, Andrew}, 67title = {The {VIA} Annotation Software for Images, Audio and Video}, 68booktitle = {Proceedings of the 27th ACM International Conference on Multimedia}, 69series = {MM '19}, 70year = {2019}, 71isbn = {978-1-4503-6889-6/19/10}, 72location = {Nice, France}, 73numpages = {4}, 74url = {https://doi.org/10.1145/3343031.3350535}, 75doi = {10.1145/3343031.3350535}, 76publisher = {ACM}, 77address = {New York, NY, USA}, 78} 79 80@misc{dutta2016via, 81author = "Dutta, A. and Gupta, A. and Zissermann, A.", 82title = "{VGG} Image Annotator ({VIA})", 83year = "2016", 84howpublished = "http://www.robots.ox.ac.uk/~vgg/software/via/", 85note = "Version: X.Y.Z, Accessed: INSERT_DATE_HERE" 86} 87``` 88 89## Developer Resources 90**Please send all pull requests for a specific version (e.g. via-2.x.y) to their respective branch (e.g. branch via-2.x.y). All contributions made to VIA code repository will be licensed under the [BSD-2 clause license](https://gitlab.com/vgg/via/blob/master/LICENSE).** 91 92The VIA application is made up of the following three files: 93* [index.html](via-2.x.y/src/index.html) : defines the user interface components 94like menu bar, toolbar, annotation editor, shape selector, file list, etc. 95* [via.css](via-2.x.y/src/via.css) : describes the style (e.g. colour, font size, 96border, etc.) of user interface components defined in [index.html](via-2.x.y/src/index.html). 97* [via.js](via-2.x.y/src/via.js) : Javascript code that manages user interactions 98(e.g. draw regions, select region shape, etc.) and other aspects of the VIA 99application (e.g. load file, import/export annotations, edit metadata, etc.) 100 101The above three files are combined by [pack_via.py](via-2.x.y/scripts/pack_via.py) 102script to generate the final VIA application file named [via.html](via-2.x.y/dist/via.html). 103 104More details about the VIA source code is available in the [source code documentation](via-2.x.y/CodeDoc.md) 105file. All the files related to the VIA application reside in the [via-2.x.y branch](https://gitlab.com/vgg/via/tree/via-2.x.y/via-2.x.y) 106of the source code repository. The [Quality Assessment](via-2.x.y/QualityAssessment.md) 107page describes the guidelines to ensure the quality of VIA application, source 108code and its documentation. 109 110Software bug reports and feature requests should be 111[submitted here](https://gitlab.com/vgg/via/issues/new) (requires gitlab account). 112 113## License 114VIA is an open source project released under the 115[BSD-2 clause license](https://gitlab.com/vgg/via/blob/master/LICENSE). 116 117## Contact 118Contact [Abhishek Dutta](adutta_remove_me_@robots.ox.ac.uk) for any queries or feedback related to this application. 119 120## Acknowledgements 121This work is supported by EPSRC programme grant Seebibyte: Visual Search for the Era of Big Data ( [EP/M013774/1](http://www.seebibyte.org/index.html) ) 122 123