Docs: 13 docstrings document parameters their functions don't have
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 84/100
- Tipo de issue
- Documentação
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Domínio
- documentation
Direção de pesquisa
Comece pelas 13 funções listadas em src/diffusers e compare cada entrada do docstring com a assinatura da função. Renomeie ou remova apenas as entradas que não correspondem, mantendo as alterações dentro dos docstrings; as cinco entradas obsoletas de pipeline são opcionais. O trabalho estará concluído quando todos os nomes de parâmetros listados corresponderem às suas assinaturas e a nota Returns fora do lugar for corrigida.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Describe the bug
Thirteen docstrings under src/diffusers document parameters that their functions don't have. Usually it's an old name left behind after a rename. Several are public API, so the wrong name shows up in the rendered docs and in IDE tooltips, and anyone who copies it gets a TypeError:
AmusedLoraLoaderMixin.save_lora_weightsdocumentsunet_lora_layers; the parameter istransformer_lora_layers.QuantizationConfigMixin.to_json_filedocumentsuse_diff, which it doesn't take (it always writesto_dict()).utils.peft_utils.check_peft_versiondocumentsversion; the parameter ismin_version.HunyuanImageRefinerPipeline.encode_promptdocumentsprompt_embeds_2andprompt_embeds_mask_2, which it doesn't take.
The full list (file:line function: documented name(s) missing from the signature):
guiders/guider_utils.py:202 _prepare_batch: input_fields
hooks/taylorseer_cache.py:315 _apply_taylorseer_cache_hook: name
loaders/lora_pipeline.py:2300 save_lora_weights: unet_lora_layers
modular_pipelines/modular_pipeline.py:2893 _dict_to_component_spec: specdict
pipelines/deprecated/alt_diffusion/pipeline_alt_diffusion.py:648 get_guidance_scale_embedding: timesteps
pipelines/deprecated/alt_diffusion/pipeline_alt_diffusion_img2img.py:720 get_guidance_scale_embedding: timesteps
pipelines/deprecated/i2vgen_xl/pipeline_i2vgen_xl.py:162 encode_prompt: do_classifier_free_guidance
pipelines/deprecated/shap_e/renderer.py:299 intersect: params
pipelines/deprecated/versatile_diffusion/pipeline_versatile_diffusion.py:302 dual_guided: negative_prompt
pipelines/hunyuan_image/pipeline_hunyuanimage_refiner.py:225 encode_prompt: prompt_embeds_2, prompt_embeds_mask_2
pipelines/stable_diffusion/convert_from_ckpt.py:1145 download_from_original_stable_diffusion_ckpt: is_img2img, return (the last is a Returns note placed under Args)
quantizers/quantization_config.py:97 to_json_file: use_diff
utils/peft_utils.py:381 check_peft_version: version
I found these by parsing every function with ast and comparing its Args: names with the signature. Functions with *args/**kwargs are skipped, so there are no false positives from forwarded arguments.
Proposed fix
A single docs-only PR that renames or removes the 13 entries, staying inside the docstrings. The five under pipelines/deprecated/ can be left out if you'd rather not touch deprecated code. Following the contributing guide, I'm checking here first: may I open that PR?
Reproduction
For example, check_peft_version(version="0.6.0") raises TypeError: check_peft_version() got an unexpected keyword argument 'version', as its docstring suggests that name.
System Info
main at the current HEAD; docstrings only.
- Linguagem predominante
- Python
- Estrelas
- 34.9k
- Forks
- 7.5k
- Merge médio
- 3d 16h
- PRs com merge (30d)
- 65
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de huggingface/diffusers
-
`ZImageImg2ImgPipeline` / `ZImageInpaintPipeline`: explicit height/width different from the input image raises RuntimeErrorTalvez já em andamento @chessing234 assumiu hoje. Abertabug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
huggingface/diffusers#15337 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
Multi-vector textual inversion uses only the first vector when the token has uppercase letters (transformers v5)Talvez já em andamento @sunhouy assumiu há 2 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
huggingface/diffusers#15313 ·
Mantenedores costumam responder em até 1 dia
-
TCDScheduler advances the generator on the final step of a strength-truncated custom scheduleTalvez já em andamento @SIDDARTHAREDDY8 assumiu há 5 dias. Abertabug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
huggingface/diffusers#15288 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
unload_textual_inversion(token) leaves the extra tokens of a multi-vector embedding behind, so it can't be loaded againTalvez já em andamento @sohailshk assumiu há 11 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
huggingface/diffusers#15211 · 3 comentários ·
Mantenedores costumam responder em até 1 dia
-
set_ip_adapter_scale(float) raises "Cannot assign 1 scale_configs to 2 IP-Adapter" when several IP-Adapters are loadedTalvez já em andamento @sohailshk assumiu há 11 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
huggingface/diffusers#15210 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
Todas as issues de huggingface/diffusers
Issues semelhantes
-
[dbt] exported dataset keys reference physical columnsTalvez já em andamento @WilliamKelley assumiu hoje. Abertaneeds-triage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
apache/ossie-converters#251 ·
Mantenedores costumam responder em até 2 dias
-
cli difficulty: easy enhancement
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
Mantenedores costumam responder em até 2 dias
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 62/100
desec-io/desec-stack#1312 ·
Mantenedores costumam responder em até 14 dias
-
needs-triage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
aws/aws-durable-execution-sdk-python#977 ·
Mantenedores costumam responder em até 1 dia
-
needs-triage
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
flashinfer-ai/flashinfer#9803 ·
Mantenedores costumam responder em até 1 dia