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

Update README.md links to some common commands #194

Closed amanex007 closed 4 years ago

amanex007 commented 4 years ago

Added CLI commands here in response to issue 179

IMPORTANT NOTES (please read, then delete):

The PR title should start with "Fix #bugnum: " (if applicable), followed by a clear one-line present-tense summary of the changes introduced in the PR. For example: "Fix #bugnum: Introduce the first version of the collection editor.".

Please make sure to mention "#bugnum" somewhere in the description of the PR. This enables Github to link the PR to the corresponding bug.

Please also make sure to follow the style rules.

pushkalkatara commented 4 years ago

Hi @amanex007 Thanks for the PR. Overall it looks good to me. I have some minor suggestions -

  1. Please edit the PR description by removing the IMPORTANT NOTES (as written in the bracket - read and delete).
  2. Some of the commands won't work as the documentation on the website is deprecated. There is an open issue to update that too - #174 . Replace 
    evalai challenge 1 participant 2

    with 

    evalai challenge 1 participate 2

    and replace

    evalai challenges future
  3. The last command - Configure the HOST URL: For forked version host url is http://localhost:8000 For online version host url is https://evalapi.cloudcv.org
yashdusing commented 4 years ago

@amanex007 it would be nice to have the screenshots as well along with the description.