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

Addressed #160: Auth Token configuration guide and references #207

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Addressed #160: Auth Token configuration guide and references #207

wants to merge 4 commits into from

Conversation

drepram
Copy link
Contributor

@drepram drepram commented Dec 15, 2019

Related to https://codein.withgoogle.com/dashboard/task-instances/5981550299054080/

I've tested the current written commands on the README.md and has improved them after I've successfully installed them on my Apple Machine. Please take a look.

3. Go to your profile (https://evalai.cloudcv.org/web/profile)
4. Click on `Get your Auth Token`
5. Copy the token
6. Set the token using the `evalai` CLI as shown below
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@drepram can you add a new line after this. It looks cluttered in markdown version

README.md Outdated
@@ -26,7 +26,7 @@ If you are interested in contributing to EvalAI-CLI, follow our [contribution gu
git clone https://github.com/Cloud-CV/evalai-cli.git evalai-cli
```

3. Create a virtual environment
3. Create a virtual environment ([Mac users could easily use Homebrew](https://gist.github.com/apavamontri/4516816))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of just for Mac users, can you add virtual env installation link to a page/post/steps that includes linux and windows as well? Something like: https://pythonforundergradengineers.com/virtualenv-in-osx-linux-windows.html

@drepram
Copy link
Contributor Author

drepram commented Dec 16, 2019

I've done the changes requested.

And I've tried the commands on https://evalai-cli.cloudcv.org/ and I found two misguiding commands. Which are:

  • evalai challenges upcoming should be evalai challenges future
  • evalai challenge 1 participant 2 should be evalai challenge 1 participate 2

Shall I make another PR for this and perhaps another GCI task?

README.md Outdated
@@ -26,7 +26,10 @@ If you are interested in contributing to EvalAI-CLI, follow our [contribution gu
git clone https://github.com/Cloud-CV/evalai-cli.git evalai-cli
```

3. Create a virtual environment
3. Create a virtual environment ([Mac users could easily use Homebrew](https://gist.github.com/apavamontri/4516816))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this: ([Mac users could easily use Homebrew](https://gist.github.com/apavamontri/4516816)) as we are adding this below

README.md Outdated
3. Create a virtual environment
3. Create a virtual environment ([Mac users could easily use Homebrew](https://gist.github.com/apavamontri/4516816))

- `virtualenv` installation guide: [guide](https://pythonforundergradengineers.com/virtualenv-in-osx-linux-windows.html)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace this with:

`virtualenv` installation guide: [Windows](https://programwithus.com/learn-to-code/Pip-and-virtualenv-on-Windows/), [Linux](https://www.linode.com/docs/development/python/create-a-python-virtualenv-on-ubuntu-1610/), [OSX](https://gist.github.com/apavamontri/4516816) 

README.md Outdated
3. Create a virtual environment ([Mac users could easily use Homebrew](https://gist.github.com/apavamontri/4516816))

- `virtualenv` installation guide: [guide](https://pythonforundergradengineers.com/virtualenv-in-osx-linux-windows.html)
- If you're on a Mac, consider using Homebrew: [guide](https://gist.github.com/apavamontri/4516816)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this line as virtualenv instructions are written before this point

@drepram
Copy link
Contributor Author

drepram commented Dec 17, 2019

Changes have been made. Please take a look.

Comment on lines +50 to +61
5. Configure your Auth Token
1. Create an account on the production site (https://evalai.cloudcv.org/)
2. Verify your email
3. Go to your profile (https://evalai.cloudcv.org/web/profile)
4. Click on `Get your Auth Token`
5. Copy the token
6. Set the token using the `evalai` CLI as shown below
<br><br>
```bash
evalai set_token <auth_token>
```

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kudos for adding these instructions!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

Copy link
Member

@krtkvrm krtkvrm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants