Skip to main content

Unearthed CLI Tool

Project description

Crowd ML CLI

This is the command line tool for Unearthed Solutions CrowdML challenges.

It is designed to make model validation and submission straightforward.

Please see the Unearthed Solutions Terms and Conditions

Commands

unearthed login

Prompts the user for their innovator portal login and stores the tokens. You must be logged in to run other commands.

unearthed new

This command asks the user which challenge they wish to download and unpack the model template for. The template will be unpacked in a named folder inside the current directory. A custom path can be specified with unearthed new /path/to/dir/

unearthed submit

This will bundle the source code in a Docker container and then submit the code to the submission pipeline. The user is provided a link to the submission tracker, which will auto-popup in their browser, so they can track the progress and logs of their submission.

You can disable the tracker from opening in the browser by specifying unearthed submit --no-tracker

unearthed tracker

Will open the tracker for the last submission that was made.

unearthed preprocess

This command will run the preprocess code in a Docker container similar to how it will execute in the submission pipeline. It can be used to validate the preprocessing code is working before submitting.

unearthed train

This command will train a model, including calling the preprocessing code, in a Docker container similar to how it will execute in the submission pipeline. It can be used to validate the training code is working before submitting.

unearthed predict

This command will simulate generating predictions on the public dataset so that the predictions can be inspected locally before submitting.

unearhted score

This command will run the scoring function to generate a score against the public dataset. It can be used to check the score against the public dataset before submitting.

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

unearthed-cli-0.1.9.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unearthed_cli-0.1.9-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file unearthed-cli-0.1.9.tar.gz.

File metadata

  • Download URL: unearthed-cli-0.1.9.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.6 Linux/5.4.109+

File hashes

Hashes for unearthed-cli-0.1.9.tar.gz
Algorithm Hash digest
SHA256 a2b635f0c5423a61afc55d905c6f3c57092b7f024ae8db641a18e9eb4768e1e8
MD5 3d6816392c16e40421e407620b552e95
BLAKE2b-256 324c0a4f47a020a1dae190f7688bb4dcb01accc9662e9536bd471df5497205ee

See more details on using hashes here.

File details

Details for the file unearthed_cli-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: unearthed_cli-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.6 Linux/5.4.109+

File hashes

Hashes for unearthed_cli-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 ba24c01f15a799fd18ea84934ac7911121964fcb61af1fd71796ac0444daa578
MD5 c486664233fc79e04cfeb9e4419428a9
BLAKE2b-256 b79965905209da24e34e3ab368eab1fb9e6e47a0cb4c75ce6084bec4507384f4

See more details on using hashes here.

Supported by

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