https://github.com/cloud-cv/evalai-cli

:cloud: :rocket: Official EvalAI Command Line Tool
https://github.com/cloud-cv/evalai-cli

ai ai-challenges click machine-learning python3

Last synced: about 1 year ago
JSON representation

:cloud: :rocket: Official EvalAI Command Line Tool

• Host: GitHub
• URL: https://github.com/cloud-cv/evalai-cli
• Owner: Cloud-CV
• License: bsd-3-clause
• Created: 2018-04-12T06:33:35.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2025-03-29T19:02:33.000Z (about 1 year ago)
• Last Synced: 2025-03-29T20:19:21.791Z (about 1 year ago)
• Topics: ai, ai-challenges, click, machine-learning, python3
• Language: Python
• Homepage: https://cli.eval.ai
• Size: 5.66 MB
• Stars: 55
• Watchers: 12
• Forks: 63
• Open Issues: 113
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# EvalAI-CLI

Official Command Line utility to use EvalAI in your terminal.

EvalAI-CLI is designed to extend the functionality of the EvalAI web application to command line to make the platform more accessible and terminal-friendly to its users.

------------------------------------------------------------------------------------------

[![Join the chat at https://gitter.im/Cloud-CV/EvalAI](https://badges.gitter.im/Cloud-CV/EvalAI.svg)](https://gitter.im/Cloud-CV/EvalAI?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Build Status](https://travis-ci.org/Cloud-CV/evalai-cli.svg?branch=master)](https://travis-ci.org/Cloud-CV/evalai-cli)

[![Coverage Status](https://coveralls.io/repos/github/Cloud-CV/evalai-cli/badge.svg?branch=master)](https://coveralls.io/github/Cloud-CV/evalai-cli?branch=master)

[![Documentation Status](https://readthedocs.org/projects/markdown-guide/badge/?version=latest)](https://cli.eval.ai/)

## Installation

EvalAI-CLI and its required dependencies can be installed using pip:

```sh

pip install evalai

```

Once EvalAI-CLI is installed, check out the [usage documentation](https://cli.eval.ai/).

## Contributing Guidelines

If you are interested in contributing to EvalAI-CLI, follow our [contribution guidelines](https://github.com/Cloud-CV/evalai-cli/blob/master/.github/CONTRIBUTING.md).

## Development Setup

1. Setup the development environment for EvalAI and make sure that it is running perfectly.

2. Clone the evalai-cli repository to your machine via git

    ```bash

    git clone https://github.com/Cloud-CV/evalai-cli.git evalai-cli

    ```

3. Create a virtual environment

    ```bash

    cd evalai-cli

    virtualenv -p python3 venv

    source venv/bin/activate

    ```

4. Install the package locally

    ```bash

    pip install -e .

    ```

 

5. Change the evalai-cli host to make request to local EvalAI server running on `http://localhost:8000` by running:

   

   ```bash

   evalai host -sh http://localhost:8000

   ```

6. Login to cli using the command ``` evalai login```

Two users will be created by default which are listed below -

    ```bash

    Host User - username: host, password: password

    Participant User - username: participant, password: password

    ```