From 06eeb16d0d2ace8f58a98b00aa1c584bf8bf8247 Mon Sep 17 00:00:00 2001 From: "docs-alot[bot]" <224863302+docs-alot[bot]@users.noreply.github.com> Date: Thu, 7 Aug 2025 19:14:21 +0000 Subject: [PATCH 1/2] docs: update quick-start.mdx for PR #89 --- quick-start.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/quick-start.mdx b/quick-start.mdx index 5853ef8..f1da396 100644 --- a/quick-start.mdx +++ b/quick-start.mdx @@ -21,6 +21,17 @@ Supported providers: - `--cloud azure` Azure Machine Learning deployment - `--cloud all` Configure all three providers at the same time +**If you run without any arguments, Magemaker will show a helpful error and guidance:** + +``` +Error: You must specify a cloud provider. +Possible solutions: +- magemaker --cloud gcp +- magemaker --cloud aws +- magemaker --cloud azure +- magemaker --cloud all +``` + ### List Models From 2e09ff841b757177d3428d6a2e8abfccc28036bd Mon Sep 17 00:00:00 2001 From: "docs-alot[bot]" <224863302+docs-alot[bot]@users.noreply.github.com> Date: Thu, 7 Aug 2025 19:14:44 +0000 Subject: [PATCH 2/2] docs: update concepts/deployment.mdx for PR #89 --- concepts/deployment.mdx | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/concepts/deployment.mdx b/concepts/deployment.mdx index 66ca7a9..e222ad5 100644 --- a/concepts/deployment.mdx +++ b/concepts/deployment.mdx @@ -205,6 +205,34 @@ Choose your instance type based on your model's requirements: Make sure you setup budget monitory and alerts to avoid unexpected charges. +## Command-line Interface Changes + +Starting with Magemaker vNext, the CLI offers: + +- Improved `--cloud` option: + Magemaker now **requires you to specify** which cloud provider you want to deploy on via `--cloud`, e.g. `--cloud aws`. Running just `magemaker` will prompt you with possible cloud choices and exit if none is provided. + +- Error messages for missing cloud provider: + If you run `magemaker` without arguments, you'll see an error like: + + ``` + Error: You must specify a cloud provider. + Possible solutions: + - magemaker --cloud gcp + - magemaker --cloud aws + - magemaker --cloud azure + - magemaker --cloud all + ``` + +- The `--cloud` flag cannot be used together with the `--deploy` option. + If you try, Magemaker will print: + + ``` + Error: You cannot specify a deployment configuration file with the --cloud flag. We will pick the destination from the yaml file + ``` + +- Improved help output: + Use `magemaker --help` or `magemaker --version` to see available options and version info. ## Troubleshooting Deployments