Module `openpack_toolkit.configs`

Expand source code

from . import datasets, releases, users
from ._schema import (
    AnnotConfig,
    DatasetConfig,
    DataStreamConfig,
    Label,
    Metadata,
    OpenPackConfig,
    ReleaseConfig,
    SessionConfig,
    UserConfig,
)

__all__ = [
    "datasets", "users", "releases",
    # Schema
    "AnnotConfig", "DatasetConfig", "DataStreamConfig",
    "Label", "Metadata",
    "OpenPackConfig",
    "ReleaseConfig", "SessionConfig", "UserConfig",
]

Sub-modules

openpack_toolkit.configs.datasets
openpack_toolkit.configs.releases
openpack_toolkit.configs.users

Classes

class AnnotConfig (kind: str = '???', name: str = '???', metadata: openpack_toolkit.configs._schema.Metadata = '???', path: openpack_toolkit.configs._schema.DataLocation = '???', classes: List[openpack_toolkit.configs._schema.Label] = '???')

AnnotConfig(kind: str = '???', name: str = '???', metadata: openpack_toolkit.configs._schema.Metadata = '???', path: openpack_toolkit.configs._schema.DataLocation = '???', classes: List[openpack_toolkit.configs._schema.Label] = '???')

Expand source code

@dataclass
class AnnotConfig(BaseConfig):
    path: DataLocation = MISSING
    classes: List[Label] = MISSING

Ancestors

openpack_toolkit.configs._schema.BaseConfig

Class variables

var classes : List[openpack_toolkit.configs._schema.Label]
var path : openpack_toolkit.configs._schema.DataLocation

class DataStreamConfig (kind: str = '???', name: str = '???', metadata: openpack_toolkit.configs._schema.Metadata = '???', path: openpack_toolkit.configs._schema.DataLocation = '???', frameRate: int = '???', devices: Optional[List[str]] = None, acc: Optional[bool] = None, gyro: Optional[bool] = None, quat: Optional[bool] = None, nodes: Optional[Dict[int, str]] = '???')

DataStreamConfig(kind: str = '???', name: str = '???', metadata: openpack_toolkit.configs._schema.Metadata = '???', path: openpack_toolkit.configs._schema.DataLocation = '???', frameRate: int = '???', devices: Optional[List[str]] = None, acc: Optional[bool] = None, gyro: Optional[bool] = None, quat: Optional[bool] = None, nodes: Optional[Dict[int, str]] = '???')

Expand source code

@dataclass
class DataStreamConfig(BaseConfig):
    path: DataLocation = MISSING
    frameRate: int = MISSING  # [Hz, fps]

    # for IMU/E4
    devices: Optional[List[str]] = None
    acc: Optional[bool] = None
    gyro: Optional[bool] = None
    quat: Optional[bool] = None

    # for keypoints
    nodes: Optional[Dict[int, str]] = MISSING

Ancestors

openpack_toolkit.configs._schema.BaseConfig

Class variables

var acc : Optional[bool]
var devices : Optional[List[str]]
var frameRate : int
var gyro : Optional[bool]
var nodes : Optional[Dict[int, str]]
var path : openpack_toolkit.configs._schema.DataLocation
var quat : Optional[bool]

class DatasetConfig (name: str = '???', streams: Optional[Dict[str, openpack_toolkit.configs._schema.DataStreamConfig]] = None, stream: Optional[openpack_toolkit.configs._schema.DataStreamConfig] = None, split: openpack_toolkit.configs._schema.DataSplitConfig = '???', annotation: openpack_toolkit.configs._schema.AnnotConfig = '???', classes: Optional[List[openpack_toolkit.configs._schema.Label]] = '???')

DatasetConfig(name: str = '???', streams: Optional[Dict[str, openpack_toolkit.configs._schema.DataStreamConfig]] = None, stream: Optional[openpack_toolkit.configs._schema.DataStreamConfig] = None, split: openpack_toolkit.configs._schema.DataSplitConfig = '???', annotation: openpack_toolkit.configs._schema.AnnotConfig = '???', classes: Optional[List[openpack_toolkit.configs._schema.Label]] = '???')

Expand source code

@dataclass
class DatasetConfig:
    name: str = MISSING
    streams: Optional[Dict[str, DataStreamConfig]] = None
    stream: Optional[DataStreamConfig] = None
    split: DataSplitConfig = MISSING
    annotation: AnnotConfig = MISSING
    classes: Optional[List[Label]] = MISSING

