Skip to content

Commit

Permalink
docs: added loss function docs in generated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
laserkelvin committed Oct 7, 2024
1 parent b9d68e5 commit 91953af
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/source/training.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,3 +150,21 @@ potential difficulty in the task.

.. autoclass:: matsciml.models.base.NodeDenoisingTask
:members:


Loss functions
==============

Each task will have a default loss function that is ensured to work for that particular task.
Some tasks and datasets may need more flexibility in how training signals are computed, and
the currently implemented interface for tasks allows a dictionary mapping of task key and
loss function to be passed as a hyperparameter. In addition to the typical PyTorch losses
like ``L1Loss`` and ``MSELoss``, we also implement some loss functions based on ideas borrowed
from other repositories, such as MACE.

.. autoclass:: matsciml.models.losses.AtomWeightedMSE
:members:


.. autoclass:: matsciml.models.losses.BatchQuantileLoss
:members:

0 comments on commit 91953af

Please sign in to comment.