Opensearch-py-ml: DataFrames and Machine Learning backed by Opensearch

Date: Aug 12, 2024 Version: 1.1.0

Useful links: Source Repository | Issues & Ideas

Opensearch-py-ml is a Python Opensearch client for exploring and analyzing data in Opensearch with a familiar Pandas-compatible API.

Where possible the package uses existing Python APIs and data structures to make it easy to switch between numpy, pandas, scikit-learn to their Opensearch powered equivalents. In general, the data resides in Opensearch and not in memory, which allows Opensearch-py-ml to access large datasets stored in Opensearch.

Installing Opensearch-py-ml

Opensearch-py-ml can be installed from PyPI via pip:

$ python -m pip install opensearch-py-ml

Getting Started

If it’s your first time using Opensearch we recommend looking through the Examples documentation for ideas on what Opensearch-py-ml is capable of.

If you’re new to Opensearch we recommend reading the documentation.

• API Reference

  • DataFrame

  • Series

  • General Utility Functions

  • Input/Output

  • MLCommons Support

  • Sentence Transformer

• Examples

  • Demo Notebook for Dataframe

  • Demo Notebook for Online Retail Analysis

  • Demo Notebook for Sentence Transformer Model Training, Saving and Uploading to OpenSearch

• License

• Contributing

• Code of Conduct