Class variables

var annotation : openpack_toolkit.configs._schema.AnnotConfig
var classes : Optional[List[openpack_toolkit.configs._schema.Label]]
var name : str
var split : openpack_toolkit.configs._schema.DataSplitConfig
var stream : Optional[openpack_toolkit.configs._schema.DataStreamConfig]
var streams : Optional[Dict[str, openpack_toolkit.configs._schema.DataStreamConfig]]

class Label (id: Union[int, str] = '???', name: str = '???', version: str = '???', is_ignore: bool = False, category: Optional[str] = None, event: Optional[str] = None)

dataclass that represent a single activity class.

Expand source code

@dataclass
class Label():
    """dataclass that represent a single activity class.
    """
    id: Union[int, str] = MISSING
    name: str = MISSING
    version: str = MISSING
    is_ignore: bool = False
    category: Optional[str] = None
    event: Optional[str] = None

Class variables

var category : Optional[str]
var event : Optional[str]
var id : Union[int, str]
var is_ignore : bool
var name : str
var version : str

class Metadata (labels: Optional[Dict[str, str]] = None)

Metadata(labels: Optional[Dict[str, str]] = None)

Expand source code

@dataclass
class Metadata:
    labels: Optional[Dict[str, str]] = None

Class variables

var labels : Optional[Dict[str, str]]

class OpenPackConfig (path: Optional[Dict] = None, dataset: openpack_toolkit.configs._schema.DatasetConfig = '???', release: Optional[openpack_toolkit.configs._schema.ReleaseConfig] = None)

OpenPackConfig(path: Optional[Dict] = None, dataset: openpack_toolkit.configs._schema.DatasetConfig = '???', release: Optional[openpack_toolkit.configs._schema.ReleaseConfig] = None)

Expand source code

@dataclass
class OpenPackConfig:
    path: Optional[Dict] = None
    dataset: DatasetConfig = MISSING
    release: Optional[ReleaseConfig] = None

Class variables

var dataset : openpack_toolkit.configs._schema.DatasetConfig
var path : Optional[Dict]
var release : Optional[openpack_toolkit.configs._schema.ReleaseConfig]

class ReleaseConfig (kind: str = '???', name: str = '???', metadata: openpack_toolkit.configs._schema.Metadata = '???', users: Dict[str, openpack_toolkit.configs._schema.ReleaseConfig._User] = '???', streams: Dict[str, List[str]] = '???')

ReleaseConfig(kind: str = '???', name: str = '???', metadata: openpack_toolkit.configs._schema.Metadata = '???', users: Dict[str, openpack_toolkit.configs._schema.ReleaseConfig._User] = '???', streams: Dict[str, List[str]] = '???')

Expand source code

@dataclass
class ReleaseConfig(BaseConfig):
    @dataclass
    class _User:
        sessions: List[str] = MISSING
        exclude: Optional[List[str]] = MISSING

    users: Dict[str, _User] = MISSING
    streams: Dict[str, List[str]] = MISSING

Ancestors

openpack_toolkit.configs._schema.BaseConfig

Class variables

var streams : Dict[str, List[str]]
var users : Dict[str, openpack_toolkit.configs._schema.ReleaseConfig._User]

class SessionConfig (duration: str = '???', end: str = '???', start: str = '???')

Attributes

start : str: Timestamp of session start time (IOS format)
end : str: Timestamp of session end time (IOS format)
duration : str: length of session, i.e., end - start

Expand source code

@dataclass
class SessionConfig:
    """
    Attributes:
        start (str): Timestamp of session start time (IOS format)
        end (str): Timestamp of session end time (IOS format)
        duration (str): length of session, i.e., end - start
    """
    duration: str = MISSING
    end: str = MISSING
    start: str = MISSING

Class variables

var duration : str
var end : str
var start : str

class UserConfig (id: int = '???', name: str = '???', sessions: Dict[str, openpack_toolkit.configs._schema.SessionConfig] = '???')

UserConfig(id: int = '???', name: str = '???', sessions: Dict[str, openpack_toolkit.configs._schema.SessionConfig] = '???')

Expand source code

@dataclass
class UserConfig:
    id: int = MISSING
    name: str = MISSING
    sessions: Dict[str, SessionConfig] = MISSING  # DictConfig

Class variables

var id : int
var name : str
var sessions : Dict[str, openpack_toolkit.configs._schema.SessionConfig]