encoders
AutoEncoderDeepBlockerFrameEncoder
Bases: DeepBlockerFrameEncoder[Tensor]
Autoencoder class for DeepBlocker Frame encoders.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
hidden_dimensions |
Tuple[int, int]
|
Tuple[int, int]: Hidden dimensions |
(2 * 150, 150)
|
num_epochs |
int
|
int: Number of epochs if training |
50
|
batch_size |
int
|
int: Batch size |
256
|
learning_rate |
float
|
float: Learning rate if training |
0.001
|
loss_function |
Optional[_Loss]: Loss function if training |
required | |
optimizer |
Optional[HintOrType[Optimizer]]: Optimizer if training |
required | |
optimizer_kwargs |
OptionalKwargs: Keyword arguments to inizialize optimizer |
required | |
frame_encoder |
HintOrType[TokenizedFrameEncoder]
|
HintOrType[TokenizedFrameEncoder]: Base encoder class |
None
|
frame_encoder_kwargs |
OptionalKwargs
|
OptionalKwargs: Keyword arguments for initializing frame encoder |
None
|
Source code in klinker/encoders/deepblocker.py
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
|
create_features(left, right)
Features for AutoEncoder.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
left |
Frame
|
Frame: left attributes. |
required |
right |
Frame
|
Frame: right attributes. |
required |
Returns:
Type | Description |
---|---|
Tuple[Tensor, Tensor, Tensor]
|
Concatenated left/right encoded, left encoded, right encoded |
Source code in klinker/encoders/deepblocker.py
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
|
AverageEmbeddingTokenizedFrameEncoder
Bases: TokenizedFrameEncoder
Averages embeddings of tokenized entity attribute values.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
tokenized_word_embedder |
HintOrType[TokenizedWordEmbedder]
|
HintOrType[TokenizedWordEmbedder]: Word Embedding class, |
None
|
tokenized_word_embedder_kwargs |
OptionalKwargs
|
OptionalKwargs: Keyword arguments for initalizing word embedder |
None
|
Source code in klinker/encoders/pretrained.py
326 327 328 329 330 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 357 358 359 360 |
|
CrossTupleTrainingDeepBlockerFrameEncoder
Bases: DeepBlockerFrameEncoder
CrossTupleTraining class for DeepBlocker Frame encoders.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
hidden_dimensions |
Tuple[int, int]
|
Tuple[int, int]: Hidden dimensions |
(2 * 150, 150)
|
num_epochs |
int
|
int: Number of epochs |
50
|
batch_size |
int
|
int: Batch size |
256
|
learning_rate |
float
|
float: Learning rate |
0.001
|
synth_tuples_per_tuple |
int
|
int: Synthetic tuples per tuple |
5
|
pos_to_neg_ratio |
float
|
float: Ratio of positiv to negative tuples |
1.0
|
max_perturbation |
float
|
float: Degree how much tuples should be corrupted |
0.4
|
random_seed |
Seed to control randomness |
None
|
|
loss_function |
Optional[_Loss]
|
Optional[_Loss]: Loss function if training |
None
|
optimizer |
Optional[HintOrType[Optimizer]]
|
Optional[HintOrType[Optimizer]]: Optimizer if training |
None
|
optimizer_kwargs |
OptionalKwargs
|
OptionalKwargs: Keyword arguments to inizialize optimizer |
None
|
frame_encoder |
HintOrType[TokenizedFrameEncoder]
|
HintOrType[TokenizedFrameEncoder]: Base encoder class |
None
|
frame_encoder_kwargs |
OptionalKwargs
|
OptionalKwargs: Keyword arguments for initializing frame encoder |
None
|
Source code in klinker/encoders/deepblocker.py
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 248 249 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 294 295 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 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 |
|
create_features(left, right)
Create features for cross-tuple training
Parameters:
Name | Type | Description | Default |
---|---|---|---|
left |
Frame
|
Frame: left attributes. |
required |
right |
Frame
|
Frame: right attributes. |
required |
Returns:
Type | Description |
---|---|
Tuple[Tuple[Tensor, Tensor, Tensor], Tensor, Tensor]
|
(left_training, right_training, labels), left encoded, right encoded |
Source code in klinker/encoders/deepblocker.py
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 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 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
|
FrameEncoder
Base class for encoding a KlinkerFrame as embedding.
Source code in klinker/encoders/base.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
|
encode(left, right, *, left_rel=None, right_rel=None, return_type='pt')
Encode dataframes into named vectors.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
left |
Frame
|
Frame: left attribute information. |
required |
right |
Frame
|
Frame: right attribute information. |
required |
left_rel |
Optional[Frame]
|
Optional[Frame]: left relation triples. |
None
|
right_rel |
Optional[Frame]
|
Optional[Frame]: right relation triples. |
None
|
return_type |
GeneralVectorLiteral
|
GeneralVectorLiteral: Either |
'pt'
|
Returns:
Type | Description |
---|---|
Tuple[NamedVector, NamedVector]
|
Embeddings of given left/right dataset. |
Source code in klinker/encoders/base.py
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
|
prepare(left, right)
Prepare for embedding (fill NaNs with empty string).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
left |
Frame
|
Frame: left attributes. |
required |
right |
Frame
|
Frame: right attributes. |
required |
Returns:
Type | Description |
---|---|
Tuple[Frame, Frame]
|
left, right |
Source code in klinker/encoders/base.py
45 46 47 48 49 50 51 52 53 54 55 |
|
validate(left, right, left_rel=None, right_rel=None)
Check if frames only consist of one column.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
left |
Frame
|
Frame: left attributes. |
required |
right |
Frame
|
Frame: right attributes. |
required |
left_rel |
Optional[Frame]
|
Optional[Frame]: left relation triples. |
None
|
right_rel |
Optional[Frame]
|
Optional[Frame]: right relation triples. |
None
|
Source code in klinker/encoders/base.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
|
GCNFrameEncoder
Bases: RelationFrameEncoder
Use untrained GCN for aggregating neighboring embeddings with self.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
depth |
int
|
How many hops of neighbors should be incorporated |
2
|
edge_weight |
float
|
Weighting of non-self-loops |
1.0
|
self_loop_weight |
float
|
Weighting of self-loops |
2.0
|
layer_dims |
int
|
Dimensionality of layers if used |
300
|
bias |
bool
|
Whether to use bias in layers |
False
|
use_weight_layers |
bool
|
Whether to use randomly initialized layers in aggregation |
True
|
aggr |
str
|
Which aggregation to use. Can be :obj: |
'sum'
|
attribute_encoder |
HintOrType[TokenizedFrameEncoder]
|
HintOrType[TokenizedFrameEncoder]: Base encoder class |
None
|
attribute_encoder_kwargs |
OptionalKwargs
|
OptionalKwargs: Keyword arguments for initializing encoder |
None
|
Source code in klinker/encoders/gcn.py
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 |
|
HybridDeepBlockerFrameEncoder
Bases: CrossTupleTrainingDeepBlockerFrameEncoder
Hybrid DeepBlocker class.
Uses both Autoencoder and CrossTupleTraining strategy.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
frame_encoder |
HintOrType[TokenizedFrameEncoder]
|
HintOrType[TokenizedFrameEncoder]: Base encoder class |
None
|
frame_encoder_kwargs |
OptionalKwargs
|
OptionalKwargs: Keyword arguments for initializing frame encoder |
None
|
hidden_dimensions |
Tuple[int, int]
|
Tuple[int, int]: Hidden dimensions |
(2 * 150, 150)
|
num_epochs |
int
|
int: Number of epochs if training |
50
|
batch_size |
int
|
int: Batch size |
256
|
learning_rate |
float
|
float: Learning rate |
0.001
|
synth_tuples_per_tuple |
int
|
int: Synthetic tuples per tuple |
5
|
pos_to_neg_ratio |
float
|
float: Ratio of positiv to negative tuples |
1.0
|
max_perturbation |
float: Degree how much tuples should be corrupted |
0.4
|
|
random_seed |
Seed to control randomness |
None
|
|
loss_function |
Optional[_Loss]
|
Optional[_Loss]: Loss function if training |
None
|
optimizer |
Optional[HintOrType[Optimizer]]
|
Optional[HintOrType[Optimizer]]: Optimizer if training |
None
|
optimizer_kwargs |
OptionalKwargs
|
OptionalKwargs: Keyword arguments to inizialize optimizer |
None
|
Source code in klinker/encoders/deepblocker.py
354 355 356 357 358 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 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 |
|
LightEAFrameEncoder
Bases: RelationFrameEncoder
Use LightEA algorithm to encode frame.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ent_dim |
int
|
int: Entity dimensions |
256
|
depth |
int
|
int: Number of hops |
2
|
mini_dim |
int
|
int: Mini batching size |
16
|
rel_dim |
Optional[int]
|
int: relation embedding dimensions (same as ent_dim if None) |
None
|
attribute_encoder |
HintOrType[TokenizedFrameEncoder]
|
HintOrType[TokenizedFrameEncoder]: Attribute encoder class |
None
|
attribute_encoder_kwargs |
OptionalKwargs
|
OptionalKwargs: Keyword arguments for initializing attribute encoder class |
None
|
Reference
Mao et. al.,"LightEA: A Scalable, Robust, and Interpretable Entity Alignment Framework via Three-view Label Propagation", EMNLP 2022 https://aclanthology.org/2022.emnlp-main.52.pdf
Source code in klinker/encoders/light_ea.py
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 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 248 249 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 |
|
RelationFrameEncoder
Bases: FrameEncoder
Base class for Encoders, that also utilize relational information.
Source code in klinker/encoders/base.py
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 248 249 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 294 295 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 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
|
encode(left, right, *, left_rel=None, right_rel=None, return_type='pt')
Encode dataframes into named vectors.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
left |
SeriesType
|
Frame: left attribute information. |
required |
right |
SeriesType
|
Frame: right attribute information. |
required |
* |
|
required | |
left_rel |
Optional[Frame]
|
Optional[Frame]: left relation triples. |
None
|
right_rel |
Optional[Frame]
|
Optional[Frame]: right relation triples. |
None
|
return_type |
GeneralVectorLiteral
|
GeneralVectorLiteral: Either |
'pt'
|
Returns:
Type | Description |
---|---|
Tuple[NamedVector, NamedVector]
|
Embeddings of given left/right dataset. |
Source code in klinker/encoders/base.py
286 287 288 289 290 291 292 293 294 295 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 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
|
validate(left, right, left_rel=None, right_rel=None)
Ensure relation info is provided and attribute frames consist of single column.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
left |
Frame
|
Frame: left attribute information. |
required |
right |
Frame
|
Frame: right attribute information. |
required |
left_rel |
Optional[Frame]
|
Optional[Frame]: left relation triples. |
None
|
right_rel |
Optional[Frame]
|
Optional[Frame]: right relation triples. |
None
|
Raises:
Type | Description |
---|---|
ValueError
|
If attribute frames consist of multiple columns or relational frames are missing. |
Source code in klinker/encoders/base.py
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
|
SIFEmbeddingTokenizedFrameEncoder
Bases: TokenizedFrameEncoder
Use Smooth Inverse Frequency weighting scheme to aggregate token embeddings.
Args:
sif_weighting_param: float: weighting parameter
remove_pc:bool: remove first principal component
min_freq: int: minimum frequency of occurence
tokenized_word_embedder: HintOrType[TokenizedWordEmbedder]: Word Embedding class,
tokenized_word_embedder_kwargs: OptionalKwargs: Keyword arguments for initalizing word embedder
Reference
Arora et. al.,"A Simple but Tough-to-Beat Baseline for Sentence Embeddings", ICLR 2017 https://openreview.net/pdf?id=SyK00v5xx
Source code in klinker/encoders/pretrained.py
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 389 390 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 429 430 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 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 |
|
tokenizer_fn: Callable[[str], List[str]]
property
prepare(left, right)
Prepare value counts.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
left |
Frame
|
Frame: left attribute frame. |
required |
right |
Frame
|
Frame: right attribute frame. |
required |
Returns:
Type | Description |
---|---|
Tuple[Frame, Frame]
|
left, right |
Source code in klinker/encoders/pretrained.py
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 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 |
|
SentenceTransformerTokenizedFrameEncoder
Bases: TokenizedFrameEncoder
Uses sentencetransformer library to encode frames.
See https://www.sbert.net/docs/pretrained_models.html for a list of models.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_name |
str
|
str: pretrained model name |
'all-MiniLM-L6-v2'
|
max_length |
int
|
int: max number of tokens per row |
128
|
batch_size |
int
|
int: size of batch for encoding |
512
|
Examples:
>>> # doctest: +SKIP
>>> import pandas as pd
>>> from klinker.data import KlinkerPandasFrame
>>> from klinker.encoders import SentenceTransformerTokenizedFrameEncoder
>>> left = KlinkerPandasFrame.from_df(
pd.DataFrame(
[("a1", "John Doe"), ("a2", "Jane Doe")], columns=["id", "values"]
),
table_name="A",
id_col="id",
).set_index("id")
>>> right = KlinkerPandasFrame.from_df(
pd.DataFrame(
[("b1", "Johnny Doe"), ("b2", "Jane Doe")], columns=["id", "values"]
),
table_name="B",
id_col="id",
).set_index("id")
>>> ttfe = SentenceTransformerTokenizedFrameEncoder(
model_name="st5",
max_length=10,
batch_size=2
)
>>> left_enc, right_enc = ttfe.encode(left=left, right=right)
Source code in klinker/encoders/pretrained.py
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 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 |
|
TokenizedFrameEncoder
Bases: FrameEncoder
FrameEncoder that uses tokenization of attribute values.
Source code in klinker/encoders/base.py
153 154 155 156 157 158 159 |
|
tokenizer_fn: Callable[[str], List[str]]
property
TransformerTokenizedFrameEncoder
Bases: TokenizedFrameEncoder
Encode frames using pre-trained transformer.
See https://huggingface.co/docs/transformers/main/en/model_doc/auto#transformers.AutoModel.from_pretrained for more information on pretrained models.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pretrained_model_name_or_path |
str
|
str: Transformer name or path |
'bert-base-cased'
|
max_length |
int
|
int: max number of tokens per row |
128
|
batch_size |
int
|
int: size of batch for encoding |
512
|
Examples:
>>> # doctest: +SKIP
>>> import pandas as pd
>>> from klinker.data import KlinkerPandasFrame
>>> from klinker.encoders import TransformerTokenizedFrameEncoder
>>> left = KlinkerPandasFrame.from_df(
pd.DataFrame(
[("a1", "John Doe"), ("a2", "Jane Doe")], columns=["id", "values"]
),
table_name="A",
id_col="id",
).set_index("id")
>>> right = KlinkerPandasFrame.from_df(
pd.DataFrame(
[("b1", "Johnny Doe"), ("b2", "Jane Doe")], columns=["id", "values"]
),
table_name="B",
id_col="id",
).set_index("id")
>>> ttfe = TransformerTokenizedFrameEncoder(
pretrained_model_name_or_path="bert-base-cased",
max_length=10,
batch_size=2
)
>>> left_enc, right_enc = ttfe.encode(left=left, right=right)
Source code in klinker/encoders/pretrained.py
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
|