opthub-scorer 0.8.1

OptHub Scorer

OptHub Scorer

OptHub Scorer is a worker program that scores a solution submitted to OptHub.

Requirements

• Python >=3.6
• Docker >=1.12

See also requirements.txt for dependent python packages.

Installation

$ pip install opthub-scorer

Usage

How to start a scorer runner

Login the docker registry where the problem image is stored.

$ docker login <registry>

Start a scorer.

$ opthub-scorer

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-scorer.yml	Configuration file

How to make a scorer

1. Write an indicator 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 ([e-mail])

License

MIT