zipnerf/train.py at main · Squadrones/zipnerf · GitHub

History

557 lines (493 loc) · 20.6 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

# coding=utf-8

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

"""Training script for mipNeRF360."""

import functools

import gc

import os

import time

from absl import app

from absl import logging

import chex

import flax

from flax.metrics import tensorboard

from flax.training import checkpoints

import gin

from internal import camera_utils

from internal import configs

from internal import datasets

from internal import image_utils

from internal import models

from internal import train_utils

from internal import utils

from internal import vis

import jax

from jax import random

import jax.numpy as jnp

import jaxcam

import numpy as np

os.environ['XLA_PYTHON_CLIENT_MEM_FRACTION'] = '0.65'

configs.define_common_flags()

jax.config.parse_flags_with_absl()

TIME_PRECISION = 1000 # Internally represent integer times in milliseconds.

def plot_camera_metrics(

summary_writer,

camera_params,

train_cameras,

train_cameras_gt,

config,

step,

tag,

plot_param_stats = False,

"""Plots camera statistics to TensorBoard."""

camera_delta = config.camera_delta_cls()

optimized_cameras: jaxcam.Camera = camera_delta.apply(

camera_params, train_cameras

)

diffs = camera_utils.compute_camera_metrics(

train_cameras_gt, optimized_cameras

)

reduce_fns = {

'mean': np.mean,

'max': np.max,

'min': np.min,

'std': np.std,

}

for reduce_name, reduce_fn in reduce_fns.items():

for stat_name, stat in diffs.items():

summary_writer.scalar(

f'train_camera_{tag}_{reduce_name}/{stat_name}',

reduce_fn(np.array(stat)),

step=step,

)

# Plot the camera parameter statistics.

if plot_param_stats:

# These should all be scalars.

stat_targets = {

'principal_point': np.linalg.norm(

optimized_cameras.principal_point, axis=-1

'focal_length': optimized_cameras.focal_length,

}

if optimized_cameras.has_radial_distortion:

stat_targets.update({

'radial_distortion_0': optimized_cameras.radial_distortion[Ellipsis, 0],

'radial_distortion_1': optimized_cameras.radial_distortion[Ellipsis, 1],

'radial_distortion_2': optimized_cameras.radial_distortion[Ellipsis, 2],

'radial_distortion_3': optimized_cameras.radial_distortion[Ellipsis, 3],

})

for reduce_name, reduce_fn in reduce_fns.items():

for stat_name, target_param in stat_targets.items():

summary_writer.scalar(

f'train_camera_stats_{reduce_name}/{stat_name}',

reduce_fn(np.array(target_param)),

step=step,

)

def main(unused_argv):

config = configs.load_config()

rng = random.PRNGKey(config.jax_rng_seed)

# Shift the numpy random seed by host_id() to shuffle data loaded by different

# hosts.

np.random.seed(config.np_rng_seed + jax.host_id())

if config.disable_pmap_and_jit:

chex.fake_pmap_and_jit().start()

if config.batch_size % jax.device_count() != 0:

raise ValueError('Batch size must be divisible by the number of devices.')

dataset = datasets.load_dataset('train', config.data_dir, config)

if config.train_render_every > 0:

test_dataset = datasets.load_dataset('test', config.data_dir, config)

test_raybatcher = datasets.RayBatcher(test_dataset)

if config.rawnerf_mode:

postprocess_fn = test_dataset.metadata['postprocess_fn']

else:

postprocess_fn = lambda z, _=None: z

np_to_jax = lambda x: jnp.array(x) if isinstance(x, np.ndarray) else x

cameras = dataset.get_train_cameras(config)

cameras = jax.tree_util.tree_map(np_to_jax, cameras)

cameras_replicated = flax.jax_utils.replicate(cameras)

rng, key = random.split(rng)

model, state, render_eval_pfn, train_pstep, lr_fn = train_utils.setup_model(

config, key, dataset=dataset

)

def fn(x):

return x.shape if isinstance(x, jnp.ndarray) else train_utils.tree_len(x)

param_summary = train_utils.summarize_tree(fn, state.params['params'])

num_chars = max([len(x) for x in param_summary])

logging.info('Optimization parameter sizes/counts:')

for k, v in param_summary.items():

logging.info('%s %s', k.ljust(num_chars), str(v))

if dataset.size > model.num_glo_embeddings and model.num_glo_features > 0:

raise ValueError(

f'Number of glo embeddings {model.num_glo_embeddings} '

'must be at least equal to number of train images '

f'{dataset.size}'

)

metric_harness = image_utils.MetricHarness(

**config.metric_harness_train_config

)

if not utils.isdir(config.checkpoint_dir):

utils.makedirs(config.checkpoint_dir)

state = checkpoints.restore_checkpoint(config.checkpoint_dir, state)

# Resume training at the step of the last checkpoint.

init_step = state.step + 1

state = flax.jax_utils.replicate(state)

if jax.host_id() == 0:

summary_writer = tensorboard.SummaryWriter(

config.checkpoint_dir, auto_flush=False

)

summary_writer.text(

'gin_config', gin.config.markdown(gin.operative_config_str()), step=0

)

if config.rawnerf_mode:

for name, data in zip(['train', 'test'], [dataset, test_dataset]):

# Log shutter speed metadata in TensorBoard for debug purposes.

for key in ['exposure_idx', 'exposure_values', 'unique_shutters']:

summary_writer.text(f'{name}_{key}', str(data.metadata[key]), 0)

# Prefetch_buffer_size = 3 x batch_size.

raybatcher = datasets.RayBatcher(dataset)

p_raybatcher = flax.jax_utils.prefetch_to_device(raybatcher, 3)

rng = rng + jax.host_id() # Make random seed separate across hosts.

rngs = random.split(rng, jax.local_device_count()) # For pmapping RNG keys.

gc.disable() # Disable automatic garbage collection for efficiency.

total_time = 0

total_steps = 0

reset_stats = True

if config.early_exit_steps is not None:

num_steps = config.early_exit_steps

else:

num_steps = config.max_steps

for step in range(init_step, num_steps + 1):

with jax.profiler.StepTraceAnnotation('train', step_num=step):

batch = next(p_raybatcher)

if reset_stats and (jax.host_id() == 0):

stats_buffer = []

train_start_time = time.time()

reset_stats = False

learning_rate = lr_fn(step)

train_frac = jnp.clip((step - 1) / (config.max_steps - 1), 0, 1)

state, stats, rngs = train_pstep(rngs, state, batch, cameras, train_frac) # pytype: disable=wrong-arg-types # jnp-type

if step % config.gc_every == 0:

gc.collect() # Disable automatic garbage collection for efficiency.

# Log training summaries. This is put behind a host_id check because in

# multi-host evaluation, all hosts need to run inference even though we

# only use host 0 to record results.

if jax.host_id() == 0:

stats = flax.jax_utils.unreplicate(stats)

stats_buffer.append(stats)

if step == init_step or step % config.print_every == 0:

elapsed_time = time.time() - train_start_time

steps_per_sec = config.print_every / elapsed_time

rays_per_sec = config.batch_size * steps_per_sec

# A robust approximation of training time in case of pre-emption.

total_time += int(round(TIME_PRECISION * elapsed_time))

total_steps += config.print_every

approx_total_time = int(round(step * total_time / total_steps))

# Transpose and stack stats_buffer along axis 0.

fs = [

flax.traverse_util.flatten_dict(s, sep='/') for s in stats_buffer

]

stats_stacked = {

k: jnp.stack([f[k] for f in fs]) for k in fs[0].keys()

}

# Split every statistic that isn't a vector into a set of statistics.

stats_split = {}

for k, v in stats_stacked.items():

if v.ndim not in [1, 2] and v.shape[0] != len(stats_buffer):

raise ValueError('statistics must be of size [n], or [n, k].')

if v.ndim == 1:

stats_split[k] = v

elif v.ndim == 2:

# The "ray_" stats are vectors of percentiles, which we would like

# to log as a single histogram and so shouldn't be broken up.

if k.startswith('ray_'):

stats_split[k] = v

else:

for i, vi in enumerate(tuple(v.T)):

stats_split[f'{k}/{i}'] = vi

if config.debug_mode:

# Summarize the entire histogram of each statistic.

for k, v in stats_split.items():

summary_writer.histogram('train_' + k, v, step)

# Take the mean and max of each statistic since the last summary.

# We don't bother logging the average and max "ray_" stats as they are

# unlikely to be informative.

kv = [

(k, v) for k, v in stats_split.items() if not k.startswith('ray_')

]

avg_stats = {k: jnp.mean(v) for k, v in kv}

max_stats = {k: jnp.max(v) for k, v in kv}

summ_fn = lambda s, v: summary_writer.scalar(s, v, step) # pylint:disable=cell-var-from-loop

# Summarize the mean and max of each statistic.

for k, v in avg_stats.items():

summ_fn(f'train_avg_{k}', v)

for k, v in max_stats.items():

summ_fn(f'train_max_{k}', v)

n = sum([np.prod(np.array(v)) for v in param_summary.values()])

summ_fn('num_params', n)

for k, v in param_summary.items():

summ_fn(f'num_params/{k}', np.prod(np.array(v)))

summ_fn('train_num_devices', len(jax.local_devices()))

summ_fn('train_learning_rate', learning_rate)

summ_fn('train_steps_per_sec', steps_per_sec)

summ_fn('train_rays_per_sec', rays_per_sec)

for tag in ['psnr', 'loss']:

summary_writer.scalar(

f'train_avg_{tag}_timed',

avg_stats[tag],

total_time // TIME_PRECISION,

)

summary_writer.scalar(

f'train_avg_{tag}_timed_approx',

avg_stats[tag],

approx_total_time // TIME_PRECISION,

)

if config.optimize_cameras and step % config.print_camera_every == 0:

plot_camera_metrics(

summary_writer=summary_writer,

step=step,

train_cameras=dataset.jax_cameras,

train_cameras_gt=dataset.jax_cameras,

config=config,

camera_params=flax.jax_utils.unreplicate(

state.params['camera_params']

tag='diff',

plot_param_stats=True,

)

plot_camera_metrics(

summary_writer=summary_writer,

step=step,

train_cameras=dataset.get_train_cameras(

config, return_jax_cameras=True

train_cameras_gt=dataset.jax_cameras,

config=config,

camera_params=flax.jax_utils.unreplicate(

state.params['camera_params']

tag='error',

)

if dataset.metadata is not None and model.learned_exposure_scaling:

params = state.params['params']

scalings = params['exposure_scaling_offsets']['embedding'][0]

num_shutter_speeds = dataset.metadata['unique_shutters'].shape[0]

for i_s in range(num_shutter_speeds):

for j_s, value in enumerate(scalings[i_s]):

summary_name = f'exposure/scaling_{i_s}_{j_s}'

summary_writer.scalar(summary_name, value, step)

params = state.params['params']

for key in params:

if 'beta' in params[key]:

summ_fn('_'.join([key, 'beta']), params[key]['beta'][0])

if model.scheduled_beta:

for i_level in range(len(model.final_betas)):

beta = model.get_scheduled_beta(i_level, train_frac)

summ_fn('beta_{}'.format(i_level), beta)

precision = int(np.ceil(np.log10(config.max_steps))) + 1

avg_loss = avg_stats['loss']

avg_psnr = avg_stats['psnr']

# Grab each "losses_{x}" field and print it as "x[:4]".

# pylint:disable=g-complex-comprehension

str_losses = [

(

k[7:11],

(f'{v:0.5f}' if v >= 1e-4 and v < 10 else f'{v:0.1e}'),

)

for k, v in avg_stats.items()

if k.startswith('losses/')

]

msg = (

f'%{precision}d/%d: loss=%0.5f, psnr=%6.3f, lr=%0.2e | '

+ ', '.join([f'{k}={s}' for k, s in str_losses])

+ ', %0.0f r/s'

)

logging.info(

msg,

step,

config.max_steps,

avg_loss,

avg_psnr,

learning_rate,

rays_per_sec,

)

# Reset everything we are tracking between summarizations.

reset_stats = True

if (config.visualize_every > 0) and (

step == 1 or step % config.visualize_every == 0

vis_start_time = time.time()

# Log histogram statistics for all trainable model parameters.

params = flax.jax_utils.unreplicate(state.params['params'])

params_flat = flax.traverse_util.flatten_dict(params)

for name_tuple, param in params_flat.items():

ps = np.percentile(

np.array(param.flatten()), np.linspace(0, 100, 101)

)

summary_writer.histogram('/'.join(name_tuple), ps, step)

# If we're running an NGP model, summarize the histogram of features

# at each scale and visualize x/y/z center-slices of each grid.

for name_tuple, param in params_flat.items():

tag = '/'.join(('param',) + name_tuple)

is_grid = name_tuple[-1].startswith('grid_')

is_hash = name_tuple[-1].startswith('hash_')

if is_grid or is_hash:

fig_array = image_utils.render_histogram(

jax.device_get(param).flatten(), bins=128, log=True

)

summary_writer.image(tag + '_loghist', fig_array, step)

if is_grid:

tag = '/'.join(('param',) + name_tuple)

for d in range(param.shape[-1]):

x_slice = param[param.shape[0] // 2, :, :, d]

y_slice = param[:, param.shape[1] // 2, :, d]

z_slice = param[:, :, param.shape[2] // 2, d]

vis_fn = vis.colorize

summary_writer.image(tag + f'/x{d}', vis_fn(x_slice), step)

summary_writer.image(tag + f'/y{d}', vis_fn(y_slice), step)

summary_writer.image(tag + f'/z{d}', vis_fn(z_slice), step)

for mlp_name in params:

# Visualize the learned vignette map, and its normalized log.

ngp_key = 'VignetteWeights'

if ngp_key in params[mlp_name]:

coords = jnp.stack(

jnp.meshgrid(*[jnp.linspace(-0.5, 0.5, 64)] * 2), axis=-1

)

weights = params[mlp_name][ngp_key]

vignette = image_utils.compute_vignette(coords, weights)

summary_writer.histogram(

'train_vignette', vignette.flatten(), step

)

tag = '/'.join(['param', mlp_name, ngp_key])

summary_writer.image(tag, vignette, step)

normalize = lambda x: (x - jnp.min(x)) / (jnp.max(x) - jnp.min(x))

summary_writer.image(

tag + '_normalized', normalize(vignette), step

)

logging.info(

'Model visualized in %0.3fs',

time.time() - vis_start_time,

)

if (step == 1 and config.checkpoint_init) or (

step % config.checkpoint_every == 0

checkpoints.save_checkpoint_multiprocess(

config.checkpoint_dir,

jax.device_get(flax.jax_utils.unreplicate(state)),

int(step),

keep=config.checkpoint_keep,

)

# Test-set evaluation.

if (

config.train_render_every > 0

and step % config.train_render_every == 0

# We reuse the same random number generator from the optimization step

# here on purpose so that the visualization matches what happened in

# training.

eval_start_time = time.time()

eval_variables = state.params # Do not unreplicate

test_case = next(test_raybatcher)

rendering = models.render_image(

functools.partial(

render_eval_pfn,

eval_variables,

train_frac,

cameras_replicated,

rays=test_case.rays,

rng=rngs[0],

config=config,

return_all_levels=True,

)

# Log eval summaries on host 0.

if jax.host_id() == 0:

eval_time = time.time() - eval_start_time

num_rays = np.prod(test_case.rays.near.shape[:-1])

rays_per_sec = num_rays / eval_time

summary_writer.scalar('test_rays_per_sec', rays_per_sec, step)

logging.info(

'Eval %d: %0.3fs., %0.0f rays/sec', step, eval_time, rays_per_sec

)

metric_start_time = time.time()

metric = metric_harness(

postprocess_fn(rendering['rgb']), postprocess_fn(test_case.rgb)

)

logging.info(

'Metrics computed in %0.3fs', time.time() - metric_start_time

)

for name, val in metric.items():

logging.info('%s = %.4f', name, val)

summary_writer.scalar('train_metrics/' + name, val, step)

residual = postprocess_fn(rendering['rgb']) - postprocess_fn(

test_case.rgb

)

summary_writer.image(

'test_residual', np.clip(residual + 0.5, 0, 1), step

)

residual_hist = image_utils.render_histogram(

np.array(residual).reshape([-1, 3]),

bins=32,

range=(-1, 1),

log=True,

color=('r', 'g', 'b'),

)

summary_writer.image('test_residual_hist', residual_hist, step)

if config.vis_decimate > 1:

d = config.vis_decimate

decimate_fn = lambda x, d=d: None if x is None else x[::d, ::d]

else:

decimate_fn = lambda x: x

rendering = jax.tree_util.tree_map(decimate_fn, rendering)

test_case = jax.tree_util.tree_map(decimate_fn, test_case)

vis_start_time = time.time()

vis_suite = vis.visualize_suite(rendering)

logging.info('Visualized in %0.3f', time.time() - vis_start_time)

if config.rawnerf_mode:

# Unprocess raw output.

vis_suite['color_raw'] = rendering['rgb']

# Autoexposed colors.

vis_suite['color_auto'] = postprocess_fn(rendering['rgb'], None)

summary_writer.image(

'test_true_auto', postprocess_fn(test_case.rgb, None), step

)

# Exposure sweep colors.

exposures = test_dataset.metadata['exposure_levels']

for p, x in list(exposures.items()):

vis_suite[f'color/{p}'] = postprocess_fn(rendering['rgb'], x)

summary_writer.image(

f'test_true_color/{p}', postprocess_fn(test_case.rgb, x), step

)

summary_writer.image('test_true_color', test_case.rgb, step)

if config.compute_normal_metrics:

summary_writer.image(

'test_true_normals', test_case.normals / 2.0 + 0.5, step

)

for k, v in vis_suite.items():

if isinstance(v, list):

for ii, vv in enumerate(v):

summary_writer.image(f'test_output_{k}/{ii}', vv, step)

else:

summary_writer.image(f'test_output_{k}', v, step)

if config.max_steps % config.checkpoint_every != 0:

checkpoints.save_checkpoint_multiprocess(

config.checkpoint_dir,

jax.device_get(flax.jax_utils.unreplicate(state)),

int(config.max_steps),

keep=config.checkpoint_keep,

)

if __name__ == '__main__':

with gin.config_scope('train'):

app.run(main)

zipnerf/train.py at main · Squadrones/zipnerf · GitHub

Expand file tree

Breadcrumbs

train.py

Latest commit

History

Breadcrumbs

train.py

File metadata and controls