Skip to main content
Version: 0.93

snorkelflow.sdk.Slice

class snorkelflow.sdk.Slice(dataset, slice_uid, name, description=None)

Bases: object

__init__​

__init__(dataset, slice_uid, name, description=None)

Create a Slice object in-memory with necessary properties. This constructor should not be called directly, and should instead be accessed through the create() and get() methods

Parameters​

NameTypeDefaultInfo
datasetUnion[str, int]The UID or name for the dataset within Snorkel Flow.
slice_uidintThe UID for the slice within Snorkel Flow.
namestrThe name of the slice.
descriptionOptional[str]NoneThe description of the slice.

Methods

__init__(dataset, slice_uid, name[, description])Create a Slice object in-memory with necessary properties.
add_x_uids(x_uids)Add datapoints to a slice.
create(dataset, name[, description])Create a slice for a dataset.
get(dataset, slice)Retrieve a slice by UID.
get_x_uids()Retrieve the UIDs of the datapoints in the slice.
list(dataset)Retrieve all slices for a dataset.
remove_x_uids(x_uids)Remove datapoints from a slice.

Attributes

dataset_uidReturn the UID of the dataset that the slice belongs to
descriptionReturn the description of the slice
nameReturn the name of the slice
slice_uidReturn the UID of the slice

add_x_uids​

add_x_uids(x_uids)

Add datapoints to a slice.

Parameters​

NameTypeDefaultInfo
x_uidsList[str]List of UIDs of the datapoints you want to add to the slice.

Return type​

None

create​

classmethod create(dataset, name, description='')

Create a slice for a dataset.

Parameters​

NameTypeDefaultInfo
datasetUnion[str, int]The UID or name for the dataset within Snorkel Flow.
namestrThe name of the slice.
descriptionstr''A description of the label schema, by default the empty string.

Returns​

The slice object

Return type​

Slice

get​

classmethod get(dataset, slice)

Retrieve a slice by UID.

Parameters​

NameTypeDefaultInfo
datasetUnion[str, int]The UID or name for the dataset within Snorkel Flow.
sliceUnion[str, int]The UID or name of the slice.

Returns​

The slice object

Return type​

Slice

Raises​

ValueError – If no slice is found with the given UID

get_x_uids​

get_x_uids()

Retrieve the UIDs of the datapoints in the slice.

Returns​

List of UIDs of the datapoints in the slice

Return type​

List[str]

list​

classmethod list(dataset)

Retrieve all slices for a dataset.

Parameters​

NameTypeDefaultInfo
datasetUnion[str, int]The UID or name for the dataset within Snorkel Flow.

Returns​

A list of all the slices available for that dataset

Return type​

List[Slice]

Raises​

ValueError – If no dataset is found with the given id

remove_x_uids​

remove_x_uids(x_uids)

Remove datapoints from a slice.

Parameters​

NameTypeDefaultInfo
x_uidsList[str]List of UIDs of the datapoints you want to remove from the slice.

Return type​

None

property dataset_uid: int

Return the UID of the dataset that the slice belongs to

property description: str | None

Return the description of the slice

property name: str

Return the name of the slice

property slice_uid: int

Return the UID of the slice