Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
EnerGNN
Light Logo Dark Logo
  • Basics
  • Tutorial
  • Use Case Implementation
  • Glossary
  • API reference
    • Graph
      • Graph.from_dict
      • Graph.to_pickle
      • Graph.from_pickle
      • Graph.is_batch
      • Graph.is_single
      • Graph.feature_flat_array
      • Graph.pad
      • Graph.unpad
      • Graph.count_connected_components
      • Graph.offset_addresses
      • Graph.quantiles
      • HyperEdgeSet.from_dict
      • HyperEdgeSet.array
      • HyperEdgeSet.is_batch
      • HyperEdgeSet.is_single
      • HyperEdgeSet.n_obj
      • HyperEdgeSet.n_batch
      • HyperEdgeSet.port_array
      • HyperEdgeSet.port_names
      • HyperEdgeSet.feature_dict
      • HyperEdgeSet.feature_flat_array
      • HyperEdgeSet.pad
      • HyperEdgeSet.unpad
      • HyperEdgeSet.offset_addresses
      • GraphShape.from_dict
      • GraphShape.to_jsonable_dict
      • GraphShape.from_jsonable_dict
      • GraphShape.max
      • GraphShape.sum
      • GraphShape.array
      • GraphShape.is_single
      • GraphShape.is_batch
      • GraphShape.n_batch
      • collate_graphs
      • concatenate_graphs
      • get_statistics
      • separate_graphs
      • check_hyper_edge_set_dict_type
      • collate_hyper_edge_sets
      • concatenate_hyper_edge_sets
      • separate_hyper_edge_sets
      • check_dict_shape
      • build_hyper_edge_set_shape
      • dict2array
      • check_dict_or_none
      • check_no_nan
      • collate_shapes
      • max_shape
      • separate_shapes
      • sum_shapes
      • to_numpy
      • np_to_jnp
      • jnp_to_np
    • Converter
      • Converter.__call__
      • Converter.get_structure
      • ElementsConverter.__init__
      • ElementsConverter.__call__
      • ElementsConverter.get_structure
    • Model
      • GNN Core
        • GNN.__call__
        • GNN.forward_batch
      • Modules
        • Normalizer
        • Encoder
        • Coupler
        • Decoder
      • Ready-to-use GNNs
    • Problem
      • Problem.__init__
      • Problem.get_context
      • Problem.get_gradient
      • Problem.get_score
      • Problem.decision_structure
      • Problem.context_structure
      • ProblemBatch.__init__
      • ProblemBatch.get_context
      • ProblemBatch.get_gradient
      • ProblemBatch.get_score
      • ProblemBatch.decision_structure
      • ProblemBatch.context_structure
      • ProblemLoader.__init__
      • ProblemLoader.__iter__
      • ProblemLoader.__next__
      • ProblemLoader.__len__
      • ProblemLoader.context_structure
      • ProblemLoader.decision_structure
    • Trainer
      • Trainer.train
      • Trainer.run_evaluation
      • Trainer.save_checkpoint
      • Trainer.load_checkpoint
Back to top
View this page

API referenceΒΆ

The energnn API reference documentation provides a detailed description of energnn classes and methods.

  • Graph
  • Converter
  • Model
  • Problem
  • Trainer
Next
Graph
Previous
Glossary
Copyright © 2024, Balthazar Donon, Hugo Kulesza
Made with Sphinx and @pradyunsg's Furo