search

Cloud-CV / evalai-cli

:cloud: :rocket: Official EvalAI Command Line Tool
https://cli.eval.ai
BSD 3-Clause "New" or "Revised" License
55 stars 63 forks source link

[Doc] : Readme.md - Description and CLI commands to be updated. #179

Open vasudev-sharma opened 4 years ago

vasudev-sharma commented 4 years ago

I think, the readme.md is quite undescriptive in the aim of this repo(evalai-cli). To elaborate further, I would like to mention 2 changes in readme.md file.

1. Description. To a user who is unaware of EvalAI, thereadme files makes little sense ( though I know, that user can go here or search about EvalAI). Nonetheless, for a good first impression, Readme file should describe how Eval-cli functions with EvalAI. For example to directly upload training codes on the platform in the form of docker images.

2. CLI commands Though CLI commands are available here , I think it's a good practice to include the commands with a brief explanation in the readme file. It would it more informative.

vasudev-sharma commented 4 years ago

A see a similar issue(#171) related to this one.