Skip to content

relation_aware

BaseRelationalBlocker

Bases: ConcatRelationalInfoMixin, Blocker

Uses seperate blocker for entity attribute values and concatenation of neighboring entity attribute values.

Source code in klinker/blockers/relation_aware.py
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
class BaseRelationalBlocker(ConcatRelationalInfoMixin, Blocker):
    """Uses seperate blocker for entity attribute values and concatenation of neighboring entity attribute values."""

    _attribute_blocker: SchemaAgnosticBlocker
    _relation_blocker: SchemaAgnosticBlocker

    def assign(
        self,
        left: KlinkerFrame,
        right: KlinkerFrame,
        left_rel: Optional[KlinkerFrame] = None,
        right_rel: Optional[KlinkerFrame] = None,
    ) -> KlinkerBlockManager:
        """Assign entity ids to blocks.

        Will concat all entity attribute information before proceeding.
        Then uses `_attribute_blocker` for entity attribute values and
        `_relation_blocker` for concatenated neighboring entity attribute values.

        Args:
        ----
          left: KlinkerFrame: Contains entity attribute information of left dataset.
          right: KlinkerFrame: Contains entity attribute information of right dataset.
          left_rel: Optional[KlinkerFrame]:  (Default value = None) Contains relational information of left dataset.
          right_rel: Optional[KlinkerFrame]:  (Default value = None) Contains relational information of left dataset.

        Returns:
        -------
            KlinkerBlockManager: instance holding the resulting blocks.
        """
        assert left_rel is not None
        assert right_rel is not None
        attr_blocked = self._attribute_blocker.assign(left=left, right=right)
        left_rel_conc, right_rel_conc = self.concat_relational_info(
            left, right, left_rel, right_rel, include_own_attributes=False
        )
        rel_blocked = self._relation_blocker._assign(left_rel_conc, right_rel_conc)
        return combine_blocks(attr_blocked, rel_blocked)

assign(left, right, left_rel=None, right_rel=None)

Assign entity ids to blocks.

Will concat all entity attribute information before proceeding. Then uses _attribute_blocker for entity attribute values and _relation_blocker for concatenated neighboring entity attribute values.


left: KlinkerFrame: Contains entity attribute information of left dataset. right: KlinkerFrame: Contains entity attribute information of right dataset. left_rel: Optional[KlinkerFrame]: (Default value = None) Contains relational information of left dataset. right_rel: Optional[KlinkerFrame]: (Default value = None) Contains relational information of left dataset.


KlinkerBlockManager: instance holding the resulting blocks.
Source code in klinker/blockers/relation_aware.py
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
def assign(
    self,
    left: KlinkerFrame,
    right: KlinkerFrame,
    left_rel: Optional[KlinkerFrame] = None,
    right_rel: Optional[KlinkerFrame] = None,
) -> KlinkerBlockManager:
    """Assign entity ids to blocks.

    Will concat all entity attribute information before proceeding.
    Then uses `_attribute_blocker` for entity attribute values and
    `_relation_blocker` for concatenated neighboring entity attribute values.

    Args:
    ----
      left: KlinkerFrame: Contains entity attribute information of left dataset.
      right: KlinkerFrame: Contains entity attribute information of right dataset.
      left_rel: Optional[KlinkerFrame]:  (Default value = None) Contains relational information of left dataset.
      right_rel: Optional[KlinkerFrame]:  (Default value = None) Contains relational information of left dataset.

    Returns:
    -------
        KlinkerBlockManager: instance holding the resulting blocks.
    """
    assert left_rel is not None
    assert right_rel is not None
    attr_blocked = self._attribute_blocker.assign(left=left, right=right)
    left_rel_conc, right_rel_conc = self.concat_relational_info(
        left, right, left_rel, right_rel, include_own_attributes=False
    )
    rel_blocked = self._relation_blocker._assign(left_rel_conc, right_rel_conc)
    return combine_blocks(attr_blocked, rel_blocked)

BaseSimpleRelationalBlocker

Bases: ConcatRelationalInfoMixin, Blocker

Uses one blocking strategy on entity attribute values and concatenation of neighboring values.

Source code in klinker/blockers/relation_aware.py
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
class BaseSimpleRelationalBlocker(ConcatRelationalInfoMixin, Blocker):
    """Uses one blocking strategy on entity attribute values and concatenation of neighboring values."""

    _blocker: SchemaAgnosticBlocker

    def assign(
        self,
        left: KlinkerFrame,
        right: KlinkerFrame,
        left_rel: Optional[KlinkerFrame] = None,
        right_rel: Optional[KlinkerFrame] = None,
    ) -> KlinkerBlockManager:
        """Assign entity ids to blocks.

        Will concat all entity attribute information and neighboring info before proceeding.

        Args:
        ----
          left: KlinkerFrame: Contains entity attribute information of left dataset.
          right: KlinkerFrame: Contains entity attribute information of right dataset.
          left_rel: Optional[KlinkerFrame]:  (Default value = None) Contains relational information of left dataset.
          right_rel: Optional[KlinkerFrame]:  (Default value = None) Contains relational information of left dataset.

        Returns:
        -------
            KlinkerBlockManager: instance holding the resulting blocks.
        """
        assert left_rel is not None
        assert right_rel is not None
        left_conc, right_conc = self.concat_relational_info(
            left=left, right=right, left_rel=left_rel, right_rel=right_rel
        )
        return self._blocker._assign(left=left_conc, right=right_conc)

assign(left, right, left_rel=None, right_rel=None)

Assign entity ids to blocks.

Will concat all entity attribute information and neighboring info before proceeding.


left: KlinkerFrame: Contains entity attribute information of left dataset. right: KlinkerFrame: Contains entity attribute information of right dataset. left_rel: Optional[KlinkerFrame]: (Default value = None) Contains relational information of left dataset. right_rel: Optional[KlinkerFrame]: (Default value = None) Contains relational information of left dataset.


KlinkerBlockManager: instance holding the resulting blocks.
Source code in klinker/blockers/relation_aware.py
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
def assign(
    self,
    left: KlinkerFrame,
    right: KlinkerFrame,
    left_rel: Optional[KlinkerFrame] = None,
    right_rel: Optional[KlinkerFrame] = None,
) -> KlinkerBlockManager:
    """Assign entity ids to blocks.

    Will concat all entity attribute information and neighboring info before proceeding.

    Args:
    ----
      left: KlinkerFrame: Contains entity attribute information of left dataset.
      right: KlinkerFrame: Contains entity attribute information of right dataset.
      left_rel: Optional[KlinkerFrame]:  (Default value = None) Contains relational information of left dataset.
      right_rel: Optional[KlinkerFrame]:  (Default value = None) Contains relational information of left dataset.

    Returns:
    -------
        KlinkerBlockManager: instance holding the resulting blocks.
    """
    assert left_rel is not None
    assert right_rel is not None
    left_conc, right_conc = self.concat_relational_info(
        left=left, right=right, left_rel=left_rel, right_rel=right_rel
    )
    return self._blocker._assign(left=left_conc, right=right_conc)

ConcatRelationalInfoMixin

Source code in klinker/blockers/relation_aware.py
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
class ConcatRelationalInfoMixin:
    def __init__(self, top_n_a: Optional[int] = None, top_n_r: Optional[int] = None):
        self.top_n_a = top_n_a
        self.top_n_r = top_n_r

    def concat_relational_info(
        self,
        left: KlinkerFrame,
        right: KlinkerFrame,
        left_rel: KlinkerFrame,
        right_rel: KlinkerFrame,
        include_own_attributes: bool = True,
        do_not_concat_values: bool = False,
    ) -> Tuple[SeriesType, SeriesType]:
        """Concatenate neighbor entity attribute values with own.

        Args:
        ----
          left: KlinkerFrame: Frame with attribute info of left dataset.
          right: KlinkerFrame: Frame with attribute info of right dataset.
          left_rel: KlinkerFrame: Relation triples of left dataset.
          right_rel: KlinkerFrame: Relation triples of right dataset.

        Returns:
        -------
            (left_conc, right_conc) Concatenated entity attribute values for left and right
        """
        left_conc = concat_neighbor_attributes(
            left,
            left_rel,
            include_own_attributes=include_own_attributes,
            top_n_a=self.top_n_a,
            top_n_r=self.top_n_r,
            do_not_concat_values=do_not_concat_values,
        )
        right_conc = concat_neighbor_attributes(
            right,
            right_rel,
            include_own_attributes=include_own_attributes,
            top_n_a=self.top_n_a,
            top_n_r=self.top_n_r,
            do_not_concat_values=do_not_concat_values,
        )
        return left_conc, right_conc

