The Superwise Knowledge Hub

Welcome to the Superwise knowledge hub. You'll find comprehensive guides and documentation to help you start working with Superwise as quickly as possible, as well as support if you get stuck or understand how to use the product better. Let's jump right in!

Get Started    

Python SDK Guide

This guide will provide a walkthrough on how to install and use Superwise.ai SDK

Overview:

Superwise's SDK is a standard Python package created as an easy-to-use integration tool to connect Superwise with customers' needs.
Use the package to integrate with Superwise and stream data to the Superwise platform

Installation:

    pip install superwise

The PyPI package homepage is: superwise-sdk

Environment variables

There are 3 environment variables used to identify and authenticate your connection:

  1. SUPERWISE_CLIENT_ID
  2. SUPERWISE_SECRET
  3. SUPERWISE_CLIENT_NAME

Coming soon - You will be able to generate these variables through the UI, but for now, ask Superwise team to provide it for you. Just email us at [email protected]

Package structure:

Superwise object - simply create an instance of a Superwise object in order to interact with Superwise APIs.

from superwise import Superwise

sw = Superwise()

All APIs are now accessible under the sw intance.
For example, all task APIs (create, get, etc.) can be found under the sw.task object.
Each object uses a Superwise model, which is an internal SDK representation of a given piece of data.

from superwise.models.task import Task
from superwise.resources.superwise_enums import TaskTypes

task = Task(
    title='fraud-detection',
    task_description='Decide whether to approve or reject a given transaction to avoid frauds',
    task_type=TaskTypes.BINARY_ESTIMATION
)

task = sw.task.create(task)

TaskModel has properties such as id, title, etc.
You can use the get_properties() method to get a dictionary of all properties.

print(task.get_properties())

An in-depth, full SDK reference will be added soon.

Updated 16 days ago

Python SDK Guide


This guide will provide a walkthrough on how to install and use Superwise.ai SDK

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.