Commit 2f09cad8 authored by Artem Pulkin's avatar Artem Pulkin

ml: docstrings fixed

parent d58c62dd
Pipeline #43951 passed with stage
in 2 minutes and 27 seconds
...@@ -913,7 +913,7 @@ class Normalization: ...@@ -913,7 +913,7 @@ class Normalization:
Returns Returns
------- -------
result : torch.Tensor result : torch.Tensor
The resulting counts. A 2D tensor `[n_samples, len(per_point_datasets)]` with counts.
""" """
return torch.cat(tuple( return torch.cat(tuple(
i.mask.sum(dim=1)[:, None] i.mask.sum(dim=1)[:, None]
...@@ -1088,10 +1088,10 @@ class Normalization: ...@@ -1088,10 +1088,10 @@ class Normalization:
offset_features : bool offset_features : bool
offset_charges : bool offset_charges : bool
If True, offsets energies, descriptors, and/or charges. If True, offsets energies, descriptors, and/or charges.
scale_energy : bool scale_energy : float
scale_features : bool scale_features : float
scale_charges : bool scale_charges : float
scale_energy_gradients : bool scale_energy_gradients : float
If set scales energies, descriptors, and/or charges to the value specified. If set scales energies, descriptors, and/or charges to the value specified.
Returns Returns
......
...@@ -468,7 +468,7 @@ class SimpleClosure: ...@@ -468,7 +468,7 @@ class SimpleClosure:
A function `loss(networks, data, criterion, **loss_kwargs)` A function `loss(networks, data, criterion, **loss_kwargs)`
returning `loss_result` tuple. returning `loss_result` tuple.
dataset : Dataset dataset : Dataset
Default dataset to compute loss for. Default dataset to compute the loss for.
criterion : torch.nn.Module criterion : torch.nn.Module
Loss criterion, defaults to MSE. Loss criterion, defaults to MSE.
optimizer : torch.optim.Optimizer optimizer : torch.optim.Optimizer
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment