# ldf_equivalence

Python API: `luxonis_ml.data.utils.ldf_equivalence`

## Classes

| Name | Description |
| --- | --- |
|
[`LDFEquivalence`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| Helpers for comparing datasets in Luxonis Data Format. |

### class `LDFEquivalence`

```python
class LDFEquivalence
```

Helpers for comparing datasets in Luxonis Data Format.

Methods

| Name | Description |
| --- | --- |
|
[`assert_equivalence`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| Assert that two prepared datasets are equivalent. |
|
[`collect_annotation_multiset`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| |
|
[`collect_bbox_multiset`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| |
|
[`collect_classification_multiset`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| |
|
[`collect_image_multiset`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| |
|
[`collect_instance_segmentation_mask_overlap_multiset`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| |
|
[`collect_instance_segmentation_multiset`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| |
|
[`collect_keypoint_multiset`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| |
|
[`collect_segmentation_mask_overlap_multiset`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| |
|
[`collect_segmentation_multiset`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| |
|
[`equivalent`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| Alias for
[ldf_equivalent](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md).
|
|
[`file_sha256`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| Return the SHA-256 hash for an image file. |
|
[`ldf_equivalent`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| Return whether two datasets are equivalent. |
|
[`multiset_equal_with_tolerance`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| |

#### class method `assert_equivalence`

```python
def assert_equivalence(previous: Any, new: Any, collector: LDFCollector | None = None)
```

Assert that two prepared datasets are equivalent.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `previous` | `Any` |
[PreparedLDF](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/exporters/exporter_utils.md)
or
[LuxonisDataset](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/datasets/luxonis_dataset.md)
reference dataset. | required |
| `new` | `Any` |
[PreparedLDF](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/exporters/exporter_utils.md)
or
[LuxonisDataset](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/datasets/luxonis_dataset.md)
dataset to compare. | required |
| `collector` | `LDFCollector | None` | Optional custom collector used for comparison. | `None` |

Raises

| Type | Description |
| --- | --- |
| `TypeError` | If `previous` or `new` is neither
[PreparedLDF](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/exporters/exporter_utils.md)
nor
[LuxonisDataset](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/datasets/luxonis_dataset.md).
|
| `AssertionError` | If the collected representations differ. |

#### class method `collect_annotation_multiset`

```python
def collect_annotation_multiset(
    prepared_ldf: PreparedLDF,
    task_type: str,
) -> dict[tuple[str], Counter]
```

#### class method `collect_bbox_multiset`

```python
def collect_bbox_multiset(prepared_ldf: PreparedLDF) -> dict[tuple[str], Counter]
```

#### class method `collect_classification_multiset`

```python
def collect_classification_multiset(
    prepared_ldf: PreparedLDF,
) -> dict[tuple[str], Counter]
```

#### class method `collect_image_multiset`

```python
def collect_image_multiset(prepared_ldf: PreparedLDF) -> Counter[str]
```

#### class method `collect_instance_segmentation_mask_overlap_multiset`

```python
def collect_instance_segmentation_mask_overlap_multiset(
    prepared_ldf: PreparedLDF,
) -> dict[tuple[str], list[np.ndarray]]
```

#### class method `collect_instance_segmentation_multiset`

```python
def collect_instance_segmentation_multiset(
    prepared_ldf: PreparedLDF,
) -> dict[tuple[str], Counter]
```

#### class method `collect_keypoint_multiset`

```python
def collect_keypoint_multiset(prepared_ldf: PreparedLDF) -> dict[tuple[str], Counter]
```

#### class method `collect_segmentation_mask_overlap_multiset`

```python
def collect_segmentation_mask_overlap_multiset(
    prepared_ldf: PreparedLDF,
) -> dict[tuple[str, str], list[np.ndarray]]
```

#### class method `collect_segmentation_multiset`

```python
def collect_segmentation_multiset(
    prepared_ldf: PreparedLDF,
) -> dict[tuple[str], Counter]
```

#### class method `equivalent`

```python
def equivalent(
    previous_dataset: str | LuxonisDataset,
    new_dataset: str | LuxonisDataset,
) -> bool
```

Alias for
[ldf_equivalent](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md).

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `previous_dataset` | `str | LuxonisDataset` | Dataset name or dataset instance used as the reference. | required |
| `new_dataset` | `str | LuxonisDataset` | Dataset name or dataset instance to compare. | required |

Returns

| Type | Description |
| --- | --- |
| `bool` | Whether the datasets are equivalent. |

Raises

| Type | Description |
| --- | --- |
| `TypeError` | If either argument is neither a dataset name nor a
[LuxonisDataset](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/datasets/luxonis_dataset.md).
|
| `ValueError` | If a dataset name matches multiple local datasets. |
| `FileNotFoundError` | If a named local dataset, split metadata, annotation parquet file, or referenced image is missing. |

#### static method `file_sha256`

```python
def file_sha256(path: Path) -> str
```

Return the SHA-256 hash for an image file.

Hashes are used to order annotations robustly when files are renamed.

#### class method `ldf_equivalent`

```python
def ldf_equivalent(
    previous_dataset: str | LuxonisDataset,
    new_dataset: str | LuxonisDataset,
) -> bool
```

Return whether two datasets are equivalent.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `previous_dataset` | `str | LuxonisDataset` | Dataset name or dataset instance used as the reference. | required |
| `new_dataset` | `str | LuxonisDataset` | Dataset name or dataset instance to compare. | required |

Returns

| Type | Description |
| --- | --- |
| `bool` | Whether the datasets are equivalent. |

Raises

| Type | Description |
| --- | --- |
| `TypeError` | If either argument is neither a dataset name nor a
[LuxonisDataset](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/datasets/luxonis_dataset.md).
|
| `ValueError` | If a dataset name matches multiple local datasets. |
| `FileNotFoundError` | If a named local dataset, split metadata, annotation parquet file, or referenced image is missing. |

#### static method `multiset_equal_with_tolerance`

```python
def multiset_equal_with_tolerance(
    prev_map: dict[tuple[str], Counter],
    new_map: dict[tuple[str], Counter],
    tol: float,
)
```

## Functions

| Name | Description |
| --- | --- |
|
[`ldf_equivalent`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| Return whether two datasets are equivalent in Luxonis Data Format. |

### function `ldf_equivalent`

```python
def ldf_equivalent(
    previous_dataset: str | LuxonisDataset,
    new_dataset: str | LuxonisDataset,
) -> bool
```

Return whether two datasets are equivalent in Luxonis Data Format.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `previous_dataset` | `str | LuxonisDataset` | Dataset name or dataset instance used as the reference. | required |
| `new_dataset` | `str | LuxonisDataset` | Dataset name or dataset instance to compare. | required |

Returns

| Type | Description |
| --- | --- |
| `bool` | Whether the datasets are equivalent. |

Raises

| Type | Description |
| --- | --- |
| `TypeError` | If either argument is neither a dataset name nor a
[LuxonisDataset](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/datasets/luxonis_dataset.md).
|
| `ValueError` | If a dataset name matches multiple local datasets. |
| `FileNotFoundError` | If a named local dataset, split metadata, annotation parquet file, or referenced image is missing. |

## Module Attributes

| Name | Description |
| --- | --- |
|
[`LDFCollector`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/ldf_equivalence.md)
| |

### type alias `LDFCollector`

```python
LDFCollector = Callable[[PreparedLDF], Any]
```
