diff --git a/README.md b/README.md index 2daf6db1..f883d8f0 100644 --- a/README.md +++ b/README.md @@ -20,22 +20,8 @@ Andrew Ng ## Sneak Peek -### Bounding boxes - -
- -
- -### Points -- -
- -### Polygons - -- +
## Set Up the Project Locally @@ -53,8 +39,23 @@ npm install # serve with hot reload at localhost:3000 npm start ``` +To ensure proper functionality of the application locally, an npm `6.x.x` and node.js `v11.x.x` versions are required. More information about this problem is available in the [#16][4]. + +## Supported Keyboard Shortcuts + +| Functionality | Context | Mac | Windows / Linux | +|:-----------------------------------|:--------:|:---:|:----------------:| +| Polygon autocomplete | Editor | Enter | Enter | +| Cancel polygon drawing | Editor | Escape | Escape | +| Delete currently selected label | Editor | Backspace | Delete | +| Load previous image | Editor | ⌥ + Left | Ctrl + Left | +| Load next image | Editor | ⌥ + Right | Ctrl + Right | +| Zoom in | Editor | ⌥ + + | Ctrl + + | +| Zoom out | Editor | ⌥ + - | Ctrl + - | +| Move image | Editor | Up / Down / Left / Right | Up / Down / Left / Right | +| Exit popup | Popup | Escape | Escape | -Some Windows 10 users may also have problems with running applications locally. The problems can be solved by adding additional dependencies to the project, through a command: `npm install normalize.css --save`. More information about this problem is available in the [#16][4]. +**Table 1.** Supported keyboard shortcuts ## Supported Output Formats @@ -64,182 +65,35 @@ Some Windows 10 users may also have problems with running applications locally. | **Rect** | ☑ | ☑ | ☑ | ☐ | ☐ | ☒ | | **Polygon** | ☐ | ☒ | ☐ | ☑ | ☐ | ☐ | -**Table 1.** The matrix of supported labels export format, where: +**Table 2.** The matrix of supported labels export format, where: * ☑ - supported format * ☐ - not yet supported format * ☒ - format does not make sense for a given label type +You can find examples of export files along with a description and schema on our [Wiki][7]. +## Privacy -**A .zip package containing files in YOLO format** - -- -**Schema:** - -`label_index rel_rect_center_x rel_rect_center_y rel_rect_width rel_rect_height` - -**Where:** - -`label_index` - index of the selected label -`rel_rect_center_x` - horizontal position of the centre of the rect in relation to overall image width, value between [0, 1] -`rel_rect_center_y` - vertical position of the centre of the rect in relation to overall image height, value between [0, 1] -`rel_rect_width` - rect width in relation to overall image width, value between [0, 1] -`rel_rect_height` - rect height in relation to overall image height, value between [0, 1] - -**Example:** - -``` -1 0.404528 0.543963 0.244094 0.727034 -2 0.610236 0.494751 0.188976 0.437008 -1 0.754921 0.791339 0.354331 0.413386 -``` -
-
-**Schema:**
-
-```xml
-
+We don't store your images, because we don't send them anywhere in the first place. -**Schema:** +## Road Map -`label_name,rect_left,rect_top,rect_width,rect_height,image_name,image_width,image_height` +Our application is being actively developed. Check out our plans for the near future on our [Wiki][6]. If you have an idea for a new functionality, please hit us on [Twitter][3] and [Gitter][5] or create an issue where you can describe your concept. In the meantime, see what improvements we are planning for you in the future. -**Where:** +## Contribution -`label_name` - selected label name -`rect_left` - absolute horizontal distance between the left edge of the image and the left edge of the rect in pixels -`rect_top` - absolute vertical distance between the top edge of the image and the top edge of the rect in pixels -`rect_width` - absolute rect width in pixels -`rect_height` - absolute rect height in pixels -`image_width` - absolute image width in pixels -`image_height` - absolute image height in pixels +Feel free to file [issues](https://github.com/SkalskiP/make-sense/issues) or [pull requests](https://github.com/SkalskiP/make-sense/pulls). -**Example:** +## Citation ``` -banana,491,164,530,614,000000.jpg,1280,960 -banana,462,245,466,353,000001.jpg,1280,960 -banana,542,477,587,375,000001.jpg,1280,960 -banana,636,109,561,695,000007.jpg,1280,960 -kiwi,198,477,317,251,000007.jpg,1280,960 -kiwi,558,423,219,222,000008.jpg,1280,960 -kiwi,758,360,252,236,000008.jpg,1280,960 +@MISC{make-sense, + author = {Piotr Skalski}, + title = {{Make Sense}}, + howpublished = "\url{https://github.com/SkalskiP/make-sense/}", + year = {2019}, +} ``` -