latest
Installation
🚀 Quick Start
PyNeuraLogic Language
Problem Definition
Understanding Rules
Model Evaluation
🦓 Module Zoo
Advanced Usage
🔬 Examples
⏱️ Benchmarks
Beyond GNNs
Hypergraph Neural Networks
Heterophily Settings
Package Reference
neuralogic
neuralogic.core
neuralogic.dataset
neuralogic.db
neuralogic.inference
neuralogic.logging
neuralogic.nn
neuralogic.optim
neuralogic.utils
PyNeuraLogic
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
A
AbstractEvaluator (class in neuralogic.nn.base)
AbstractNeuraLogic (class in neuralogic.nn.base)
Adam (class in neuralogic.optim)
add_handler() (in module neuralogic.logging)
add_hook() (Template method)
add_log_handler() (in module neuralogic.logging)
add_metadata_function() (JavaFactory method)
add_module() (Template method)
add_parametrized_function() (JavaFactory method)
add_rule() (Template method)
add_rules() (Template method)
Aggregation (class in neuralogic.core.constructs.function)
aggregation (Metadata attribute)
ALL (Level attribute)
APPNPConv (class in neuralogic.nn.module.gnn.appnp)
ArithmeticLR (class in neuralogic.optim.lr_scheduler)
arity (Predicate attribute)
atom_to_clause() (JavaFactory method)
AtomFactory (class in neuralogic.core.constructs.factories)
AtomFactory.Predicate (class in neuralogic.core.constructs.factories)
attach_activation_function() (BaseRelation method)
(WeightedRelation method)
Attention (class in neuralogic.nn.module.general.attention)
AVG (Aggregation attribute)
(Combination attribute)
avg() (in module neuralogic.nn.functional)
avg_comb() (in module neuralogic.nn.functional)
AvgPooling (class in neuralogic.nn.module.general.pooling)
B
backprop() (NeuraLogic method)
BaseRelation (class in neuralogic.core.constructs.relation)
batch_size (BuiltDataset attribute)
betas (Adam property)
body (Rule attribute)
build() (Template method)
build_dataset() (AbstractEvaluator method)
(AbstractNeuraLogic method)
(DatasetBuilder method)
build_examples() (DatasetBuilder method)
build_model() (Builder method)
build_queries() (DatasetBuilder method)
build_template_from_file() (Builder method)
Builder (class in neuralogic.core.builder)
BuiltDataset (class in neuralogic.core.builder)
BUP (Grounder attribute)
C
chain_pruning (Settings property)
(SettingsProxy property)
clear_handlers() (in module neuralogic.logging)
clone() (Template method)
COLOR (Formatter attribute)
Combination (class in neuralogic.core.constructs.function)
combination (Metadata attribute)
combine() (Metadata method)
CONCAT (Aggregation attribute)
(Combination attribute)
concat() (in module neuralogic.nn.functional)
concat_comb() (in module neuralogic.nn.functional)
CONFIG (Level attribute)
Constant (class in neuralogic.nn.init)
CONSTANT (InitializerNames attribute)
ConstantFactory (class in neuralogic.core.constructs.factories)
Converter (class in neuralogic.db)
copy() (Metadata method)
COSSIM (Combination attribute)
cossim_comb() (in module neuralogic.nn.functional)
COUNT (Aggregation attribute)
(Combination attribute)
count() (in module neuralogic.nn.functional)
count_comb() (in module neuralogic.nn.functional)
create_disconnected_proxy() (Settings method)
create_proxy() (Settings method)
CrossEntropy (class in neuralogic.nn.loss)
CROSSENTROPY (ErrorFunctionNames attribute)
CROSSSUM (Combination attribute)
crosssum_comb() (in module neuralogic.nn.functional)
CSVDataset (class in neuralogic.dataset.csv)
CSVFile (class in neuralogic.dataset.csv)
D
Data (class in neuralogic.dataset.tensor)
Dataset (class in neuralogic.dataset.logic)
DatasetBuilder (class in neuralogic.core.builder)
DBDataset (class in neuralogic.dataset.db)
DBSource (class in neuralogic.dataset.db)
debug_exporting (SettingsProxy property)
decay() (LRDecay method)
default_fact_value (SettingsProxy property)
draw() (AbstractEvaluator method)
(AbstractNeuraLogic method)
(in module neuralogic.utils.visualize)
(Template method)
draw_grounding() (in module neuralogic.utils.visualize)
draw_model() (in module neuralogic.utils.visualize)
draw_sample() (in module neuralogic.utils.visualize)
duplicit_grounding (Metadata attribute)
E
ELPRODUCT (Combination attribute)
elproduct_comb() (in module neuralogic.nn.functional)
epochs (Settings property)
(SettingsProxy property)
eps (Adam property)
error_function (Settings property)
(SettingsProxy property)
ErrorFunction (class in neuralogic.nn.loss)
ErrorFunctionNames (class in neuralogic.nn.loss)
EvaluationInferenceEngine (class in neuralogic.inference)
EXP (Transformation attribute)
exp() (in module neuralogic.nn.functional)
F
Family() (in module neuralogic.utils.data)
FileDataset (class in neuralogic.dataset.file)
FINE (Level attribute)
FINER (Level attribute)
FINEST (Level attribute)
fixed() (WeightedRelation method)
Formatter (class in neuralogic.logging)
formatter (LogHandler attribute)
forward() (NeuraLogic method)
from_args() (Sources static method)
from_iterable() (Metadata static method)
from_java() (ValueFactory static method)
from_pyg() (Data static method)
from_settings() (Sources static method)
function (BaseRelation attribute)
Function (class in neuralogic.core.constructs.function)
G
GATv2Conv (class in neuralogic.nn.module.gnn.gatv2)
GCNConv (class in neuralogic.nn.module.gnn.gcn)
GENConv (class in neuralogic.nn.module.gnn.gen)
GeometricLR (class in neuralogic.optim.lr_scheduler)
get() (AtomFactory method)
(AtomFactory.Predicate method)
(ConstantFactory method)
(Function method)
(VariableFactory method)
get_aggregation_function() (SettingsProxy method)
get_builders() (Builder static method)
get_combination_function() (SettingsProxy method)
get_conjunction() (JavaFactory method)
get_default_graphviz_path() (in module neuralogic)
get_drawing_settings() (in module neuralogic.utils.visualize)
get_empty_function() (PostgresConverter static method)
get_evaluator() (in module neuralogic.nn)
get_fact_sql_function() (Converter method)
(PostgresConverter method)
get_function() (PostgresConverter static method)
get_generic_relation() (JavaFactory method)
get_graphviz_path() (in module neuralogic.utils.visualize)
get_grounding_drawer() (in module neuralogic.utils.visualize)
get_helpers() (Converter method)
(PostgresConverter method)
get_lifted_example() (JavaFactory method)
get_lr_decay() (Optimizer method)
get_metadata() (JavaFactory method)
get_neuralogic_layer() (in module neuralogic.nn)
get_new_weight_factory() (JavaFactory method)
get_parsed_template() (Template method)
get_predicate() (AtomFactory.Predicate static method)
(JavaFactory method)
get_predicate_metadata_pair() (JavaFactory method)
get_queries() (InferenceEngine method)
get_query() (JavaFactory method)
get_relation() (JavaFactory method)
get_relation_interface_sql_function() (Converter method)
(PostgresConverter method)
get_rule() (JavaFactory method)
get_rule_aggregation_function() (Converter method)
(PostgresConverter method)
get_rule_sql_function() (Converter method)
(PostgresConverter method)
get_sample_drawer() (in module neuralogic.utils.visualize)
get_settings() (Constant method)
(Glorot method)
(He method)
(Initializer method)
(Uniform method)
get_std_functions() (Converter method)
get_template_drawer() (in module neuralogic.utils.visualize)
get_term() (JavaFactory method)
get_transformation_function() (SettingsProxy method)
get_unit_weight() (Weight static method)
get_value() (ValueFactory method)
get_valued_fact() (JavaFactory method)
get_variable_factory() (JavaFactory method)
get_weight() (JavaFactory method)
GINConv (class in neuralogic.nn.module.gnn.gin)
GINEConv (class in neuralogic.nn.module.gnn.gine)
Glorot (class in neuralogic.nn.init)
GLOROT (InitializerNames attribute)
GRINGO (Grounder attribute)
ground() (AbstractNeuraLogic method)
ground_dataset() (DatasetBuilder method)
ground_from_logic_samples() (Builder method)
ground_from_sources() (Builder method)
GroundedDataset (class in neuralogic.core.builder)
Grounder (class in neuralogic.core.enums)
grounder (Settings property)
(SettingsProxy property)
GRU (class in neuralogic.nn.module.general.gru)
H
He (class in neuralogic.nn.init)
HE (InitializerNames attribute)
head (Rule attribute)
hidden (AtomFactory.Predicate property)
(Predicate attribute)
I
IDENTITY (Transformation attribute)
identity() (in module neuralogic.nn.functional)
InferenceEngine (class in neuralogic.inference)
INFO (Level attribute)
initial_seed() (in module neuralogic)
initialize() (Adam method)
(in module neuralogic)
(Optimizer method)
(SGD method)
Initializer (class in neuralogic.nn.init)
initializer (Settings property)
(SettingsProxy property)
initializer_const (SettingsProxy property)
initializer_uniform_scale (SettingsProxy property)
InitializerNames (class in neuralogic.nn.init)
INVERSE (Transformation attribute)
inverse() (in module neuralogic.nn.functional)
is_ellipsis_templated() (Rule method)
is_fixed (WeightedRelation attribute)
is_initialized() (in module neuralogic)
is_jupyter() (in module neuralogic.utils.visualize)
is_parametrized() (Function method)
is_simple() (Glorot method)
(He method)
(Initializer method)
iso_value_compression (Settings property)
(SettingsProxy property)
J
JavaEvaluator (class in neuralogic.nn.evaluator.java)
JavaFactory (class in neuralogic.core.constructs.java_objects)
L
LEAKY_RELU (Transformation attribute)
leaky_relu() (in module neuralogic.nn.functional)
learnable (Metadata attribute)
Level (class in neuralogic.logging)
level (LogHandler attribute)
Linear (class in neuralogic.nn.module.general.linear)
literals (RuleBody attribute)
load_state_dict() (AbstractEvaluator method)
(AbstractNeuraLogic method)
(JavaEvaluator method)
(NeuraLogic method)
LOG (Transformation attribute)
log() (in module neuralogic.nn.functional)
LogHandler (class in neuralogic.logging)
Longtail (class in neuralogic.nn.init)
LONGTAIL (InitializerNames attribute)
lr (Optimizer property)
LRDecay (class in neuralogic.optim.lr_scheduler)
LSTM (class in neuralogic.nn.module.general.lstm)
LUKASIEWICZ (Transformation attribute)
lukasiewicz() (in module neuralogic.nn.functional)
M
MAGNNLinear (class in neuralogic.nn.module.meta.magnn)
MAGNNMean (class in neuralogic.nn.module.meta.magnn)
manual_seed() (in module neuralogic)
MAX (Aggregation attribute)
(Combination attribute)
max() (in module neuralogic.nn.functional)
max_comb() (in module neuralogic.nn.functional)
MaxPooling (class in neuralogic.nn.module.general.pooling)
merge_queries_with_examples() (DatasetBuilder static method)
MetaConv (class in neuralogic.nn.module.meta.meta)
Metadata (class in neuralogic.core.constructs.metadata)
metadata (PredicateMetadata attribute)
(Rule attribute)
(RuleBody attribute)
MIN (Aggregation attribute)
(Combination attribute)
min() (in module neuralogic.nn.functional)
min_comb() (in module neuralogic.nn.functional)
MLP (class in neuralogic.nn.module.general.mlp)
Mode (class in neuralogic.dataset.csv)
model (AbstractEvaluator property)
model_to_dot_source() (in module neuralogic.utils.visualize)
module
neuralogic
neuralogic.core.builder
neuralogic.core.constructs.factories
neuralogic.core.constructs.function
neuralogic.core.constructs.java_objects
neuralogic.core.constructs.metadata
neuralogic.core.constructs.predicate
neuralogic.core.constructs.relation
neuralogic.core.constructs.rule
neuralogic.core.enums
neuralogic.core.settings
neuralogic.core.settings.settings_proxy
neuralogic.core.sources
neuralogic.core.template
neuralogic.db
neuralogic.inference
neuralogic.logging
neuralogic.nn
neuralogic.nn.base
neuralogic.nn.evaluator.java
neuralogic.nn.functional
neuralogic.nn.init
neuralogic.nn.java
neuralogic.nn.loss
neuralogic.nn.torch_function
neuralogic.optim
neuralogic.optim.lr_scheduler
neuralogic.utils.data
neuralogic.utils.visualize
MSE (class in neuralogic.nn.loss)
(ErrorFunctionNames attribute)
MultiheadAttention (class in neuralogic.nn.module.general.attention)
Mutagenesis() (in module neuralogic.utils.data)
N
name (Aggregation attribute)
(Combination attribute)
(Function attribute)
(Predicate attribute)
(Transformation attribute)
name() (Optimizer method)
Nations() (in module neuralogic.utils.data)
negated (BaseRelation attribute)
neuralize() (Builder method)
(GroundedDataset method)
neuralogic
module
NeuraLogic (class in neuralogic.nn.java)
(class in neuralogic.nn.torch_function)
neuralogic.core.builder
module
neuralogic.core.constructs.factories
module
neuralogic.core.constructs.function
module
neuralogic.core.constructs.java_objects
module
neuralogic.core.constructs.metadata
module
neuralogic.core.constructs.predicate
module
neuralogic.core.constructs.relation
module
neuralogic.core.constructs.rule
module
neuralogic.core.enums
module
neuralogic.core.settings
module
neuralogic.core.settings.settings_proxy
module
neuralogic.core.sources
module
neuralogic.core.template
module
neuralogic.db
module
neuralogic.inference
module
neuralogic.logging
module
neuralogic.nn
module
neuralogic.nn.base
module
neuralogic.nn.evaluator.java
module
neuralogic.nn.functional
module
neuralogic.nn.init
module
neuralogic.nn.java
module
neuralogic.nn.loss
module
neuralogic.nn.torch_function
module
neuralogic.optim
module
neuralogic.optim.lr_scheduler
module
neuralogic.utils.data
module
neuralogic.utils.visualize
module
Neuron (class in neuralogic.core.builder)
NORM (Transformation attribute)
norm() (in module neuralogic.nn.functional)
Normal (class in neuralogic.nn.init)
NORMAL (Formatter attribute)
(InitializerNames attribute)
number_format() (SettingsProxy static method)
O
OFF (Level attribute)
Optimizer (class in neuralogic.optim)
optimizer (Settings property)
(SettingsProxy property)
output (LogHandler attribute)
P
parameters() (AbstractEvaluator method)
(AbstractNeuraLogic method)
parse_hook_name() (Neuron static method)
Pooling (class in neuralogic.nn.module.general.pooling)
PositionalEncoding (class in neuralogic.nn.module.general.positional_encoding)
PostgresConverter (class in neuralogic.db)
predicate (BaseRelation attribute)
Predicate (class in neuralogic.core.constructs.predicate)
predicate (PredicateMetadata attribute)
PredicateMetadata (class in neuralogic.core.constructs.predicate)
pretty_str() (Function method)
process_head() (Function method)
PRODUCT (Combination attribute)
product_comb() (in module neuralogic.nn.functional)
prune_only_identities (Settings property)
(SettingsProxy property)
Q
q() (EvaluationInferenceEngine method)
(InferenceEngine method)
query() (EvaluationInferenceEngine method)
(InferenceEngine method)
R
relation_combination (Settings property)
(SettingsProxy property)
relation_name (TableMapping attribute)
relation_transformation (Settings property)
(SettingsProxy property)
RELU (Transformation attribute)
relu() (in module neuralogic.nn.functional)
remove_duplicates() (Template method)
remove_hook() (Template method)
reset_parameters() (AbstractEvaluator method)
(NeuraLogic method)
ResGatedGraphConv (class in neuralogic.nn.module.gnn.res_gated)
RESHAPE (Transformation attribute)
reshape() (in module neuralogic.nn.functional)
restart() (LRDecay method)
REVERSE (Transformation attribute)
reverse() (in module neuralogic.nn.functional)
RGCNConv (class in neuralogic.nn.module.gnn.rgcn)
RNN (class in neuralogic.nn.module.general.rnn)
Rule (class in neuralogic.core.constructs.rule)
rule_aggregation (Settings property)
(SettingsProxy property)
rule_combination (Settings property)
(SettingsProxy property)
rule_head_dependant() (Function method)
rule_transformation (Settings property)
(SettingsProxy property)
RuleBody (class in neuralogic.core.constructs.rule)
run_hook() (AbstractNeuraLogic method)
RvNN (class in neuralogic.nn.module.general.rvnn)
S
SAGEConv (class in neuralogic.nn.module.gnn.gsage)
sample_to_dot_source() (in module neuralogic.utils.visualize)
samples (BuiltDataset attribute)
samples_to_examples_and_queries() (DatasetBuilder static method)
seed() (in module neuralogic)
set_arity() (Predicate method)
set_graphviz_path() (in module neuralogic)
set_hooks() (AbstractNeuraLogic method)
set_jvm_options() (in module neuralogic)
set_jvm_path() (in module neuralogic)
set_knowledge() (EvaluationInferenceEngine method)
(InferenceEngine method)
set_max_memory_size() (in module neuralogic)
set_training_samples() (NeuraLogic method)
Settings (class in neuralogic.core.settings)
SettingsProxy (class in neuralogic.core.settings.settings_proxy)
SEVERE (Level attribute)
SGConv (class in neuralogic.nn.module.gnn.sg)
SGD (class in neuralogic.optim)
SIGMOID (Transformation attribute)
sigmoid() (in module neuralogic.nn.functional)
SIGNUM (Transformation attribute)
signum() (in module neuralogic.nn.functional)
SLICE (Transformation attribute)
slice() (in module neuralogic.nn.functional)
SoftEntropy (class in neuralogic.nn.loss)
SOFTENTROPY (ErrorFunctionNames attribute)
SOFTMAX (Aggregation attribute)
(Combination attribute)
(Transformation attribute)
softmax() (in module neuralogic.nn.functional)
softmax_agg() (in module neuralogic.nn.functional)
softmax_comb() (in module neuralogic.nn.functional)
Sources (class in neuralogic.core.sources)
SPARSEMAX (Combination attribute)
(Transformation attribute)
sparsemax() (in module neuralogic.nn.functional)
sparsemax_comb() (in module neuralogic.nn.functional)
special (AtomFactory.Predicate property)
(Predicate attribute)
SQRT (Transformation attribute)
sqrt() (in module neuralogic.nn.functional)
state_dict() (AbstractEvaluator method)
(AbstractNeuraLogic method)
(JavaEvaluator method)
(NeuraLogic method)
SUM (Aggregation attribute)
(Combination attribute)
sum() (in module neuralogic.nn.functional)
sum_comb() (in module neuralogic.nn.functional)
SumPooling (class in neuralogic.nn.module.general.pooling)
sync_template() (AbstractNeuraLogic method)
T
T (BaseRelation property)
(WeightedRelation property)
table_name (TableMapping attribute)
TableMapping (class in neuralogic.db)
TAGConv (class in neuralogic.nn.module.gnn.tag)
TANH (Transformation attribute)
tanh() (in module neuralogic.nn.functional)
Template (class in neuralogic.core.template)
TensorDataset (class in neuralogic.dataset.tensor)
term_columns (TableMapping attribute)
terms (BaseRelation attribute)
test() (AbstractEvaluator method)
(JavaEvaluator method)
(NeuraLogic method)
TextIOWrapper (class in neuralogic.logging)
to_dot_source() (in module neuralogic.utils.visualize)
to_json() (SettingsProxy method)
(Sources method)
to_sql() (Converter method)
to_str() (BaseRelation method)
(Predicate method)
(Rule method)
(WeightedRelation method)
train() (AbstractEvaluator method)
(JavaEvaluator method)
(NeuraLogic method)
Trains() (in module neuralogic.utils.data)
Transformation (class in neuralogic.core.constructs.function)
transformation (Metadata attribute)
Transformer (class in neuralogic.nn.module.general.transformer)
TransformerDecoder (class in neuralogic.nn.module.general.transformer)
TransformerEncoder (class in neuralogic.nn.module.general.transformer)
TRANSP (Transformation attribute)
transp() (in module neuralogic.nn.functional)
U
Uniform (class in neuralogic.nn.init)
UNIFORM (InitializerNames attribute)
V
value_column (TableMapping attribute)
ValueFactory (class in neuralogic.core.constructs.java_objects)
VariableFactory (class in neuralogic.core.constructs.factories)
W
WARNING (Level attribute)
Weight (class in neuralogic.core.builder)
weight (WeightedRelation attribute)
weight_name (WeightedRelation attribute)
WeightedRelation (class in neuralogic.core.constructs.relation)
wrap() (Function method)
write() (TextIOWrapper method)
X
XOR() (in module neuralogic.utils.data)
XOR_Vectorized() (in module neuralogic.utils.data)
Read the Docs
v: latest
Versions
latest
dev
Downloads
On Read the Docs
Project Home
Builds