Skip to content

[PROPOSAL] Merge ML APIs to opensearch-py #867

Open
@nathaliellenaa

Description

What are you proposing?

In regard to this proposal, we want to merge ML APIs from opensearch-py-ml to opensearch-py.

What problems are you trying to solve?

Currently, users need to install and manage two different packages when they want to use ML functionalities. By merging ML APIs to opensearch-py, users who want to use ML functionalities would only need to install and manage a single package, reducing their effort and confusion.

What is the developer experience going to be?

The coordination of updates and releases for ML features will be easier. With ML APIs integrated into opensearch-py, the codebase management will be simplified. There is also opportunity to refactor and optimize ML APIs during the merger process.

What is the user experience going to be?

Users only require a single package installation for both core OpenSearch operations and ML functionalities. It will simplify dependency management in their projects.

Are there breaking changes to the User Experience?

This change should not introduce breaking changes to the existing user experience. Users who currently use opensearch-py-ml for ML APIs might need to update their import statements, but the functionality and method signatures should remain the same.

What will it take to execute?

  • Move ML API code from opensearch-py-ml to opensearch-py, ensuring proper integration and maintaining existing functionality.
  • Develop and run comprehensive tests to ensure all ML APIs work correctly in the new environment and don't interfere with existing opensearch-py features.
  • Update all relevant documentation, including API references, user guides, and migration guides for existing opensearch-py-ml users.
  • Determine appropriate versioning strategy for the updated opensearch-py package.

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions