Diffusers documentation
구성
구성
SchedulerMixin의 스케줄러와 ModelMixin의 모델은 ConfigMixin을 상속받으며, 이는 각각의 __init__ 메서드에 전달된 모든 매개변수를 JSON 구성 파일에 저장합니다.
비공개 또는 게이트된 모델을 사용하려면
hf auth login으로 로그인하세요.
ConfigMixin
모든 구성 클래스의 기본 클래스입니다. 모든 구성 매개변수는 self.config 아래에 저장됩니다. 또한 ConfigMixin을 상속하는 클래스를 로드, 다운로드 및 저장하기 위한 from_config() 및 save_config() 메서드를 제공합니다.
클래스 속성:
- config_name (
str) — save_config()를 호출할 때 설정을 저장할 파일 이름입니다 (부모 클래스에서 재정의되어야 합니다). - ignore_for_config (
list[str]) — config에 저장되지 않아야 할 속성의 목록 (서브클래스에서 재정의해야 합니다). - has_compatibles (
bool) — 해당 클래스에 호환 클래스가 있는지 여부(서브클래스에서 재정의해야 합니다). - _deprecated_kwargs (
list[str]) — 비활성화된 키워드 인자입니다.init함수에는 적어도 하나의 인자가 비활성화된 경우에만kwargs인자가 있어야 합니다(서브클래스에서 재정의해야 합니다).
load_config
< source >( pretrained_model_name_or_path: str | os.PathLikereturn_unused_kwargs = Falsereturn_commit_hash = False**kwargs ) → dict
매개변수
- pretrained_model_name_or_path (
str또는os.PathLike, 선택 사항) — 다음 중 하나일 수 있습니다:- Hub에 호스팅된 사전 학습 모델의 model id 문자열(예:
google/ddpm-celebahq-256). - save_config()로 저장된 모델 가중치가 포함된 디렉터리의 경로(예:
./my_model_directory)
- Hub에 호스팅된 사전 학습 모델의 model id 문자열(예:
- 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, optional, 기본값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 toFalse) -- Whether thecommit_hash` of the loaded configuration are returned.
반환값
dict
JSON 구성 파일에 저장된 모든 매개변수의 사전입니다.
모델 또는 스케줄러 구성을 로드합니다.
from_config
< source >( config: diffusers.configuration_utils.FrozenDict | dict[str, typing.Any] = Nonereturn_unused_kwargs = False**kwargs ) → ModelMixin or SchedulerMixin
매개변수
- config (
dict[str, Any]) — Python 클래스가 인스턴스화되는 설정 사전입니다. 호환되는 클래스의 설정 파일만 로드하도록 하십시오. - return_unused_kwargs (
bool, 선택 사항, 기본값False) — Python 클래스에서 소비되지 않는 kwargs를 반환할지 여부입니다. - kwargs (나머지 키워드 인자 사전, 선택 사항) —
구성 객체를 업데이트(로드된 후)하고 Python 클래스를 초기화하는 데 사용할 수 있습니다.
**kwargs는 기본적으로 스케줄러/모델의__init__메서드에 직접 전달되며, 최종적으로config의 동일한 이름의 인자를 덮어씁니다.
반환값
config 딕셔너리에서 인스턴스화된 모델 또는 스케줄러 객체.
config 사전에서 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
< source >( save_directory: str | os.PathLikepush_to_hub: bool = False**kwargs )
매개변수
- 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() 메서드에 함께 전달되는 추가 키워드 인자입니다.
save_directory에 지정된 디렉토리에 구성 객체를 저장하여 from_config() 클래스 메서드를 사용해 다시 로드할 수 있도록 합니다.
to_json_file
< source >( json_file_path: str | os.PathLike )
구성 인스턴스의 매개변수를 JSON 파일에 저장합니다.
구성 인스턴스를 JSON 문자열로 직렬화합니다.