remove dayz_utils file multi-table

Author: R-Palazzo

sdv/multi_table/_dayz_utils.py

@@ -1,9 +1,16 @@
 """Multi-Table DayZ parameter detection and creation."""
 
+import json
+
+import pandas as pd
+
 from sdv.cag._utils import _is_list_of_type
 from sdv.errors import SynthesizerInputError, SynthesizerProcessingError
-from sdv.multi_table._dayz_utils import create_parameters_multi_table
-from sdv.single_table.dayz import _validate_parameter_structure, _validate_tables_parameter
+from sdv.single_table.dayz import (
+    _validate_parameter_structure,
+    _validate_tables_parameter,
+    create_parameters,
+)
 
 REQUIRED_RELATIONSHIP_KEYS = [
     'parent_table_name',
@@ -19,6 +26,53 @@
 DEFAULT_NUM_ROWS = 1000
 
 
+def _detect_relationship_parameters(data, metadata):
+    """Detect all relationship-level for the DayZ parameters.
+
+    The relationship-level parameters are:
+    - The min and max cardinality
+
+    Args:
+        data (dict[str, pd.DataFrame]): The input data.
+        metadata (Metadata): The metadata object.
+
+    Returns:
+        dict: A list containing the detected parameters.
+    """
+    relationship_parameters = []
+    for relationship in metadata.relationships:
+        rel_tuple = (
+            relationship['parent_table_name'],
+            relationship['child_table_name'],
+            relationship['parent_primary_key'],
+            relationship['child_foreign_key'],
+        )
+        cardinality_table = pd.DataFrame(index=data[rel_tuple[0]][rel_tuple[2]].copy())
+        cardinality_table['cardinality'] = data[rel_tuple[1]][rel_tuple[3]].value_counts()
+        cardinality_table = cardinality_table.fillna(0)
+        relationship_parameters.append({
+            'parent_table_name': rel_tuple[0],
+            'child_table_name': rel_tuple[1],
+            'parent_primary_key': rel_tuple[2],
+            'child_foreign_key': rel_tuple[3],
+            'min_cardinality': cardinality_table['cardinality'].min(),
+            'max_cardinality': cardinality_table['cardinality'].max(),
+        })
+
+    return relationship_parameters
+
+
+def create_parameters_multi_table(data, metadata, output_filename):
+    """Create parameters for the DayZSynthesizer."""
+    parameters = create_parameters(data, metadata, None)
+    parameters['relationships'] = _detect_relationship_parameters(data, metadata)
+    if output_filename:
+        with open(output_filename, 'w') as f:
+            json.dump(parameters, f, indent=4)
+
+    return parameters
+
+
 def _validate_min_cardinality(relationship):
     min_cardinality = relationship['min_cardinality']
     if not isinstance(min_cardinality, int) or min_cardinality < 0:

sdv/multi_table/dayz.py

@@ -150,26 +150,6 @@ def create_parameters(data, metadata, output_filename):
     if len(metadata.tables) == 0:
         raise ValueError('Metadata is empty')
 
-    metadata.validate()
-    datas = data if isinstance(data, dict) else {metadata._get_single_table_name(): data}
-    metadata.validate_data(datas)
-    parameters = {'DAYZ_SPEC_VERSION': 'V1', 'tables': {}}
-    for table_name, table_data in datas.items():
-        parameters['tables'][table_name] = {}
-        parameters['tables'][table_name].update(_detect_table_parameters(table_data))
-        parameters['tables'][table_name].update(
-            _detect_column_parameters(table_data, metadata, table_name)
-        )
-
-    if output_filename:
-        with open(output_filename, 'w') as f:
-            json.dump(parameters, f, indent=4)
-
-    return parameters
-
-
-def create_parameters(data, metadata, output_filename):
-    """Detect and create a parameter dict for the DayZ model."""
     metadata.validate()
     datas = data if isinstance(data, dict) else {metadata._get_single_table_name(): data}
     metadata.validate_data(datas)

sdv/single_table/dayz.py

@@ -1,3 +1,4 @@
+import json
 import re
 from unittest.mock import call, patch
 
@@ -9,10 +10,12 @@
 from sdv.metadata import Metadata
 from sdv.multi_table.dayz import (
     DayZSynthesizer,
+    _detect_relationship_parameters,
     _validate_cardinality,
     _validate_parameters,
     _validate_relationship_parameters,
     _validate_relationship_structure,
+    create_parameters_multi_table,
 )
 
 
@@ -52,6 +55,109 @@ def metadata():
     })
 
 
+def test__detect_relationship_parameters():
+    """Test the `_detect_relationship_parameters` method."""
+    # Setup
+    parent_data = pd.DataFrame({'parent_id': [1, 2, 3, 4, 5]})
+    child_data = pd.DataFrame({
+        'child_id': [10, 11, 12, 13, 14, 15, 16],
+        'parent_id': [1, 1, 2, 2, 2, 3, None],
+    })
+    data = {'parent': parent_data, 'child': child_data}
+    metadata_dict = {
+        'tables': {
+            'parent': {'columns': {'parent_id': {'sdtype': 'id'}}, 'primary_key': 'parent_id'},
+            'child': {
+                'columns': {'child_id': {'sdtype': 'id'}, 'parent_id': {'sdtype': 'id'}},
+                'primary_key': 'child_id',
+            },
+        },
+        'relationships': [
+            {
+                'parent_table_name': 'parent',
+                'child_table_name': 'child',
+                'parent_primary_key': 'parent_id',
+                'child_foreign_key': 'parent_id',
+            }
+        ],
+    }
+    metadata = Metadata.load_from_dict(metadata_dict)
+
+    # Run
+    result = _detect_relationship_parameters(data, metadata)
+
+    # Assert
+    expected = [
+        {
+            'parent_table_name': 'parent',
+            'child_table_name': 'child',
+            'parent_primary_key': 'parent_id',
+            'child_foreign_key': 'parent_id',
+            'min_cardinality': 0,
+            'max_cardinality': 3,
+        }
+    ]
+    assert result == expected
+
+
+@patch('sdv.multi_table.dayz._detect_relationship_parameters')
+@patch('sdv.multi_table.dayz.create_parameters')
+def test_create_parameters_multi_table(mock_create_parameters, mock_detect_relationship, tmp_path):
+    """Test the `create_parameters_multi_table` method."""
+    # Setup
+    data = pd.DataFrame()
+    metadata = Metadata()
+    output_filename = str(tmp_path / 'output.json')
+    mock_detect_relationship.return_value = {
+        '["parent_table", "child_table", "parent_pk", "child_fk"]': {
+            'min_cardinality': 0,
+            'max_cardinality': 10,
+        }
+    }
+    mock_create_parameters.return_value = {
+        'DAYZ_SPEC_VERSION': 'V1',
+        'tables': {
+            'table_name': {
+                'num_rows': 100,
+                'columns': {
+                    'col1': {'missing_values_proportion': 0.1},
+                    'col2': {'missing_values_proportion': 0.2},
+                },
+            }
+        },
+    }
+
+    # Run
+    result = create_parameters_multi_table(data, metadata, output_filename)
+
+    # Assert
+    mock_create_parameters.assert_called_once_with(data, metadata, None)
+    mock_detect_relationship.assert_called_once_with(data, metadata)
+    assert result == {
+        'DAYZ_SPEC_VERSION': 'V1',
+        'tables': {
+            'table_name': {
+                'num_rows': 100,
+                'columns': {
+                    'col1': {'missing_values_proportion': 0.1},
+                    'col2': {'missing_values_proportion': 0.2},
+                },
+            }
+        },
+        'relationships': {
+            '["parent_table", "child_table", "parent_pk", "child_fk"]': {
+                'min_cardinality': 0,
+                'max_cardinality': 10,
+            }
+        },
+    }
+    assert result == mock_create_parameters.return_value
+    with open(output_filename) as f:
+        output = json.load(f)
+
+    assert output == result
+
+
 def test__validate_relationship_structure():
     """Test validating the relationship parameters structure."""
     # Setup