Welcome to the Chaiverse CLI (Command-Line Interface) User Guide. This guide is designed to help you navigate through the Chaiverse CLI, enabling you to interact with the platform efficiently from your terminal. Whether you're submitting models, managing submissions, or accessing leaderboard information, this guide covers the essential commands and their usage.
Run pip install chaiverse
. Remember to upgrade to the newest version.
To interact with Chaiverse services, you'll need to authenticate using your developer key. If you haven't already, login using the login
command: chaiverse login
.
If you haven’t got your developer key, please join chaiverse discord and our bot will greet you and give you a developer key.
chaiverse login
: Login with your chai developer_keychaiverse logout
: Logout and clear develoepr_key from cachechaiverse my-submissions
: List your submissions in the format of
<submission_id> : <status>
chaiverse model-info <submission_id>
: Print the model information of a submission
chaiverse sample-feedback <submission_id>
: Randomly samples a feedback of a submission. It uses cached feedback by default, to refresh, please pass in '--reload': chaiverse sample-feedback --reload <submission_id>
chaiverse leaderboard
: Display the current season’s leaderboard
chaiverse list-formatters
: List available Prompt formatters that can be used directly in your submission.chaiverse formatter-info <formatter_name>
: Provide formatter_name, print its information.chaiverse submit-model
: Submit model with detailed submission and generation parameters provided as options. See detailed guidance below.