pykeen.nn

PyKEEN internal “nn” module.

nn

• Stateful Interaction Modules
  • Classes
    • Interaction
      • Interaction
        • Interaction.dimensions
        • Interaction.entity_shape
        • Interaction.head_indices
        • Interaction.head_shape
        • Interaction.is_complex
        • Interaction.relation_shape
        • Interaction.tail_indices
        • Interaction.tail_shape
        • Interaction.value_range
        • Interaction.forward()
        • Interaction.reset_parameters()
        • Interaction.score()
        • Interaction.score_h()
        • Interaction.score_hrt()
        • Interaction.score_r()
        • Interaction.score_t()
    • NormBasedInteraction
      • NormBasedInteraction
    • MonotonicAffineTransformationInteraction
      • MonotonicAffineTransformationInteraction
        • MonotonicAffineTransformationInteraction.forward()
        • MonotonicAffineTransformationInteraction.reset_parameters()
    • ClampedInteraction
      • ClampedInteraction
        • ClampedInteraction.entity_shape
        • ClampedInteraction.relation_shape
        • ClampedInteraction.forward()
    • DirectionAverageInteraction
      • DirectionAverageInteraction
        • DirectionAverageInteraction.forward()
    • AutoSFInteraction
      • AutoSFInteraction
        • AutoSFInteraction.extend()
        • AutoSFInteraction.forward()
        • AutoSFInteraction.from_searched_sf()
        • AutoSFInteraction.latex_visualize()
    • BoxEInteraction
      • BoxEInteraction
        • BoxEInteraction.entity_shape
        • BoxEInteraction.relation_shape
        • BoxEInteraction.boxe_kg_arity_position_score()
        • BoxEInteraction.compute_box()
        • BoxEInteraction.forward()
        • BoxEInteraction.point_to_box_distance()
        • BoxEInteraction.product_normalize()
    • ComplExInteraction
      • ComplExInteraction
        • ComplExInteraction.is_complex
        • ComplExInteraction.forward()
    • ConvEInteraction
      • ConvEInteraction
        • ConvEInteraction.entity_shape
        • ConvEInteraction.forward()
    • ConvKBInteraction
      • ConvKBInteraction
        • ConvKBInteraction.forward()
        • ConvKBInteraction.reset_parameters()
    • CPInteraction
      • CPInteraction
        • CPInteraction.entity_shape
        • CPInteraction.relation_shape
        • CPInteraction.forward()
    • CrossEInteraction
      • CrossEInteraction
        • CrossEInteraction.relation_shape
        • CrossEInteraction.forward()
    • DistMAInteraction
      • DistMAInteraction
        • DistMAInteraction.forward()
    • DistMultInteraction
      • DistMultInteraction
        • DistMultInteraction.forward()
    • ERMLPEInteraction
      • ERMLPEInteraction
        • ERMLPEInteraction.forward()
    • ERMLPInteraction
      • ERMLPInteraction
        • ERMLPInteraction.forward()
        • ERMLPInteraction.reset_parameters()
    • HolEInteraction
      • HolEInteraction
        • HolEInteraction.forward()
    • KG2EInteraction
      • KG2EInteraction
        • KG2EInteraction.entity_shape
        • KG2EInteraction.relation_shape
        • KG2EInteraction.forward()
    • LineaREInteraction
      • LineaREInteraction
        • LineaREInteraction.relation_shape
        • LineaREInteraction.forward()
    • MultiLinearTuckerInteraction
      • MultiLinearTuckerInteraction
        • MultiLinearTuckerInteraction.entity_shape
        • MultiLinearTuckerInteraction.relation_shape
        • MultiLinearTuckerInteraction.forward()
        • MultiLinearTuckerInteraction.reset_parameters()
    • MuREInteraction
      • MuREInteraction
        • MuREInteraction.entity_shape
        • MuREInteraction.relation_shape
        • MuREInteraction.forward()
    • NTNInteraction
      • NTNInteraction
        • NTNInteraction.relation_shape
        • NTNInteraction.forward()
    • PairREInteraction
      • PairREInteraction
        • PairREInteraction.relation_shape
        • PairREInteraction.forward()
    • ProjEInteraction
      • ProjEInteraction
        • ProjEInteraction.forward()
        • ProjEInteraction.reset_parameters()
    • QuatEInteraction
      • QuatEInteraction
        • QuatEInteraction.entity_shape
        • QuatEInteraction.relation_shape
        • QuatEInteraction.forward()
    • RESCALInteraction
      • RESCALInteraction
        • RESCALInteraction.relation_shape
        • RESCALInteraction.forward()
    • RotatEInteraction
      • RotatEInteraction
        • RotatEInteraction.is_complex
        • RotatEInteraction.forward()
    • SEInteraction
      • SEInteraction
        • SEInteraction.relation_shape
        • SEInteraction.forward()
    • SimplEInteraction
      • SimplEInteraction
        • SimplEInteraction.entity_shape
        • SimplEInteraction.relation_shape
    • TorusEInteraction
      • TorusEInteraction
        • TorusEInteraction.forward()
    • TransDInteraction
      • TransDInteraction
        • TransDInteraction.entity_shape
        • TransDInteraction.relation_shape
        • TransDInteraction.forward()
    • TransEInteraction
      • TransEInteraction
        • TransEInteraction.forward()
    • TransFInteraction
      • TransFInteraction
        • TransFInteraction.forward()
    • TransformerInteraction
      • TransformerInteraction
        • TransformerInteraction.forward()
    • TransHInteraction
      • TransHInteraction
        • TransHInteraction.relation_shape
        • TransHInteraction.forward()
    • TransRInteraction
      • TransRInteraction
        • TransRInteraction.relation_shape
        • TransRInteraction.forward()
    • TripleREInteraction
      • TripleREInteraction
        • TripleREInteraction.relation_shape
        • TripleREInteraction.forward()
    • TuckERInteraction
      • TuckERInteraction
        • TuckERInteraction.default_core_initializer_kwargs
        • TuckERInteraction.default_core_initializer()
        • TuckERInteraction.forward()
        • TuckERInteraction.reset_parameters()
    • UMInteraction
      • UMInteraction
        • UMInteraction.relation_shape
        • UMInteraction.forward()
  • Variables
    • interaction_resolver
      • interaction_resolver
  • Class Inheritance Diagram
