From 8b26d37479f228c71427f42f156ae5b0b8fea38e Mon Sep 17 00:00:00 2001 From: lmasson Date: Mon, 27 May 2024 17:40:50 +0200 Subject: [PATCH] golden allUsage --- ...t-all-usage-inference-acl-add-usage.golden | 21 + ...ll-usage-inference-acl-delete-usage.golden | 19 + ...-all-usage-inference-acl-list-usage.golden | 19 + ...t-all-usage-inference-acl-set-usage.golden | 21 + .../test-all-usage-inference-acl-usage.golden | 23 + ...e-inference-deployment-create-usage.golden | 30 ++ ...e-inference-deployment-delete-usage.golden | 20 + ...ce-deployment-get-certificate-usage.golden | 20 + ...sage-inference-deployment-get-usage.golden | 19 + ...age-inference-deployment-list-usage.golden | 23 + ...e-inference-deployment-update-usage.golden | 23 + ...ll-usage-inference-deployment-usage.golden | 25 ++ ...age-inference-endpoint-create-usage.golden | 22 + ...age-inference-endpoint-delete-usage.golden | 19 + ...age-inference-endpoint-update-usage.golden | 20 + ...-all-usage-inference-endpoint-usage.golden | 22 + ...all-usage-inference-model-get-usage.golden | 19 + ...ll-usage-inference-model-list-usage.golden | 22 + ...est-all-usage-inference-model-usage.golden | 21 + ...sage-inference-node-type-list-usage.golden | 19 + ...all-usage-inference-node-type-usage.golden | 20 + .../test-all-usage-inference-usage.golden | 24 ++ docs/commands/llm-inference.md | 402 ------------------ 23 files changed, 471 insertions(+), 402 deletions(-) create mode 100644 cmd/scw/testdata/test-all-usage-inference-acl-add-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-acl-delete-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-acl-list-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-acl-set-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-acl-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-deployment-create-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-deployment-delete-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-deployment-get-certificate-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-deployment-get-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-deployment-list-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-deployment-update-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-deployment-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-endpoint-create-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-endpoint-delete-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-endpoint-update-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-endpoint-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-model-get-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-model-list-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-model-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-node-type-list-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-node-type-usage.golden create mode 100644 cmd/scw/testdata/test-all-usage-inference-usage.golden delete mode 100644 docs/commands/llm-inference.md diff --git a/cmd/scw/testdata/test-all-usage-inference-acl-add-usage.golden b/cmd/scw/testdata/test-all-usage-inference-acl-add-usage.golden new file mode 100644 index 0000000000..4aaf0cbf2c --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-acl-add-usage.golden @@ -0,0 +1,21 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Add new ACL rules for a specific deployment. + +USAGE: + scw inference acl add [arg=value ...] + +ARGS: + deployment-id ID of the deployment to add ACL rules to + [acls.{index}.ip] IP address to be allowed + [acls.{index}.description] Description of the ACL rule + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for add + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-acl-delete-usage.golden b/cmd/scw/testdata/test-all-usage-inference-acl-delete-usage.golden new file mode 100644 index 0000000000..d971120549 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-acl-delete-usage.golden @@ -0,0 +1,19 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Delete an exising ACL. + +USAGE: + scw inference acl delete [arg=value ...] + +ARGS: + acl-id ID of the ACL rule to delete + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for delete + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-acl-list-usage.golden b/cmd/scw/testdata/test-all-usage-inference-acl-list-usage.golden new file mode 100644 index 0000000000..99602ab34e --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-acl-list-usage.golden @@ -0,0 +1,19 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +List ACLs for a specific deployment. + +USAGE: + scw inference acl list [arg=value ...] + +ARGS: + deployment-id ID of the deployment to list ACL rules for + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all) + +FLAGS: + -h, --help help for list + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-acl-set-usage.golden b/cmd/scw/testdata/test-all-usage-inference-acl-set-usage.golden new file mode 100644 index 0000000000..b4eaef6c71 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-acl-set-usage.golden @@ -0,0 +1,21 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Set new ACL rules for a specific deployment. + +USAGE: + scw inference acl set [arg=value ...] + +ARGS: + deployment-id ID of the deployment to set ACL rules for + [acls.{index}.ip] IP address to be allowed + [acls.{index}.description] Description of the ACL rule + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for set + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-acl-usage.golden b/cmd/scw/testdata/test-all-usage-inference-acl-usage.golden new file mode 100644 index 0000000000..4351d6b812 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-acl-usage.golden @@ -0,0 +1,23 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Access Control List (ACL) management commands. + +USAGE: + scw inference acl + +AVAILABLE COMMANDS: + add Add new ACLs + delete Delete an exising ACL + list List your ACLs + set Set new ACL + +FLAGS: + -h, --help help for acl + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use + +Use "scw inference acl [command] --help" for more information about a command. diff --git a/cmd/scw/testdata/test-all-usage-inference-deployment-create-usage.golden b/cmd/scw/testdata/test-all-usage-inference-deployment-create-usage.golden new file mode 100644 index 0000000000..2533060416 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-deployment-create-usage.golden @@ -0,0 +1,30 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Create a new inference deployment related to a specific model. + +USAGE: + scw inference deployment create [arg=value ...] + +ARGS: + name= Name of the deployment + [project-id] Project ID to use. If none is passed the default project ID will be used + model-name Name of the model to use + [accept-eula] Accept the model's End User License Agreement (EULA). + node-type Name of the node type to use + [tags.{index}] List of tags to apply to the deployment + [min-size] Defines the minimum size of the pool + [max-size] Defines the maximum size of the pool + [endpoints.{index}.is-public=false] Will configure your public endpoint if true + [endpoints.{index}.private-network.private-network-id] ID of the Private Network + [endpoints.{index}.disable-auth=false] Disable the authentication on the endpoint. + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for create + -w, --wait wait until the deployment is ready + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-deployment-delete-usage.golden b/cmd/scw/testdata/test-all-usage-inference-deployment-delete-usage.golden new file mode 100644 index 0000000000..573fde48cf --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-deployment-delete-usage.golden @@ -0,0 +1,20 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Delete an existing inference deployment. + +USAGE: + scw inference deployment delete [arg=value ...] + +ARGS: + deployment-id ID of the deployment to delete + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for delete + -w, --wait wait until the deployment is ready + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-deployment-get-certificate-usage.golden b/cmd/scw/testdata/test-all-usage-inference-deployment-get-certificate-usage.golden new file mode 100644 index 0000000000..6d218792cb --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-deployment-get-certificate-usage.golden @@ -0,0 +1,20 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Get the CA certificate used for the deployment of private endpoints. +The CA certificate will be returned as a PEM file. + +USAGE: + scw inference deployment get-certificate [arg=value ...] + +ARGS: + deployment-id + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for get-certificate + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-deployment-get-usage.golden b/cmd/scw/testdata/test-all-usage-inference-deployment-get-usage.golden new file mode 100644 index 0000000000..0a090dc074 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-deployment-get-usage.golden @@ -0,0 +1,19 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Get the deployment for the given ID. + +USAGE: + scw inference deployment get [arg=value ...] + +ARGS: + deployment-id ID of the deployment to get + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for get + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-deployment-list-usage.golden b/cmd/scw/testdata/test-all-usage-inference-deployment-list-usage.golden new file mode 100644 index 0000000000..4d2e55d6f7 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-deployment-list-usage.golden @@ -0,0 +1,23 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +List all your inference deployments. + +USAGE: + scw inference deployment list [arg=value ...] + +ARGS: + [order-by] Order in which to return results (created_at_desc | created_at_asc | name_asc | name_desc) + [project-id] Filter by Project ID + [name] Filter by deployment name + [tags.{index}] Filter by tags + [organization-id] Filter by Organization ID + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all) + +FLAGS: + -h, --help help for list + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-deployment-update-usage.golden b/cmd/scw/testdata/test-all-usage-inference-deployment-update-usage.golden new file mode 100644 index 0000000000..6fc16bf4e1 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-deployment-update-usage.golden @@ -0,0 +1,23 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Update an existing inference deployment. + +USAGE: + scw inference deployment update [arg=value ...] + +ARGS: + deployment-id ID of the deployment to update + [name] Name of the deployment + [tags.{index}] List of tags to apply to the deployment + [min-size] Defines the new minimum size of the pool + [max-size] Defines the new maximum size of the pool + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for update + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-deployment-usage.golden b/cmd/scw/testdata/test-all-usage-inference-deployment-usage.golden new file mode 100644 index 0000000000..e2b8000d1a --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-deployment-usage.golden @@ -0,0 +1,25 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Deployment commands. + +USAGE: + scw inference deployment + +AVAILABLE COMMANDS: + create Create a deployment + delete Delete a deployment + get Get a deployment + get-certificate Get the CA certificate + list List inference deployments + update Update a deployment + +FLAGS: + -h, --help help for deployment + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use + +Use "scw inference deployment [command] --help" for more information about a command. diff --git a/cmd/scw/testdata/test-all-usage-inference-endpoint-create-usage.golden b/cmd/scw/testdata/test-all-usage-inference-endpoint-create-usage.golden new file mode 100644 index 0000000000..c7a57de456 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-endpoint-create-usage.golden @@ -0,0 +1,22 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Create a new Endpoint related to a specific deployment. + +USAGE: + scw inference endpoint create [arg=value ...] + +ARGS: + deployment-id ID of the deployment to create the endpoint for + [endpoint.is-public=false] Will configure your public endpoint if true + [endpoint.private-network.private-network-id] ID of the Private Network + [endpoint.disable-auth=false] Disable the authentication on the endpoint. + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for create + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-endpoint-delete-usage.golden b/cmd/scw/testdata/test-all-usage-inference-endpoint-delete-usage.golden new file mode 100644 index 0000000000..0c826056e8 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-endpoint-delete-usage.golden @@ -0,0 +1,19 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Delete an existing Endpoint. + +USAGE: + scw inference endpoint delete [arg=value ...] + +ARGS: + endpoint-id ID of the endpoint to delete + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for delete + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-endpoint-update-usage.golden b/cmd/scw/testdata/test-all-usage-inference-endpoint-update-usage.golden new file mode 100644 index 0000000000..1dc7b8f10d --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-endpoint-update-usage.golden @@ -0,0 +1,20 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Update an existing Endpoint. + +USAGE: + scw inference endpoint update [arg=value ...] + +ARGS: + endpoint-id ID of the endpoint to update + [disable-auth] Disable the authentication on the endpoint. + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for update + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-endpoint-usage.golden b/cmd/scw/testdata/test-all-usage-inference-endpoint-usage.golden new file mode 100644 index 0000000000..ecb3d2f65c --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-endpoint-usage.golden @@ -0,0 +1,22 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Endpoint management commands. + +USAGE: + scw inference endpoint + +AVAILABLE COMMANDS: + create Create an endpoint + delete Delete an endpoint + update Update an endpoint + +FLAGS: + -h, --help help for endpoint + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use + +Use "scw inference endpoint [command] --help" for more information about a command. diff --git a/cmd/scw/testdata/test-all-usage-inference-model-get-usage.golden b/cmd/scw/testdata/test-all-usage-inference-model-get-usage.golden new file mode 100644 index 0000000000..f0cdefb619 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-model-get-usage.golden @@ -0,0 +1,19 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Get the model for the given ID. + +USAGE: + scw inference model get [arg=value ...] + +ARGS: + model-id ID of the model to get + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par) + +FLAGS: + -h, --help help for get + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-model-list-usage.golden b/cmd/scw/testdata/test-all-usage-inference-model-list-usage.golden new file mode 100644 index 0000000000..2b9d2e9365 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-model-list-usage.golden @@ -0,0 +1,22 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +List all available models. + +USAGE: + scw inference model list [arg=value ...] + +ARGS: + [order-by] Order in which to return results (created_at_asc | created_at_desc | name_asc | name_desc) + [project-id] Filter by Project ID + [name] Filter by model name + [tags.{index}] Filter by tags + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all) + +FLAGS: + -h, --help help for list + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-model-usage.golden b/cmd/scw/testdata/test-all-usage-inference-model-usage.golden new file mode 100644 index 0000000000..6291a33f31 --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-model-usage.golden @@ -0,0 +1,21 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Models commands. + +USAGE: + scw inference model + +AVAILABLE COMMANDS: + get Get a model + list List models + +FLAGS: + -h, --help help for model + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use + +Use "scw inference model [command] --help" for more information about a command. diff --git a/cmd/scw/testdata/test-all-usage-inference-node-type-list-usage.golden b/cmd/scw/testdata/test-all-usage-inference-node-type-list-usage.golden new file mode 100644 index 0000000000..8b95fbf2bc --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-node-type-list-usage.golden @@ -0,0 +1,19 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. + +USAGE: + scw inference node-type list [arg=value ...] + +ARGS: + [include-disabled-types] Include disabled node types in the response + [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all) + +FLAGS: + -h, --help help for list + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use diff --git a/cmd/scw/testdata/test-all-usage-inference-node-type-usage.golden b/cmd/scw/testdata/test-all-usage-inference-node-type-usage.golden new file mode 100644 index 0000000000..5c82db717b --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-node-type-usage.golden @@ -0,0 +1,20 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +Node types management commands. + +USAGE: + scw inference node-type + +AVAILABLE COMMANDS: + list List available node types + +FLAGS: + -h, --help help for node-type + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use + +Use "scw inference node-type [command] --help" for more information about a command. diff --git a/cmd/scw/testdata/test-all-usage-inference-usage.golden b/cmd/scw/testdata/test-all-usage-inference-usage.golden new file mode 100644 index 0000000000..2cbbaaa78b --- /dev/null +++ b/cmd/scw/testdata/test-all-usage-inference-usage.golden @@ -0,0 +1,24 @@ +🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 +πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ +This API allows you to manage your Inference services. + +USAGE: + scw inference + +AVAILABLE COMMANDS: + acl Access Control List (ACL) management commands + deployment Deployment commands + endpoint Endpoint management commands + model Models commands + node-type Node types management commands + +FLAGS: + -h, --help help for inference + +GLOBAL FLAGS: + -c, --config string The path to the config file + -D, --debug Enable debug mode + -o, --output string Output format: json or human, see 'scw help output' for more info (default "human") + -p, --profile string The config profile to use + +Use "scw inference [command] --help" for more information about a command. diff --git a/docs/commands/llm-inference.md b/docs/commands/llm-inference.md deleted file mode 100644 index 87abc1370b..0000000000 --- a/docs/commands/llm-inference.md +++ /dev/null @@ -1,402 +0,0 @@ - -# Documentation for `scw llm-inference` -This API allows you to manage your Inference services. - -- [Access Control List (ACL) management commands](#access-control-list-(acl)-management-commands) - - [Add new ACLs](#add-new-acls) - - [Delete an exising ACL](#delete-an-exising-acl) - - [List your ACLs](#list-your-acls) - - [Set new ACL](#set-new-acl) -- [Deployment commands](#deployment-commands) - - [Create a deployment](#create-a-deployment) - - [Delete a deployment](#delete-a-deployment) - - [Get a deployment](#get-a-deployment) - - [Get the CA certificate](#get-the-ca-certificate) - - [List inference deployments](#list-inference-deployments) - - [Update a deployment](#update-a-deployment) -- [Endpoint management commands](#endpoint-management-commands) - - [Create an endpoint](#create-an-endpoint) - - [Delete an endpoint](#delete-an-endpoint) - - [Update an endpoint](#update-an-endpoint) -- [Models commands](#models-commands) - - [Get a model](#get-a-model) - - [List models](#list-models) -- [Node types management commands](#node-types-management-commands) - - [List available node types](#list-available-node-types) - - -## Access Control List (ACL) management commands - -Access Control List (ACL) management commands. - - -### Add new ACLs - -Add new ACL rules for a specific deployment. - -**Usage:** - -``` -scw llm-inference acl add [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| deployment-id | Required | ID of the deployment to add ACL rules to | -| acls.{index}.ip | | IP address to be allowed | -| acls.{index}.description | | Description of the ACL rule | -| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | - - - -### Delete an exising ACL - -Delete an exising ACL. - -**Usage:** - -``` -scw llm-inference acl delete [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| acl-id | Required | ID of the ACL rule to delete | -| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | - - - -### List your ACLs - -List ACLs for a specific deployment. - -**Usage:** - -``` -scw llm-inference acl list [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| deployment-id | Required | ID of the deployment to list ACL rules for | -| region | Default: `fr-par`
One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config | - - - -### Set new ACL - -Set new ACL rules for a specific deployment. - -**Usage:** - -``` -scw llm-inference acl set [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| deployment-id | Required | ID of the deployment to set ACL rules for | -| acls.{index}.ip | | IP address to be allowed | -| acls.{index}.description | | Description of the ACL rule | -| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | - - - -## Deployment commands - -Deployment commands. - - -### Create a deployment - -Create a new inference deployment related to a specific model. - -**Usage:** - -``` -scw llm-inference deployment create [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| name | Required
Default: `` | Name of the deployment | -| project-id | | Project ID to use. If none is passed the default project ID will be used | -| model-name | Required | Name of the model to use | -| accept-eula | | Accept the model's End User License Agreement (EULA). | -| node-type | Required | Name of the node type to use | -| tags.{index} | | List of tags to apply to the deployment | -| min-size | | Defines the minimum size of the pool | -| max-size | | Defines the maximum size of the pool | -| endpoints.{index}.is-public | Default: `false` | Will configure your public endpoint if true | -| endpoints.{index}.private-network.private-network-id | | ID of the Private Network | -| endpoints.{index}.disable-auth | Default: `false` | Disable the authentication on the endpoint. | -| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | - - - -### Delete a deployment - -Delete an existing inference deployment. - -**Usage:** - -``` -scw llm-inference deployment delete [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| deployment-id | Required | ID of the deployment to delete | -| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | - - - -### Get a deployment - -Get the deployment for the given ID. - -**Usage:** - -``` -scw llm-inference deployment get [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| deployment-id | Required | ID of the deployment to get | -| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | - - - -### Get the CA certificate - -Get the CA certificate used for the deployment of private endpoints. -The CA certificate will be returned as a PEM file. - -**Usage:** - -``` -scw llm-inference deployment get-certificate [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| deployment-id | Required | | -| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | - - - -### List inference deployments - -List all your inference deployments. - -**Usage:** - -``` -scw llm-inference deployment list [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| order-by | One of: `created_at_desc`, `created_at_asc`, `name_asc`, `name_desc` | Order in which to return results | -| project-id | | Filter by Project ID | -| name | | Filter by deployment name | -| tags.{index} | | Filter by tags | -| organization-id | | Filter by Organization ID | -| region | Default: `fr-par`
One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config | - - - -### Update a deployment - -Update an existing inference deployment. - -**Usage:** - -``` -scw llm-inference deployment update [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| deployment-id | Required | ID of the deployment to update | -| name | | Name of the deployment | -| tags.{index} | | List of tags to apply to the deployment | -| min-size | | Defines the new minimum size of the pool | -| max-size | | Defines the new maximum size of the pool | -| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | - - - -## Endpoint management commands - -Endpoint management commands. - - -### Create an endpoint - -Create a new Endpoint related to a specific deployment. - -**Usage:** - -``` -scw llm-inference endpoint create [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| deployment-id | Required | ID of the deployment to create the endpoint for | -| endpoint.is-public | Default: `false` | Will configure your public endpoint if true | -| endpoint.private-network.private-network-id | | ID of the Private Network | -| endpoint.disable-auth | Default: `false` | Disable the authentication on the endpoint. | -| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | - - - -### Delete an endpoint - -Delete an existing Endpoint. - -**Usage:** - -``` -scw llm-inference endpoint delete [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| endpoint-id | Required | ID of the endpoint to delete | -| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | - - - -### Update an endpoint - -Update an existing Endpoint. - -**Usage:** - -``` -scw llm-inference endpoint update [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| endpoint-id | Required | ID of the endpoint to update | -| disable-auth | | Disable the authentication on the endpoint. | -| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | - - - -## Models commands - -Models commands. - - -### Get a model - -Get the model for the given ID. - -**Usage:** - -``` -scw llm-inference model get [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| model-id | Required | ID of the model to get | -| region | Default: `fr-par`
One of: `fr-par` | Region to target. If none is passed will use default region from the config | - - - -### List models - -List all available models. - -**Usage:** - -``` -scw llm-inference model list [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | Order in which to return results | -| project-id | | Filter by Project ID | -| name | | Filter by model name | -| tags.{index} | | Filter by tags | -| region | Default: `fr-par`
One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config | - - - -## Node types management commands - -Node types management commands. - - -### List available node types - -List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. - -**Usage:** - -``` -scw llm-inference node-type list [arg=value ...] -``` - - -**Args:** - -| Name | | Description | -|------|---|-------------| -| include-disabled-types | | Include disabled node types in the response | -| region | Default: `fr-par`
One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config | - - -