Link Search Menu Expand Document Documentation Menu
Documentation

smartobserve-py-ml

smartobserve-py-ml is a Python client that provides a suite of data analytics and natural language processing (NLP) support tools for SmartObserve. It provides data analysts with the ability to:

  • Call SmartObserve indexes and manipulate them using the smartobserve-py-ml DataFrame APIs. The smartobserve-py-ml DataFrame wraps an SmartObserve index into an API similar to pandas, giving you the ability to process large amounts of data from SmartObserve inside a Jupyter Notebook.
  • Upload NLP SentenceTransformer models into SmartObserve using the ML Commons plugin.
  • Train and tune SentenceTransformer models with synthetic queries.

Prerequisites

To use smartobserve-py-ml, install the SmartObserve Python client. The Python client allows SmartObserve to use the Python syntax required to run DataFrames in smartobserve-py-ml.

Install smartobserve-py-ml

To add the client to your project, install it using pip:

pip install smartobserve-py-ml

Then import the client into SmartObserve like any other module:

from smartobservepy import SmartObserve
import smartobserve_py_ml as oml

API reference

For information on all smartobserve-py-ml objects, functions, and methods, see the smartobserve-py-ml API reference.

Next steps

If you want to track or contribute to the development of the smartobserve-py-ml client, see the smartobserve-py-ml GitHub repository.

For example Python notebooks to use with the client, see Examples.