concat_relational_info(left, right, left_rel, right_rel, include_own_attributes=True, do_not_concat_values=False)

Concatenate neighbor entity attribute values with own.


left: KlinkerFrame: Frame with attribute info of left dataset. right: KlinkerFrame: Frame with attribute info of right dataset. left_rel: KlinkerFrame: Relation triples of left dataset. right_rel: KlinkerFrame: Relation triples of right dataset.


(left_conc, right_conc) Concatenated entity attribute values for left and right
Source code in klinker/blockers/relation_aware.py
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
def concat_relational_info(
    self,
    left: KlinkerFrame,
    right: KlinkerFrame,
    left_rel: KlinkerFrame,
    right_rel: KlinkerFrame,
    include_own_attributes: bool = True,
    do_not_concat_values: bool = False,
) -> Tuple[SeriesType, SeriesType]:
    """Concatenate neighbor entity attribute values with own.

    Args:
    ----
      left: KlinkerFrame: Frame with attribute info of left dataset.
      right: KlinkerFrame: Frame with attribute info of right dataset.
      left_rel: KlinkerFrame: Relation triples of left dataset.
      right_rel: KlinkerFrame: Relation triples of right dataset.

    Returns:
    -------
        (left_conc, right_conc) Concatenated entity attribute values for left and right
    """
    left_conc = concat_neighbor_attributes(
        left,
        left_rel,
        include_own_attributes=include_own_attributes,
        top_n_a=self.top_n_a,
        top_n_r=self.top_n_r,
        do_not_concat_values=do_not_concat_values,
    )
    right_conc = concat_neighbor_attributes(
        right,
        right_rel,
        include_own_attributes=include_own_attributes,
        top_n_a=self.top_n_a,
        top_n_r=self.top_n_r,
        do_not_concat_values=do_not_concat_values,
    )
    return left_conc, right_conc

RelationalDeepBlocker

Bases: BaseRelationalBlocker

Seperate DeepBlocker strategy on concatenation of entity attribute values and neighboring values.

Examples

>>> # doctest: +SKIP
>>> from sylloge import MovieGraphBenchmark
>>> from klinker.data import KlinkerDataset
>>> ds = KlinkerDataset.from_sylloge(MovieGraphBenchmark(),clean=True)
>>> from klinker.blockers import RelationalDeepBlocker
>>> blocker = RelationalDeepBlocker(attr_frame_encoder="autoencoder", rel_frame_encoder="autoencoder")
>>> blocks = blocker.assign(left=ds.left, right=ds.right, left_rel=ds.left_rel, right_rel=ds.right_rel)
Source code in klinker/blockers/relation_aware.py
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
class RelationalDeepBlocker(BaseRelationalBlocker):
    """Seperate DeepBlocker strategy on concatenation of entity attribute values and neighboring values.

    Examples
    --------
        >>> # doctest: +SKIP
        >>> from sylloge import MovieGraphBenchmark
        >>> from klinker.data import KlinkerDataset
        >>> ds = KlinkerDataset.from_sylloge(MovieGraphBenchmark(),clean=True)
        >>> from klinker.blockers import RelationalDeepBlocker
        >>> blocker = RelationalDeepBlocker(attr_frame_encoder="autoencoder", rel_frame_encoder="autoencoder")
        >>> blocks = blocker.assign(left=ds.left, right=ds.right, left_rel=ds.left_rel, right_rel=ds.right_rel)
    """

    _attribute_blocker: DeepBlocker
    _relation_blocker: DeepBlocker

    def __init__(
        self,
        attr_frame_encoder: HintOrType[DeepBlockerFrameEncoder] = None,
        attr_frame_encoder_kwargs: OptionalKwargs = None,
        attr_embedding_block_builder: HintOrType[EmbeddingBlockBuilder] = None,
        attr_embedding_block_builder_kwargs: OptionalKwargs = None,
        rel_frame_encoder: HintOrType[DeepBlockerFrameEncoder] = None,
        rel_frame_encoder_kwargs: OptionalKwargs = None,
        rel_embedding_block_builder: HintOrType[EmbeddingBlockBuilder] = None,
        rel_embedding_block_builder_kwargs: OptionalKwargs = None,
        save: bool = True,
        save_dir: Optional[Union[str, pathlib.Path]] = None,
        force: bool = False,
        top_n_a: Optional[int] = None,
        top_n_r: Optional[int] = None,
    ):
        super().__init__(top_n_a=top_n_a, top_n_r=top_n_r)
        self._attribute_blocker = DeepBlocker(
            frame_encoder=attr_frame_encoder,
            frame_encoder_kwargs=attr_frame_encoder_kwargs,
            embedding_block_builder=attr_embedding_block_builder,
            embedding_block_builder_kwargs=attr_embedding_block_builder_kwargs,
        )
        self._relation_blocker = DeepBlocker(
            frame_encoder=rel_frame_encoder,
            frame_encoder_kwargs=rel_frame_encoder_kwargs,
            embedding_block_builder=rel_embedding_block_builder,
            embedding_block_builder_kwargs=rel_embedding_block_builder_kwargs,
        )
        # set after instatiating seperate blocker to use setter
        self.save = save
        self.force = force
        self.save_dir = save_dir

    @property
    def save(self) -> bool:
        return self._save

    @save.setter
    def save(self, value: bool):
        self._save = value
        self._attribute_blocker.save = value
        self._relation_blocker.save = value

    @property
    def force(self) -> bool:
        return self._force

    @force.setter
    def force(self, value: bool):
        self._force = value
        self._attribute_blocker.force = value
        self._relation_blocker.force = value

    @property
    def save_dir(self) -> Optional[Union[str, pathlib.Path]]:
        return self._save_dir

    @save_dir.setter
    def save_dir(self, value: Optional[Union[str, pathlib.Path]]):
        if value is None:
            self._save_dir = None
            self._attribute_blocker.save_dir = None
            self._relation_blocker.save_dir = None
        else:
            sd = pathlib.Path(value)
            self._save_dir = sd
            self._attribute_blocker.save_dir = sd.joinpath("attributes")
            self._relation_blocker.save_dir = sd.joinpath("relation")

RelationalMinHashLSHBlocker

Bases: BaseRelationalBlocker

Seperate MinHashLSH blocking on concatenation of entity attribute values and neighboring values.

Examples

>>> # doctest: +SKIP
>>> from sylloge import MovieGraphBenchmark
>>> from klinker.data import KlinkerDataset
>>> ds = KlinkerDataset.from_sylloge(MovieGraphBenchmark(),clean=True)
>>> from klinker.blockers import RelationalMinHashLSHBlocker
>>> blocker = RelationalMinHashLSHBlocker(attr_threshold=0.7, rel_threshold=0.9)
>>> blocks = blocker.assign(left=ds.left, right=ds.right, left_rel=ds.left_rel, right_rel=ds.right_rel)
Source code in klinker/blockers/relation_aware.py
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
class RelationalMinHashLSHBlocker(BaseRelationalBlocker):
    """Seperate MinHashLSH blocking on concatenation of entity attribute values and neighboring values.

    Examples
    --------
        >>> # doctest: +SKIP
        >>> from sylloge import MovieGraphBenchmark
        >>> from klinker.data import KlinkerDataset
        >>> ds = KlinkerDataset.from_sylloge(MovieGraphBenchmark(),clean=True)
        >>> from klinker.blockers import RelationalMinHashLSHBlocker
        >>> blocker = RelationalMinHashLSHBlocker(attr_threshold=0.7, rel_threshold=0.9)
        >>> blocks = blocker.assign(left=ds.left, right=ds.right, left_rel=ds.left_rel, right_rel=ds.right_rel)
    """

    def __init__(
        self,
        tokenize_fn: Callable = word_tokenize,
        attr_threshold: float = 0.5,
        attr_num_perm: int = 128,
        attr_weights: Tuple[float, float] = (0.5, 0.5),
        rel_threshold: float = 0.7,
        rel_num_perm: int = 128,
        rel_weights: Tuple[float, float] = (0.5, 0.5),
        top_n_a: Optional[int] = None,
        top_n_r: Optional[int] = None,
    ):
        super().__init__(top_n_a=top_n_a, top_n_r=top_n_r)
        self._attribute_blocker = MinHashLSHBlocker(
            tokenize_fn=tokenize_fn,
            threshold=attr_threshold,
            num_perm=attr_num_perm,
            weights=attr_weights,
        )
        self._relation_blocker = MinHashLSHBlocker(
            tokenize_fn=tokenize_fn,
            threshold=rel_threshold,
            num_perm=rel_num_perm,
            weights=rel_weights,
        )

