API Documentation
CLI Reference
The RemyxAI CLI provides commands to interact with the RemyxAI platform for model management, deployment, and evaluation.
CLI Commands
list_models
Lists all your trained models.
Usage:
Description:
- Lists the models available for interaction.
Example:
summarize_model [model_name]
Retrieves a summary for the specified model.
Usage:
Arguments:
- model_name: The name of the model to summarize.
Description:
- Provides detailed summary information for the specified model.
Example:
evaluate_myxboard [models] [tasks]
Evaluates models using specified tasks on the MyxBoard.
Usage:
Arguments:
- models: The list of model names to evaluate.
- tasks: The evaluation tasks to perform on the models.
Description:
- Runs the specified evaluation tasks on the provided models using the MyxBoard.
Example:
deploy_model [model_name] [action]
Deploys or tears down a model using Docker.
Usage:
Arguments:
- model_name: The name of the model to deploy or tear down.
- action: The action to perform:
"up"
for deploying,"down"
for tearing down.
Description:
- Deploys a model to a Triton Inference Server using Docker, or tears down the model.
Example:
dataset [action] [dataset_name]
Manage datasets.
Usage:
Arguments:
- action: The action to perform:
"list"
for listing datasets,"delete"
for deleting a dataset,"download"
for downloading a dataset. - dataset_name: The name of the dataset to manage. Only required for the
"delete"
and"download"
actions.
Description:
- Lists, deletes, or downloads a dataset.
Example: