Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REVIEW] README.md comments. #1

Closed
16 of 17 tasks
satyarth934 opened this issue Sep 14, 2021 · 0 comments
Closed
16 of 17 tasks

[REVIEW] README.md comments. #1

satyarth934 opened this issue Sep 14, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation review Updates/Comments/Suggestion during a review session.

Comments

@satyarth934
Copy link
Member

satyarth934 commented Sep 14, 2021

Section 1: Active Labeler

  • The first line in quotes, it has no context. If it's supposed to be a tagline, put it in a separate sentence to make that evident. Something even better would be to have it as a part of the image (at the bottom of it).
  • Involve Ricardo to check if we can improve the color scheme of the image and the text.
  • Get rid of the title that is separately mentioned at the top of the README. (match the other repos like Image Similarity Search or Chrome extension).
  • Check the other repos for formats to include the "Published by" line and the buttons.

Section 2: What is Active Learning?

  • Since the topic talks about explaining the concept, spend a couple more lines on explaining what active learning is and why we need it rather than directly jumping into the strategies.
  • Graphs or images highlighting the data being picked can be included for the different strategies but I don't feel too strongly about it. But some links can be referred to each strategy for introduction or wiki pages.

Section 4: Setup

  • For the directory structure, this can be used:
Dataset/
└── Unlabeled
    ├── Image1.png
    ├── Image2.png
    └── Image3.png

The tree command in linux gives this kind of output.

Section 5: How to use

  • Include a question mark at the end of the title.
  • Include the colab hyperlink as a button as well on top.

Section 6: Mandatory Arguments

  • In the first line, instead of "main pipeline", write "main.py file".
  • If possible, include a diagram highlighting what exactly is "Pipeline" in "Pipeline config" and what is model training in "Model config".
  • Also include hyperlinks to the pipeline_config.yml and model_config.yaml either in the title or in the first line of each sub-section.
  • Stick to a single extension format. Either yaml or yml.
  • Consider getting rid of -- from each parameter because that is not how the parameters are fed into the config files.
  • There are some spelling errors. Just go over it once again.

Section 7: Where can I find the trained model?

  • I couldn't find where the path to model is specified. Just check the reference once again.

Section 8: Citation

  • The author section is missing. (keeping consistent with the other repos)
@satyarth934 satyarth934 added documentation Improvements or additions to documentation review Updates/Comments/Suggestion during a review session. labels Sep 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation review Updates/Comments/Suggestion during a review session.
Projects
None yet
Development

No branches or pull requests

2 participants