• Similarity
  • pykeen.nn.sim Module
    • Classes
      • KG2ESimilarity
        • KG2ESimilarity
          • KG2ESimilarity.forward()
      • ExpectedLikelihood
        • ExpectedLikelihood
          • ExpectedLikelihood.forward()
      • NegativeKullbackLeiblerDivergence
        • NegativeKullbackLeiblerDivergence
          • NegativeKullbackLeiblerDivergence.forward()
    • Variables
      • kg2e_similarity_resolver
        • kg2e_similarity_resolver
    • Class Inheritance Diagram
• Representation
  • Classes
    • Representation
      • Representation
        • Representation.device
        • Representation.forward()
        • Representation.iter_extra_repr()
        • Representation.post_parameter_update()
        • Representation.reset_parameters()
    • Embedding
      • Embedding
        • Embedding.from_pretrained()
        • Embedding.post_parameter_update()
        • Embedding.reset_parameters()
    • LowRankRepresentation
      • LowRankRepresentation
        • LowRankRepresentation.num_bases
        • LowRankRepresentation.approximate()
    • CompGCNLayer
      • CompGCNLayer
        • CompGCNLayer.forward()
        • CompGCNLayer.message()
        • CompGCNLayer.reset_parameters()
    • CombinedCompGCNRepresentations
      • CombinedCompGCNRepresentations
        • CombinedCompGCNRepresentations.forward()
        • CombinedCompGCNRepresentations.post_parameter_update()
        • CombinedCompGCNRepresentations.split()
        • CombinedCompGCNRepresentations.train()
    • PartitionRepresentation
      • PartitionRepresentation
    • BackfillRepresentation
      • BackfillRepresentation
    • SingleCompGCNRepresentation
      • SingleCompGCNRepresentation
    • SubsetRepresentation
      • SubsetRepresentation
    • CombinedRepresentation
      • CombinedRepresentation
    • TensorTrainRepresentation
      • TensorTrainRepresentation
        • TensorTrainRepresentation.check_assignment()
        • TensorTrainRepresentation.check_factors()
        • TensorTrainRepresentation.create_default_assignment()
        • TensorTrainRepresentation.factor_sizes()
        • TensorTrainRepresentation.get_shapes_and_einsum_eq()
        • TensorTrainRepresentation.iter_extra_repr()
    • MultiBackfillRepresentation
      • MultiBackfillRepresentation
    • TransformedRepresentation
      • TransformedRepresentation
    • TextRepresentation
      • TextRepresentation
        • TextRepresentation.from_dataset()
        • TextRepresentation.from_triples_factory()
    • CachedTextRepresentation
      • CachedTextRepresentation
        • CachedTextRepresentation.from_triples_factory()
    • WikidataTextRepresentation
      • WikidataTextRepresentation
    • BiomedicalCURIERepresentation
      • BiomedicalCURIERepresentation
    • EmbeddingBagRepresentation
      • EmbeddingBagRepresentation
        • EmbeddingBagRepresentation.from_iter()
  • Variables
    • constrainer_resolver
      • constrainer_resolver
    • normalizer_resolver
      • normalizer_resolver
  • Class Inheritance Diagram
• Initialization
  • Functions
    • xavier_uniform
      • xavier_uniform_()
    • xavier_normal
      • xavier_normal_()
    • init_phases
      • init_phases()
  • Classes
    • PretrainedInitializer
      • PretrainedInitializer
        • PretrainedInitializer.__call__()
        • PretrainedInitializer.as_embedding()
    • LabelBasedInitializer
      • LabelBasedInitializer
        • LabelBasedInitializer.from_triples_factory()
    • WeisfeilerLehmanInitializer
      • WeisfeilerLehmanInitializer
    • RandomWalkPositionalEncodingInitializer
      • RandomWalkPositionalEncodingInitializer
  • Variables
    • xavier_uniform_norm
      • xavier_uniform_norm_
    • xavier_normal_norm
      • xavier_normal_norm_
    • uniform_norm
      • uniform_norm_
    • uniform_norm_p1
      • uniform_norm_p1_
    • normal_norm
      • normal_norm_
    • initializer_resolver
      • initializer_resolver
  • Class Inheritance Diagram
• Message Passing
  • Classes
    • RGCNRepresentation
      • RGCNRepresentation
        • RGCNRepresentation.post_parameter_update()
        • RGCNRepresentation.reset_parameters()
    • RGCNLayer
      • RGCNLayer
        • RGCNLayer.forward()
    • Decomposition
      • Decomposition
        • Decomposition.forward()
        • Decomposition.forward_horizontally_stacked()
        • Decomposition.forward_vertically_stacked()
        • Decomposition.iter_extra_repr()
        • Decomposition.reset_parameters()
    • BasesDecomposition
      • BasesDecomposition
        • BasesDecomposition.base_weights
        • BasesDecomposition.bases
        • BasesDecomposition.forward_horizontally_stacked()
        • BasesDecomposition.forward_vertically_stacked()
        • BasesDecomposition.iter_extra_repr()
        • BasesDecomposition.reset_parameters()
    • BlockDecomposition
      • BlockDecomposition
        • BlockDecomposition.forward_horizontally_stacked()
        • BlockDecomposition.forward_vertically_stacked()
        • BlockDecomposition.iter_extra_repr()
        • BlockDecomposition.reset_parameters()
  • Variables
    • decomposition_resolver
      • decomposition_resolver
  • Class Inheritance Diagram
• PyG Message Passing
  • Classes
    • MessagePassingRepresentation
      • MessagePassingRepresentation
        • MessagePassingRepresentation.pass_messages()
    • SimpleMessagePassingRepresentation
      • SimpleMessagePassingRepresentation
        • SimpleMessagePassingRepresentation.pass_messages()
    • FeaturizedMessagePassingRepresentation
      • FeaturizedMessagePassingRepresentation
        • FeaturizedMessagePassingRepresentation.pass_messages()
    • TypedMessagePassingRepresentation
      • TypedMessagePassingRepresentation
        • TypedMessagePassingRepresentation.pass_messages()
  • Class Inheritance Diagram
• Weighting
  • Classes
    • EdgeWeighting
      • EdgeWeighting
        • EdgeWeighting.needs_message
        • EdgeWeighting.forward()
    • InverseInDegreeEdgeWeighting
      • InverseInDegreeEdgeWeighting
        • InverseInDegreeEdgeWeighting.forward()
    • InverseOutDegreeEdgeWeighting
      • InverseOutDegreeEdgeWeighting
        • InverseOutDegreeEdgeWeighting.forward()
    • SymmetricEdgeWeighting
      • SymmetricEdgeWeighting
        • SymmetricEdgeWeighting.forward()
    • AttentionEdgeWeighting
      • AttentionEdgeWeighting
        • AttentionEdgeWeighting.needs_message
        • AttentionEdgeWeighting.forward()
  • Variables
    • edge_weight_resolver
      • edge_weight_resolver
  • Class Inheritance Diagram
• Combinations
  • Classes
    • Combination
      • Combination
        • Combination.forward()
        • Combination.output_shape()
    • ComplexSeparatedCombination
      • ComplexSeparatedCombination
        • ComplexSeparatedCombination.forward()
        • ComplexSeparatedCombination.output_shape()
    • ConcatCombination
      • ConcatCombination
        • ConcatCombination.forward()
        • ConcatCombination.iter_extra_repr()
    • ConcatAggregationCombination
      • ConcatAggregationCombination
        • ConcatAggregationCombination.forward()
        • ConcatAggregationCombination.iter_extra_repr()
    • ConcatProjectionCombination
      • ConcatProjectionCombination
        • ConcatProjectionCombination.forward()
    • GatedCombination
      • GatedCombination
        • GatedCombination.forward()
  • Variables
    • combination_resolver
      • combination_resolver
  • Class Inheritance Diagram
• Compositions
  • Classes
    • CompositionModule
      • CompositionModule
        • CompositionModule.forward()
    • FunctionalCompositionModule
      • FunctionalCompositionModule
        • FunctionalCompositionModule.forward()
    • SubtractionCompositionModule
      • SubtractionCompositionModule
        • SubtractionCompositionModule.func()
    • MultiplicationCompositionModule
      • MultiplicationCompositionModule
        • MultiplicationCompositionModule.func()
    • CircularCorrelationCompositionModule
      • CircularCorrelationCompositionModule
        • CircularCorrelationCompositionModule.func()
  • Variables
    • composition_resolver
      • composition_resolver
  • Class Inheritance Diagram
• Perceptron
  • ConcatMLP
    • ConcatMLP.forward()
  • TwoLayerMLP
• Utilities
  • ShapeError
    • ShapeError.verify()
  • adjacency_tensor_to_stacked_matrix()
  • apply_optional_bn()
  • safe_diagonal()
  • use_horizontal_stacking()
  • hamiltonian_product()
  • multiplication_table()
  • normalize()
