Summary¶
Schemas¶
DataSampleSpec¶
Specification to create one or many data samples To create one data sample, use the ‘path’ field, otherwise use the ‘paths’ field.
- path: Optional[Path]
- paths: Optional[List[Path]]
- test_only: bool
- data_manager_keys: List[str]
DatasetSpec¶
Specification for creating a dataset
note : metadata field does not accept strings containing ‘__’ as dict key
- name: str
- data_opener: Path
- type: str
- description: Path
- permissions: Permissions
- metadata: Optional[Mapping[str, str]]
- logs_permission: Permissions
AlgoSpec¶
Specification for creating an algo
note : metadata field does not accept strings containing ‘__’ as dict key
- name: str
- description: Path
- file: Path
- permissions: Permissions
- metadata: Optional[Mapping[str, str]]
- inputs: Optional[List[AlgoInputSpec]]
- outputs: Optional[List[AlgoOutputSpec]]
AlgoInputSpec¶
Asset creation specification base class.
- identifier: str
- multiple: bool
- optional: bool
- kind: AssetKind
AlgoOutputSpec¶
Asset creation specification base class.
- identifier: str
- kind: AssetKind
- multiple: bool
TaskSpec¶
Asset creation specification base class.
- key: str
- tag: Optional[str]
- compute_plan_key: Optional[str]
- metadata: Optional[Mapping[str, str]]
- algo_key: str
- worker: str
- rank: Optional[int]
- inputs: Optional[List[InputRef]]
- outputs: Optional[Mapping[str, ComputeTaskOutputSpec]]
ComputePlanSpec¶
Specification for creating a compute plan
note : metadata field does not accept strings containing ‘__’ as dict key
- key: str
- tasks: Optional[List[ComputePlanTaskSpec]]
- tag: Optional[str]
- name: str
- metadata: Optional[Mapping[str, str]]
UpdateComputePlanTuplesSpec¶
Specification for updating a compute plan’s tuples
- key: str
- tasks: Optional[List[ComputePlanTaskSpec]]
ComputePlanTaskSpec¶
Specification of a compute task inside a compute plan specification
note : metadata field does not accept strings containing ‘__’ as dict key
- task_id: str
- algo_key: str
- worker: str
- tag: Optional[str]
- metadata: Optional[Mapping[str, str]]
- inputs: Optional[List[InputRef]]
- outputs: Optional[Mapping[str, ComputeTaskOutputSpec]]
Permissions¶
Specification for permissions. If public is False, give the list of authorized ids.
- public: bool
- authorized_ids: List[str]
PrivatePermissions¶
Specification for private permissions. Only the organizations whose ids are in authorized_ids can access the asset.
- authorized_ids: List[str]