beta release of the Waylay Python SDK
Project description
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.10
).
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|IO), extra dependency configurations are available, that will check or install framework-specific dependencies.
Either for a specific runtime:
byoml-xgboost-1.3, byoml-sklearn-0.24, byoml-xgboost-1.0, byoml-pytorch-1.4, byoml-custom-1.0, byoml-tensorflow-2.1, byoml-pytorch-1.5, byoml-pytorch-1.8, byoml-sklearn-0.22, byoml-tensorflow-2.4
or for the default runtime of one of the supported frameworks:
byoml-sklearn, byoml-tensorflow, byoml-custom, 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
[IO]
https:://console-io.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)
[IO]
api-io.waylay.ioand your API key/API secret credentials.
For more details see
[Enterprise]
https://docs.waylay.io
[IO]
https://docs-io.waylay.io
Usage Examples
See demo notebooks for the usage examples supported in the current release.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for waylay_beta-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c14b166b8a848b3568a0f20da79b0a218b523559d51e5b237ce0e20013c81515 |
|
MD5 | cac392ac9a6ca9308d302eff63165f39 |
|
BLAKE2b-256 | 979ac41d9c3674b4c169904fde854708a73bb02e55115549668b39c97f9b8024 |