Model
=====

.. currentmodule:: pykeen.models

.. autoclass:: Model
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Model.device
      ~Model.loss_default_kwargs
      ~Model.num_parameter_bytes
      ~Model.num_parameters
      ~Model.num_real_relations

   .. rubric:: Methods Summary

   .. autosummary::

      ~Model.collect_regularization_term
      ~Model.get_grad_params
      ~Model.load_state
      ~Model.post_forward_pass
      ~Model.post_parameter_update
      ~Model.predict
      ~Model.predict_h
      ~Model.predict_hrt
      ~Model.predict_r
      ~Model.predict_t
      ~Model.reset_parameters_
      ~Model.save_state
      ~Model.score_h
      ~Model.score_h_inverse
      ~Model.score_hrt
      ~Model.score_hrt_inverse
      ~Model.score_r
      ~Model.score_t
      ~Model.score_t_inverse

   .. rubric:: Attributes Documentation

   .. autoattribute:: device
   .. autoattribute:: loss_default_kwargs
   .. autoattribute:: num_parameter_bytes
   .. autoattribute:: num_parameters
   .. autoattribute:: num_real_relations

   .. rubric:: Methods Documentation

   .. automethod:: collect_regularization_term
   .. automethod:: get_grad_params
   .. automethod:: load_state
   .. automethod:: post_forward_pass
   .. automethod:: post_parameter_update
   .. automethod:: predict
   .. automethod:: predict_h
   .. automethod:: predict_hrt
   .. automethod:: predict_r
   .. automethod:: predict_t
   .. automethod:: reset_parameters_
   .. automethod:: save_state
   .. automethod:: score_h
   .. automethod:: score_h_inverse
   .. automethod:: score_hrt
   .. automethod:: score_hrt_inverse
   .. automethod:: score_r
   .. automethod:: score_t
   .. automethod:: score_t_inverse