Skip to main content
Version: 0.91

snorkelflow.client

Interfaces to interact with the Snorkel Flow REST API.

Most of the functions in the snorkelflow.client module require a client context object — SnorkelFlowContext — that points to the Snorkel Flow instance:

import snorkelflow.client as sf
ctx = sf.SnorkelFlowContext.from_kwargs()

All the functions under submodules are also available under snorkelflow.client. Examples:

import snorkelflow.client as sf
# get_node is available under snorkelflow.client.nodes
sf.nodes.get_node(node)
# also available under snorkelflow.client (recommended)
sf.get_node(node)

Since snorkelflow.client submodules may be reorganized in the future, we recommend accessing functions directly from snorkelflow.client to minimize the risk of future breaking changes.

Submodules

snorkelflow.client.analysesAnalysis related functions
snorkelflow.client.annotationsAnnotations-related SDK functions.
snorkelflow.client.annotation_sourcesAnnotation source related functions
snorkelflow.client.applicationsApplication related functions
snorkelflow.client.batches(Annotation) batch related functions
snorkelflow.client.blocksBlock related functions
snorkelflow.client.commentsComment related functions.
snorkelflow.client.ctxContext related classes
snorkelflow.client.custom_pipCustom pip install related functions
snorkelflow.client.datasetsDataset related functions
snorkelflow.client.datasourcesDatasource related functions
snorkelflow.client.exportsExport related functions
snorkelflow.client.file_storage_configsFile storage config related functions
snorkelflow.client.fm_suiteWarm Start related functions.
snorkelflow.client.gtsGround truth related functions.
snorkelflow.client.lf_packagesLF package related functions
snorkelflow.client.lf_templatesLF template related functions
snorkelflow.client.lfsLF related functions
snorkelflow.client.metricsMetric related functions
snorkelflow.client.modelsModel related functions
snorkelflow.client.monitoringMonitoring related functions
snorkelflow.client.nodesNode related functions
snorkelflow.client.object_storageMinio related functions
snorkelflow.client.operatorsOperator related functions
snorkelflow.client.secretsSecret store related functions
snorkelflow.client.studioStudio related functions
snorkelflow.client.tagsTag-related functions.
snorkelflow.client.training_setsTraining set related functions
snorkelflow.client.transferSDK functions for transferring assets between applications or nodes on a single Snorkel Flow instance.
snorkelflow.client.utilsUtility functions
snorkelflow.client.usersUser related functions
snorkelflow.client.workflowsWorkflow related functions