Skip to main content

Library for Opthub CLI tools.

Project description

日本語版 👈

OptHub Client

Skills

The Opthub Client is a Python package that provides the following features:

  • Submitting solutions to OptHub competitions
  • Checking the history and status of solutions submitted to OptHub competitions

This section explains how to install the OptHub Client and provides a tutorial. For more detailed instructions, please refer to the OptHub Client User Guide.

Installation

Make sure you have Python 3.10 or higher installed and that you have set up pip as your package manager. Then, run the following command to install opthub-client from PyPI.

$ pip install opthub-client

Tutorial

In this tutorial, we will explain how to submit solutions for the competitions you are participating in and how to review the history of your submissions.

To submit solutions, you need to create an account and join a competition beforehand.

👉 How to Create an Account and Join a Competition

Login

Execute opt login and enter your username and password.

$ opt login
Username: [username] # Your username
Password: [password]   # Your password
Hello [username]. Successfully logged in.

⚠ You need to create an account and verify your email address beforehand.

Select a Competition and Match

Execute opt select and select a competition and match.

$ opt select
? Select a competition: [competition_id] # Use ↑↓ keys to select a competition
? Select a match: [match_id] # Use ↑↓ keys to select a match
You have selected [competition_id]/[match_id]

⚠ You need to join at least one competition beforehand.

Submit a Solution

Execute opt submit and enter a solution according to the competition's input/output requirements.

$ opt submit
? Write the solution: [your_solution] # Enter your solution
Submitting to [competition_id]/[match_id]... # Submitting
...Submitted # Submission complete

👉 How to submit solutions from files 👉 How to submit solutions by your program

Check Submitted Solutions

Execute opt show trials to display the solutions you have submitted. Press n to display the next 20 solutions, or press e to exit the check.

$ opt show trials # Displays 20 solutions in descending order by default
Trial No: 30, status: success, Score: 0.0001
Trial No: 29, status: scoring
Trial No: 28, status: evaluating
・・・
n: next solutions, e: exit
# Press n to display the next 20 solutions, e to exit the check

Download Submitted Solutions

Execute opt download to download the solutions by specifying the range of trial numbers.

$ opt download -s 10 -e 30 # Download trial numbers 10 to 30
Downloading trials  [####################################]  100%
Trials have been written to trials_match1.json

👉 Format of the Output JSON File

For Contributors

Follow these steps to set up the environment:

  1. Clone this repository.
  2. Set up Poetry.
  3. Run poetry install.
  4. Download the recommended VSCode Extensions.
  5. Disable the following VS Code Extensions for this workspace to avoid conflicts with other packages:
    • ms-python.pylint
    • ms-python.black-formatter
    • ms-python.flake8
    • ms-python.isort

Once you have completed the above setup, you can use the opt command in the project's root directory.

Contact

If you have any questions or concerns, please feel free to contact us (Email: dev@opthub.ai).

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_client-0.8.0.tar.gz (23.6 kB view details)

Uploaded Source

Built Distribution

opthub_client-0.8.0-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

Details for the file opthub_client-0.8.0.tar.gz.

File metadata

  • Download URL: opthub_client-0.8.0.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.1 Linux/6.5.0-1025-azure

File hashes

Hashes for opthub_client-0.8.0.tar.gz
Algorithm Hash digest
SHA256 363ef2c0e6c253e5077a76f2b742cf4267cf49f12ef63d8bb91ec05feb55a7a2
MD5 27a2c302bc851af8e48d65020d3d641c
BLAKE2b-256 94279a144f789016e626b05fb733b2863f33cf06f61a6f0cb00fc088d98c5f52

See more details on using hashes here.

File details

Details for the file opthub_client-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: opthub_client-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 36.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.1 Linux/6.5.0-1025-azure

File hashes

Hashes for opthub_client-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 11dd214b81ac17c64a992006f0bb8b1b7106528a8bceed97fee96e4a4a34c01e
MD5 87e5f14a00d84c9aecc56446b69b1693
BLAKE2b-256 e55be275c2889f37c6a47524127a5d3c436f4a57035b27af12de2e4317a4b299

See more details on using hashes here.

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