RelationalTokenBlocker

Bases: BaseRelationalBlocker

Seperate Tokenblocking on concatenation of entity attribute values and neighboring values.

Examples

>>> # doctest: +SKIP
>>> from sylloge import MovieGraphBenchmark
>>> from klinker.data import KlinkerDataset
>>> ds = KlinkerDataset.from_sylloge(MovieGraphBenchmark(),clean=True)
>>> from klinker.blockers import RelationalTokenBlocker
>>> blocker = RelationalTokenBlocker(attr_min_token_length=3, rel_min_token_length=5)
>>> blocks = blocker.assign(left=ds.left, right=ds.right, left_rel=ds.left_rel, right_rel=ds.right_rel)
Source code in klinker/blockers/relation_aware.py
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
class RelationalTokenBlocker(BaseRelationalBlocker):
    """Seperate Tokenblocking on concatenation of entity attribute values and neighboring values.

    Examples
    --------
        >>> # doctest: +SKIP
        >>> from sylloge import MovieGraphBenchmark
        >>> from klinker.data import KlinkerDataset
        >>> ds = KlinkerDataset.from_sylloge(MovieGraphBenchmark(),clean=True)
        >>> from klinker.blockers import RelationalTokenBlocker
        >>> blocker = RelationalTokenBlocker(attr_min_token_length=3, rel_min_token_length=5)
        >>> blocks = blocker.assign(left=ds.left, right=ds.right, left_rel=ds.left_rel, right_rel=ds.right_rel)

    """

    def __init__(
        self,
        tokenize_fn: Callable[[str], List[str]] = word_tokenize,
        attr_min_token_length: int = 3,
        rel_min_token_length: int = 3,
        top_n_a: Optional[int] = None,
        top_n_r: Optional[int] = None,
    ):
        super().__init__(top_n_a=top_n_a, top_n_r=top_n_r)
        self._attribute_blocker = TokenBlocker(
            tokenize_fn=tokenize_fn,
            min_token_length=attr_min_token_length,
        )
        self._relation_blocker = TokenBlocker(
            tokenize_fn=tokenize_fn,
            min_token_length=rel_min_token_length,
        )

SimpleRelationalMinHashLSHBlocker

Bases: BaseSimpleRelationalBlocker

MinHashLSH blocking on concatenation of entity attribute values and neighboring values.

Examples

