Skip to content

Docs: Update quick-start for PR#86#70

Open
pr-docs[bot] wants to merge 1 commit into
mainfrom
docs/pr-86
Open

Docs: Update quick-start for PR#86#70
pr-docs[bot] wants to merge 1 commit into
mainfrom
docs/pr-86

Conversation

@pr-docs
Copy link
Copy Markdown

@pr-docs pr-docs Bot commented Apr 24, 2025

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

@docsalot-app
Copy link
Copy Markdown

docsalot-app Bot commented Apr 24, 2025

Overall Summary

Pull Request Summary:

This PR updates the documentation (quick-start.mdx) to introduce a new feature in MageMaker: YAML-based querying via the command-line.

Key Changes:

  • New Command-Line Argument: Adds support for a --query argument, allowing users to submit inference requests using a YAML configuration file.
    • The --query parameter expects the file path to a YAML file specifying the model endpoint and the inputs.
    • Example code and usage are provided for clarity.
  • Documentation Additions:
    • Explains how to use the new argument and the benefits of structured, batch, and automated querying with YAML.
    • Includes an example YAML file and corresponding command-line usage.
  • Summary Section: Highlights the purpose and how the new feature improves usability for MageMaker workflows.

Overall:
This change makes it easier and more flexible for users to perform model queries by leveraging YAML configuration files, improving both interactive use and automation. No breaking changes, only new functionality and documentation.

Per-file Summary

File Summary

@github-actions
Copy link
Copy Markdown

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants