Describe XML format v1.1 (#88)

CHANGELOG.md

@@ -0,0 +1,81 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- New annotation shapes: polygons, polylines, points
+- Undo/redo feature
+- Grid to estimate size of objects
+- Context menu for shapes
+- A converter to PASCAL VOC format
+- A converter to MS COCO format
+- A converter to mask format
+- License header for most of all files
+- .gitattribute to avoid problems with bash scripts inside a container
+- CHANGELOG.md itself
+- Drawing size of a bounding box during resize
+- Color by instance, group, label
+- Group objects
+- Object propagation on next frames
+- Full screen view
+
+### Changed
+- Documentation, screencasts, the primary screenshot
+- Content-type for save_job request is application/json
+
+### Fixed
+- Player navigation if the browser's window is scrolled
+- Filter doesn't support dash (-)
+- Several memory leaks
+- Inconsistent extensions between filenames in an annotation file and real filenames
+
+## [0.1.2] - 2018-08-07
+### Added
+- 7z archive support when creating a task
+- .vscode/launch.json file for developing with VS code
+
+### Fixed
+- #14: docker-compose down command as written in the readme does not remove volumes
+- #15: all checkboxes in temporary attributes are checked when reopening job after saving the job
+- #18: extend CONTRIBUTING.md
+- #19: using the same attribute for label twice -> stuck
+
+### Changed
+- More strict verification for labels with attributes
+
+## [0.1.1] - 2018-07-6
+### Added
+- Links on a screenshot, documentation, screencasts into README.md
+- CONTRIBUTORS.md
+
+### Fixed
+- GitHub documentation
+
+## 0.1.0 - 2018-06-29
+### Added
+- Initial version
+
+## Template
+```
+## [Unreleased]
+### Added
+-
+
+### Changed
+-
+
+### Deprecated
+-
+
+### Removed
+-
+
+### Fixed
+-
+
+### Security
+-
+```

README.md

@@ -2,7 +2,7 @@
 
 CVAT is completely re-designed and re-implemented version of [Video Annotation Tool from Irvine, California](http://carlvondrick.com/vatic/) tool. It is free, online, interactive video and image annotation tool for computer vision. It is being used by our team to annotate million of objects with different properties. Many UI and UX decisions are based on feedbacks from professional data annotation team.
 
-![CVAT screenshot](cvat/apps/documentation/static/documentation/images/gif003.gif)
+![CVAT screenshot](cvat/apps/documentation/static/documentation/images/cvat.jpg)
 
 ## Documentation
 
@@ -11,9 +11,10 @@ CVAT is completely re-designed and re-implemented version of [Video Annotation T
 
 ## Screencasts
 
-- [Annotation mode](https://www.youtube.com/watch?v=uSqaQENdyJE)
-- [Interpolation mode](https://www.youtube.com/watch?v=sc5X5hvxNfA)
-- [Attribute mode](https://www.youtube.com/watch?v=5yXaG0V7X0Q)
+- [Annotation mode](https://youtu.be/6h7HxGL6Ct4)
+- [Interpolation mode](https://youtu.be/U3MYDhESHo4)
+- [Attribute mode](https://youtu.be/UPNfWl8Egd8)
+- [Segmentation mode](https://youtu.be/6IJ0QN7PBKo)
 
 ## LICENSE
 
@@ -131,12 +132,12 @@ services:
       CVAT_SHARE_URL: "Mounted from /mnt/share host directory"
     volumes:
       cvat_share:/home/django/share:ro
-      
+
 volumes:
   cvat_share:
     driver_opts:
       type: none
       device: /mnt/share
       o: bind
 ```
-You can change the share device path to your actual share. For user convenience we have defined the enviroment variable $CVAT_SHARE_URL. This variable contains a text (url for example) which will be being shown in the client-share browser. 
+You can change the share device path to your actual share. For user convenience we have defined the enviroment variable $CVAT_SHARE_URL. This variable contains a text (url for example) which will be being shown in the client-share browser.

cvat/apps/documentation/user_guide.md

@@ -32,9 +32,13 @@ There you can:
 
     ![](static/documentation/images/image005.jpg)
 
-    __Labels__. Use the following schema to create labels: ``label_name <prefix>input_type=attribute_name:attribute_value1,attribute_value2``
+    __Labels__. Use the following schema to create labels: ``label_name <prefix>input_type=attribute_name:attribute_value1,attribute_value2``. You can specify multiple labels and multiple attributes separated by space. Attributes belong to previous label.
 
-    Example: ``vehicle @select=type:__undefined__,car,truck,bus,train ~radio=quality:good,bad ~checkbox=parked:false``
+    Example:
+    - ``vehicle @select=type:__undefined__,car,truck,bus,train ~radio=quality:good,bad ~checkbox=parked:false`` -
+    one label with multiple attributes
+    - ``car person bike`` - three labels without attributes
+    - ``circle @radio=color:green,red,blue @number=radius:0,10,0.1 line square`` - one label with two attributes and two labels without attributes
 
     ``label_name``: for example *vehicle, person, face etc.*
 
@@ -61,7 +65,11 @@ There you can:
 
     __Z-Order__. Defines the order on drawn polygons. Check the box for enable layered dislaying.
 
-    __Overlap Size__. Use this option to make overlapped segments. The option makes tracks continuous from one segment into another. Use it for interpolation mode.
+    __Overlap Size__. Use this option to make overlapped segments. The option makes tracks continuous from one segment into another. Use it for interpolation mode. There are several use cases for the parameter:
+    - For an interpolation task (video sequence) if an object exists on overlapped segments it will be automatically merged into one track if overlap is greater than zero and annotation is good enough on adjacent segments. If overlap equals to zero or annotation is poor on adjacent segments inside a dumped annotation file you will have several tracks, one for each segment, which correspond to the object).
+    - For an annotation task (independent images) if an object exists on overlapped segments bounding boxes will be automatically merged into one if overlap is greater than zero and annotation is good enough on adjacent segments. If overlap equals to zero or annotation is poor on adjacent segments inside a dumped annotation file you will have several bounding boxes for the same object.
+
+    Thus you annotate an object on first segment. You annotate the same object on second segment and if you do it right you will have one track inside your annotation file. If annotations on different segments (on overlapped frames) are very different or overlap is zero you will have two tracks for the same object. The functionality only works for bounding boxes. Polygon, polyline, points don't support automatic merge on overlapped segments even the overlap parameter isn't zero and match between corresponding shapes on adjacent segments is perfect.
 
     __Segment size__. Use this option to divide huge dataset by a few less size segments.
 
@@ -209,7 +217,7 @@ Usage examples:
 
     ![](static/documentation/images/image028.jpg)
 
-3. The annotation will be written into **.xml** file. To find the annotation file go to the directory where your browser saves downloaded files by default. For more information visit [.xml format page](./documentation/xml_format.html).
+3. The annotation will be written into **.xml** file. To find the annotation file go to the directory where your browser saves downloaded files by default. For more information visit [.xml format page](/documentation/xml_format.html).
 
     ![](static/documentation/images/image029.jpg)