waylay-beta 0.7.1

beta release of the Waylay Python SDK

waylay-beta

This Python SDK helps you to connect with the REST APIs of the Waylay Platform.

It provides a selection of services and utilities, focused on supporting our data science users:

• importing and querying timeseries data.
• uploading your own machine learning models for usage in the Waylay Rule Engine
• provisioning waylay resources and resource types.

The SDK is optimised for interactive usage in Jupyter Notebooks.

Prerequisites

This package requires a python runtime 3.7 or higher (validated up to 3.11). For datascience purposes you typically want to prepare an anaconda environment:

conda create --name my_waylay_env python=3.8
conda activate my_waylay_env
conda install jupyter
pip install waylay-beta
jupyter notebook 

Installation

pip install waylay-beta

BYOML dependencies

If you want to prepare BYOML models (Enterprise), extra dependency configurations are available, that will check or install framework-specific dependencies.

Either for a specific runtime:

byoml-xgboost-1.0, byoml-sklearn-0.24, byoml-tensorflow-2.4, byoml-custom-1.0, byoml-xgboost-1.3, byoml-pytorch-1.8, byoml-sklearn-0.22, byoml-pytorch-1.4, byoml-tensorflow-2.1, byoml-pytorch-1.5

or for the default runtime of one of the supported frameworks:

byoml-tensorflow, byoml-custom, byoml-sklearn, byoml-pytorch, byoml-xgboost

E.g. to install with sklearn dependencies for byoml:

pip install waylay-beta['byoml-sklearn-0.24']

or

pip install waylay-beta['byoml-sklearn']

In some cases (e.g. older framework versions) it might be needed to use the same python version when serializing models. Check the supported python version with calls such as:

> waylay_client.byoml.runtimes.get('byoml-pytorch-1.8')
{'framework': 'pytorch', 'framework_version': '1.8', 'name': 'byoml-pytorch-1.8', 'python_version': '3.7'}

Quickstart

• Login to the waylay console, and get hold of an API key, API secret pair [>Settings>Authentication keys]

  [Enterprise] https://console.waylay.io

• Create an SDK client

  from waylay import WaylayConfig, WaylayClient
  waylay_client = WaylayClient.from_profile()
  

  On first usage, this will prompt for a gateway endpoint,

  [Enterprise] api.waylay.io (default)

  and your API key/API secret credentials.

For more details see

[Enterprise] https://docs.waylay.io

Usage Examples

See demo notebooks for the usage examples supported in the current release.