Cloud-CV / Cloud-CV/evalai-cli

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

Open
#179 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
57
Forks
70
PR merge metrics
No merged PRs in 30d

Description

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, the` readme` files makes little sense ( though I know, that user can go [here](https://evalai-cli.cloudcv.org) 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](https://evalai-cli.cloudcv.org) , I think it's a good practice to include the commands with a brief explanation in the `readme` file. It would it more informative.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.