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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file crunch_cli-11.9.0.tar.gz.
File metadata
- Download URL: crunch_cli-11.9.0.tar.gz
- Upload date:
- Size: 83.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
70197710816356a0a4752637dda057e3b052f729d9ba602ca3b5547f93f31172
|
|
| MD5 |
5786d41362cd12dc8c52236bb2f38dc7
|
|
| BLAKE2b-256 |
d2da5da0325c8a96b2f1189e9758bcc3f2c8c4b6cc66662b7ebba7aae90ce2a7
|
File details
Details for the file crunch_cli-11.9.0-py3-none-any.whl.
File metadata
- Download URL: crunch_cli-11.9.0-py3-none-any.whl
- Upload date:
- Size: 110.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
baa2f2a974d9ad7fb9c445bdaccd8e0cf38ada3195e123d7e6742442275368c2
|
|
| MD5 |
968a6ef994f731501287d3a19a530278
|
|
| BLAKE2b-256 |
dd86ac6923a07957866e4263c67e96f65a5ccbb03f223a02675e16804d823b76
|