>>> # doctest: +SKIP
>>> from sylloge import MovieGraphBenchmark
>>> from klinker.data import KlinkerDataset
>>> ds = KlinkerDataset.from_sylloge(MovieGraphBenchmark(),clean=True)
>>> from klinker.blockers import SimpleRelationalTokenBlocker
>>> blocker = SimpleRelationalMinHashLSHBlocker()
>>> blocks = blocker.assign(left=ds.left, right=ds.right, left_rel=ds.left_rel, right_rel=ds.right_rel)
Source code in klinker/blockers/relation_aware.py
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
class SimpleRelationalMinHashLSHBlocker(BaseSimpleRelationalBlocker):
    """MinHashLSH blocking on concatenation of entity attribute values and neighboring values.

    Examples
    --------
        >>> # doctest: +SKIP
        >>> from sylloge import MovieGraphBenchmark
        >>> from klinker.data import KlinkerDataset
        >>> ds = KlinkerDataset.from_sylloge(MovieGraphBenchmark(),clean=True)
        >>> from klinker.blockers import SimpleRelationalTokenBlocker
        >>> blocker = SimpleRelationalMinHashLSHBlocker()
        >>> blocks = blocker.assign(left=ds.left, right=ds.right, left_rel=ds.left_rel, right_rel=ds.right_rel)
    """

    def __init__(
        self,
        tokenize_fn: Callable = word_tokenize,
        threshold: float = 0.5,
        num_perm: int = 128,
        weights: Tuple[float, float] = (0.5, 0.5),
        top_n_a: Optional[int] = None,
        top_n_r: Optional[int] = None,
    ):
        super().__init__(top_n_a=top_n_a, top_n_r=top_n_r)
        self._blocker = MinHashLSHBlocker(
            tokenize_fn=tokenize_fn,
            threshold=threshold,
            num_perm=num_perm,
            weights=weights,
        )

SimpleRelationalTokenBlocker

Bases: BaseSimpleRelationalBlocker

Token blocking on concatenation of entity attribute values and neighboring values.

Examples

>>> # doctest: +SKIP
>>> from sylloge import MovieGraphBenchmark
>>> from klinker.data import KlinkerDataset
>>> ds = KlinkerDataset.from_sylloge(MovieGraphBenchmark(),clean=True)
>>> from klinker.blockers import SimpleRelationalTokenBlocker
>>> blocker = SimpleRelationalTokenBlocker()
>>> blocks = blocker.assign(left=ds.left, right=ds.right, left_rel=ds.left_rel, right_rel=ds.right_rel)
Source code in klinker/blockers/relation_aware.py
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
class SimpleRelationalTokenBlocker(BaseSimpleRelationalBlocker):
    """Token blocking on concatenation of entity attribute values and neighboring values.

    Examples
    --------
        >>> # doctest: +SKIP
        >>> from sylloge import MovieGraphBenchmark
        >>> from klinker.data import KlinkerDataset
        >>> ds = KlinkerDataset.from_sylloge(MovieGraphBenchmark(),clean=True)
        >>> from klinker.blockers import SimpleRelationalTokenBlocker
        >>> blocker = SimpleRelationalTokenBlocker()
        >>> blocks = blocker.assign(left=ds.left, right=ds.right, left_rel=ds.left_rel, right_rel=ds.right_rel)
    """

    def __init__(
        self,
        tokenize_fn: Callable[[str], List[str]] = word_tokenize,
        min_token_length: int = 3,
        top_n_a: Optional[int] = None,
        top_n_r: Optional[int] = None,
    ):
        super().__init__(top_n_a=top_n_a, top_n_r=top_n_r)
        self._blocker = TokenBlocker(
            tokenize_fn=tokenize_fn,
            min_token_length=min_token_length,
        )

concat_neighbor_attributes(attribute_frame, rel_frame, include_own_attributes=True, top_n_a=None, top_n_r=None, do_not_concat_values=False)

Return concatenated attributes of neighboring entities.


attribute_frame: KlinkerFrame with entity attributes rel_frame: Frame with relation triples include_own_attributes: if True also concatenates attributes of entity itself attribute_frame: KlinkerFrame: rel_frame: Frame: include_own_attributes: bool: (Default value = True) top_n_a: Optional[int]: If set determines the number of most important properties to keep top_n_r: Optional[int]: If set determines the number of most important relations to keep


Series with concatenated attribute values of neighboring entities

