Skip to main content

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 (hmkz@s101.xrea.com)

License

MIT

Metadata

Release files for opthub-scorer 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for opthub-scorer 0.8.1
File Size Uploaded Provenance Actions
opthub-scorer-0.8.1.tar.gz 8.3 kB Without provenance Details for opthub-scorer-0.8.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for opthub-scorer 0.8.1
File Interpreter ABI Platform Actions
opthub_scorer-0.8.1-py3-none-any.whl Python 3 none any Details for opthub_scorer-0.8.1-py3-none-any.whl

Total release size: 16.9 kB

Release files / opthub-scorer-0.8.1.tar.gz

Download URL opthub-scorer-0.8.1.tar.gz
Size 8.3 kB
Tags Source
SHA-256 checksum
How to use checksums
ffa78319f2cd876342719f993af1dc2869f4006cb921e2ee2da73c92ceb866fd
BLAKE2b-256 checksum
How to use checksums
757925d072a68823addfa58422e8d86822a4c5d8b4d834aca8450407fba8845c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.18

Release files / opthub_scorer-0.8.1-py3-none-any.whl

Download URL opthub_scorer-0.8.1-py3-none-any.whl
Size 8.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7c2ccfc99bf1fa75eeed686f32753613a7815ededea6b7efb7d393bd1032def7
BLAKE2b-256 checksum
How to use checksums
b112d6d102ec685b09cd957bbdf158adf444a4abcadd2946d8c2ddf108ebb0a0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.18

Security for opthub-scorer 0.8.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page