snorkelai.sdk.client.ctx.SnorkelSDKContext

class snorkelai.sdk.client.ctx.SnorkelSDKContext(tdm_client, storage_client=None, workspace_name=None, set_global=True, debug=False)

Bases: object

The SnorkelSDKContext object provides client context for the Snorkel Flow SDK. It allows the Snorkel Flow SDK to recognize a Snorkel Flow instance by identifying Snorkel Flow’s essential API services (TDM & Storage API) via user-provided parameters, a YAML config file, or a Snorkel Flow API key.

Examples

import snorkelai.sdk.client as sai
ctx = sai.SnorkelSDKContext.from_endpoint_url(...)

\_\_init\_\_

__init__

__init__(tdm_client, storage_client=None, workspace_name=None, set_global=True, debug=False)

Initialize a SnorkelSDKContext.

Methods

__init__(tdm_client[, storage_client, ...])	Initialize a SnorkelSDKContext.
from_endpoint_url([endpoint, api_key, ...])	Initialize a SnorkelSDKContext from keyword arguments.
get_global()	Retrieve the global SnorkelSDKContext object.
set_debug(debug)	Set the verbosity of warnings, details, and stacktraces
set_global([ctx])	Set a SnorkelSDKContext object globally.

Attributes

storage_client
workspace_name	SnorkelSDKContext objects are only scoped to work in a particular workspace.

from\_endpoint\_url

from_endpoint_url

classmethod from_endpoint_url(endpoint=None, api_key=None, workspace_name=None, set_global=True, debug=False, *args, **kwargs)

Initialize a SnorkelSDKContext from keyword arguments.

Examples

# Instantiate with default kwargs and a custom url
import snorkelai.sdk.client as sai
ctx = sai.SnorkelSDKContext.from_endpoint_url("https://edge.k8s.g498.io/")

# Instantiate with custom kwargs
import snorkelai.sdk.client as sai
ctx = sai.SnorkelSDKContext.from_endpoint_url(
    endpoint="https://edge.k8s.g498.io/",
    workspace_name="my-workspace",
)

# Instantiate with an API key
import snorkelai.sdk.client as sai
ctx = sai.SnorkelSDKContext.from_endpoint_url(
    endpoint="https://edge.k8s.g498.io/",
    api_key="my-api-key",
)

Parameters

Parameters

Name	Type	Default	Info
endpoint	Optional[str]	None	The baseurl to a snorkelflow instance.
workspace_name	Optional[str]	None	The workspace name, which determines the workspace a dataset and application will be created in and queried from.
api_key	Optional[str]	None	The API key to use for the TDM and Storage API.
set_global	bool	True	Whether to set the context as the global context, accessible across all notebooks.
debug	bool	False	Whether to enable debug mode. Debug mode will print more verbose errors to the screen inside of the Python notebook.

Returns

Returns

A SnorkelSDKContext object that can be used to interact with the TDM and Storage API clients directly.

Return type

Return type

SnorkelSDKContext

get\_global

get_global

classmethod get_global()

Retrieve the global SnorkelSDKContext object.

Examples

import snorkelai.sdk.client as sai
ctx = sai.SnorkelSDKContext.get_global()

Returns

Returns

A SnorkelSDKContext object that can be used to interact with the TDM and Storage API clients directly.

Return type

Return type

SnorkelSDKContext

Raises

Raises

AttributeError – If no global context has been set.

set\_debug

set_debug

set_debug(debug)

Set the verbosity of warnings, details, and stacktraces

Parameters

Parameters

Name	Type	Default	Info
debug	bool		If True, SDK operations will print more verbose errors to the screen inside of the Python notebook.

Return type

Return type

None

set\_global

set_global

classmethod set_global(ctx=None)

Set a SnorkelSDKContext object globally. This context object will be used by all Snorkel Platform SDK functions.

Examples

import snorkelai.sdk.client as sai
ctx = sai.SnorkelSDKContext.from_endpoint_url(...)
sai.SnorkelSDKContext.set_global(ctx)

Parameters

Parameters

Name	Type	Default	Info
ctx	Optional[SnorkelSDKContext]	None	A context to set as global. If no context is provided, will attempt to create one with default parameters.

Return type

Return type

None

property storage_client: StorageClient

property workspace_name: str

SnorkelSDKContext objects are only scoped to work in a particular workspace.

Returns

Returns

The name of the workspace belonging to this context object.

Return type

Return type

str