Docs: Update quick-start for PR#87

[pr-docs]

This PR updates the quick-start documentation based on changes from slashml/magemaker.

[github-actions]

📝 From @SirDocsALot the new docs are staged at https://magemaker-staging-a7933add265b4f9e.slashml.com

[docsalot-app]

Overall Summary

Summary of Pull Request:

This pull request updates the MageMaker documentation (quick-start.mdx) to introduce and explain a new feature: YAML-based query configuration for deployed model endpoints.

Key Points:

• New CLI Argument: Introduces a new --query command-line argument to the MageMaker CLI, allowing users to specify a YAML file that defines a query for a deployed model.
• Documentation Added: Adds detailed documentation about the new --query feature, including:
  • Overview and rationale for YAML-based queries.
  • How to use the --query argument with examples.
  • Example YAML configuration files for model inference requests.
  • Usage best practices and recommendations for versioning, validation, and team documentation.
  • A summary table for the new argument and its purpose.
• Sample Code: Provides a sample addition to the CLI argument parser showing how --query would be defined.
• Improved User Workflow: Highlights how this feature enables scripting, automation, and reproducibility of inference requests using simple YAML files.

Purpose:
To make querying deployed ML models via MageMaker more flexible, robust, and user-friendly through structured YAML specifications, improving automation and team collaboration.

No Code Functionality Change in This PR:
This is a documentation update describing a feature (implementation of the --query argument and YAML configuration processing is referenced but not included in this diff).

Per-file Summary

File	Summary
quick-start.mdx	Summary of Code Diff:

This change introduces documentation for a new feature in MageMaker: querying deployed models using a YAML configuration file via the command-line interface.

Key Points:

• New CLI Argument: Adds a --query argument to the MageMaker CLI, allowing users to specify a path to a YAML file containing query definitions.
  • The argument expects a string path to the YAML file.
  • Example of CLI usage: magemaker --query path/to/your-model.yaml
  • Example of code addition for argument parsing is included.
  • The action='query' custom action is referenced, implying code implementation elsewhere.
• YAML Configuration Support: Users can define the details of a model inference/query (like endpoint, inputs, options) in a YAML file for structured, reusable queries.
  • Example YAML is given showing parameters like endpoint, inputs, and options.
• Updated Documentation: Includes overview, example CLI commands, summary table of the new argument, best practices for YAML config maintenance, and recommendations for integrating this feature into development workflows.
• Benefits Highlighted: Emphasizes reproducibility, clarity, and ease of automation for model queries using YAML configs.

In Summary:
MageMaker now supports model inference queries defined through YAML configuration files, accessed via the new --query command-line argument. This streamlines workflow automation and improves reproducibility of model queries. |