Crunch CLI
This Python library is designed for the Crunch Hub, offering convenient access to competition's data and enabling effortless submission. When utilized in the command-line interface (CLI), its goal is to deliver a user experience akin to GitHub, enabling you to seamlessly push the code from your local environment.
Installation
Use pip to install the crunch-cli.
pip install crunch-cli --upgrade
Usage
Setup your environment
Go to any competition's page and click on the 'Submit' section. Then copy and paste the command into your terminal.
Write your model
import crunch
crunch_tools = crunch.load_notebook()
# load the data
data = crunch_tools.load_data()
# define your model
def train(): ...
def infer(): ...
# test your model
crunch_tools.test()
[!TIP] We always recommend trying the quickstarter, which already contains a working model to help you get started in minutes!
Detecting the environment
Being able to detect whether you are running inside the Runner allows you to configure your programme more precisely.
import crunch
if crunch.is_inside_runner:
print("running inside the runner")
else:
print("running elsewhere")
model.enable_debug()
logger.set_level("TRACE")
Submit with Crunch CLI
Usage: crunch push [OPTIONS]
Send the new submission of your code.
Options:
-m, --message TEXT Specify the change of your code. (like a commit message, limited to 1000 characters)
--main-file TEXT Entrypoint of your code. [default: main.py]
--model-directory TEXT Directory where your model is stored. [default: resources]
--export TEXT Copy the `.tar` to the specified file.
--no-pip-freeze Do not do a `pip freeze` to know preferred packages version.
--dry Prepare file but do not really create the submission.
Contributing
Pull requests are always welcome! If you find any issues or have suggestions for improvements, please feel free to submit a pull request or open an issue in the GitHub repository.
License
1 maintainer
Metadata
1 maintainer
Release files for crunch-cli 11.12.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| crunch_cli-11.12.0.tar.gz | 85.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| crunch_cli-11.12.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 197.8 kB
Release files / crunch_cli-11.12.0.tar.gz
| Download URL | crunch_cli-11.12.0.tar.gz |
|---|---|
| Size | 85.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e276fb20afbc5d4e30127d8015d0fc9608e83d290f95057332c9ee62818d122d
|
|
BLAKE2b-256 checksum How to use checksums |
f7b4e05aaad391285717b3444fc4a9ae53c938f16c37a6c3335f9c3b39fe7a2e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / crunch_cli-11.12.0-py3-none-any.whl
| Download URL | crunch_cli-11.12.0-py3-none-any.whl |
|---|---|
| Size | 112.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ed82bb337343137826717a5aba151e07153715f8009dbc1bf49ad7d86639190c
|
|
BLAKE2b-256 checksum How to use checksums |
f2a39e49d4f6901df796e8301a4980c2cbb34cf5c849b59825d6a4cfc8ad39b5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
