models.mdx 1.54 KB
Newer Older
Nathan Lambert's avatar
Nathan Lambert committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<!--Copyright 2022 The HuggingFace Team. All rights reserved.

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.
-->

# Models

Diffusers contains pretrained models for popular algorithms and modules for creating the next set of diffusion models.
The primary function of these models is to denoise an input sample, by modeling the distribution $p_\theta(\mathbf{x}_{t-1}|\mathbf{x}_t)$.
The models are built on the base class ['ModelMixin'] that is a `torch.nn.module` with basic functionality for saving and loading models both locally and from the HuggingFace hub.

Kashif Rasul's avatar
Kashif Rasul committed
19
20
## ModelMixin
[[autodoc]] ModelMixin
Nathan Lambert's avatar
Nathan Lambert committed
21

Kashif Rasul's avatar
Kashif Rasul committed
22
23
## UNet2DOutput
[[autodoc]] models.unet_2d.UNet2DOutput
Nathan Lambert's avatar
Nathan Lambert committed
24

Kashif Rasul's avatar
Kashif Rasul committed
25
26
## UNet2DModel
[[autodoc]] UNet2DModel
Nathan Lambert's avatar
Nathan Lambert committed
27

Kashif Rasul's avatar
Kashif Rasul committed
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
## UNet2DConditionOutput
[[autodoc]] models.unet_2d_condition.UNet2DConditionOutput

## UNet2DConditionModel
[[autodoc]] UNet2DConditionModel

## DecoderOutput
[[autodoc]] models.vae.DecoderOutput

## VQEncoderOutput
[[autodoc]] models.vae.VQEncoderOutput

## VQModel
[[autodoc]] VQModel

## AutoencoderKLOutput
[[autodoc]] models.vae.AutoencoderKLOutput

## AutoencoderKL
[[autodoc]] AutoencoderKL