• NodePiece
  • pykeen.nn.node_piece Package
    • Classes
      • AnchorSearcher
        • AnchorSearcher
          • AnchorSearcher.__call__()
      • ScipySparseAnchorSearcher
        • ScipySparseAnchorSearcher
          • ScipySparseAnchorSearcher.__call__()
          • ScipySparseAnchorSearcher.bfs()
          • ScipySparseAnchorSearcher.create_adjacency()
          • ScipySparseAnchorSearcher.iter_extra_repr()
          • ScipySparseAnchorSearcher.select()
      • SparseBFSSearcher
        • SparseBFSSearcher
          • SparseBFSSearcher.__call__()
          • SparseBFSSearcher.bfs()
          • SparseBFSSearcher.create_adjacency()
          • SparseBFSSearcher.iter_extra_repr()
          • SparseBFSSearcher.select()
      • CSGraphAnchorSearcher
        • CSGraphAnchorSearcher
          • CSGraphAnchorSearcher.__call__()
          • CSGraphAnchorSearcher.topk_argpartition()
          • CSGraphAnchorSearcher.topk_argsort()
      • PersonalizedPageRankAnchorSearcher
        • PersonalizedPageRankAnchorSearcher
          • PersonalizedPageRankAnchorSearcher.__call__()
          • PersonalizedPageRankAnchorSearcher.iter_extra_repr()
          • PersonalizedPageRankAnchorSearcher.precalculate_anchor_ppr()
      • AnchorSelection
        • AnchorSelection
          • AnchorSelection.__call__()
          • AnchorSelection.filter_unique()
          • AnchorSelection.iter_extra_repr()
      • SingleSelection
        • SingleSelection
          • SingleSelection.__call__()
          • SingleSelection.rank()
      • DegreeAnchorSelection
        • DegreeAnchorSelection
          • DegreeAnchorSelection.rank()
      • MixtureAnchorSelection
        • MixtureAnchorSelection
          • MixtureAnchorSelection.__call__()
          • MixtureAnchorSelection.iter_extra_repr()
      • PageRankAnchorSelection
        • PageRankAnchorSelection
          • PageRankAnchorSelection.iter_extra_repr()
          • PageRankAnchorSelection.rank()
      • RandomAnchorSelection
        • RandomAnchorSelection
          • RandomAnchorSelection.rank()
      • Tokenizer
        • Tokenizer
          • Tokenizer.__call__()
      • RelationTokenizer
        • RelationTokenizer
          • RelationTokenizer.__call__()
      • AnchorTokenizer
        • AnchorTokenizer
          • AnchorTokenizer.__call__()
      • MetisAnchorTokenizer
        • MetisAnchorTokenizer
          • MetisAnchorTokenizer.__call__()
      • PrecomputedPoolTokenizer
        • PrecomputedPoolTokenizer
          • PrecomputedPoolTokenizer.__call__()
      • PrecomputedTokenizerLoader
        • PrecomputedTokenizerLoader
          • PrecomputedTokenizerLoader.__call__()
      • GalkinPrecomputedTokenizerLoader
        • GalkinPrecomputedTokenizerLoader
          • GalkinPrecomputedTokenizerLoader.__call__()
      • TorchPrecomputedTokenizerLoader
        • TorchPrecomputedTokenizerLoader
          • TorchPrecomputedTokenizerLoader.__call__()
          • TorchPrecomputedTokenizerLoader.save()
      • TokenizationRepresentation
        • TokenizationRepresentation
          • TokenizationRepresentation.num_tokens
          • TokenizationRepresentation.from_tokenizer()
          • TokenizationRepresentation.iter_extra_repr()
          • TokenizationRepresentation.save_assignment()
      • NodePieceRepresentation
        • NodePieceRepresentation
          • NodePieceRepresentation.estimate_diversity()
      • HashDiversityInfo
        • HashDiversityInfo
          • HashDiversityInfo.uniques_per_representation
          • HashDiversityInfo.uniques_total
    • Variables
      • anchor_searcher_resolver
        • anchor_searcher_resolver
      • anchor_selection_resolver
        • anchor_selection_resolver
      • tokenizer_resolver
        • tokenizer_resolver
      • precomputed_tokenizer_loader_resolver
        • precomputed_tokenizer_loader_resolver
    • Class Inheritance Diagram
• Text Encoders
  • Classes
    • TextCache
      • TextCache
        • TextCache.get_texts()
        • TextCache.get_texts_dict()
    • IdentityCache
      • IdentityCache
        • IdentityCache.get_texts()
    • PyOBOTextCache
      • PyOBOTextCache
        • PyOBOTextCache.get_texts()
    • WikidataTextCache
      • WikidataTextCache
        • WikidataTextCache.HEADERS
        • WikidataTextCache.WIKIDATA_ENDPOINT
        • WikidataTextCache.get_descriptions()
        • WikidataTextCache.get_labels()
        • WikidataTextCache.get_labels_dict()
        • WikidataTextCache.get_texts()
        • WikidataTextCache.query()
        • WikidataTextCache.query_text()
        • WikidataTextCache.verify_ids()
    • TextEncoder
      • TextEncoder
        • TextEncoder.encode_all()
        • TextEncoder.forward()
        • TextEncoder.forward_normalized()
    • CharacterEmbeddingTextEncoder
      • CharacterEmbeddingTextEncoder
        • CharacterEmbeddingTextEncoder.forward_normalized()
    • TransformerTextEncoder
      • TransformerTextEncoder
        • TransformerTextEncoder.forward_normalized()
  • Variables
    • text_cache_resolver
      • text_cache_resolver
    • text_encoder_resolver
      • text_encoder_resolver
  • Class Inheritance Diagram
• Vision Encoders
  • Classes
    • VisionDataset
      • VisionDataset
    • VisualRepresentation
      • VisualRepresentation
    • WikidataVisualRepresentation
      • WikidataVisualRepresentation
        • WikidataVisualRepresentation.from_dataset()
        • WikidataVisualRepresentation.from_triples_factory()
  • Class Inheritance Diagram
• Meta-components
  • Classes
    • MLPTransformedRepresentation
      • MLPTransformedRepresentation
    • FeatureEnrichedEmbedding
      • FeatureEnrichedEmbedding
  • Class Inheritance Diagram