# migration

Python API: `luxonis_ml.data.datasets.migration`

## Classes

| Name | Description |
| --- | --- |
|
[`LDF_1_0_0_MetadataDict`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/datasets/migration.md)
| Metadata dictionary used by LDF `1.0.0`. |

### class `LDF_1_0_0_MetadataDict`

```python
class LDF_1_0_0_MetadataDict(TypedDict)
```

Metadata dictionary used by LDF `1.0.0`.

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `categorical_encodings` | `dict[str, dict[str, int]]` | Categorical metadata encodings. |
| `classes` | `dict[str, list[str]]` | Class names keyed by old task names. |
| `ldf_version` | `str` | LDF version string. |
| `metadata_types` | `dict[str, Literal['float', 'int', 'str', 'Category']]` | Metadata value types. |
| `skeletons` | `dict[str, Skeletons]` | Keypoint skeletons keyed by task name. |
| `source` | `dict[str, Any]` | Source metadata dictionary. |
| `tasks` | `dict[str, list[str]]` | Task types keyed by old task names. |

## Functions

| Name | Description |
| --- | --- |
|
[`migrate_dataframe`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/datasets/migration.md)
| |
|
[`migrate_metadata`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/datasets/migration.md)
| Migrate LDF `1.0.0` metadata to the current schema. |

### function `migrate_dataframe`

```python
def migrate_dataframe(df: pl.LazyFrame | pl.DataFrame) -> pl.LazyFrame | pl.DataFrame
```

### function `migrate_metadata`

```python
def migrate_metadata(
    metadata: LDF_1_0_0_MetadataDict,
    df: pl.LazyFrame | None,
) -> Metadata
```

Migrate LDF `1.0.0` metadata to the current schema.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `metadata` | `LDF_1_0_0_MetadataDict` | Metadata dictionary in the LDF `1.0.0` layout. | required |
| `df` | `pl.LazyFrame | None` | Optional annotation dataframe used to infer task names for non-default datasets. | required |

Returns

| Type | Description |
| --- | --- |
| `Metadata` | Migrated metadata model. |

Raises

| Type | Description |
| --- | --- |
| `ValueError` | If task inference requires annotation rows but `df` is `None`. |

## Module Attributes

| Name | Type | Description |
| --- | --- | --- |
|
[`LDF_1_0_0_TASK_TYPES`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/datasets/migration.md)
| `dict[str, str]` | |
|
[`LDF_1_0_0_TASKS`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/datasets/migration.md)
| `set[str]` | |

### constant `LDF_1_0_0_TASK_TYPES`

```python
LDF_1_0_0_TASK_TYPES: dict[str, str] = {
    'BBoxAnnotation': 'boundingbox',
    'ClassificationAnnotation': 'classification',
    'PolylineSegmentationAnnotation': 'segmentation',
    'RLESegmentationAnnotation': 'segmentation',
    'MaskSegmentationAnnotation': 'segmentation',
    'KeypointAnnotation': 'keypoints',
    'ArrayAnnotation': 'array',
}
```

### constant `LDF_1_0_0_TASKS`

```python
LDF_1_0_0_TASKS: set[str] = {
    'classification',
    'segmentation',
    'boundingbox',
    'keypoints',
    'array',
}
```
