Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[META] Certified connector blueprint #3096

Open
ylwu-amzn opened this issue Oct 11, 2024 · 0 comments
Open

[META] Certified connector blueprint #3096

ylwu-amzn opened this issue Oct 11, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@ylwu-amzn
Copy link
Collaborator

Description:

We aim to establish a certified blueprint process for ML Commons connectors to streamline the creation, verification, and publication of custom connector blueprints. The process will allow developers to follow blueprint definitions, submit their blueprints, and have them verified through a CI workflow before being published to the official blueprint repository.

Proposal:

  1. Blueprint Definition:
  • Provide a clear definition and template for users to create their own blueprints.
  • Define all necessary fields and structures required for a valid blueprint.
  • Documentation will be provided to guide users through the process.
  1. Certification Process:
  • Implement a CI workflow that automatically verifies submitted blueprints.
  • The CI workflow will check for:
    • Valid structure and required fields.
    • Functionality and compatibility with the ML Commons plugin.
    • Ensure no breaking changes or invalid configurations.
  1. Publishing to Blueprint Repository:
  • Once a blueprint passes the CI workflow, it will be published automatically to the blueprint repository.
  • A unique blueprint ID will be generated for each successful blueprint.
  1. Connector Creation:
  • Users will be able to use the blueprint ID to easily create connectors within the ML Commons plugin.
  • This simplifies the process for leveraging external ML models or services in OpenSearch.
@ylwu-amzn ylwu-amzn added enhancement New feature or request untriaged and removed untriaged labels Oct 11, 2024
@dhrubo-os dhrubo-os moved this to Untriaged in ml-commons projects Oct 22, 2024
@dhrubo-os dhrubo-os moved this from Untriaged to On-deck in ml-commons projects Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: On-deck
Development

No branches or pull requests

2 participants