Source code in klinker/blockers/relation_aware.py
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
def concat_neighbor_attributes(
    attribute_frame: KlinkerFrame,
    rel_frame: Frame,
    include_own_attributes: bool = True,
    top_n_a: Optional[int] = None,
    top_n_r: Optional[int] = None,
    do_not_concat_values: bool = False,
) -> SeriesType:
    """Return concatenated attributes of neighboring entities.

    Args:
    ----
      attribute_frame: KlinkerFrame with entity attributes
      rel_frame: Frame with relation triples
      include_own_attributes: if True also concatenates attributes of entity itself
      attribute_frame: KlinkerFrame:
      rel_frame: Frame:
      include_own_attributes: bool:  (Default value = True)
      top_n_a: Optional[int]: If set determines the number of most important properties to keep
      top_n_r: Optional[int]: If set determines the number of most important relations to keep

    Returns:
    -------
      Series with concatenated attribute values of neighboring entities

    """
    assert attribute_frame.table_name
    table_name = attribute_frame.table_name
    num_entities = None
    rev_rel_frame = reverse_rel(rel_frame)
    with_inv = concat_frames([rel_frame, rev_rel_frame])

    # concat all attribute values (and filter if needed)
    if top_n_a:
        num_entities = count_entities(attribute_frame, rel_frame)
        prop_importance = name_importance(attribute_frame, num_entities)
        attribute_frame = filter_importance(
            attribute_frame,
            prop_importance,
            top_n_a,
            table_name=table_name,
            id_col=attribute_frame.id_col,
        )
    if do_not_concat_values:
        concat_attr = attribute_frame[
            [attribute_frame.id_col, attribute_frame.columns[2]]
        ]
    else:
        concat_attr = attribute_frame.concat_values().to_frame().reset_index()
    if isinstance(concat_attr, dd.DataFrame):
        concat_attr._meta = pd.DataFrame(
            [], columns=[attribute_frame.id_col, attribute_frame.table_name], dtype=str
        )

    # filter relations
    if top_n_r:
        if num_entities is None:
            num_entities = count_entities(attribute_frame, rel_frame)
        rel_importance = relation_importance(rel_frame, num_entities)
        with_inv = filter_importance(
            with_inv,
            rel_importance,
            top_n=top_n_r,
        )
    conc_frame = (
        with_inv.set_index(with_inv.columns[2])
        .join(concat_attr.set_index(attribute_frame.id_col), how="left")
        .dropna()
    )

    if isinstance(attribute_frame, KlinkerPandasFrame):
        if include_own_attributes:
            concat_attr = _upgrade_to_triple(concat_attr, conc_frame)
            conc_frame = pd.concat([conc_frame, concat_attr])
        res = KlinkerTriplePandasFrame(
            conc_frame,
            table_name=attribute_frame.table_name,
            id_col=rel_frame.columns[0],
        )
    else:
        if include_own_attributes:
            concat_attr = _upgrade_to_triple(concat_attr, conc_frame)
            conc_frame = dd.concat([conc_frame, concat_attr])
        res = KlinkerTripleDaskFrame.from_dask_dataframe(
            conc_frame,
            table_name=attribute_frame.table_name,
            id_col=rel_frame.columns[0],
            construction_class=KlinkerTriplePandasFrame,
        )
    if do_not_concat_values:
        return res
    return res.concat_values()

reverse_rel(rel_frame, inverse_prefix='')

Reverse the relations by switching first and last column.


rel_frame: Frame: Frame with relation triples. inverse_prefix: Prefix for new inverse relations


rel_frame with reversed relations

Source code in klinker/blockers/relation_aware.py
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def reverse_rel(rel_frame: Frame, inverse_prefix: str = "") -> Frame:
    """Reverse the relations by switching first and last column.

    Args:
    ----
      rel_frame: Frame: Frame with relation triples.
      inverse_prefix: Prefix for new inverse relations

    Returns:
    -------
      rel_frame with reversed relations
    """
    orig_columns = rel_frame.columns
    rev_rel_frame = rel_frame[rel_frame.columns[::-1]]
    rev_rel_frame[rev_rel_frame.columns[1]] = (
        inverse_prefix + rev_rel_frame[rev_rel_frame.columns[1]]
    )
    rev_rel_frame.columns = orig_columns
    return rev_rel_frame