Buckets:

hf-doc-build/doc / diffusers /main /ko /api /configuration.md
mishig's picture
|
download
raw
8.71 kB
# 구성
[SchedulerMixin](/docs/diffusers/main/ko/api/schedulers/overview#diffusers.SchedulerMixin)의 스케줄러와 [ModelMixin](/docs/diffusers/main/ko/api/models/overview#diffusers.ModelMixin)의 모델은 [ConfigMixin](/docs/diffusers/main/ko/api/configuration#diffusers.ConfigMixin)을 상속받으며, 이는 각각의 `__init__` 메서드에 전달된 모든 매개변수를 JSON 구성 파일에 저장합니다.
> [!TIP]
> 비공개 또는 [게이트](https://huggingface.co/docs/hub/models-gated#gated-models)된 모델을 사용하려면 `hf auth login`으로 로그인하세요.
## ConfigMixin[[diffusers.ConfigMixin]]
#### diffusers.ConfigMixin[[diffusers.ConfigMixin]]
```python
diffusers.ConfigMixin()
```
[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L87)
모든 구성 클래스의 기본 클래스입니다. 모든 구성 매개변수는 `self.config` 아래에 저장됩니다. 또한 [ConfigMixin](/docs/diffusers/main/ko/api/configuration#diffusers.ConfigMixin)을 상속하는 클래스를 로드, 다운로드 및 저장하기 위한 [from_config()](/docs/diffusers/main/ko/api/configuration#diffusers.ConfigMixin.from_config) 및 [save_config()](/docs/diffusers/main/ko/api/configuration#diffusers.ConfigMixin.save_config) 메서드를 제공합니다.
클래스 속성:
- **config_name** (`str`) -- [save_config()](/docs/diffusers/main/ko/api/configuration#diffusers.ConfigMixin.save_config)를 호출할 때 설정을 저장할 파일 이름입니다 (부모 클래스에서 재정의되어야 합니다).
- **ignore_for_config** (`list[str]`) -- config에 저장되지 않아야 할 속성의 목록 (서브클래스에서 재정의해야 함).
- **has_compatibles** (`bool`) -- 해당 클래스에 호환 클래스가 있는지 여부(서브클래스에서 재정의해야 합니다).
- **_deprecated_kwargs** (`list[str]`) -- 비활성화된 키워드 인자입니다. `init` 함수는 적어도 하나의 인자가 비활성화된 경우에만 `kwargs` 인자를 가져야 합니다(서브클래스에서 재정의되어야 합니다).
#### load_config[[diffusers.ConfigMixin.load_config]]
```python
load_config(pretrained_model_name_or_path: str | os.PathLike, return_unused_kwargs = False, return_commit_hash = False, **kwargs)
```
[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L322)
**매개변수:**
pretrained_model_name_or_path (`str` 또는 `os.PathLike`, *선택 사항*) : 다음 중 하나일 수 있습니다. - Hub에 호스팅된 사전 학습 모델의 *모델 ID* 문자열(예: `google/ddpm-celebahq-256`). - [save_config()](/docs/diffusers/main/ko/api/configuration#diffusers.ConfigMixin.save_config)로 저장된 모델 가중치가 포함된 *디렉터리* 경로(예: `./my_model_directory`).
cache_dir (`str | os.PathLike`, *선택 사항*) : 표준 캐시를 사용하지 않을 경우, 다운로드된 사전 학습 모델 구성이 캐시되는 디렉터리의 경로입니다.
force_download (`bool`, *선택 사항*, 기본값 `False`) : 캐시된 버전이 존재하더라도 모델 가중치 및 구성 파일의 (재)다운로드를 강제할지 여부.
proxies (`dict[str, str]`, *선택 사항*) : 프로토콜 또는 엔드포인트별로 사용할 프록시 서버의 사전입니다. 예를 들어, `{'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}`와 같습니다. 각 요청에 프록시가 사용됩니다.
output_loading_info(`bool`, *선택 사항*, 기본값 `False`) : 누락된 키, 예상치 못한 키 및 오류 메시지가 포함된 사전도 함께 반환할지 여부.
local_files_only (`bool`, *선택 사항*, 기본값 `False`) : 로컬 모델 가중치와 구성 파일만 로드할지 여부를 지정합니다. `True`로 설정하면 Hub에서 모델을 다운로드하지 않습니다.
token (`str` 또는 *bool*, *선택 사항*) : 원격 파일에 대한 HTTP bearer 인증으로 사용할 토큰입니다. `True`인 경우, `diffusers-cli login`에서 생성된 토큰(`~/.huggingface`에 저장됨)이 사용됩니다.
revision (`str`, *선택 사항*, 기본값 `"main"`) : 사용할 특정 모델 버전입니다. Git에서 허용하는 브랜치 이름, 태그 이름, 커밋 ID 또는 기타 식별자일 수 있습니다.
subfolder (`str`, *선택 사항*, 기본값 `""`) : Hub 또는 로컬의 더 큰 모델 저장소 내에서 모델 파일의 서브폴더 위치입니다.
return_unused_kwargs (`bool`, *선택 사항*, 기본값 `False) : config의 미사용 키워드 인수가 반환되는지 여부.
return_commit_hash (`bool`, *optional*, defaults to `False) : Whether the `commit_hash` of the loaded configuration are returned.
**반환값:** `dict`
JSON 구성 파일에 저장된 모든 매개변수의 사전입니다.
모델 또는 스케줄러 구성을 로드합니다.
#### from_config[[diffusers.ConfigMixin.from_config]]
```python
from_config(config: diffusers.configuration_utils.FrozenDict | dict[str, typing.Any] = None, return_unused_kwargs = False, **kwargs)
```
[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L221)
**매개변수:**
config (`dict[str, Any]`) : Python 클래스가 인스턴스화되는 설정 사전입니다. 호환되는 클래스의 설정 파일만 로드하도록 하십시오.
return_unused_kwargs (`bool`, *선택 사항*, 기본값 `False`) : Python 클래스에서 소비되지 않는 kwargs를 반환할지 여부.
kwargs (남은 키워드 인수의 사전, *선택 사항*) : 구성 객체를 로드한 후 이를 업데이트하고 Python 클래스를 초기화하는 데 사용할 수 있습니다. `**kwargs`는 기본적으로 사용 중인 스케줄러/모델의 `__init__` 메서드에 직접 전달되며, 최종적으로 `config`의 동일한 이름의 인수를 덮어씁니다.
**반환값:** [ModelMixin](/docs/diffusers/main/ko/api/models/overview#diffusers.ModelMixin) 또는 [SchedulerMixin](/docs/diffusers/main/ko/api/schedulers/overview#diffusers.SchedulerMixin)
config 딕셔너리에서 인스턴스화된 모델 또는 스케줄러 객체.
config 사전에서 Python 클래스를 인스턴스화합니다.
예:
```python
>>> from diffusers import DDPMScheduler, DDIMScheduler, PNDMScheduler
>>> # Download scheduler from huggingface.co and cache.
>>> scheduler = DDPMScheduler.from_pretrained("google/ddpm-cifar10-32")
>>> # Instantiate DDIM scheduler class with same config as DDPM
>>> scheduler = DDIMScheduler.from_config(scheduler.config)
>>> # Instantiate PNDM scheduler class with same config as DDPM
>>> scheduler = PNDMScheduler.from_config(scheduler.config)
```
#### save_config[[diffusers.ConfigMixin.save_config]]
```python
save_config(save_directory: str | os.PathLike, push_to_hub: bool = False, **kwargs)
```
[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L177)
**매개변수:**
save_directory (`str` 또는 `os.PathLike`) : 구성 JSON 파일이 저장될 디렉터리(존재하지 않으면 생성됨).
push_to_hub (`bool`, *선택 사항*, 기본값 `False`) : 모델을 저장한 후 Hugging Face Hub에 푸시할지 여부입니다. `repo_id`를 사용하여 푸시할 저장소를 지정할 수 있습니다(기본값은 네임스페이스의 `save_directory` 이름입니다).
kwargs (`dict[str, Any]`, *선택 사항*) : [push_to_hub()](/docs/diffusers/main/ko/api/schedulers/overview#diffusers.utils.PushToHubMixin.push_to_hub) 메서드에 함께 전달되는 추가 키워드 인자입니다.
`save_directory`에 지정된 디렉토리에 구성 객체를 저장하여 [from_config()](/docs/diffusers/main/ko/api/configuration#diffusers.ConfigMixin.from_config) 클래스 메서드를 사용해 다시 로드할 수 있도록 합니다.
#### to_json_file[[diffusers.ConfigMixin.to_json_file]]
```python
to_json_file(json_file_path: str | os.PathLike)
```
[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L647)
**매개변수:**
json_file_path (`str` 또는 `os.PathLike`) : 설정 인스턴스의 매개변수를 저장할 JSON 파일의 경로.
Save the configuration instance's parameters to a JSON file.
#### to_json_string[[diffusers.ConfigMixin.to_json_string]]
```python
to_json_string()
```
[소스](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L602)
**반환값:** `str`
JSON 형식으로 구성된 설정 인스턴스를 구성하는 모든 속성이 포함된 문자열.
구성 인스턴스를 JSON 문자열로 직렬화합니다.

Xet Storage Details

Size:
8.71 kB
·
Xet hash:
99b3034cd2dc67feeda40d8930d1e7e3950e2d62c439fbb6132b8e853e54cab0

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