LDM3D Text-to-(RGB, Depth)
Text-to-(RGB, depth)
LDM3D was proposed in LDM3D: Latent Diffusion Model for 3D by Gabriela Ben Melech Stan, Diana Wofk, Scottie Fox, Alex Redden, Will Saxton, Jean Yu, Estelle Aflalo, Shao-Yen Tseng, Fabio Nonato, Matthias Muller, and Vasudev Lal. LDM3D generates an image and a depth map from a given text prompt unlike the existing text-to-image diffusion models such as Stable Diffusion which only generates an image. With almost the same number of parameters, LDM3D achieves to create a latent space that can compress both the RGB images and the depth maps.
The abstract from the paper is:
This research paper proposes a Latent Diffusion Model for 3D (LDM3D) that generates both image and depth map data from a given text prompt, allowing users to generate RGBD images from text prompts. The LDM3D model is fine-tuned on a dataset of tuples containing an RGB image, depth map and caption, and validated through extensive experiments. We also develop an application called DepthFusion, which uses the generated RGB images and depth maps to create immersive and interactive 360-degree-view experiences using TouchDesigner. This technology has the potential to transform a wide range of industries, from entertainment and gaming to architecture and design. Overall, this paper presents a significant contribution to the field of generative AI and computer vision, and showcases the potential of LDM3D and DepthFusion to revolutionize content creation and digital experiences. A short video summarizing the approach can be found at this url.
Make sure to check out the Stable Diffusion Tips section to learn how to explore the tradeoff between scheduler speed and quality, and how to reuse pipeline components efficiently!
StableDiffusionLDM3DPipeline
class diffusers.StableDiffusionLDM3DPipeline
( vae: AutoencoderKLtext_encoder: CLIPTextModeltokenizer: CLIPTokenizerunet: UNet2DConditionModelscheduler: KarrasDiffusionSchedulerssafety_checker: StableDiffusionSafetyCheckerfeature_extractor: CLIPImageProcessorrequires_safety_checker: bool = True )
Parameters
vae (AutoencoderKL) β Variational Auto-Encoder (VAE) model to encode and decode images to and from latent representations.
text_encoder (
CLIPTextModel
) β Frozen text-encoder (clip-vit-large-patch14).tokenizer (
CLIPTokenizer
) β ACLIPTokenizer
to tokenize text.unet (UNet2DConditionModel) β A
UNet2DConditionModel
to denoise the encoded image latents.scheduler (SchedulerMixin) β A scheduler to be used in combination with
unet
to denoise the encoded image latents. Can be one of DDIMScheduler, LMSDiscreteScheduler, or PNDMScheduler.safety_checker (
StableDiffusionSafetyChecker
) β Classification module that estimates whether generated images could be considered offensive or harmful. Please refer to the model card for more details about a modelβs potential harms.feature_extractor (
CLIPImageProcessor
) β ACLIPImageProcessor
to extract features from generated images; used as inputs to thesafety_checker
.
Pipeline for text-to-image and 3D generation using LDM3D.
This model inherits from DiffusionPipeline. Check the superclass documentation for the generic methods implemented for all pipelines (downloading, saving, running on a particular device, etc.).
The pipeline also inherits the following loading methods:
load_textual_inversion() for loading textual inversion embeddings
load_lora_weights() for loading LoRA weights
save_lora_weights() for saving LoRA weights
from_single_file() for loading
.ckpt
files
__call__
( prompt: typing.Union[str, typing.List[str]] = Noneheight: typing.Optional[int] = Nonewidth: typing.Optional[int] = Nonenum_inference_steps: int = 49guidance_scale: float = 5.0negative_prompt: typing.Union[str, typing.List[str], NoneType] = Nonenum_images_per_prompt: typing.Optional[int] = 1eta: float = 0.0generator: typing.Union[torch._C.Generator, typing.List[torch._C.Generator], NoneType] = Nonelatents: typing.Optional[torch.FloatTensor] = Noneprompt_embeds: typing.Optional[torch.FloatTensor] = Nonenegative_prompt_embeds: typing.Optional[torch.FloatTensor] = Noneoutput_type: typing.Optional[str] = 'pil'return_dict: bool = Truecallback: typing.Union[typing.Callable[[int, int, torch.FloatTensor], NoneType], NoneType] = Nonecallback_steps: int = 1cross_attention_kwargs: typing.Union[typing.Dict[str, typing.Any], NoneType] = None ) β StableDiffusionPipelineOutput or tuple
Parameters
prompt (
str
orList[str]
, optional) β The prompt or prompts to guide image generation. If not defined, you need to passprompt_embeds
.height (
int
, optional, defaults toself.unet.config.sample_size * self.vae_scale_factor
) β The height in pixels of the generated image.width (
int
, optional, defaults toself.unet.config.sample_size * self.vae_scale_factor
) β The width in pixels of the generated image.num_inference_steps (
int
, optional, defaults to 50) β The number of denoising steps. More denoising steps usually lead to a higher quality image at the expense of slower inference.guidance_scale (
float
, optional, defaults to 5.0) β A higher guidance scale value encourages the model to generate images closely linked to the textprompt
at the expense of lower image quality. Guidance scale is enabled whenguidance_scale > 1
.negative_prompt (
str
orList[str]
, optional) β The prompt or prompts to guide what to not include in image generation. If not defined, you need to passnegative_prompt_embeds
instead. Ignored when not using guidance (guidance_scale < 1
).num_images_per_prompt (
int
, optional, defaults to 1) β The number of images to generate per prompt.eta (
float
, optional, defaults to 0.0) β Corresponds to parameter eta (Ξ·) from the DDIM paper. Only applies to the DDIMScheduler, and is ignored in other schedulers.generator (
torch.Generator
orList[torch.Generator]
, optional) β Atorch.Generator
to make generation deterministic.latents (
torch.FloatTensor
, optional) β Pre-generated noisy latents sampled from a Gaussian distribution, to be used as inputs for image generation. Can be used to tweak the same generation with different prompts. If not provided, a latents tensor is generated by sampling using the supplied randomgenerator
.prompt_embeds (
torch.FloatTensor
, optional) β Pre-generated text embeddings. Can be used to easily tweak text inputs (prompt weighting). If not provided, text embeddings are generated from theprompt
input argument.negative_prompt_embeds (
torch.FloatTensor
, optional) β Pre-generated negative text embeddings. Can be used to easily tweak text inputs (prompt weighting). If not provided,negative_prompt_embeds
are generated from thenegative_prompt
input argument.output_type (
str
, optional, defaults to"pil"
) β The output format of the generated image. Choose betweenPIL.Image
ornp.array
.return_dict (
bool
, optional, defaults toTrue
) β Whether or not to return a StableDiffusionPipelineOutput instead of a plain tuple.callback (
Callable
, optional) β A function that calls everycallback_steps
steps during inference. The function is called with the following arguments:callback(step: int, timestep: int, latents: torch.FloatTensor)
.callback_steps (
int
, optional, defaults to 1) β The frequency at which thecallback
function is called. If not specified, the callback is called at every step.cross_attention_kwargs (
dict
, optional) β A kwargs dictionary that if specified is passed along to theAttentionProcessor
as defined inself.processor
.
Returns
StableDiffusionPipelineOutput or tuple
If return_dict
is True
, StableDiffusionPipelineOutput is returned, otherwise a tuple
is returned where the first element is a list with the generated images and the second element is a list of bool
s indicating whether the corresponding generated image contains βnot-safe-for-workβ (nsfw) content.
The call function to the pipeline for generation.
Examples:
Copied
disable_vae_slicing
( )
Disable sliced VAE decoding. If enable_vae_slicing
was previously enabled, this method will go back to computing decoding in one step.
disable_vae_tiling
( )
Disable tiled VAE decoding. If enable_vae_tiling
was previously enabled, this method will go back to computing decoding in one step.
enable_vae_slicing
( )
Enable sliced VAE decoding. When this option is enabled, the VAE will split the input tensor in slices to compute decoding in several steps. This is useful to save some memory and allow larger batch sizes.
enable_vae_tiling
( )
Enable tiled VAE decoding. When this option is enabled, the VAE will split the input tensor into tiles to compute decoding and encoding in several steps. This is useful for saving a large amount of memory and to allow processing larger images.
encode_prompt
( promptdevicenum_images_per_promptdo_classifier_free_guidancenegative_prompt = Noneprompt_embeds: typing.Optional[torch.FloatTensor] = Nonenegative_prompt_embeds: typing.Optional[torch.FloatTensor] = Nonelora_scale: typing.Optional[float] = None )
Parameters
prompt (
str
orList[str]
, optional) β prompt to be encoded device β (torch.device
): torch devicenum_images_per_prompt (
int
) β number of images that should be generated per promptdo_classifier_free_guidance (
bool
) β whether to use classifier free guidance or notnegative_prompt (
str
orList[str]
, optional) β The prompt or prompts not to guide the image generation. If not defined, one has to passnegative_prompt_embeds
instead. Ignored when not using guidance (i.e., ignored ifguidance_scale
is less than1
).prompt_embeds (
torch.FloatTensor
, optional) β Pre-generated text embeddings. Can be used to easily tweak text inputs, e.g. prompt weighting. If not provided, text embeddings will be generated fromprompt
input argument.negative_prompt_embeds (
torch.FloatTensor
, optional) β Pre-generated negative text embeddings. Can be used to easily tweak text inputs, e.g. prompt weighting. If not provided, negative_prompt_embeds will be generated fromnegative_prompt
input argument.lora_scale (
float
, optional) β A lora scale that will be applied to all LoRA layers of the text encoder if LoRA layers are loaded.
Encodes the prompt into text encoder hidden states.
LDM3DPipelineOutput
class diffusers.pipelines.stable_diffusion.pipeline_stable_diffusion_ldm3d.LDM3DPipelineOutput
( rgb: typing.Union[typing.List[PIL.Image.Image], numpy.ndarray]depth: typing.Union[typing.List[PIL.Image.Image], numpy.ndarray]nsfw_content_detected: typing.Optional[typing.List[bool]] )
Parameters
rgb (
List[PIL.Image.Image]
ornp.ndarray
) β List of denoised PIL images of lengthbatch_size
or NumPy array of shape(batch_size, height, width, num_channels)
.depth (
List[PIL.Image.Image]
ornp.ndarray
) β List of denoised PIL images of lengthbatch_size
or NumPy array of shape(batch_size, height, width, num_channels)
.nsfw_content_detected (
List[bool]
) β List indicating whether the corresponding generated image contains βnot-safe-for-workβ (nsfw) content orNone
if safety checking could not be performed.
Output class for Stable Diffusion pipelines.
__call__
( *args**kwargs )
Call self as a function.
Last updated