Fix some typing problems (#1940)

* Fix some typing problems

* nerfstudio.data typing error fixes

* Add tiny fixes

* Remove ABC from pipeline

* Prevent circular imports

* Tweak ModuleList typing

* TrainingCallbackAttributes cleanup

* Various minor nits

* More nits

* Run `ruff`

---------

Co-authored-by: Brent Yi <yibrenth@gmail.com>
This commit is contained in:
Jonáš KulhánekandBrent Yi authored and GitHub committed 2023-05-17 17:36:56 -07:00
1 parent c6111e377e
commit f481f5ebec
27 files changed
+154 -75

No files matched your search

+14 -10
View File
@@ -16,13 +16,14 @@
Collection of Losses.
"""
from enum import Enum
from typing import Dict, Literal, Optional, TypeVar, cast
from typing import Dict, Literal, Optional, Tuple, cast
import torch
from jaxtyping import Bool, Float
from torch import Tensor, nn
from nerfstudio.cameras.rays import RaySamples
from nerfstudio.field_components.field_heads import FieldHeadNames
from nerfstudio.utils.math import masked_reduction, normalized_depth_scale_and_shift
L1Loss = nn.L1Loss
@@ -103,7 +104,7 @@ def ray_samples_to_sdist(ray_samples):
return sdist
def interlevel_loss(weights_list, ray_samples_list):
def interlevel_loss(weights_list, ray_samples_list) -> torch.Tensor:
"""Calculates the proposal loss in the MipNeRF-360 paper.
https://github.com/kakaobrain/NeRF-Factory/blob/f61bb8744a5cb4820a4d968fb3bfbed777550f4a/src/model/mipnerf360/model.py#L515
@@ -111,12 +112,16 @@ def interlevel_loss(weights_list, ray_samples_list):
"""
c = ray_samples_to_sdist(ray_samples_list[-1]).detach()
w = weights_list[-1][..., 0].detach()
assert len(ray_samples_list) > 0
loss_interlevel = 0.0
for ray_samples, weights in zip(ray_samples_list[:-1], weights_list[:-1]):
sdist = ray_samples_to_sdist(ray_samples)
cp = sdist # (num_rays, num_samples + 1)
wp = weights[..., 0] # (num_rays, num_samples)
loss_interlevel += torch.mean(lossfun_outer(c, w, cp, wp))
assert isinstance(loss_interlevel, Tensor)
return loss_interlevel
@@ -398,7 +403,8 @@ class GradientLoss(nn.Module):
Returns:
gradient loss based on reduction function
"""
total = 0
assert self.__scales >= 1
total = 0.0
for scale in range(self.__scales):
step = pow(2, scale)
@@ -410,7 +416,8 @@ class GradientLoss(nn.Module):
)
total += grad_loss
return cast(Tensor, total)
assert isinstance(total, Tensor)
return total
def gradient_loss(
self,
@@ -534,12 +541,9 @@ class _GradientScaler(torch.autograd.Function): # typing: ignore
return output_grad * scaling, grad_scaling
K = TypeVar("K")
def scale_gradients_by_distance_squared(
field_outputs: Dict[K, torch.Tensor], ray_samples: RaySamples
) -> Dict[K, torch.Tensor]:
field_outputs: Dict[FieldHeadNames, torch.Tensor], ray_samples: RaySamples
) -> Dict[FieldHeadNames, torch.Tensor]:
"""
Scale gradients by the ray distance to the pixel
as suggested in `Radiance Field Gradient Scaling for Unbiased Near-Camera Training` paper
@@ -554,5 +558,5 @@ def scale_gradients_by_distance_squared(
ray_dist = (ray_samples.frustums.starts + ray_samples.frustums.ends) / 2
scaling = torch.square(ray_dist).clamp(0, 1)
for key, value in field_outputs.items():
out[key], _ = _GradientScaler.apply(value, scaling)
out[key], _ = cast(Tuple[Tensor, Tensor], _GradientScaler.apply(value, scaling))
return out
@@ -32,6 +32,8 @@ class RayGenerator(nn.Module):
pose_optimizer: pose optimization module, for optimizing noisy camera intrinsics/extrinsics.
"""
image_coords: Tensor
def __init__(self, cameras: Cameras, pose_optimizer: CameraOptimizer) -> None:
super().__init__()
self.cameras = cameras
+20 -6
View File
@@ -17,7 +17,7 @@ Collection of sampling strategies
"""
from abc import abstractmethod
from typing import Callable, List, Optional, Tuple, Union
from typing import Callable, List, Optional, Protocol, Tuple, Union
import torch
from jaxtyping import Float
@@ -277,7 +277,7 @@ class PDFSampler(Sampler):
self,
ray_bundle: Optional[RayBundle] = None,
ray_samples: Optional[RaySamples] = None,
weights: Float[Tensor, "*batch num_samples 1"] = None,
weights: Optional[Float[Tensor, "*batch num_samples 1"]] = None,
num_samples: Optional[int] = None,
eps: float = 1e-5,
) -> RaySamples:
@@ -296,6 +296,7 @@ class PDFSampler(Sampler):
if ray_samples is None or ray_bundle is None:
raise ValueError("ray_samples and ray_bundle must be provided")
assert weights is not None, "weights must be provided"
num_samples = num_samples or self.num_samples
assert num_samples is not None
@@ -371,6 +372,17 @@ class PDFSampler(Sampler):
return ray_samples
class DensityFn(Protocol):
"""
Function that evaluates density at a given point.
"""
def __call__(
self, positions: Float[Tensor, "*batch 3"], times: Optional[Float[Tensor, "*batch 1"]] = None
) -> Float[Tensor, "*batch 1"]:
...
class VolumetricSampler(Sampler):
"""Sampler inspired by the one proposed in the Instant-NGP paper.
Generates samples along a ray by sampling the occupancy field.
@@ -385,8 +397,8 @@ class VolumetricSampler(Sampler):
def __init__(
self,
occupancy_grid: OccGridEstimator,
density_fn: Optional[Callable[[Float[Tensor, "*batch 3"]], Float[Tensor, "*batch 1"]]] = None,
) -> None:
density_fn: Optional[DensityFn] = None,
):
super().__init__()
assert occupancy_grid is not None
self.density_fn = density_fn
@@ -523,7 +535,7 @@ class ProposalNetworkSampler(Sampler):
def __init__(
self,
num_proposal_samples_per_ray: Tuple[int] = (64,),
num_proposal_samples_per_ray: Tuple[int, ...] = (64,),
num_nerf_samples_per_ray: int = 32,
num_proposal_network_iterations: int = 2,
single_jitter: bool = False,
@@ -634,7 +646,7 @@ class NeuSSampler(Sampler):
def generate_ray_samples(
self,
ray_bundle: Optional[RayBundle] = None,
sdf_fn: Optional[Callable] = None,
sdf_fn: Optional[Callable[[RaySamples], torch.Tensor]] = None,
ray_samples: Optional[RaySamples] = None,
) -> Union[Tuple[RaySamples, torch.Tensor], RaySamples]:
assert ray_bundle is not None
@@ -647,6 +659,7 @@ class NeuSSampler(Sampler):
total_iters = 0
sorted_index = None
sdf: Optional[torch.Tensor] = None
new_samples = ray_samples
base_variance = self.base_variance
@@ -657,6 +670,7 @@ class NeuSSampler(Sampler):
# merge sdf predictions
if sorted_index is not None:
assert sdf is not None
sdf_merge = torch.cat([sdf.squeeze(-1), new_sdf.squeeze(-1)], -1)
sdf = torch.gather(sdf_merge, 1, sorted_index).unsqueeze(-1)
else: