Swipe-Labeler
Swipe-Labeler copied to clipboard
[REVIEW] README.md comments.
Title
- [x] The title format does not match the other repos like Image Similarity Search or Chrome extension.
- [x] Check the other repos for formats to include the "Published by" line and the buttons.
- [x] Move the Colab button here.
Section 1: intro
- [x] Set title "About the tool" or something similar for this section.
- [x] Move the first line defining the tool with the later paragraph. Format it to match the other text.
- [x] Move the colab button to the title section.
- [x] Highlight the left and right swipe and keyboard keys in the labeling instructions.
- [ ] Ask Ricardo if he has some better ideas for the GIF that can also include the mobile GUI.
Section 2: Usage vs. Development Modes
- [x] Directly specify the Usage and Development as separate titles. Keep in mind that the reader would want to start using the tool ASAP. So minimize the reading content if it's not mandatory.
Section 2.1 Usage
- [x] Make this the major title.
- [x] In step 2, also add the command to move to the project folder.
cd Swipe-Labeler
- [x] In step 3, can mention that although optional, it is recommended that the user creates a virtual env.
- [x] In step 5, replace the command with
python api/api.py --path_for_unlabeled=path/to/unlabelled_images_dir --batch_size=5
- [ ] Include a directory tree showing a sample directory structure before and after the labeling process.
- [x] Make sure that the port number
5000
is fixed for every use.
Section 2.2: Setup (for development)
Section 2.2.1: Setting up the web server
- [x] In step 5, can mention that although optional, it is recommended that the user creates a virtual env.
Section 2.2.3: Usage (for development)
- [x] In step 2, replace the command with
python api/api.py --to_be_labeled=path/to/unlabelled_images_dir
- [x] Put
npm run build
command in a separate line.
Section 3: FAQs
- [x] Move the python3 and pip questions as 1 and 2 because they are referred first in the usage section.
Section 4: About the authors
- [x] Fill this section.
Section 5: Citation
- [x] Fill the
author
field.