Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /main /pt /api /schedulers /ipndm.md

mishig

8 days ago

preview code

download

raw

5.93 kB

# IPNDMScheduler

`IPNDMScheduler` é um scheduler de quarta ordem do tipo Improved Pseudo Linear Multistep. A implementação original pode ser encontrada em [crowsonkb/v-diffusion-pytorch](https://github.com/crowsonkb/v-diffusion-pytorch/blob/987f8985e38208345c1959b0ea767a625831cc9b/diffusion/sampling.py#L296).

## IPNDMScheduler[[diffusers.IPNDMScheduler]]

#### diffusers.IPNDMScheduler[[diffusers.IPNDMScheduler]]

```python
diffusers.IPNDMScheduler(num_train_timesteps: int = 1000, trained_betas: numpy.ndarray | list[float] | None = None)
```

[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_ipndm.py#L24)

**Parâmetros:**

num_train_timesteps (`int`, padrão 1000) : O número de etapas de difusão para treinar o modelo.

trained_betas (`np.ndarray` ou `List[float]`, *opcional*) : Passe um array de betas diretamente para o construtor para ignorar `beta_start` e `beta_end`.
Um scheduler de passo linear pseudo melhorado de quarta ordem.
Este modelo herda de [SchedulerMixin](/docs/diffusers/main/pt/api/schedulers/overview#diffusers.SchedulerMixin) e [ConfigMixin](/docs/diffusers/main/pt/api/configuration#diffusers.ConfigMixin). Consulte a documentação da superclasse para os métodos genéricos que a biblioteca implementa para todos os agendadores, como carregamento e salvamento.
#### index_for_timestep[[diffusers.IPNDMScheduler.index_for_timestep]]
```python
index_for_timestep(timestep: typing.Union[float, torch.Tensor], schedule_timesteps: typing.Optional[torch.Tensor] = None)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_ipndm.py#L124)
**Parâmetros:**
timestep (`float` ou `torch.Tensor`) : O valor do timestep a ser encontrado no schedule.
schedule_timesteps (`torch.Tensor`, *opcional*) : O cronograma de passos de tempo a ser pesquisado. Se `None`, usa `self.timesteps`.
**Retorna:** `int`
O índice do timestep no schedule. Para o primeiro passo, retorna o segundo índice se existirem múltiplas correspondências, a fim de evitar pular um sigma ao iniciar no meio do schedule (por exemplo, para image-to-image).
Encontre o índice de um timestep específico na agenda de timesteps.
#### scale_model_input[[diffusers.IPNDMScheduler.scale_model_input]]
```python
scale_model_input(sample: Tensor, *args, **kwargs)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_ipndm.py#L228)
**Parâmetros:**

sample (`torch.Tensor`) : A amostra de entrada.

**Retorna:** `torch.Tensor`

Uma amostra de entrada escalada.

Garante a intercambiabilidade com agendadores que precisam escalar a entrada do modelo de desruidamento dependendo do passo de tempo atual.

#### set_begin_index[[diffusers.IPNDMScheduler.set_begin_index]]

```python
set_begin_index(begin_index: int = 0)
```

[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_ipndm.py#L85)

**Parâmetros:**

begin_index (`int`, padrão `0`) : O índice inicial para o agendador.
Define o índice inicial para o agendador. Esta função deve ser executada a partir do pipeline antes da inferência.
#### set_timesteps[[diffusers.IPNDMScheduler.set_timesteps]]
```python
set_timesteps(num_inference_steps: int, device: typing.Union[str, torch.device, NoneType] = None)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_ipndm.py#L95)
**Parâmetros:**
num_inference_steps (`int`) : O número de etapas de difusão usadas ao gerar amostras com um modelo pré-treinado.
device (`str` ou `torch.device`, *opcional*) : O dispositivo para o qual os timesteps devem ser movidos. Se `None`, os timesteps não são movidos.
Define os passos discretos usados para a cadeia de difusão (a ser executado antes da inferência).
#### etapa[[diffusers.IPNDMScheduler.step]]
```python
step(model_output: Tensor, timestep: typing.Union[int, torch.Tensor], sample: Tensor, return_dict: bool = True)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_ipndm.py#L170)
**Parâmetros:**
model_output (`torch.Tensor`) : A saída direta do modelo de difusão aprendido.
timestep (`int` ou `torch.Tensor`) : O passo de tempo discreto atual na cadeia de difusão.
sample (`torch.Tensor`) : Uma instância atual de uma amostra criada pelo processo de difusão.
return_dict (`bool`) : Se deve ou não retornar um [SchedulerOutput](/docs/diffusers/main/pt/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) ou uma tupla.
**Retorna:** [SchedulerOutput](/docs/diffusers/main/pt/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) ou `tuple`
Se return_dict for `True`, [SchedulerOutput](/docs/diffusers/main/pt/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) é retornado; caso contrário, uma tupla é retornada, em que o primeiro elemento é o tensor de amostras.
Preveja a amostra do passo de tempo anterior revertendo o SDE. Esta função propaga a amostra com o método multietapa linear. Ele executa uma passagem para frente várias vezes para aproximar a solução.
## SchedulerOutput[[diffusers.schedulers.scheduling_utils.SchedulerOutput]]
#### diffusers.schedulers.scheduling_utils.SchedulerOutput[[diffusers.schedulers.scheduling_utils.SchedulerOutput]]
```python
diffusers.schedulers.scheduling_utils.SchedulerOutput(prev_sample: Tensor)
```
[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_utils.py#L66)
**Parâmetros:**
prev_sample (`torch.Tensor` de forma `(batch_size, num_channels, height, width)` para imagens) : Amostra calculada `(x_{t-1})` do passo anterior. `prev_sample` deve ser usado como entrada do próximo modelo no loop de remoção de ruído.
Classe base para a saída da função `step` de um agendador.

Xet Storage Details

Size:: 5.93 kB
Xet hash:: 3e5a82d356e7cca7121cef42052ec38fd479dbb47e59ce39991d7f15b9366321

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.

	# IPNDMScheduler

	`IPNDMScheduler` é um scheduler de quarta ordem do tipo Improved Pseudo Linear Multistep. A implementação original pode ser encontrada em [crowsonkb/v-diffusion-pytorch](https://github.com/crowsonkb/v-diffusion-pytorch/blob/987f8985e38208345c1959b0ea767a625831cc9b/diffusion/sampling.py#L296).

	## IPNDMScheduler[[diffusers.IPNDMScheduler]]

	#### diffusers.IPNDMScheduler[[diffusers.IPNDMScheduler]]

	```python
	diffusers.IPNDMScheduler(num_train_timesteps: int = 1000, trained_betas: numpy.ndarray \| list[float] \| None = None)
	```

	[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_ipndm.py#L24)

	Parâmetros:

	num_train_timesteps (`int`, padrão 1000) : O número de etapas de difusão para treinar o modelo.

	trained_betas (`np.ndarray` ou `List[float]`, opcional) : Passe um array de betas diretamente para o construtor para ignorar `beta_start` e `beta_end`.

	Um scheduler de passo linear pseudo melhorado de quarta ordem.

	Este modelo herda de [SchedulerMixin](/docs/diffusers/main/pt/api/schedulers/overview#diffusers.SchedulerMixin) e [ConfigMixin](/docs/diffusers/main/pt/api/configuration#diffusers.ConfigMixin). Consulte a documentação da superclasse para os métodos genéricos que a biblioteca implementa para todos os agendadores, como carregamento e salvamento.

	#### index_for_timestep[[diffusers.IPNDMScheduler.index_for_timestep]]

	```python
	index_for_timestep(timestep: typing.Union[float, torch.Tensor], schedule_timesteps: typing.Optional[torch.Tensor] = None)
	```

	[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_ipndm.py#L124)

	Parâmetros:

	timestep (`float` ou `torch.Tensor`) : O valor do timestep a ser encontrado no schedule.

	schedule_timesteps (`torch.Tensor`, opcional) : O cronograma de passos de tempo a ser pesquisado. Se `None`, usa `self.timesteps`.

	Retorna: `int`

	O índice do timestep no schedule. Para o primeiro passo, retorna o segundo índice se existirem múltiplas correspondências, a fim de evitar pular um sigma ao iniciar no meio do schedule (por exemplo, para image-to-image).

	Encontre o índice de um timestep específico na agenda de timesteps.

	#### scale_model_input[[diffusers.IPNDMScheduler.scale_model_input]]

	```python
	scale_model_input(sample: Tensor, args, *kwargs)
	```

	[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_ipndm.py#L228)

	Parâmetros:

	sample (`torch.Tensor`) : A amostra de entrada.

	Retorna: `torch.Tensor`

	Uma amostra de entrada escalada.

	Garante a intercambiabilidade com agendadores que precisam escalar a entrada do modelo de desruidamento dependendo do passo de tempo atual.

	#### set_begin_index[[diffusers.IPNDMScheduler.set_begin_index]]

	```python
	set_begin_index(begin_index: int = 0)
	```

	[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_ipndm.py#L85)

	Parâmetros:

	begin_index (`int`, padrão `0`) : O índice inicial para o agendador.

	Define o índice inicial para o agendador. Esta função deve ser executada a partir do pipeline antes da inferência.

	#### set_timesteps[[diffusers.IPNDMScheduler.set_timesteps]]

	```python
	set_timesteps(num_inference_steps: int, device: typing.Union[str, torch.device, NoneType] = None)
	```

	[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_ipndm.py#L95)

	Parâmetros:

	num_inference_steps (`int`) : O número de etapas de difusão usadas ao gerar amostras com um modelo pré-treinado.

	device (`str` ou `torch.device`, opcional) : O dispositivo para o qual os timesteps devem ser movidos. Se `None`, os timesteps não são movidos.

	Define os passos discretos usados para a cadeia de difusão (a ser executado antes da inferência).

	#### etapa[[diffusers.IPNDMScheduler.step]]

	```python
	step(model_output: Tensor, timestep: typing.Union[int, torch.Tensor], sample: Tensor, return_dict: bool = True)
	```

	[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_ipndm.py#L170)

	Parâmetros:

	model_output (`torch.Tensor`) : A saída direta do modelo de difusão aprendido.

	timestep (`int` ou `torch.Tensor`) : O passo de tempo discreto atual na cadeia de difusão.

	sample (`torch.Tensor`) : Uma instância atual de uma amostra criada pelo processo de difusão.

	return_dict (`bool`) : Se deve ou não retornar um [SchedulerOutput](/docs/diffusers/main/pt/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) ou uma tupla.

	Retorna: [SchedulerOutput](/docs/diffusers/main/pt/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) ou `tuple`

	Se return_dict for `True`, [SchedulerOutput](/docs/diffusers/main/pt/api/schedulers/ipndm#diffusers.schedulers.scheduling_utils.SchedulerOutput) é retornado; caso contrário, uma tupla é retornada, em que o primeiro elemento é o tensor de amostras.

	Preveja a amostra do passo de tempo anterior revertendo o SDE. Esta função propaga a amostra com o método multietapa linear. Ele executa uma passagem para frente várias vezes para aproximar a solução.

	## SchedulerOutput[[diffusers.schedulers.scheduling_utils.SchedulerOutput]]

	#### diffusers.schedulers.scheduling_utils.SchedulerOutput[[diffusers.schedulers.scheduling_utils.SchedulerOutput]]

	```python
	diffusers.schedulers.scheduling_utils.SchedulerOutput(prev_sample: Tensor)
	```

	[Fonte](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_utils.py#L66)

	Parâmetros:

	prev_sample (`torch.Tensor` de forma `(batch_size, num_channels, height, width)` para imagens) : Amostra calculada `(x_{t-1})` do passo anterior. `prev_sample` deve ser usado como entrada do próximo modelo no loop de remoção de ruído.

	Classe base para a saída da função `step` de um agendador.