config_help.md

October 15, 2024 ยท View on GitHub

Important configuration options for inference.py:

1. General configs

ConfigurationdefaultExplanation
--image_dir'./test/images/fruit.png'Image file path
--out_dir'./output'Output directory
--device'cuda:0'The device to use
--exp_nameNoneExperiment name, use image file name by default

2. Point cloud render configs

The definition of world coordinate system and tips for adjusting point cloud render configs are illustrated in render document.

ConfigurationdefaultExplanation
--mode'single_view_txt'Currently we support 'single_view_txt' and 'single_view_target'
--traj_txtNoneRequired for 'single_view_txt' mode, a txt file that specify camera trajectory
--elevation5.The elevation angle of the input image in degree. Estimate a rough value based on your visual judgment
--center_scale1.Scale factor for the spherical radius (r). By default, r is set to the depth value of the center pixel (H//2, W//2) of the reference image
--d_theta10.Required for 'single_view_target' mode, specify target theta angle as (theta + d_theta)
--d_phi30.Required for 'single_view_target' mode, specify target phi angle as (phi + d_phi)
--d_r-.2Required for 'single_view_target' mode, specify target radius as (r + r*dr)
--bg_trd0.2Range from [0,1). Required for 'sparse_view_interp' mode, higher values will produce a cleaner point cloud but may create holes in the background

3. Diffusion configs

ConfigurationdefaultExplanation
--ckpt_path'./checkpoints/ViewCrafter_25.ckpt'Checkpoint path
--config'./configs/inference_pvd_1024.yaml'Config (yaml) path
--ddim_steps50Steps of ddim if positive, otherwise use DDPM, reduce to 10 to speed up inference
--ddim_eta1.0Eta for ddim sampling (0.0 yields deterministic sampling)
--bs1Batch size for inference, should be one
--height576Image height, in pixel space
--width1024Image width, in pixel space
--frame_stride10Fixed
--unconditional_guidance_scale7.5Prompt classifier-free guidance
--seed123Seed for seed_everything
--video_length25Inference video length, change to 16 if you use 16 frame model
--negative_promptFalseUnused
--text_inputFalseUnused
--prompt'Rotating view of a scene'Fixed
--multiple_cond_cfgFalseUse multi-condition cfg or not
--cfg_imgNoneGuidance scale for image conditioning
--timestep_spacing"uniform_trailing"The way the timesteps should be scaled. Refer to Table 2 of the Common Diffusion Noise Schedules and Sample Steps are Flawed for more information.
--guidance_rescale0.7Guidance rescale in Common Diffusion Noise Schedules and Sample Steps are Flawed
--perframe_aeTrueIf we use per-frame AE decoding, set it to True to save GPU memory, especially for the model of 576x1024
--n_samples1Num of samples per prompt