sdk_schemas.md

Summary

• DataSampleSpec
• DatasetSpec
• ObjectiveSpec
• TesttupleSpec
• TraintupleSpec
• AggregatetupleSpec
• CompositeTraintupleSpec
• CompositeAlgoSpec
• AggregateAlgoSpec
• ComputePlanSpec
• UpdateComputePlanSpec
• ComputePlanTesttupleSpec
• ComputePlanAggregatetupleSpec
• ComputePlanCompositeTraintupleSpec
• ComputePlanTraintupleSpec
• Permissions
• PrivatePermissions

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

- name: str
- data_opener: Path
- type: str
- description: Path
- permissions: Permissions
- objective_key: Optional[str]
- metadata: Optional[Mapping[str, str]]

ObjectiveSpec

Specification for creating an objective

- name: str
- description: Path
- metrics_name: str
- metrics: Path
- test_data_sample_keys: Optional[List[str]]
- test_data_manager_key: Optional[str]
- permissions: Permissions
- metadata: Optional[Mapping[str, str]]

TesttupleSpec

Specification for creating a testtuple

- objective_key: str
- traintuple_key: str
- tag: Optional[str]
- data_manager_key: Optional[str]
- test_data_sample_keys: Optional[List[str]]
- metadata: Optional[Mapping[str, str]]

TraintupleSpec

Specification for creating a traintuple

- algo_key: str
- data_manager_key: str
- train_data_sample_keys: List[str]
- in_models_keys: Optional[List[str]]
- tag: Optional[str]
- compute_plan_key: Optional[str]
- rank: Optional[int]
- metadata: Optional[Mapping[str, str]]

AggregatetupleSpec

Specification for creating an aggregate tuple

- algo_key: str
- worker: str
- in_models_keys: List[str]
- tag: Optional[str]
- compute_plan_key: Optional[str]
- rank: Optional[int]
- metadata: Optional[Mapping[str, str]]

CompositeTraintupleSpec

Specification for creating a composite traintuple

- algo_key: str
- data_manager_key: str
- train_data_sample_keys: List[str]
- in_head_model_key: Optional[str]
- in_trunk_model_key: Optional[str]
- tag: Optional[str]
- compute_plan_key: Optional[str]
- out_trunk_model_permissions: PrivatePermissions
- rank: Optional[int]
- metadata: Optional[Mapping[str, str]]

CompositeAlgoSpec

Specification for creating a composite algo

- name: str
- description: Path
- file: Path
- permissions: Permissions
- metadata: Optional[Mapping[str, str]]

AggregateAlgoSpec

Specification for creating an aggregate algo

- name: str
- description: Path
- file: Path
- permissions: Permissions
- metadata: Optional[Mapping[str, str]]

ComputePlanSpec

Specification for creating a compute plan

- traintuples: Optional[List[ComputePlanTraintupleSpec]]
- composite_traintuples: Optional[List[ComputePlanCompositeTraintupleSpec]]
- aggregatetuples: Optional[List[ComputePlanAggregatetupleSpec]]
- testtuples: Optional[List[ComputePlanTesttupleSpec]]
- tag: Optional[str]
- clean_models: Optional[bool]
- metadata: Optional[Mapping[str, str]]

UpdateComputePlanSpec

Specification for updating a compute plan

- traintuples: Optional[List[ComputePlanTraintupleSpec]]
- composite_traintuples: Optional[List[ComputePlanCompositeTraintupleSpec]]
- aggregatetuples: Optional[List[ComputePlanAggregatetupleSpec]]
- testtuples: Optional[List[ComputePlanTesttupleSpec]]

ComputePlanTesttupleSpec

Specification of a testtuple inside a compute plan specification

- objective_key: str
- traintuple_id: str
- tag: Optional[str]
- data_manager_key: Optional[str]
- test_data_sample_keys: Optional[List[str]]
- metadata: Optional[Mapping[str, str]]

ComputePlanAggregatetupleSpec

Specification of an aggregate tuple inside a compute plan specification

- aggregatetuple_id: str
- algo_key: str
- worker: str
- in_models_ids: Optional[List[str]]
- tag: Optional[str]
- metadata: Optional[Mapping[str, str]]

ComputePlanCompositeTraintupleSpec

Specification of a composite traintuple inside a compute plan specification

- composite_traintuple_id: str
- algo_key: str
- data_manager_key: str
- train_data_sample_keys: List[str]
- in_head_model_id: Optional[str]
- in_trunk_model_id: Optional[str]
- tag: Optional[str]
- out_trunk_model_permissions: Permissions
- metadata: Optional[Mapping[str, str]]

ComputePlanTraintupleSpec

Specification of a traintuple inside a compute plan specification

- algo_key: str
- data_manager_key: str
- train_data_sample_keys: List[str]
- traintuple_id: str
- in_models_ids: Optional[List[str]]
- tag: Optional[str]
- metadata: Optional[Mapping[str, str]]

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 nodes whose ids are in authorized_ids can access the asset.

- authorized_ids: List[str]