Skip to content

Commit

Permalink
Update the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MalcolmMielle authored and mariamhegazy committed Mar 14, 2024
1 parent 4343681 commit d1097f7
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
11 changes: 4 additions & 7 deletions thermo_nerf/thermal_nerf/thermal_field.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,12 @@


class ThermalFieldHead(BaseThermalFieldHead):
"""Thermal output
Args:
num_classes: Number of semantic classes
in_dim: input dimension. If not defined in constructor, it must be set later.
activation: output head activation
"""
"""Thermal output"""

def __init__(self, in_dim: int | None = None) -> None:
"""`in_dim` is the input dimension. If not defined in the constructor,
it must be set later.
"""
super().__init__(
in_dim=in_dim,
out_dim=1,
Expand Down
13 changes: 8 additions & 5 deletions thermo_nerf/thermal_nerf/thermal_field_head.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ def __init__(
in_dim: Optional[int] = None,
activation: Optional[Union[nn.Module, Callable]] = None,
) -> None:
"""`out_dim` represents the output dimension for the renderer.
`field_head_name` is the type of field output.
`in_dim` is the input dimension. If not defined in the constructor, it must be
set later. `activation` is the output head activation."""
super().__init__()
self.out_dim = out_dim
self.activation = activation
Expand All @@ -49,13 +53,12 @@ def _construct_net(self):
def forward(
self, in_tensor: Shaped[Tensor, "*bs in_dim"]
) -> Shaped[Tensor, "*bs out_dim"]:
"""Process network output for renderer
"""
Process network output for renderer
Args:
in_tensor: Network input
`in_tensor` is the network input.
Returns:
Render head output
:return: Render head output
"""
if not self.net:
raise SystemError(
Expand Down

0 comments on commit d1097f7

Please sign in to comment.