Skip to main content

OptHub Evaluator

Project description

OptHub Evaluator

OptHub Evaluator is a worker program that evaluates a solution submitted to OptHub.

Requirements

  • Python >=3.6
  • Docker >=1.12

See also requirements.txt for dependent python packages.

Installation

$ pip install opthub-evaluator

Usage

How to start an evaluator

Login the docker registry where the problem image is stored.

$ docker login <registry>

Start an evaluator.

$ opthub-evaluator

Options

Parameter Type Default Description
url path https://opthub-api.herokuapp.com/v1/graphql URL to OptHub
apikey str ApiKey
interval int 2 Polling interval
verify/no-verify bool True Verify SSL certificate
retries int 3 Retries to establish HTTPS connection
timeout int 600 Timeout to process a query
rm Remove containers after exit
quiet Be quieter
verbose Be more verbose
config path opthub-evaluator.yml Configuration file

How to make an problem image

  1. Write a problem program in your favorite language.
  2. Dockerize it.
  3. Push the docker image to DockerHub or somewhere else accessible from OptHub. For this purpose, OptHub hosts its own docker private registry.
  4. Register the image tag to OptHub.

See also example.

Author

Naoki Hamada (hmkz@s101.xrea.com)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

opthub-evaluator-0.8.1.tar.gz (9.7 kB view hashes)

Uploaded Source

Built Distribution

opthub_evaluator-0.8.1-py3-none-any.whl (9.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page