Diffusers documentation
Cấu hình
Cấu hình
Các Scheduler từ SchedulerMixin và các model từ ModelMixin kế thừa từ ConfigMixin, thành phần lưu trữ tất cả các tham số được truyền vào các phương thức __init__ tương ứng của chúng trong một tệp cấu hình JSON.
Để sử dụng các mô hình riêng tư hoặc được kiểm soát, hãy đăng nhập bằng
hf auth login.
ConfigMixin
Lớp cơ sở cho tất cả các lớp cấu hình. Tất cả các tham số cấu hình được lưu trữ dưới self.config. Ngoài ra còn cung cấp các phương thức from_config() và save_config() để tải xuống, tải và lưu các lớp kế thừa từ ConfigMixin.
Thuộc tính lớp:
- config_name (
str) — Tên tệp mà cấu hình sẽ được lưu khi gọi save_config() (nên được ghi đè bởi lớp cha). - ignore_for_config (
list[str]) — Một danh sách các thuộc tính không nên được lưu trong cấu hình (nên được ghi đè bởi lớp con). - has_compatibles (
bool) — Cho biết lớp có các lớp tương thích hay không (nên được ghi đè bởi lớp con). - _deprecated_kwargs (
list[str]) — Các tham số keyword đã bị ngừng hỗ trợ. Lưu ý rằng hàminitchỉ nên có tham sốkwargsnếu ít nhất một tham số đã bị ngừng hỗ trợ (nên được ghi đè bởi lớp con).
load_config
< source >( pretrained_model_name_or_path: str | os.PathLikereturn_unused_kwargs = Falsereturn_commit_hash = False**kwargs ) → dict
Tham số
- pretrained_model_name_or_path (
strhoặcos.PathLike, tùy chọn) — Có thể là:- Một chuỗi, model id (ví dụ
google/ddpm-celebahq-256) của một mô hình được huấn luyện trước có sẵn trên Hub. - Đường dẫn đến một thư mục (ví dụ
./my_model_directory) chứa trọng số mô hình được lưu bằng save_config().
- Một chuỗi, model id (ví dụ
- cache_dir (
str | os.PathLike, tùy chọn) — Đường dẫn đến thư mục nơi cấu hình mô hình được huấn luyện trước đã tải xuống được lưu đệm nếu không sử dụng bộ lưu đệm tiêu chuẩn. - force_download (
bool, tùy chọn, mặc định làFalse) — Có nên buộc tải lại (re-download) trọng số mô hình và các tệp cấu hình, ghi đè lên các phiên bản đã được lưu trong bộ nhớ đệm nếu chúng tồn tại hay không. - proxies (
dict[str, str], tuỳ chọn) — Một từ điển các máy chủ proxy để sử dụng theo giao thức hoặc điểm cuối, ví dụ,{'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. Các proxy này được sử dụng cho mỗi yêu cầu. - output_loading_info(
bool, optional, mặc định làFalse) — Có nên trả về một từ điển chứa các khóa bị thiếu, các khóa không mong đợi và thông báo lỗi hay không. - local_files_only (
bool, tùy chọn, mặc định làFalse) — Xác định có chỉ tải trọng số và tệp cấu hình của mô hình từ cục bộ hay không. Nếu đặt thànhTrue, mô hình sẽ không được tải xuống từ Hub. - token (
strhoặc bool, tùy chọn) — Token được sử dụng làm HTTP bearer authorization cho các tệp từ xa. NếuTrue, token được tạo từdiffusers-cli login(được lưu trong~/.huggingface) sẽ được sử dụng. - revision (
str, tùy chọn, mặc định là"main") — Phiên bản mô hình cụ thể cần sử dụng. Nó có thể là tên nhánh, tên thẻ, id commit, hoặc bất kỳ định danh nào được Git cho phép. - subfolder (
str, tùy chọn, mặc định là"") — Vị trí thư mục con của tệp mô hình bên trong một kho lưu trữ mô hình lớn hơn trên Hub hoặc cục bộ. - return_unused_kwargs (
bool, tuỳ chọn, mặc định là `False) — Xác định xem các đối số từ khóa không được sử dụng của cấu hình có được trả về hay không. - return_commit_hash (
bool, optional, defaults toFalse) -- Whether thecommit_hash` of the loaded configuration are returned.
Trả về
dict
Một từ điển chứa tất cả các tham số được lưu trữ trong tệp cấu hình JSON.
Tải cấu hình mô hình hoặc trình lập lịch.
from_config
< source >( config: diffusers.configuration_utils.FrozenDict | dict[str, typing.Any] = Nonereturn_unused_kwargs = False**kwargs ) → ModelMixin or SchedulerMixin
Tham số
- config (
dict[str, Any]) — Một từ điển cấu hình dùng để khởi tạo lớp Python. Hãy đảm bảo chỉ tải các tệp cấu hình của các lớp tương thích. - return_unused_kwargs (
bool, tùy chọn, mặc định làFalse) — Liệu các kwargs không được lớp Python sử dụng có nên được trả về hay không. - kwargs (từ điển các đối số từ khóa còn lại, tùy chọn) —
Có thể được sử dụng để cập nhật đối tượng cấu hình (sau khi nó được tải) và khởi tạo lớp Python.
**kwargsđược truyền trực tiếp đến phương thức__init__của bộ lập lịch/mô hình cơ bản và cuối cùng ghi đè lên các đối số cùng tên trongconfig.
Trả về
ModelMixin hoặc SchedulerMixin
Một đối tượng mô hình hoặc trình lập lịch được khởi tạo từ một từ điển cấu hình.
Tạo một lớp Python từ một từ điển cấu hình.
Ví dụ:
>>> 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 )
Tham số
- save_directory (
strhoặcos.PathLike) — Thư mục nơi tệp JSON cấu hình được lưu (sẽ được tạo nếu chưa tồn tại). - push_to_hub (
bool, tùy chọn, mặc định làFalse) — Có đẩy mô hình của bạn lên Hugging Face Hub sau khi lưu hay không. Bạn có thể chỉ định kho lưu trữ muốn đẩy bằngrepo_id(mặc định sẽ là tên củasave_directorytrong không gian tên của bạn). - kwargs (
dict[str, Any], tùy chọn) — Các đối số từ khóa bổ sung được truyền đến phương thức push_to_hub().
Lưu đối tượng cấu hình vào thư mục được chỉ định trong save_directory để có thể tải lại bằng phương thức lớp from_config().
to_json_file
< source >( json_file_path: str | os.PathLike )
Lưu các tham số của instance cấu hình vào một tệp JSON.
to_json_string
< source >( ) → str
Trả về
str
Chuỗi chứa tất cả các thuộc tính cấu thành lên bản thể cấu hình ở định dạng JSON.
Chuẩn hóa (serialize) cấu hình (configuration) thành một chuỗi JSON.