Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@atxtechbro
Copy link
Owner

Summary

Add the MLflow tracking implementation as a concrete example in the AI provider agnosticism principle documentation.

Context

We recently implemented truly provider-agnostic MLflow tracking in PR #1328 that demonstrates the principle perfectly by:

  • Avoiding N×M complexity (N providers × M patterns)
  • Focusing on extracting actual commands rather than provider-specific formatting
  • Using a single parser (tracking/parse_session.py) for all AI assistants

Changes

Added a new section "Implementation Example: MLflow Session Tracking" that:

  • Shows the anti-pattern (provider-specific regex patterns)
  • Documents the correct pattern (provider-agnostic command extraction)
  • References the actual implementation with specific line numbers

Benefits

  • Shows a concrete implementation of the principle
  • Demonstrates how to avoid the N×M problem
  • Provides a reference for future provider-agnostic implementations

Related

…iple

Add concrete implementation example showing how MLflow tracking
demonstrates provider agnosticism by extracting actual commands
rather than maintaining provider-specific patterns. This avoids
N×M complexity and works automatically with any AI assistant.

References tracking/parse_session.py:72-96 as the implementation.

Closes #1329
@amazon-q-developer
Copy link
Contributor

Code review in progress. Analyzing for code quality issues and best practices. Detailed findings will be posted upon completion.

Using Amazon Q Developer for GitHub

Amazon Q Developer1 is an AI-powered assistant that integrates directly into your GitHub workflow, enhancing your development process with intelligent features for code development, review, and transformation.

Slash Commands

Command Description
/q <message> Chat with the agent to ask questions or request revisions
/q review Requests an Amazon Q powered code review
/q help Displays usage information

Features

Agentic Chat
Enables interactive conversation with Amazon Q to ask questions about the pull request or request specific revisions. Use /q <message> in comment threads or the review body to engage with the agent directly.

Code Review
Analyzes pull requests for code quality, potential issues, and security concerns. Provides feedback and suggested fixes. Automatically triggered on new or reopened PRs (can be disabled for AWS registered installations), or manually with /q review slash command in a comment.

Customization

You can create project-specific rules for Amazon Q Developer to follow:

  1. Create a .amazonq/rules folder in your project root.
  2. Add Markdown files in this folder to define rules (e.g., cdk-rules.md).
  3. Write detailed prompts in these files, such as coding standards or best practices.
  4. Amazon Q Developer will automatically use these rules when generating code or providing assistance.

Example rule:

All Amazon S3 buckets must have encryption enabled, enforce SSL, and block public access.
All Amazon DynamoDB Streams tables must have encryption enabled.
All Amazon SNS topics must have encryption enabled and enforce SSL.
All Amazon SNS queues must enforce SSL.

Feedback

To provide feedback on Amazon Q Developer, create an issue in the Amazon Q Developer public repository.

For more detailed information, visit the Amazon Q for GitHub documentation.

Footnotes

  1. Amazon Q Developer uses generative AI. You may need to verify generated code before using it in your environment. See the AWS Responsible AI Policy.

@amazon-q-developer
Copy link
Contributor

⚠️ Review Failed

I was unable to finalize my review because the pull request head or merge base was modified since I began my review. Please try again.

Request ID: 9d989eff-a666-54d9-961b-ffb177e82b47

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.

docs: add MLflow tracking as example of AI provider agnosticism principle

2 participants