openfl.interface.interactive_api.shard_descriptor.ShardDescriptor

class openfl.interface.interactive_api.shard_descriptor.ShardDescriptor

Bases: object

Shard descriptor class.

Methods

get_dataset

Return a shard dataset by type.

Attributes

dataset_description	Return the dataset description.
sample_shape	Return the sample shape info.
target_shape	Return the target shape info.

property dataset_description: str

Return the dataset description.

Returns:

str – The dataset description.

get_dataset(dataset_type: str) → ShardDataset

Return a shard dataset by type.

Parameters:

dataset_type (str) – The type of the dataset.

Returns:

ShardDataset – The shard dataset.

property sample_shape: List[int]

Return the sample shape info.

Returns:

List[int] – The sample shape.

property target_shape: List[int]

Return the target shape info.

Returns:

List[int] – The target shape.