From c6ae9b7df65bbeee93e49fc11e6044f9ce8b56e1 Mon Sep 17 00:00:00 2001 From: camenduru <54370274+camenduru@users.noreply.github.com> Date: Wed, 26 Jul 2023 19:18:14 +0300 Subject: [PATCH] Where did this 'x' come from, Elon? (#4277) * why mdx? * why mdx? * why mdx? * no x for kandinksy either --------- Co-authored-by: Patrick von Platen --- PHILOSOPHY.md | 2 +- docs/README.md | 8 +- .../{attnprocessor.mdx => attnprocessor.md} | 0 .../{configuration.mdx => configuration.md} | 0 ...ion_pipeline.mdx => diffusion_pipeline.md} | 0 ...image_processor.mdx => image_processor.md} | 0 .../source/en/api/{loaders.mdx => loaders.md} | 0 .../source/en/api/{logging.mdx => logging.md} | 0 ...coderkl.mdx => asymmetricautoencoderkl.md} | 0 .../{autoencoderkl.mdx => autoencoderkl.md} | 0 .../models/{controlnet.mdx => controlnet.md} | 0 .../api/models/{overview.mdx => overview.md} | 0 ...r_transformer.mdx => prior_transformer.md} | 0 .../{transformer2d.mdx => transformer2d.md} | 0 ...r_temporal.mdx => transformer_temporal.md} | 0 .../en/api/models/{unet.mdx => unet.md} | 0 .../{unet2d-cond.mdx => unet2d-cond.md} | 0 .../en/api/models/{unet2d.mdx => unet2d.md} | 0 .../{unet3d-cond.mdx => unet3d-cond.md} | 0 docs/source/en/api/models/{vq.mdx => vq.md} | 0 .../source/en/api/{outputs.mdx => outputs.md} | 0 .../{alt_diffusion.mdx => alt_diffusion.md} | 0 ...nd_and_excite.mdx => attend_and_excite.md} | 0 ...audio_diffusion.mdx => audio_diffusion.md} | 0 .../pipelines/{audioldm.mdx => audioldm.md} | 0 .../{auto_pipeline.mdx => auto_pipeline.md} | 0 ...tency_models.mdx => consistency_models.md} | 0 .../{controlnet.mdx => controlnet.md} | 0 ...cycle_diffusion.mdx => cycle_diffusion.md} | 0 ...dance_diffusion.mdx => dance_diffusion.md} | 0 .../en/api/pipelines/{ddim.mdx => ddim.md} | 0 .../en/api/pipelines/{ddpm.mdx => ddpm.md} | 0 .../{deepfloyd_if.mdx => deepfloyd_if.md} | 0 .../pipelines/{diffedit.mdx => diffedit.md} | 0 .../en/api/pipelines/{dit.mdx => dit.md} | 0 .../pipelines/{kandinsky.mdx => kandinsky.md} | 0 .../{kandinsky_v22.mdx => kandinsky_v22.md} | 0 ...tent_diffusion.mdx => latent_diffusion.md} | 0 ..._uncond.mdx => latent_diffusion_uncond.md} | 0 .../{model_editing.mdx => model_editing.md} | 0 .../pipelines/{overview.mdx => overview.md} | 0 ...int_by_example.mdx => paint_by_example.md} | 0 .../pipelines/{panorama.mdx => panorama.md} | 0 .../pipelines/{paradigms.mdx => paradigms.md} | 0 .../api/pipelines/{pix2pix.mdx => pix2pix.md} | 0 .../{pix2pix_zero.mdx => pix2pix_zero.md} | 0 .../en/api/pipelines/{pndm.mdx => pndm.md} | 0 .../api/pipelines/{repaint.mdx => repaint.md} | 0 .../{score_sde_ve.mdx => score_sde_ve.md} | 0 ...uidance.mdx => self_attention_guidance.md} | 0 ...usion.mdx => semantic_stable_diffusion.md} | 0 .../api/pipelines/{shap_e.mdx => shap_e.md} | 0 ...diffusion.mdx => spectrogram_diffusion.md} | 0 .../{adapter.mdx => adapter.md} | 0 .../{depth2img.mdx => depth2img.md} | 0 ...image_variation.mdx => image_variation.md} | 0 .../{img2img.mdx => img2img.md} | 0 .../{inpaint.mdx => inpaint.md} | 0 .../{latent_upscale.mdx => latent_upscale.md} | 0 ...ldm3d_diffusion.mdx => ldm3d_diffusion.md} | 0 .../{overview.mdx => overview.md} | 0 ..._diffusion_2.mdx => stable_diffusion_2.md} | 0 ...sion_safe.mdx => stable_diffusion_safe.md} | 0 ...iffusion_xl.mdx => stable_diffusion_xl.md} | 0 .../{text2img.mdx => text2img.md} | 0 .../{upscale.mdx => upscale.md} | 0 .../{stable_unclip.mdx => stable_unclip.md} | 0 ..._karras_ve.mdx => stochastic_karras_ve.md} | 0 .../{text_to_video.mdx => text_to_video.md} | 0 ...o_video_zero.mdx => text_to_video_zero.md} | 0 .../api/pipelines/{unclip.mdx => unclip.md} | 0 .../{unidiffuser.mdx => unidiffuser.md} | 0 ..._sampling.mdx => value_guided_sampling.md} | 0 ...e_diffusion.mdx => versatile_diffusion.md} | 0 .../{vq_diffusion.mdx => vq_diffusion.md} | 0 ...erative.mdx => cm_stochastic_iterative.md} | 0 .../en/api/schedulers/{ddim.mdx => ddim.md} | 0 .../{ddim_inverse.mdx => ddim_inverse.md} | 0 .../en/api/schedulers/{ddpm.mdx => ddpm.md} | 0 .../en/api/schedulers/{deis.mdx => deis.md} | 0 .../{dpm_discrete.mdx => dpm_discrete.md} | 0 ...ncestral.mdx => dpm_discrete_ancestral.md} | 0 .../schedulers/{dpm_sde.mdx => dpm_sde.md} | 0 .../en/api/schedulers/{euler.mdx => euler.md} | 0 ...euler_ancestral.mdx => euler_ancestral.md} | 0 .../en/api/schedulers/{heun.mdx => heun.md} | 0 .../en/api/schedulers/{ipndm.mdx => ipndm.md} | 0 .../{lms_discrete.mdx => lms_discrete.md} | 0 ...dpm_solver.mdx => multistep_dpm_solver.md} | 0 ...se.mdx => multistep_dpm_solver_inverse.md} | 0 .../schedulers/{overview.mdx => overview.md} | 0 .../en/api/schedulers/{pndm.mdx => pndm.md} | 0 .../schedulers/{repaint.mdx => repaint.md} | 0 .../{score_sde_ve.mdx => score_sde_ve.md} | 0 .../{score_sde_vp.mdx => score_sde_vp.md} | 0 ...pm_solver.mdx => singlestep_dpm_solver.md} | 0 ..._karras_ve.mdx => stochastic_karras_ve.md} | 0 .../en/api/schedulers/{unipc.mdx => unipc.md} | 0 .../{vq_diffusion.mdx => vq_diffusion.md} | 0 .../en/api/{utilities.mdx => utilities.md} | 0 .../{contribution.mdx => contribution.md} | 0 ...l_guidelines.mdx => ethical_guidelines.md} | 102 +++++++++--------- .../{evaluation.mdx => evaluation.md} | 0 .../{philosophy.mdx => philosophy.md} | 2 +- docs/source/en/{index.mdx => index.md} | 0 .../en/{installation.mdx => installation.md} | 0 .../en/optimization/{coreml.mdx => coreml.md} | 0 .../en/optimization/{fp16.mdx => fp16.md} | 0 .../en/optimization/{habana.mdx => habana.md} | 0 .../en/optimization/{mps.mdx => mps.md} | 0 .../en/optimization/{onnx.mdx => onnx.md} | 0 .../{open_vino.mdx => open_vino.md} | 0 .../{opt_overview.mdx => opt_overview.md} | 0 .../en/optimization/{tome.mdx => tome.md} | 0 .../{torch2.0.mdx => torch2.0.md} | 0 .../{xformers.mdx => xformers.md} | 0 .../source/en/{quicktour.mdx => quicktour.md} | 0 ...able_diffusion.mdx => stable_diffusion.md} | 0 .../{adapt_a_model.mdx => adapt_a_model.md} | 0 .../{controlnet.mdx => controlnet.md} | 0 .../{create_dataset.mdx => create_dataset.md} | 0 ...stom_diffusion.mdx => custom_diffusion.md} | 0 ...inference.mdx => distributed_inference.md} | 0 .../{dreambooth.mdx => dreambooth.md} | 0 ...instructpix2pix.mdx => instructpix2pix.md} | 0 docs/source/en/training/{lora.mdx => lora.md} | 0 .../en/training/{overview.mdx => overview.md} | 0 .../{text2image.mdx => text2image.md} | 0 .../{text_inversion.mdx => text_inversion.md} | 0 ...training.mdx => unconditional_training.md} | 0 .../{basic_training.mdx => basic_training.md} | 0 ...rial_overview.mdx => tutorial_overview.md} | 0 ...on.mdx => conditional_image_generation.md} | 0 ...te_pipeline.mdx => contribute_pipeline.md} | 0 ...l_brightness.mdx => control_brightness.md} | 0 ...neration.mdx => controlling_generation.md} | 0 ...amples.mdx => custom_pipeline_examples.md} | 0 ...erview.mdx => custom_pipeline_overview.md} | 0 .../{depth2img.mdx => depth2img.md} | 0 .../{img2img.mdx => img2img.md} | 0 .../{inpaint.mdx => inpaint.md} | 0 .../{loading.mdx => loading.md} | 0 ...ading_overview.mdx => loading_overview.md} | 0 .../{other-formats.mdx => other-formats.md} | 0 ...her-modalities.mdx => other-modalities.md} | 0 ...line_overview.mdx => pipeline_overview.md} | 0 ...reproducibility.mdx => reproducibility.md} | 0 .../{reusing_seeds.mdx => reusing_seeds.md} | 0 .../{schedulers.mdx => schedulers.md} | 2 +- ..._to.mdx => stable_diffusion_jax_how_to.md} | 0 ...nce.mdx => textual_inversion_inference.md} | 0 ....mdx => unconditional_image_generation.md} | 0 ...g_safetensors.mdx => using_safetensors.md} | 0 ...ighted_prompts.mdx => weighted_prompts.md} | 0 ...own_pipeline.mdx => write_own_pipeline.md} | 0 .../{in_translation.mdx => in_translation.md} | 0 docs/source/ko/{index.mdx => index.md} | 0 .../ko/{installation.mdx => installation.md} | 0 .../ko/optimization/{fp16.mdx => fp16.md} | 0 .../ko/optimization/{habana.mdx => habana.md} | 0 .../ko/optimization/{mps.mdx => mps.md} | 0 .../ko/optimization/{onnx.mdx => onnx.md} | 0 .../{open_vino.mdx => open_vino.md} | 0 .../{opt_overview.mdx => opt_overview.md} | 0 .../{torch2.0.mdx => torch2.0.md} | 0 .../{xformers.mdx => xformers.md} | 0 .../source/ko/{quicktour.mdx => quicktour.md} | 0 .../{adapt_a_model.mdx => adapt_a_model.md} | 0 .../{dreambooth.mdx => dreambooth.md} | 0 docs/source/ko/training/{lora.mdx => lora.md} | 0 .../ko/training/{overview.mdx => overview.md} | 0 .../{text2image.mdx => text2image.md} | 0 .../{text_inversion.mdx => text_inversion.md} | 0 ...training.mdx => unconditional_training.md} | 0 .../{basic_training.mdx => basic_training.md} | 0 ...rial_overview.mdx => tutorial_overview.md} | 0 ...amples.mdx => custom_pipeline_examples.md} | 0 ...erview.mdx => custom_pipeline_overview.md} | 0 .../{depth2img.mdx => depth2img.md} | 0 .../{img2img.mdx => img2img.md} | 0 .../{inpaint.mdx => inpaint.md} | 0 .../{loading.mdx => loading.md} | 0 .../{other-formats.mdx => other-formats.md} | 0 ...line_overview.mdx => pipeline_overview.md} | 0 .../{reusing_seeds.mdx => reusing_seeds.md} | 0 .../{schedulers.mdx => schedulers.md} | 2 +- ....mdx => unconditional_image_generation.md} | 0 ...g_safetensors.mdx => using_safetensors.md} | 0 ...own_pipeline.mdx => write_own_pipeline.md} | 0 docs/source/zh/{index.mdx => index.md} | 0 .../zh/{installation.mdx => installation.md} | 0 .../source/zh/{quicktour.mdx => quicktour.md} | 0 utils/check_repo.py | 4 +- utils/check_table.py | 6 +- 194 files changed, 64 insertions(+), 64 deletions(-) rename docs/source/en/api/{attnprocessor.mdx => attnprocessor.md} (100%) rename docs/source/en/api/{configuration.mdx => configuration.md} (100%) rename docs/source/en/api/{diffusion_pipeline.mdx => diffusion_pipeline.md} (100%) rename docs/source/en/api/{image_processor.mdx => image_processor.md} (100%) rename docs/source/en/api/{loaders.mdx => loaders.md} (100%) rename docs/source/en/api/{logging.mdx => logging.md} (100%) rename docs/source/en/api/models/{asymmetricautoencoderkl.mdx => asymmetricautoencoderkl.md} (100%) rename docs/source/en/api/models/{autoencoderkl.mdx => autoencoderkl.md} (100%) rename docs/source/en/api/models/{controlnet.mdx => controlnet.md} (100%) rename docs/source/en/api/models/{overview.mdx => overview.md} (100%) rename docs/source/en/api/models/{prior_transformer.mdx => prior_transformer.md} (100%) rename docs/source/en/api/models/{transformer2d.mdx => transformer2d.md} (100%) rename docs/source/en/api/models/{transformer_temporal.mdx => transformer_temporal.md} (100%) rename docs/source/en/api/models/{unet.mdx => unet.md} (100%) rename docs/source/en/api/models/{unet2d-cond.mdx => unet2d-cond.md} (100%) rename docs/source/en/api/models/{unet2d.mdx => unet2d.md} (100%) rename docs/source/en/api/models/{unet3d-cond.mdx => unet3d-cond.md} (100%) rename docs/source/en/api/models/{vq.mdx => vq.md} (100%) rename docs/source/en/api/{outputs.mdx => outputs.md} (100%) rename docs/source/en/api/pipelines/{alt_diffusion.mdx => alt_diffusion.md} (100%) rename docs/source/en/api/pipelines/{attend_and_excite.mdx => attend_and_excite.md} (100%) rename docs/source/en/api/pipelines/{audio_diffusion.mdx => audio_diffusion.md} (100%) rename docs/source/en/api/pipelines/{audioldm.mdx => audioldm.md} (100%) rename docs/source/en/api/pipelines/{auto_pipeline.mdx => auto_pipeline.md} (100%) rename docs/source/en/api/pipelines/{consistency_models.mdx => consistency_models.md} (100%) rename docs/source/en/api/pipelines/{controlnet.mdx => controlnet.md} (100%) rename docs/source/en/api/pipelines/{cycle_diffusion.mdx => cycle_diffusion.md} (100%) rename docs/source/en/api/pipelines/{dance_diffusion.mdx => dance_diffusion.md} (100%) rename docs/source/en/api/pipelines/{ddim.mdx => ddim.md} (100%) rename docs/source/en/api/pipelines/{ddpm.mdx => ddpm.md} (100%) rename docs/source/en/api/pipelines/{deepfloyd_if.mdx => deepfloyd_if.md} (100%) rename docs/source/en/api/pipelines/{diffedit.mdx => diffedit.md} (100%) rename docs/source/en/api/pipelines/{dit.mdx => dit.md} (100%) rename docs/source/en/api/pipelines/{kandinsky.mdx => kandinsky.md} (100%) rename docs/source/en/api/pipelines/{kandinsky_v22.mdx => kandinsky_v22.md} (100%) rename docs/source/en/api/pipelines/{latent_diffusion.mdx => latent_diffusion.md} (100%) rename docs/source/en/api/pipelines/{latent_diffusion_uncond.mdx => latent_diffusion_uncond.md} (100%) rename docs/source/en/api/pipelines/{model_editing.mdx => model_editing.md} (100%) rename docs/source/en/api/pipelines/{overview.mdx => overview.md} (100%) rename docs/source/en/api/pipelines/{paint_by_example.mdx => paint_by_example.md} (100%) rename docs/source/en/api/pipelines/{panorama.mdx => panorama.md} (100%) rename docs/source/en/api/pipelines/{paradigms.mdx => paradigms.md} (100%) rename docs/source/en/api/pipelines/{pix2pix.mdx => pix2pix.md} (100%) rename docs/source/en/api/pipelines/{pix2pix_zero.mdx => pix2pix_zero.md} (100%) rename docs/source/en/api/pipelines/{pndm.mdx => pndm.md} (100%) rename docs/source/en/api/pipelines/{repaint.mdx => repaint.md} (100%) rename docs/source/en/api/pipelines/{score_sde_ve.mdx => score_sde_ve.md} (100%) rename docs/source/en/api/pipelines/{self_attention_guidance.mdx => self_attention_guidance.md} (100%) rename docs/source/en/api/pipelines/{semantic_stable_diffusion.mdx => semantic_stable_diffusion.md} (100%) rename docs/source/en/api/pipelines/{shap_e.mdx => shap_e.md} (100%) rename docs/source/en/api/pipelines/{spectrogram_diffusion.mdx => spectrogram_diffusion.md} (100%) rename docs/source/en/api/pipelines/stable_diffusion/{adapter.mdx => adapter.md} (100%) rename docs/source/en/api/pipelines/stable_diffusion/{depth2img.mdx => depth2img.md} (100%) rename docs/source/en/api/pipelines/stable_diffusion/{image_variation.mdx => image_variation.md} (100%) rename docs/source/en/api/pipelines/stable_diffusion/{img2img.mdx => img2img.md} (100%) rename docs/source/en/api/pipelines/stable_diffusion/{inpaint.mdx => inpaint.md} (100%) rename docs/source/en/api/pipelines/stable_diffusion/{latent_upscale.mdx => latent_upscale.md} (100%) rename docs/source/en/api/pipelines/stable_diffusion/{ldm3d_diffusion.mdx => ldm3d_diffusion.md} (100%) rename docs/source/en/api/pipelines/stable_diffusion/{overview.mdx => overview.md} (100%) rename docs/source/en/api/pipelines/stable_diffusion/{stable_diffusion_2.mdx => stable_diffusion_2.md} (100%) rename docs/source/en/api/pipelines/stable_diffusion/{stable_diffusion_safe.mdx => stable_diffusion_safe.md} (100%) rename docs/source/en/api/pipelines/stable_diffusion/{stable_diffusion_xl.mdx => stable_diffusion_xl.md} (100%) rename docs/source/en/api/pipelines/stable_diffusion/{text2img.mdx => text2img.md} (100%) rename docs/source/en/api/pipelines/stable_diffusion/{upscale.mdx => upscale.md} (100%) rename docs/source/en/api/pipelines/{stable_unclip.mdx => stable_unclip.md} (100%) rename docs/source/en/api/pipelines/{stochastic_karras_ve.mdx => stochastic_karras_ve.md} (100%) rename docs/source/en/api/pipelines/{text_to_video.mdx => text_to_video.md} (100%) rename docs/source/en/api/pipelines/{text_to_video_zero.mdx => text_to_video_zero.md} (100%) rename docs/source/en/api/pipelines/{unclip.mdx => unclip.md} (100%) rename docs/source/en/api/pipelines/{unidiffuser.mdx => unidiffuser.md} (100%) rename docs/source/en/api/pipelines/{value_guided_sampling.mdx => value_guided_sampling.md} (100%) rename docs/source/en/api/pipelines/{versatile_diffusion.mdx => versatile_diffusion.md} (100%) rename docs/source/en/api/pipelines/{vq_diffusion.mdx => vq_diffusion.md} (100%) rename docs/source/en/api/schedulers/{cm_stochastic_iterative.mdx => cm_stochastic_iterative.md} (100%) rename docs/source/en/api/schedulers/{ddim.mdx => ddim.md} (100%) rename docs/source/en/api/schedulers/{ddim_inverse.mdx => ddim_inverse.md} (100%) rename docs/source/en/api/schedulers/{ddpm.mdx => ddpm.md} (100%) rename docs/source/en/api/schedulers/{deis.mdx => deis.md} (100%) rename docs/source/en/api/schedulers/{dpm_discrete.mdx => dpm_discrete.md} (100%) rename docs/source/en/api/schedulers/{dpm_discrete_ancestral.mdx => dpm_discrete_ancestral.md} (100%) rename docs/source/en/api/schedulers/{dpm_sde.mdx => dpm_sde.md} (100%) rename docs/source/en/api/schedulers/{euler.mdx => euler.md} (100%) rename docs/source/en/api/schedulers/{euler_ancestral.mdx => euler_ancestral.md} (100%) rename docs/source/en/api/schedulers/{heun.mdx => heun.md} (100%) rename docs/source/en/api/schedulers/{ipndm.mdx => ipndm.md} (100%) rename docs/source/en/api/schedulers/{lms_discrete.mdx => lms_discrete.md} (100%) rename docs/source/en/api/schedulers/{multistep_dpm_solver.mdx => multistep_dpm_solver.md} (100%) rename docs/source/en/api/schedulers/{multistep_dpm_solver_inverse.mdx => multistep_dpm_solver_inverse.md} (100%) rename docs/source/en/api/schedulers/{overview.mdx => overview.md} (100%) rename docs/source/en/api/schedulers/{pndm.mdx => pndm.md} (100%) rename docs/source/en/api/schedulers/{repaint.mdx => repaint.md} (100%) rename docs/source/en/api/schedulers/{score_sde_ve.mdx => score_sde_ve.md} (100%) rename docs/source/en/api/schedulers/{score_sde_vp.mdx => score_sde_vp.md} (100%) rename docs/source/en/api/schedulers/{singlestep_dpm_solver.mdx => singlestep_dpm_solver.md} (100%) rename docs/source/en/api/schedulers/{stochastic_karras_ve.mdx => stochastic_karras_ve.md} (100%) rename docs/source/en/api/schedulers/{unipc.mdx => unipc.md} (100%) rename docs/source/en/api/schedulers/{vq_diffusion.mdx => vq_diffusion.md} (100%) rename docs/source/en/api/{utilities.mdx => utilities.md} (100%) rename docs/source/en/conceptual/{contribution.mdx => contribution.md} (100%) rename docs/source/en/conceptual/{ethical_guidelines.mdx => ethical_guidelines.md} (98%) rename docs/source/en/conceptual/{evaluation.mdx => evaluation.md} (100%) rename docs/source/en/conceptual/{philosophy.mdx => philosophy.md} (99%) rename docs/source/en/{index.mdx => index.md} (100%) rename docs/source/en/{installation.mdx => installation.md} (100%) rename docs/source/en/optimization/{coreml.mdx => coreml.md} (100%) rename docs/source/en/optimization/{fp16.mdx => fp16.md} (100%) rename docs/source/en/optimization/{habana.mdx => habana.md} (100%) rename docs/source/en/optimization/{mps.mdx => mps.md} (100%) rename docs/source/en/optimization/{onnx.mdx => onnx.md} (100%) rename docs/source/en/optimization/{open_vino.mdx => open_vino.md} (100%) rename docs/source/en/optimization/{opt_overview.mdx => opt_overview.md} (100%) rename docs/source/en/optimization/{tome.mdx => tome.md} (100%) rename docs/source/en/optimization/{torch2.0.mdx => torch2.0.md} (100%) rename docs/source/en/optimization/{xformers.mdx => xformers.md} (100%) rename docs/source/en/{quicktour.mdx => quicktour.md} (100%) rename docs/source/en/{stable_diffusion.mdx => stable_diffusion.md} (100%) rename docs/source/en/training/{adapt_a_model.mdx => adapt_a_model.md} (100%) rename docs/source/en/training/{controlnet.mdx => controlnet.md} (100%) rename docs/source/en/training/{create_dataset.mdx => create_dataset.md} (100%) rename docs/source/en/training/{custom_diffusion.mdx => custom_diffusion.md} (100%) rename docs/source/en/training/{distributed_inference.mdx => distributed_inference.md} (100%) rename docs/source/en/training/{dreambooth.mdx => dreambooth.md} (100%) rename docs/source/en/training/{instructpix2pix.mdx => instructpix2pix.md} (100%) rename docs/source/en/training/{lora.mdx => lora.md} (100%) rename docs/source/en/training/{overview.mdx => overview.md} (100%) rename docs/source/en/training/{text2image.mdx => text2image.md} (100%) rename docs/source/en/training/{text_inversion.mdx => text_inversion.md} (100%) rename docs/source/en/training/{unconditional_training.mdx => unconditional_training.md} (100%) rename docs/source/en/tutorials/{basic_training.mdx => basic_training.md} (100%) rename docs/source/en/tutorials/{tutorial_overview.mdx => tutorial_overview.md} (100%) rename docs/source/en/using-diffusers/{conditional_image_generation.mdx => conditional_image_generation.md} (100%) rename docs/source/en/using-diffusers/{contribute_pipeline.mdx => contribute_pipeline.md} (100%) rename docs/source/en/using-diffusers/{control_brightness.mdx => control_brightness.md} (100%) rename docs/source/en/using-diffusers/{controlling_generation.mdx => controlling_generation.md} (100%) rename docs/source/en/using-diffusers/{custom_pipeline_examples.mdx => custom_pipeline_examples.md} (100%) rename docs/source/en/using-diffusers/{custom_pipeline_overview.mdx => custom_pipeline_overview.md} (100%) rename docs/source/en/using-diffusers/{depth2img.mdx => depth2img.md} (100%) rename docs/source/en/using-diffusers/{img2img.mdx => img2img.md} (100%) rename docs/source/en/using-diffusers/{inpaint.mdx => inpaint.md} (100%) rename docs/source/en/using-diffusers/{loading.mdx => loading.md} (100%) rename docs/source/en/using-diffusers/{loading_overview.mdx => loading_overview.md} (100%) rename docs/source/en/using-diffusers/{other-formats.mdx => other-formats.md} (100%) rename docs/source/en/using-diffusers/{other-modalities.mdx => other-modalities.md} (100%) rename docs/source/en/using-diffusers/{pipeline_overview.mdx => pipeline_overview.md} (100%) rename docs/source/en/using-diffusers/{reproducibility.mdx => reproducibility.md} (100%) rename docs/source/en/using-diffusers/{reusing_seeds.mdx => reusing_seeds.md} (100%) rename docs/source/en/using-diffusers/{schedulers.mdx => schedulers.md} (99%) rename docs/source/en/using-diffusers/{stable_diffusion_jax_how_to.mdx => stable_diffusion_jax_how_to.md} (100%) rename docs/source/en/using-diffusers/{textual_inversion_inference.mdx => textual_inversion_inference.md} (100%) rename docs/source/en/using-diffusers/{unconditional_image_generation.mdx => unconditional_image_generation.md} (100%) rename docs/source/en/using-diffusers/{using_safetensors.mdx => using_safetensors.md} (100%) rename docs/source/en/using-diffusers/{weighted_prompts.mdx => weighted_prompts.md} (100%) rename docs/source/en/using-diffusers/{write_own_pipeline.mdx => write_own_pipeline.md} (100%) rename docs/source/ko/{in_translation.mdx => in_translation.md} (100%) rename docs/source/ko/{index.mdx => index.md} (100%) rename docs/source/ko/{installation.mdx => installation.md} (100%) rename docs/source/ko/optimization/{fp16.mdx => fp16.md} (100%) rename docs/source/ko/optimization/{habana.mdx => habana.md} (100%) rename docs/source/ko/optimization/{mps.mdx => mps.md} (100%) rename docs/source/ko/optimization/{onnx.mdx => onnx.md} (100%) rename docs/source/ko/optimization/{open_vino.mdx => open_vino.md} (100%) rename docs/source/ko/optimization/{opt_overview.mdx => opt_overview.md} (100%) rename docs/source/ko/optimization/{torch2.0.mdx => torch2.0.md} (100%) rename docs/source/ko/optimization/{xformers.mdx => xformers.md} (100%) rename docs/source/ko/{quicktour.mdx => quicktour.md} (100%) rename docs/source/ko/training/{adapt_a_model.mdx => adapt_a_model.md} (100%) rename docs/source/ko/training/{dreambooth.mdx => dreambooth.md} (100%) rename docs/source/ko/training/{lora.mdx => lora.md} (100%) rename docs/source/ko/training/{overview.mdx => overview.md} (100%) rename docs/source/ko/training/{text2image.mdx => text2image.md} (100%) rename docs/source/ko/training/{text_inversion.mdx => text_inversion.md} (100%) rename docs/source/ko/training/{unconditional_training.mdx => unconditional_training.md} (100%) rename docs/source/ko/tutorials/{basic_training.mdx => basic_training.md} (100%) rename docs/source/ko/tutorials/{tutorial_overview.mdx => tutorial_overview.md} (100%) rename docs/source/ko/using-diffusers/{custom_pipeline_examples.mdx => custom_pipeline_examples.md} (100%) rename docs/source/ko/using-diffusers/{custom_pipeline_overview.mdx => custom_pipeline_overview.md} (100%) rename docs/source/ko/using-diffusers/{depth2img.mdx => depth2img.md} (100%) rename docs/source/ko/using-diffusers/{img2img.mdx => img2img.md} (100%) rename docs/source/ko/using-diffusers/{inpaint.mdx => inpaint.md} (100%) rename docs/source/ko/using-diffusers/{loading.mdx => loading.md} (100%) rename docs/source/ko/using-diffusers/{other-formats.mdx => other-formats.md} (100%) rename docs/source/ko/using-diffusers/{pipeline_overview.mdx => pipeline_overview.md} (100%) rename docs/source/ko/using-diffusers/{reusing_seeds.mdx => reusing_seeds.md} (100%) rename docs/source/ko/using-diffusers/{schedulers.mdx => schedulers.md} (99%) rename docs/source/ko/using-diffusers/{unconditional_image_generation.mdx => unconditional_image_generation.md} (100%) rename docs/source/ko/using-diffusers/{using_safetensors.mdx => using_safetensors.md} (100%) rename docs/source/ko/using-diffusers/{write_own_pipeline.mdx => write_own_pipeline.md} (100%) rename docs/source/zh/{index.mdx => index.md} (100%) rename docs/source/zh/{installation.mdx => installation.md} (100%) rename docs/source/zh/{quicktour.mdx => quicktour.md} (100%) diff --git a/PHILOSOPHY.md b/PHILOSOPHY.md index 399cb0bfb4..fe511eb444 100644 --- a/PHILOSOPHY.md +++ b/PHILOSOPHY.md @@ -102,7 +102,7 @@ The following design principles are followed: - One scheduler python file corresponds to one scheduler algorithm (as might be defined in a paper). - If schedulers share similar functionalities, we can make use of the `#Copied from` mechanism. - Schedulers all inherit from `SchedulerMixin` and `ConfigMixin`. -- Schedulers can be easily swapped out with the [`ConfigMixin.from_config`](https://huggingface.co/docs/diffusers/main/en/api/configuration#diffusers.ConfigMixin.from_config) method as explained in detail [here](./using-diffusers/schedulers.mdx). +- Schedulers can be easily swapped out with the [`ConfigMixin.from_config`](https://huggingface.co/docs/diffusers/main/en/api/configuration#diffusers.ConfigMixin.from_config) method as explained in detail [here](./using-diffusers/schedulers.md). - Every scheduler has to have a `set_num_inference_steps`, and a `step` function. `set_num_inference_steps(...)` has to be called before every denoising process, *i.e.* before `step(...)` is called. - Every scheduler exposes the timesteps to be "looped over" via a `timesteps` attribute, which is an array of timesteps the model will be called upon - The `step(...)` function takes a predicted model output and the "current" sample (x_t) and returns the "previous", slightly more denoised sample (x_t-1). diff --git a/docs/README.md b/docs/README.md index 739f880f65..e6408dc976 100644 --- a/docs/README.md +++ b/docs/README.md @@ -68,7 +68,7 @@ The `preview` command only works with existing doc files. When you add a complet ## Adding a new element to the navigation bar -Accepted files are Markdown (.md or .mdx). +Accepted files are Markdown (.md). Create a file with its extension and put it in the source directory. You can then link it to the toc-tree by putting the filename without the extension in the [`_toctree.yml`](https://github.com/huggingface/diffusers/blob/main/docs/source/_toctree.yml) file. @@ -96,7 +96,7 @@ Sections that were moved: Use the relative style to link to the new file so that the versioned docs continue to work. -For an example of a rich moved section set please see the very end of [the transformers Trainer doc](https://github.com/huggingface/transformers/blob/main/docs/source/en/main_classes/trainer.mdx). +For an example of a rich moved section set please see the very end of [the transformers Trainer doc](https://github.com/huggingface/transformers/blob/main/docs/source/en/main_classes/trainer.md). ## Writing Documentation - Specification @@ -119,8 +119,8 @@ depending on the intended targets (beginners, more advanced users, or researcher When adding a new pipeline: -- create a file `xxx.mdx` under `docs/source/api/pipelines` (don't hesitate to copy an existing file as template). -- Link that file in (*Diffusers Summary*) section in `docs/source/api/pipelines/overview.mdx`, along with the link to the paper, and a colab notebook (if available). +- create a file `xxx.md` under `docs/source/api/pipelines` (don't hesitate to copy an existing file as template). +- Link that file in (*Diffusers Summary*) section in `docs/source/api/pipelines/overview.md`, along with the link to the paper, and a colab notebook (if available). - Write a short overview of the diffusion model: - Overview with paper & authors - Paper abstract diff --git a/docs/source/en/api/attnprocessor.mdx b/docs/source/en/api/attnprocessor.md similarity index 100% rename from docs/source/en/api/attnprocessor.mdx rename to docs/source/en/api/attnprocessor.md diff --git a/docs/source/en/api/configuration.mdx b/docs/source/en/api/configuration.md similarity index 100% rename from docs/source/en/api/configuration.mdx rename to docs/source/en/api/configuration.md diff --git a/docs/source/en/api/diffusion_pipeline.mdx b/docs/source/en/api/diffusion_pipeline.md similarity index 100% rename from docs/source/en/api/diffusion_pipeline.mdx rename to docs/source/en/api/diffusion_pipeline.md diff --git a/docs/source/en/api/image_processor.mdx b/docs/source/en/api/image_processor.md similarity index 100% rename from docs/source/en/api/image_processor.mdx rename to docs/source/en/api/image_processor.md diff --git a/docs/source/en/api/loaders.mdx b/docs/source/en/api/loaders.md similarity index 100% rename from docs/source/en/api/loaders.mdx rename to docs/source/en/api/loaders.md diff --git a/docs/source/en/api/logging.mdx b/docs/source/en/api/logging.md similarity index 100% rename from docs/source/en/api/logging.mdx rename to docs/source/en/api/logging.md diff --git a/docs/source/en/api/models/asymmetricautoencoderkl.mdx b/docs/source/en/api/models/asymmetricautoencoderkl.md similarity index 100% rename from docs/source/en/api/models/asymmetricautoencoderkl.mdx rename to docs/source/en/api/models/asymmetricautoencoderkl.md diff --git a/docs/source/en/api/models/autoencoderkl.mdx b/docs/source/en/api/models/autoencoderkl.md similarity index 100% rename from docs/source/en/api/models/autoencoderkl.mdx rename to docs/source/en/api/models/autoencoderkl.md diff --git a/docs/source/en/api/models/controlnet.mdx b/docs/source/en/api/models/controlnet.md similarity index 100% rename from docs/source/en/api/models/controlnet.mdx rename to docs/source/en/api/models/controlnet.md diff --git a/docs/source/en/api/models/overview.mdx b/docs/source/en/api/models/overview.md similarity index 100% rename from docs/source/en/api/models/overview.mdx rename to docs/source/en/api/models/overview.md diff --git a/docs/source/en/api/models/prior_transformer.mdx b/docs/source/en/api/models/prior_transformer.md similarity index 100% rename from docs/source/en/api/models/prior_transformer.mdx rename to docs/source/en/api/models/prior_transformer.md diff --git a/docs/source/en/api/models/transformer2d.mdx b/docs/source/en/api/models/transformer2d.md similarity index 100% rename from docs/source/en/api/models/transformer2d.mdx rename to docs/source/en/api/models/transformer2d.md diff --git a/docs/source/en/api/models/transformer_temporal.mdx b/docs/source/en/api/models/transformer_temporal.md similarity index 100% rename from docs/source/en/api/models/transformer_temporal.mdx rename to docs/source/en/api/models/transformer_temporal.md diff --git a/docs/source/en/api/models/unet.mdx b/docs/source/en/api/models/unet.md similarity index 100% rename from docs/source/en/api/models/unet.mdx rename to docs/source/en/api/models/unet.md diff --git a/docs/source/en/api/models/unet2d-cond.mdx b/docs/source/en/api/models/unet2d-cond.md similarity index 100% rename from docs/source/en/api/models/unet2d-cond.mdx rename to docs/source/en/api/models/unet2d-cond.md diff --git a/docs/source/en/api/models/unet2d.mdx b/docs/source/en/api/models/unet2d.md similarity index 100% rename from docs/source/en/api/models/unet2d.mdx rename to docs/source/en/api/models/unet2d.md diff --git a/docs/source/en/api/models/unet3d-cond.mdx b/docs/source/en/api/models/unet3d-cond.md similarity index 100% rename from docs/source/en/api/models/unet3d-cond.mdx rename to docs/source/en/api/models/unet3d-cond.md diff --git a/docs/source/en/api/models/vq.mdx b/docs/source/en/api/models/vq.md similarity index 100% rename from docs/source/en/api/models/vq.mdx rename to docs/source/en/api/models/vq.md diff --git a/docs/source/en/api/outputs.mdx b/docs/source/en/api/outputs.md similarity index 100% rename from docs/source/en/api/outputs.mdx rename to docs/source/en/api/outputs.md diff --git a/docs/source/en/api/pipelines/alt_diffusion.mdx b/docs/source/en/api/pipelines/alt_diffusion.md similarity index 100% rename from docs/source/en/api/pipelines/alt_diffusion.mdx rename to docs/source/en/api/pipelines/alt_diffusion.md diff --git a/docs/source/en/api/pipelines/attend_and_excite.mdx b/docs/source/en/api/pipelines/attend_and_excite.md similarity index 100% rename from docs/source/en/api/pipelines/attend_and_excite.mdx rename to docs/source/en/api/pipelines/attend_and_excite.md diff --git a/docs/source/en/api/pipelines/audio_diffusion.mdx b/docs/source/en/api/pipelines/audio_diffusion.md similarity index 100% rename from docs/source/en/api/pipelines/audio_diffusion.mdx rename to docs/source/en/api/pipelines/audio_diffusion.md diff --git a/docs/source/en/api/pipelines/audioldm.mdx b/docs/source/en/api/pipelines/audioldm.md similarity index 100% rename from docs/source/en/api/pipelines/audioldm.mdx rename to docs/source/en/api/pipelines/audioldm.md diff --git a/docs/source/en/api/pipelines/auto_pipeline.mdx b/docs/source/en/api/pipelines/auto_pipeline.md similarity index 100% rename from docs/source/en/api/pipelines/auto_pipeline.mdx rename to docs/source/en/api/pipelines/auto_pipeline.md diff --git a/docs/source/en/api/pipelines/consistency_models.mdx b/docs/source/en/api/pipelines/consistency_models.md similarity index 100% rename from docs/source/en/api/pipelines/consistency_models.mdx rename to docs/source/en/api/pipelines/consistency_models.md diff --git a/docs/source/en/api/pipelines/controlnet.mdx b/docs/source/en/api/pipelines/controlnet.md similarity index 100% rename from docs/source/en/api/pipelines/controlnet.mdx rename to docs/source/en/api/pipelines/controlnet.md diff --git a/docs/source/en/api/pipelines/cycle_diffusion.mdx b/docs/source/en/api/pipelines/cycle_diffusion.md similarity index 100% rename from docs/source/en/api/pipelines/cycle_diffusion.mdx rename to docs/source/en/api/pipelines/cycle_diffusion.md diff --git a/docs/source/en/api/pipelines/dance_diffusion.mdx b/docs/source/en/api/pipelines/dance_diffusion.md similarity index 100% rename from docs/source/en/api/pipelines/dance_diffusion.mdx rename to docs/source/en/api/pipelines/dance_diffusion.md diff --git a/docs/source/en/api/pipelines/ddim.mdx b/docs/source/en/api/pipelines/ddim.md similarity index 100% rename from docs/source/en/api/pipelines/ddim.mdx rename to docs/source/en/api/pipelines/ddim.md diff --git a/docs/source/en/api/pipelines/ddpm.mdx b/docs/source/en/api/pipelines/ddpm.md similarity index 100% rename from docs/source/en/api/pipelines/ddpm.mdx rename to docs/source/en/api/pipelines/ddpm.md diff --git a/docs/source/en/api/pipelines/deepfloyd_if.mdx b/docs/source/en/api/pipelines/deepfloyd_if.md similarity index 100% rename from docs/source/en/api/pipelines/deepfloyd_if.mdx rename to docs/source/en/api/pipelines/deepfloyd_if.md diff --git a/docs/source/en/api/pipelines/diffedit.mdx b/docs/source/en/api/pipelines/diffedit.md similarity index 100% rename from docs/source/en/api/pipelines/diffedit.mdx rename to docs/source/en/api/pipelines/diffedit.md diff --git a/docs/source/en/api/pipelines/dit.mdx b/docs/source/en/api/pipelines/dit.md similarity index 100% rename from docs/source/en/api/pipelines/dit.mdx rename to docs/source/en/api/pipelines/dit.md diff --git a/docs/source/en/api/pipelines/kandinsky.mdx b/docs/source/en/api/pipelines/kandinsky.md similarity index 100% rename from docs/source/en/api/pipelines/kandinsky.mdx rename to docs/source/en/api/pipelines/kandinsky.md diff --git a/docs/source/en/api/pipelines/kandinsky_v22.mdx b/docs/source/en/api/pipelines/kandinsky_v22.md similarity index 100% rename from docs/source/en/api/pipelines/kandinsky_v22.mdx rename to docs/source/en/api/pipelines/kandinsky_v22.md diff --git a/docs/source/en/api/pipelines/latent_diffusion.mdx b/docs/source/en/api/pipelines/latent_diffusion.md similarity index 100% rename from docs/source/en/api/pipelines/latent_diffusion.mdx rename to docs/source/en/api/pipelines/latent_diffusion.md diff --git a/docs/source/en/api/pipelines/latent_diffusion_uncond.mdx b/docs/source/en/api/pipelines/latent_diffusion_uncond.md similarity index 100% rename from docs/source/en/api/pipelines/latent_diffusion_uncond.mdx rename to docs/source/en/api/pipelines/latent_diffusion_uncond.md diff --git a/docs/source/en/api/pipelines/model_editing.mdx b/docs/source/en/api/pipelines/model_editing.md similarity index 100% rename from docs/source/en/api/pipelines/model_editing.mdx rename to docs/source/en/api/pipelines/model_editing.md diff --git a/docs/source/en/api/pipelines/overview.mdx b/docs/source/en/api/pipelines/overview.md similarity index 100% rename from docs/source/en/api/pipelines/overview.mdx rename to docs/source/en/api/pipelines/overview.md diff --git a/docs/source/en/api/pipelines/paint_by_example.mdx b/docs/source/en/api/pipelines/paint_by_example.md similarity index 100% rename from docs/source/en/api/pipelines/paint_by_example.mdx rename to docs/source/en/api/pipelines/paint_by_example.md diff --git a/docs/source/en/api/pipelines/panorama.mdx b/docs/source/en/api/pipelines/panorama.md similarity index 100% rename from docs/source/en/api/pipelines/panorama.mdx rename to docs/source/en/api/pipelines/panorama.md diff --git a/docs/source/en/api/pipelines/paradigms.mdx b/docs/source/en/api/pipelines/paradigms.md similarity index 100% rename from docs/source/en/api/pipelines/paradigms.mdx rename to docs/source/en/api/pipelines/paradigms.md diff --git a/docs/source/en/api/pipelines/pix2pix.mdx b/docs/source/en/api/pipelines/pix2pix.md similarity index 100% rename from docs/source/en/api/pipelines/pix2pix.mdx rename to docs/source/en/api/pipelines/pix2pix.md diff --git a/docs/source/en/api/pipelines/pix2pix_zero.mdx b/docs/source/en/api/pipelines/pix2pix_zero.md similarity index 100% rename from docs/source/en/api/pipelines/pix2pix_zero.mdx rename to docs/source/en/api/pipelines/pix2pix_zero.md diff --git a/docs/source/en/api/pipelines/pndm.mdx b/docs/source/en/api/pipelines/pndm.md similarity index 100% rename from docs/source/en/api/pipelines/pndm.mdx rename to docs/source/en/api/pipelines/pndm.md diff --git a/docs/source/en/api/pipelines/repaint.mdx b/docs/source/en/api/pipelines/repaint.md similarity index 100% rename from docs/source/en/api/pipelines/repaint.mdx rename to docs/source/en/api/pipelines/repaint.md diff --git a/docs/source/en/api/pipelines/score_sde_ve.mdx b/docs/source/en/api/pipelines/score_sde_ve.md similarity index 100% rename from docs/source/en/api/pipelines/score_sde_ve.mdx rename to docs/source/en/api/pipelines/score_sde_ve.md diff --git a/docs/source/en/api/pipelines/self_attention_guidance.mdx b/docs/source/en/api/pipelines/self_attention_guidance.md similarity index 100% rename from docs/source/en/api/pipelines/self_attention_guidance.mdx rename to docs/source/en/api/pipelines/self_attention_guidance.md diff --git a/docs/source/en/api/pipelines/semantic_stable_diffusion.mdx b/docs/source/en/api/pipelines/semantic_stable_diffusion.md similarity index 100% rename from docs/source/en/api/pipelines/semantic_stable_diffusion.mdx rename to docs/source/en/api/pipelines/semantic_stable_diffusion.md diff --git a/docs/source/en/api/pipelines/shap_e.mdx b/docs/source/en/api/pipelines/shap_e.md similarity index 100% rename from docs/source/en/api/pipelines/shap_e.mdx rename to docs/source/en/api/pipelines/shap_e.md diff --git a/docs/source/en/api/pipelines/spectrogram_diffusion.mdx b/docs/source/en/api/pipelines/spectrogram_diffusion.md similarity index 100% rename from docs/source/en/api/pipelines/spectrogram_diffusion.mdx rename to docs/source/en/api/pipelines/spectrogram_diffusion.md diff --git a/docs/source/en/api/pipelines/stable_diffusion/adapter.mdx b/docs/source/en/api/pipelines/stable_diffusion/adapter.md similarity index 100% rename from docs/source/en/api/pipelines/stable_diffusion/adapter.mdx rename to docs/source/en/api/pipelines/stable_diffusion/adapter.md diff --git a/docs/source/en/api/pipelines/stable_diffusion/depth2img.mdx b/docs/source/en/api/pipelines/stable_diffusion/depth2img.md similarity index 100% rename from docs/source/en/api/pipelines/stable_diffusion/depth2img.mdx rename to docs/source/en/api/pipelines/stable_diffusion/depth2img.md diff --git a/docs/source/en/api/pipelines/stable_diffusion/image_variation.mdx b/docs/source/en/api/pipelines/stable_diffusion/image_variation.md similarity index 100% rename from docs/source/en/api/pipelines/stable_diffusion/image_variation.mdx rename to docs/source/en/api/pipelines/stable_diffusion/image_variation.md diff --git a/docs/source/en/api/pipelines/stable_diffusion/img2img.mdx b/docs/source/en/api/pipelines/stable_diffusion/img2img.md similarity index 100% rename from docs/source/en/api/pipelines/stable_diffusion/img2img.mdx rename to docs/source/en/api/pipelines/stable_diffusion/img2img.md diff --git a/docs/source/en/api/pipelines/stable_diffusion/inpaint.mdx b/docs/source/en/api/pipelines/stable_diffusion/inpaint.md similarity index 100% rename from docs/source/en/api/pipelines/stable_diffusion/inpaint.mdx rename to docs/source/en/api/pipelines/stable_diffusion/inpaint.md diff --git a/docs/source/en/api/pipelines/stable_diffusion/latent_upscale.mdx b/docs/source/en/api/pipelines/stable_diffusion/latent_upscale.md similarity index 100% rename from docs/source/en/api/pipelines/stable_diffusion/latent_upscale.mdx rename to docs/source/en/api/pipelines/stable_diffusion/latent_upscale.md diff --git a/docs/source/en/api/pipelines/stable_diffusion/ldm3d_diffusion.mdx b/docs/source/en/api/pipelines/stable_diffusion/ldm3d_diffusion.md similarity index 100% rename from docs/source/en/api/pipelines/stable_diffusion/ldm3d_diffusion.mdx rename to docs/source/en/api/pipelines/stable_diffusion/ldm3d_diffusion.md diff --git a/docs/source/en/api/pipelines/stable_diffusion/overview.mdx b/docs/source/en/api/pipelines/stable_diffusion/overview.md similarity index 100% rename from docs/source/en/api/pipelines/stable_diffusion/overview.mdx rename to docs/source/en/api/pipelines/stable_diffusion/overview.md diff --git a/docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_2.mdx b/docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_2.md similarity index 100% rename from docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_2.mdx rename to docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_2.md diff --git a/docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_safe.mdx b/docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_safe.md similarity index 100% rename from docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_safe.mdx rename to docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_safe.md diff --git a/docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_xl.mdx b/docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_xl.md similarity index 100% rename from docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_xl.mdx rename to docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_xl.md diff --git a/docs/source/en/api/pipelines/stable_diffusion/text2img.mdx b/docs/source/en/api/pipelines/stable_diffusion/text2img.md similarity index 100% rename from docs/source/en/api/pipelines/stable_diffusion/text2img.mdx rename to docs/source/en/api/pipelines/stable_diffusion/text2img.md diff --git a/docs/source/en/api/pipelines/stable_diffusion/upscale.mdx b/docs/source/en/api/pipelines/stable_diffusion/upscale.md similarity index 100% rename from docs/source/en/api/pipelines/stable_diffusion/upscale.mdx rename to docs/source/en/api/pipelines/stable_diffusion/upscale.md diff --git a/docs/source/en/api/pipelines/stable_unclip.mdx b/docs/source/en/api/pipelines/stable_unclip.md similarity index 100% rename from docs/source/en/api/pipelines/stable_unclip.mdx rename to docs/source/en/api/pipelines/stable_unclip.md diff --git a/docs/source/en/api/pipelines/stochastic_karras_ve.mdx b/docs/source/en/api/pipelines/stochastic_karras_ve.md similarity index 100% rename from docs/source/en/api/pipelines/stochastic_karras_ve.mdx rename to docs/source/en/api/pipelines/stochastic_karras_ve.md diff --git a/docs/source/en/api/pipelines/text_to_video.mdx b/docs/source/en/api/pipelines/text_to_video.md similarity index 100% rename from docs/source/en/api/pipelines/text_to_video.mdx rename to docs/source/en/api/pipelines/text_to_video.md diff --git a/docs/source/en/api/pipelines/text_to_video_zero.mdx b/docs/source/en/api/pipelines/text_to_video_zero.md similarity index 100% rename from docs/source/en/api/pipelines/text_to_video_zero.mdx rename to docs/source/en/api/pipelines/text_to_video_zero.md diff --git a/docs/source/en/api/pipelines/unclip.mdx b/docs/source/en/api/pipelines/unclip.md similarity index 100% rename from docs/source/en/api/pipelines/unclip.mdx rename to docs/source/en/api/pipelines/unclip.md diff --git a/docs/source/en/api/pipelines/unidiffuser.mdx b/docs/source/en/api/pipelines/unidiffuser.md similarity index 100% rename from docs/source/en/api/pipelines/unidiffuser.mdx rename to docs/source/en/api/pipelines/unidiffuser.md diff --git a/docs/source/en/api/pipelines/value_guided_sampling.mdx b/docs/source/en/api/pipelines/value_guided_sampling.md similarity index 100% rename from docs/source/en/api/pipelines/value_guided_sampling.mdx rename to docs/source/en/api/pipelines/value_guided_sampling.md diff --git a/docs/source/en/api/pipelines/versatile_diffusion.mdx b/docs/source/en/api/pipelines/versatile_diffusion.md similarity index 100% rename from docs/source/en/api/pipelines/versatile_diffusion.mdx rename to docs/source/en/api/pipelines/versatile_diffusion.md diff --git a/docs/source/en/api/pipelines/vq_diffusion.mdx b/docs/source/en/api/pipelines/vq_diffusion.md similarity index 100% rename from docs/source/en/api/pipelines/vq_diffusion.mdx rename to docs/source/en/api/pipelines/vq_diffusion.md diff --git a/docs/source/en/api/schedulers/cm_stochastic_iterative.mdx b/docs/source/en/api/schedulers/cm_stochastic_iterative.md similarity index 100% rename from docs/source/en/api/schedulers/cm_stochastic_iterative.mdx rename to docs/source/en/api/schedulers/cm_stochastic_iterative.md diff --git a/docs/source/en/api/schedulers/ddim.mdx b/docs/source/en/api/schedulers/ddim.md similarity index 100% rename from docs/source/en/api/schedulers/ddim.mdx rename to docs/source/en/api/schedulers/ddim.md diff --git a/docs/source/en/api/schedulers/ddim_inverse.mdx b/docs/source/en/api/schedulers/ddim_inverse.md similarity index 100% rename from docs/source/en/api/schedulers/ddim_inverse.mdx rename to docs/source/en/api/schedulers/ddim_inverse.md diff --git a/docs/source/en/api/schedulers/ddpm.mdx b/docs/source/en/api/schedulers/ddpm.md similarity index 100% rename from docs/source/en/api/schedulers/ddpm.mdx rename to docs/source/en/api/schedulers/ddpm.md diff --git a/docs/source/en/api/schedulers/deis.mdx b/docs/source/en/api/schedulers/deis.md similarity index 100% rename from docs/source/en/api/schedulers/deis.mdx rename to docs/source/en/api/schedulers/deis.md diff --git a/docs/source/en/api/schedulers/dpm_discrete.mdx b/docs/source/en/api/schedulers/dpm_discrete.md similarity index 100% rename from docs/source/en/api/schedulers/dpm_discrete.mdx rename to docs/source/en/api/schedulers/dpm_discrete.md diff --git a/docs/source/en/api/schedulers/dpm_discrete_ancestral.mdx b/docs/source/en/api/schedulers/dpm_discrete_ancestral.md similarity index 100% rename from docs/source/en/api/schedulers/dpm_discrete_ancestral.mdx rename to docs/source/en/api/schedulers/dpm_discrete_ancestral.md diff --git a/docs/source/en/api/schedulers/dpm_sde.mdx b/docs/source/en/api/schedulers/dpm_sde.md similarity index 100% rename from docs/source/en/api/schedulers/dpm_sde.mdx rename to docs/source/en/api/schedulers/dpm_sde.md diff --git a/docs/source/en/api/schedulers/euler.mdx b/docs/source/en/api/schedulers/euler.md similarity index 100% rename from docs/source/en/api/schedulers/euler.mdx rename to docs/source/en/api/schedulers/euler.md diff --git a/docs/source/en/api/schedulers/euler_ancestral.mdx b/docs/source/en/api/schedulers/euler_ancestral.md similarity index 100% rename from docs/source/en/api/schedulers/euler_ancestral.mdx rename to docs/source/en/api/schedulers/euler_ancestral.md diff --git a/docs/source/en/api/schedulers/heun.mdx b/docs/source/en/api/schedulers/heun.md similarity index 100% rename from docs/source/en/api/schedulers/heun.mdx rename to docs/source/en/api/schedulers/heun.md diff --git a/docs/source/en/api/schedulers/ipndm.mdx b/docs/source/en/api/schedulers/ipndm.md similarity index 100% rename from docs/source/en/api/schedulers/ipndm.mdx rename to docs/source/en/api/schedulers/ipndm.md diff --git a/docs/source/en/api/schedulers/lms_discrete.mdx b/docs/source/en/api/schedulers/lms_discrete.md similarity index 100% rename from docs/source/en/api/schedulers/lms_discrete.mdx rename to docs/source/en/api/schedulers/lms_discrete.md diff --git a/docs/source/en/api/schedulers/multistep_dpm_solver.mdx b/docs/source/en/api/schedulers/multistep_dpm_solver.md similarity index 100% rename from docs/source/en/api/schedulers/multistep_dpm_solver.mdx rename to docs/source/en/api/schedulers/multistep_dpm_solver.md diff --git a/docs/source/en/api/schedulers/multistep_dpm_solver_inverse.mdx b/docs/source/en/api/schedulers/multistep_dpm_solver_inverse.md similarity index 100% rename from docs/source/en/api/schedulers/multistep_dpm_solver_inverse.mdx rename to docs/source/en/api/schedulers/multistep_dpm_solver_inverse.md diff --git a/docs/source/en/api/schedulers/overview.mdx b/docs/source/en/api/schedulers/overview.md similarity index 100% rename from docs/source/en/api/schedulers/overview.mdx rename to docs/source/en/api/schedulers/overview.md diff --git a/docs/source/en/api/schedulers/pndm.mdx b/docs/source/en/api/schedulers/pndm.md similarity index 100% rename from docs/source/en/api/schedulers/pndm.mdx rename to docs/source/en/api/schedulers/pndm.md diff --git a/docs/source/en/api/schedulers/repaint.mdx b/docs/source/en/api/schedulers/repaint.md similarity index 100% rename from docs/source/en/api/schedulers/repaint.mdx rename to docs/source/en/api/schedulers/repaint.md diff --git a/docs/source/en/api/schedulers/score_sde_ve.mdx b/docs/source/en/api/schedulers/score_sde_ve.md similarity index 100% rename from docs/source/en/api/schedulers/score_sde_ve.mdx rename to docs/source/en/api/schedulers/score_sde_ve.md diff --git a/docs/source/en/api/schedulers/score_sde_vp.mdx b/docs/source/en/api/schedulers/score_sde_vp.md similarity index 100% rename from docs/source/en/api/schedulers/score_sde_vp.mdx rename to docs/source/en/api/schedulers/score_sde_vp.md diff --git a/docs/source/en/api/schedulers/singlestep_dpm_solver.mdx b/docs/source/en/api/schedulers/singlestep_dpm_solver.md similarity index 100% rename from docs/source/en/api/schedulers/singlestep_dpm_solver.mdx rename to docs/source/en/api/schedulers/singlestep_dpm_solver.md diff --git a/docs/source/en/api/schedulers/stochastic_karras_ve.mdx b/docs/source/en/api/schedulers/stochastic_karras_ve.md similarity index 100% rename from docs/source/en/api/schedulers/stochastic_karras_ve.mdx rename to docs/source/en/api/schedulers/stochastic_karras_ve.md diff --git a/docs/source/en/api/schedulers/unipc.mdx b/docs/source/en/api/schedulers/unipc.md similarity index 100% rename from docs/source/en/api/schedulers/unipc.mdx rename to docs/source/en/api/schedulers/unipc.md diff --git a/docs/source/en/api/schedulers/vq_diffusion.mdx b/docs/source/en/api/schedulers/vq_diffusion.md similarity index 100% rename from docs/source/en/api/schedulers/vq_diffusion.mdx rename to docs/source/en/api/schedulers/vq_diffusion.md diff --git a/docs/source/en/api/utilities.mdx b/docs/source/en/api/utilities.md similarity index 100% rename from docs/source/en/api/utilities.mdx rename to docs/source/en/api/utilities.md diff --git a/docs/source/en/conceptual/contribution.mdx b/docs/source/en/conceptual/contribution.md similarity index 100% rename from docs/source/en/conceptual/contribution.mdx rename to docs/source/en/conceptual/contribution.md diff --git a/docs/source/en/conceptual/ethical_guidelines.mdx b/docs/source/en/conceptual/ethical_guidelines.md similarity index 98% rename from docs/source/en/conceptual/ethical_guidelines.mdx rename to docs/source/en/conceptual/ethical_guidelines.md index 0c1a7b7892..100a92152f 100644 --- a/docs/source/en/conceptual/ethical_guidelines.mdx +++ b/docs/source/en/conceptual/ethical_guidelines.md @@ -1,51 +1,51 @@ -# 🧨 Diffusers’ Ethical Guidelines - -## Preamble - -[Diffusers](https://huggingface.co/docs/diffusers/index) provides pre-trained diffusion models and serves as a modular toolbox for inference and training. - -Given its real case applications in the world and potential negative impacts on society, we think it is important to provide the project with ethical guidelines to guide the development, users’ contributions, and usage of the Diffusers library. - -The risks associated with using this technology are still being examined, but to name a few: copyrights issues for artists; deep-fake exploitation; sexual content generation in inappropriate contexts; non-consensual impersonation; harmful social biases perpetuating the oppression of marginalized groups. -We will keep tracking risks and adapt the following guidelines based on the community's responsiveness and valuable feedback. - - -## Scope - -The Diffusers community will apply the following ethical guidelines to the project’s development and help coordinate how the community will integrate the contributions, especially concerning sensitive topics related to ethical concerns. - - -## Ethical guidelines - -The following ethical guidelines apply generally, but we will primarily implement them when dealing with ethically sensitive issues while making a technical choice. Furthermore, we commit to adapting those ethical principles over time following emerging harms related to the state of the art of the technology in question. - -- **Transparency**: we are committed to being transparent in managing PRs, explaining our choices to users, and making technical decisions. - -- **Consistency**: we are committed to guaranteeing our users the same level of attention in project management, keeping it technically stable and consistent. - -- **Simplicity**: with a desire to make it easy to use and exploit the Diffusers library, we are committed to keeping the project’s goals lean and coherent. - -- **Accessibility**: the Diffusers project helps lower the entry bar for contributors who can help run it even without technical expertise. Doing so makes research artifacts more accessible to the community. - -- **Reproducibility**: we aim to be transparent about the reproducibility of upstream code, models, and datasets when made available through the Diffusers library. - -- **Responsibility**: as a community and through teamwork, we hold a collective responsibility to our users by anticipating and mitigating this technology's potential risks and dangers. - - -## Examples of implementations: Safety features and Mechanisms - -The team works daily to make the technical and non-technical tools available to deal with the potential ethical and social risks associated with diffusion technology. Moreover, the community's input is invaluable in ensuring these features' implementation and raising awareness with us. - -- [**Community tab**](https://huggingface.co/docs/hub/repositories-pull-requests-discussions): it enables the community to discuss and better collaborate on a project. - -- **Bias exploration and evaluation**: the Hugging Face team provides a [space](https://huggingface.co/spaces/society-ethics/DiffusionBiasExplorer) to demonstrate the biases in Stable Diffusion interactively. In this sense, we support and encourage bias explorers and evaluations. - -- **Encouraging safety in deployment** - - - [**Safe Stable Diffusion**](https://huggingface.co/docs/diffusers/main/en/api/pipelines/stable_diffusion_safe): It mitigates the well-known issue that models, like Stable Diffusion, that are trained on unfiltered, web-crawled datasets tend to suffer from inappropriate degeneration. Related paper: [Safe Latent Diffusion: Mitigating Inappropriate Degeneration in Diffusion Models](https://arxiv.org/abs/2211.05105). - - - [**Safety Checker**](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/stable_diffusion/safety_checker.py): It checks and compares the class probability of a set of hard-coded harmful concepts in the embedding space against an image after it has been generated. The harmful concepts are intentionally hidden to prevent reverse engineering of the checker. - -- **Staged released on the Hub**: in particularly sensitive situations, access to some repositories should be restricted. This staged release is an intermediary step that allows the repository’s authors to have more control over its use. - -- **Licensing**: [OpenRAILs](https://huggingface.co/blog/open_rail), a new type of licensing, allow us to ensure free access while having a set of restrictions that ensure more responsible use. +# 🧨 Diffusers’ Ethical Guidelines + +## Preamble + +[Diffusers](https://huggingface.co/docs/diffusers/index) provides pre-trained diffusion models and serves as a modular toolbox for inference and training. + +Given its real case applications in the world and potential negative impacts on society, we think it is important to provide the project with ethical guidelines to guide the development, users’ contributions, and usage of the Diffusers library. + +The risks associated with using this technology are still being examined, but to name a few: copyrights issues for artists; deep-fake exploitation; sexual content generation in inappropriate contexts; non-consensual impersonation; harmful social biases perpetuating the oppression of marginalized groups. +We will keep tracking risks and adapt the following guidelines based on the community's responsiveness and valuable feedback. + + +## Scope + +The Diffusers community will apply the following ethical guidelines to the project’s development and help coordinate how the community will integrate the contributions, especially concerning sensitive topics related to ethical concerns. + + +## Ethical guidelines + +The following ethical guidelines apply generally, but we will primarily implement them when dealing with ethically sensitive issues while making a technical choice. Furthermore, we commit to adapting those ethical principles over time following emerging harms related to the state of the art of the technology in question. + +- **Transparency**: we are committed to being transparent in managing PRs, explaining our choices to users, and making technical decisions. + +- **Consistency**: we are committed to guaranteeing our users the same level of attention in project management, keeping it technically stable and consistent. + +- **Simplicity**: with a desire to make it easy to use and exploit the Diffusers library, we are committed to keeping the project’s goals lean and coherent. + +- **Accessibility**: the Diffusers project helps lower the entry bar for contributors who can help run it even without technical expertise. Doing so makes research artifacts more accessible to the community. + +- **Reproducibility**: we aim to be transparent about the reproducibility of upstream code, models, and datasets when made available through the Diffusers library. + +- **Responsibility**: as a community and through teamwork, we hold a collective responsibility to our users by anticipating and mitigating this technology's potential risks and dangers. + + +## Examples of implementations: Safety features and Mechanisms + +The team works daily to make the technical and non-technical tools available to deal with the potential ethical and social risks associated with diffusion technology. Moreover, the community's input is invaluable in ensuring these features' implementation and raising awareness with us. + +- [**Community tab**](https://huggingface.co/docs/hub/repositories-pull-requests-discussions): it enables the community to discuss and better collaborate on a project. + +- **Bias exploration and evaluation**: the Hugging Face team provides a [space](https://huggingface.co/spaces/society-ethics/DiffusionBiasExplorer) to demonstrate the biases in Stable Diffusion interactively. In this sense, we support and encourage bias explorers and evaluations. + +- **Encouraging safety in deployment** + + - [**Safe Stable Diffusion**](https://huggingface.co/docs/diffusers/main/en/api/pipelines/stable_diffusion_safe): It mitigates the well-known issue that models, like Stable Diffusion, that are trained on unfiltered, web-crawled datasets tend to suffer from inappropriate degeneration. Related paper: [Safe Latent Diffusion: Mitigating Inappropriate Degeneration in Diffusion Models](https://arxiv.org/abs/2211.05105). + + - [**Safety Checker**](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/stable_diffusion/safety_checker.py): It checks and compares the class probability of a set of hard-coded harmful concepts in the embedding space against an image after it has been generated. The harmful concepts are intentionally hidden to prevent reverse engineering of the checker. + +- **Staged released on the Hub**: in particularly sensitive situations, access to some repositories should be restricted. This staged release is an intermediary step that allows the repository’s authors to have more control over its use. + +- **Licensing**: [OpenRAILs](https://huggingface.co/blog/open_rail), a new type of licensing, allow us to ensure free access while having a set of restrictions that ensure more responsible use. diff --git a/docs/source/en/conceptual/evaluation.mdx b/docs/source/en/conceptual/evaluation.md similarity index 100% rename from docs/source/en/conceptual/evaluation.mdx rename to docs/source/en/conceptual/evaluation.md diff --git a/docs/source/en/conceptual/philosophy.mdx b/docs/source/en/conceptual/philosophy.md similarity index 99% rename from docs/source/en/conceptual/philosophy.mdx rename to docs/source/en/conceptual/philosophy.md index 564530f2cb..733f741b2b 100644 --- a/docs/source/en/conceptual/philosophy.mdx +++ b/docs/source/en/conceptual/philosophy.md @@ -102,7 +102,7 @@ The following design principles are followed: - One scheduler python file corresponds to one scheduler algorithm (as might be defined in a paper). - If schedulers share similar functionalities, we can make use of the `#Copied from` mechanism. - Schedulers all inherit from `SchedulerMixin` and `ConfigMixin`. -- Schedulers can be easily swapped out with the [`ConfigMixin.from_config`](https://huggingface.co/docs/diffusers/main/en/api/configuration#diffusers.ConfigMixin.from_config) method as explained in detail [here](./using-diffusers/schedulers.mdx). +- Schedulers can be easily swapped out with the [`ConfigMixin.from_config`](https://huggingface.co/docs/diffusers/main/en/api/configuration#diffusers.ConfigMixin.from_config) method as explained in detail [here](./using-diffusers/schedulers.md). - Every scheduler has to have a `set_num_inference_steps`, and a `step` function. `set_num_inference_steps(...)` has to be called before every denoising process, *i.e.* before `step(...)` is called. - Every scheduler exposes the timesteps to be "looped over" via a `timesteps` attribute, which is an array of timesteps the model will be called upon. - The `step(...)` function takes a predicted model output and the "current" sample (x_t) and returns the "previous", slightly more denoised sample (x_t-1). diff --git a/docs/source/en/index.mdx b/docs/source/en/index.md similarity index 100% rename from docs/source/en/index.mdx rename to docs/source/en/index.md diff --git a/docs/source/en/installation.mdx b/docs/source/en/installation.md similarity index 100% rename from docs/source/en/installation.mdx rename to docs/source/en/installation.md diff --git a/docs/source/en/optimization/coreml.mdx b/docs/source/en/optimization/coreml.md similarity index 100% rename from docs/source/en/optimization/coreml.mdx rename to docs/source/en/optimization/coreml.md diff --git a/docs/source/en/optimization/fp16.mdx b/docs/source/en/optimization/fp16.md similarity index 100% rename from docs/source/en/optimization/fp16.mdx rename to docs/source/en/optimization/fp16.md diff --git a/docs/source/en/optimization/habana.mdx b/docs/source/en/optimization/habana.md similarity index 100% rename from docs/source/en/optimization/habana.mdx rename to docs/source/en/optimization/habana.md diff --git a/docs/source/en/optimization/mps.mdx b/docs/source/en/optimization/mps.md similarity index 100% rename from docs/source/en/optimization/mps.mdx rename to docs/source/en/optimization/mps.md diff --git a/docs/source/en/optimization/onnx.mdx b/docs/source/en/optimization/onnx.md similarity index 100% rename from docs/source/en/optimization/onnx.mdx rename to docs/source/en/optimization/onnx.md diff --git a/docs/source/en/optimization/open_vino.mdx b/docs/source/en/optimization/open_vino.md similarity index 100% rename from docs/source/en/optimization/open_vino.mdx rename to docs/source/en/optimization/open_vino.md diff --git a/docs/source/en/optimization/opt_overview.mdx b/docs/source/en/optimization/opt_overview.md similarity index 100% rename from docs/source/en/optimization/opt_overview.mdx rename to docs/source/en/optimization/opt_overview.md diff --git a/docs/source/en/optimization/tome.mdx b/docs/source/en/optimization/tome.md similarity index 100% rename from docs/source/en/optimization/tome.mdx rename to docs/source/en/optimization/tome.md diff --git a/docs/source/en/optimization/torch2.0.mdx b/docs/source/en/optimization/torch2.0.md similarity index 100% rename from docs/source/en/optimization/torch2.0.mdx rename to docs/source/en/optimization/torch2.0.md diff --git a/docs/source/en/optimization/xformers.mdx b/docs/source/en/optimization/xformers.md similarity index 100% rename from docs/source/en/optimization/xformers.mdx rename to docs/source/en/optimization/xformers.md diff --git a/docs/source/en/quicktour.mdx b/docs/source/en/quicktour.md similarity index 100% rename from docs/source/en/quicktour.mdx rename to docs/source/en/quicktour.md diff --git a/docs/source/en/stable_diffusion.mdx b/docs/source/en/stable_diffusion.md similarity index 100% rename from docs/source/en/stable_diffusion.mdx rename to docs/source/en/stable_diffusion.md diff --git a/docs/source/en/training/adapt_a_model.mdx b/docs/source/en/training/adapt_a_model.md similarity index 100% rename from docs/source/en/training/adapt_a_model.mdx rename to docs/source/en/training/adapt_a_model.md diff --git a/docs/source/en/training/controlnet.mdx b/docs/source/en/training/controlnet.md similarity index 100% rename from docs/source/en/training/controlnet.mdx rename to docs/source/en/training/controlnet.md diff --git a/docs/source/en/training/create_dataset.mdx b/docs/source/en/training/create_dataset.md similarity index 100% rename from docs/source/en/training/create_dataset.mdx rename to docs/source/en/training/create_dataset.md diff --git a/docs/source/en/training/custom_diffusion.mdx b/docs/source/en/training/custom_diffusion.md similarity index 100% rename from docs/source/en/training/custom_diffusion.mdx rename to docs/source/en/training/custom_diffusion.md diff --git a/docs/source/en/training/distributed_inference.mdx b/docs/source/en/training/distributed_inference.md similarity index 100% rename from docs/source/en/training/distributed_inference.mdx rename to docs/source/en/training/distributed_inference.md diff --git a/docs/source/en/training/dreambooth.mdx b/docs/source/en/training/dreambooth.md similarity index 100% rename from docs/source/en/training/dreambooth.mdx rename to docs/source/en/training/dreambooth.md diff --git a/docs/source/en/training/instructpix2pix.mdx b/docs/source/en/training/instructpix2pix.md similarity index 100% rename from docs/source/en/training/instructpix2pix.mdx rename to docs/source/en/training/instructpix2pix.md diff --git a/docs/source/en/training/lora.mdx b/docs/source/en/training/lora.md similarity index 100% rename from docs/source/en/training/lora.mdx rename to docs/source/en/training/lora.md diff --git a/docs/source/en/training/overview.mdx b/docs/source/en/training/overview.md similarity index 100% rename from docs/source/en/training/overview.mdx rename to docs/source/en/training/overview.md diff --git a/docs/source/en/training/text2image.mdx b/docs/source/en/training/text2image.md similarity index 100% rename from docs/source/en/training/text2image.mdx rename to docs/source/en/training/text2image.md diff --git a/docs/source/en/training/text_inversion.mdx b/docs/source/en/training/text_inversion.md similarity index 100% rename from docs/source/en/training/text_inversion.mdx rename to docs/source/en/training/text_inversion.md diff --git a/docs/source/en/training/unconditional_training.mdx b/docs/source/en/training/unconditional_training.md similarity index 100% rename from docs/source/en/training/unconditional_training.mdx rename to docs/source/en/training/unconditional_training.md diff --git a/docs/source/en/tutorials/basic_training.mdx b/docs/source/en/tutorials/basic_training.md similarity index 100% rename from docs/source/en/tutorials/basic_training.mdx rename to docs/source/en/tutorials/basic_training.md diff --git a/docs/source/en/tutorials/tutorial_overview.mdx b/docs/source/en/tutorials/tutorial_overview.md similarity index 100% rename from docs/source/en/tutorials/tutorial_overview.mdx rename to docs/source/en/tutorials/tutorial_overview.md diff --git a/docs/source/en/using-diffusers/conditional_image_generation.mdx b/docs/source/en/using-diffusers/conditional_image_generation.md similarity index 100% rename from docs/source/en/using-diffusers/conditional_image_generation.mdx rename to docs/source/en/using-diffusers/conditional_image_generation.md diff --git a/docs/source/en/using-diffusers/contribute_pipeline.mdx b/docs/source/en/using-diffusers/contribute_pipeline.md similarity index 100% rename from docs/source/en/using-diffusers/contribute_pipeline.mdx rename to docs/source/en/using-diffusers/contribute_pipeline.md diff --git a/docs/source/en/using-diffusers/control_brightness.mdx b/docs/source/en/using-diffusers/control_brightness.md similarity index 100% rename from docs/source/en/using-diffusers/control_brightness.mdx rename to docs/source/en/using-diffusers/control_brightness.md diff --git a/docs/source/en/using-diffusers/controlling_generation.mdx b/docs/source/en/using-diffusers/controlling_generation.md similarity index 100% rename from docs/source/en/using-diffusers/controlling_generation.mdx rename to docs/source/en/using-diffusers/controlling_generation.md diff --git a/docs/source/en/using-diffusers/custom_pipeline_examples.mdx b/docs/source/en/using-diffusers/custom_pipeline_examples.md similarity index 100% rename from docs/source/en/using-diffusers/custom_pipeline_examples.mdx rename to docs/source/en/using-diffusers/custom_pipeline_examples.md diff --git a/docs/source/en/using-diffusers/custom_pipeline_overview.mdx b/docs/source/en/using-diffusers/custom_pipeline_overview.md similarity index 100% rename from docs/source/en/using-diffusers/custom_pipeline_overview.mdx rename to docs/source/en/using-diffusers/custom_pipeline_overview.md diff --git a/docs/source/en/using-diffusers/depth2img.mdx b/docs/source/en/using-diffusers/depth2img.md similarity index 100% rename from docs/source/en/using-diffusers/depth2img.mdx rename to docs/source/en/using-diffusers/depth2img.md diff --git a/docs/source/en/using-diffusers/img2img.mdx b/docs/source/en/using-diffusers/img2img.md similarity index 100% rename from docs/source/en/using-diffusers/img2img.mdx rename to docs/source/en/using-diffusers/img2img.md diff --git a/docs/source/en/using-diffusers/inpaint.mdx b/docs/source/en/using-diffusers/inpaint.md similarity index 100% rename from docs/source/en/using-diffusers/inpaint.mdx rename to docs/source/en/using-diffusers/inpaint.md diff --git a/docs/source/en/using-diffusers/loading.mdx b/docs/source/en/using-diffusers/loading.md similarity index 100% rename from docs/source/en/using-diffusers/loading.mdx rename to docs/source/en/using-diffusers/loading.md diff --git a/docs/source/en/using-diffusers/loading_overview.mdx b/docs/source/en/using-diffusers/loading_overview.md similarity index 100% rename from docs/source/en/using-diffusers/loading_overview.mdx rename to docs/source/en/using-diffusers/loading_overview.md diff --git a/docs/source/en/using-diffusers/other-formats.mdx b/docs/source/en/using-diffusers/other-formats.md similarity index 100% rename from docs/source/en/using-diffusers/other-formats.mdx rename to docs/source/en/using-diffusers/other-formats.md diff --git a/docs/source/en/using-diffusers/other-modalities.mdx b/docs/source/en/using-diffusers/other-modalities.md similarity index 100% rename from docs/source/en/using-diffusers/other-modalities.mdx rename to docs/source/en/using-diffusers/other-modalities.md diff --git a/docs/source/en/using-diffusers/pipeline_overview.mdx b/docs/source/en/using-diffusers/pipeline_overview.md similarity index 100% rename from docs/source/en/using-diffusers/pipeline_overview.mdx rename to docs/source/en/using-diffusers/pipeline_overview.md diff --git a/docs/source/en/using-diffusers/reproducibility.mdx b/docs/source/en/using-diffusers/reproducibility.md similarity index 100% rename from docs/source/en/using-diffusers/reproducibility.mdx rename to docs/source/en/using-diffusers/reproducibility.md diff --git a/docs/source/en/using-diffusers/reusing_seeds.mdx b/docs/source/en/using-diffusers/reusing_seeds.md similarity index 100% rename from docs/source/en/using-diffusers/reusing_seeds.mdx rename to docs/source/en/using-diffusers/reusing_seeds.md diff --git a/docs/source/en/using-diffusers/schedulers.mdx b/docs/source/en/using-diffusers/schedulers.md similarity index 99% rename from docs/source/en/using-diffusers/schedulers.mdx rename to docs/source/en/using-diffusers/schedulers.md index c2395c106c..99c6a39f28 100644 --- a/docs/source/en/using-diffusers/schedulers.mdx +++ b/docs/source/en/using-diffusers/schedulers.md @@ -15,7 +15,7 @@ specific language governing permissions and limitations under the License. [[open-in-colab]] Diffusion pipelines are inherently a collection of diffusion models and schedulers that are partly independent from each other. This means that one is able to switch out parts of the pipeline to better customize -a pipeline to one's use case. The best example of this is the [Schedulers](../api/schedulers/overview.mdx). +a pipeline to one's use case. The best example of this is the [Schedulers](../api/schedulers/overview.md). Whereas diffusion models usually simply define the forward pass from noise to a less noisy sample, schedulers define the whole denoising process, *i.e.*: diff --git a/docs/source/en/using-diffusers/stable_diffusion_jax_how_to.mdx b/docs/source/en/using-diffusers/stable_diffusion_jax_how_to.md similarity index 100% rename from docs/source/en/using-diffusers/stable_diffusion_jax_how_to.mdx rename to docs/source/en/using-diffusers/stable_diffusion_jax_how_to.md diff --git a/docs/source/en/using-diffusers/textual_inversion_inference.mdx b/docs/source/en/using-diffusers/textual_inversion_inference.md similarity index 100% rename from docs/source/en/using-diffusers/textual_inversion_inference.mdx rename to docs/source/en/using-diffusers/textual_inversion_inference.md diff --git a/docs/source/en/using-diffusers/unconditional_image_generation.mdx b/docs/source/en/using-diffusers/unconditional_image_generation.md similarity index 100% rename from docs/source/en/using-diffusers/unconditional_image_generation.mdx rename to docs/source/en/using-diffusers/unconditional_image_generation.md diff --git a/docs/source/en/using-diffusers/using_safetensors.mdx b/docs/source/en/using-diffusers/using_safetensors.md similarity index 100% rename from docs/source/en/using-diffusers/using_safetensors.mdx rename to docs/source/en/using-diffusers/using_safetensors.md diff --git a/docs/source/en/using-diffusers/weighted_prompts.mdx b/docs/source/en/using-diffusers/weighted_prompts.md similarity index 100% rename from docs/source/en/using-diffusers/weighted_prompts.mdx rename to docs/source/en/using-diffusers/weighted_prompts.md diff --git a/docs/source/en/using-diffusers/write_own_pipeline.mdx b/docs/source/en/using-diffusers/write_own_pipeline.md similarity index 100% rename from docs/source/en/using-diffusers/write_own_pipeline.mdx rename to docs/source/en/using-diffusers/write_own_pipeline.md diff --git a/docs/source/ko/in_translation.mdx b/docs/source/ko/in_translation.md similarity index 100% rename from docs/source/ko/in_translation.mdx rename to docs/source/ko/in_translation.md diff --git a/docs/source/ko/index.mdx b/docs/source/ko/index.md similarity index 100% rename from docs/source/ko/index.mdx rename to docs/source/ko/index.md diff --git a/docs/source/ko/installation.mdx b/docs/source/ko/installation.md similarity index 100% rename from docs/source/ko/installation.mdx rename to docs/source/ko/installation.md diff --git a/docs/source/ko/optimization/fp16.mdx b/docs/source/ko/optimization/fp16.md similarity index 100% rename from docs/source/ko/optimization/fp16.mdx rename to docs/source/ko/optimization/fp16.md diff --git a/docs/source/ko/optimization/habana.mdx b/docs/source/ko/optimization/habana.md similarity index 100% rename from docs/source/ko/optimization/habana.mdx rename to docs/source/ko/optimization/habana.md diff --git a/docs/source/ko/optimization/mps.mdx b/docs/source/ko/optimization/mps.md similarity index 100% rename from docs/source/ko/optimization/mps.mdx rename to docs/source/ko/optimization/mps.md diff --git a/docs/source/ko/optimization/onnx.mdx b/docs/source/ko/optimization/onnx.md similarity index 100% rename from docs/source/ko/optimization/onnx.mdx rename to docs/source/ko/optimization/onnx.md diff --git a/docs/source/ko/optimization/open_vino.mdx b/docs/source/ko/optimization/open_vino.md similarity index 100% rename from docs/source/ko/optimization/open_vino.mdx rename to docs/source/ko/optimization/open_vino.md diff --git a/docs/source/ko/optimization/opt_overview.mdx b/docs/source/ko/optimization/opt_overview.md similarity index 100% rename from docs/source/ko/optimization/opt_overview.mdx rename to docs/source/ko/optimization/opt_overview.md diff --git a/docs/source/ko/optimization/torch2.0.mdx b/docs/source/ko/optimization/torch2.0.md similarity index 100% rename from docs/source/ko/optimization/torch2.0.mdx rename to docs/source/ko/optimization/torch2.0.md diff --git a/docs/source/ko/optimization/xformers.mdx b/docs/source/ko/optimization/xformers.md similarity index 100% rename from docs/source/ko/optimization/xformers.mdx rename to docs/source/ko/optimization/xformers.md diff --git a/docs/source/ko/quicktour.mdx b/docs/source/ko/quicktour.md similarity index 100% rename from docs/source/ko/quicktour.mdx rename to docs/source/ko/quicktour.md diff --git a/docs/source/ko/training/adapt_a_model.mdx b/docs/source/ko/training/adapt_a_model.md similarity index 100% rename from docs/source/ko/training/adapt_a_model.mdx rename to docs/source/ko/training/adapt_a_model.md diff --git a/docs/source/ko/training/dreambooth.mdx b/docs/source/ko/training/dreambooth.md similarity index 100% rename from docs/source/ko/training/dreambooth.mdx rename to docs/source/ko/training/dreambooth.md diff --git a/docs/source/ko/training/lora.mdx b/docs/source/ko/training/lora.md similarity index 100% rename from docs/source/ko/training/lora.mdx rename to docs/source/ko/training/lora.md diff --git a/docs/source/ko/training/overview.mdx b/docs/source/ko/training/overview.md similarity index 100% rename from docs/source/ko/training/overview.mdx rename to docs/source/ko/training/overview.md diff --git a/docs/source/ko/training/text2image.mdx b/docs/source/ko/training/text2image.md similarity index 100% rename from docs/source/ko/training/text2image.mdx rename to docs/source/ko/training/text2image.md diff --git a/docs/source/ko/training/text_inversion.mdx b/docs/source/ko/training/text_inversion.md similarity index 100% rename from docs/source/ko/training/text_inversion.mdx rename to docs/source/ko/training/text_inversion.md diff --git a/docs/source/ko/training/unconditional_training.mdx b/docs/source/ko/training/unconditional_training.md similarity index 100% rename from docs/source/ko/training/unconditional_training.mdx rename to docs/source/ko/training/unconditional_training.md diff --git a/docs/source/ko/tutorials/basic_training.mdx b/docs/source/ko/tutorials/basic_training.md similarity index 100% rename from docs/source/ko/tutorials/basic_training.mdx rename to docs/source/ko/tutorials/basic_training.md diff --git a/docs/source/ko/tutorials/tutorial_overview.mdx b/docs/source/ko/tutorials/tutorial_overview.md similarity index 100% rename from docs/source/ko/tutorials/tutorial_overview.mdx rename to docs/source/ko/tutorials/tutorial_overview.md diff --git a/docs/source/ko/using-diffusers/custom_pipeline_examples.mdx b/docs/source/ko/using-diffusers/custom_pipeline_examples.md similarity index 100% rename from docs/source/ko/using-diffusers/custom_pipeline_examples.mdx rename to docs/source/ko/using-diffusers/custom_pipeline_examples.md diff --git a/docs/source/ko/using-diffusers/custom_pipeline_overview.mdx b/docs/source/ko/using-diffusers/custom_pipeline_overview.md similarity index 100% rename from docs/source/ko/using-diffusers/custom_pipeline_overview.mdx rename to docs/source/ko/using-diffusers/custom_pipeline_overview.md diff --git a/docs/source/ko/using-diffusers/depth2img.mdx b/docs/source/ko/using-diffusers/depth2img.md similarity index 100% rename from docs/source/ko/using-diffusers/depth2img.mdx rename to docs/source/ko/using-diffusers/depth2img.md diff --git a/docs/source/ko/using-diffusers/img2img.mdx b/docs/source/ko/using-diffusers/img2img.md similarity index 100% rename from docs/source/ko/using-diffusers/img2img.mdx rename to docs/source/ko/using-diffusers/img2img.md diff --git a/docs/source/ko/using-diffusers/inpaint.mdx b/docs/source/ko/using-diffusers/inpaint.md similarity index 100% rename from docs/source/ko/using-diffusers/inpaint.mdx rename to docs/source/ko/using-diffusers/inpaint.md diff --git a/docs/source/ko/using-diffusers/loading.mdx b/docs/source/ko/using-diffusers/loading.md similarity index 100% rename from docs/source/ko/using-diffusers/loading.mdx rename to docs/source/ko/using-diffusers/loading.md diff --git a/docs/source/ko/using-diffusers/other-formats.mdx b/docs/source/ko/using-diffusers/other-formats.md similarity index 100% rename from docs/source/ko/using-diffusers/other-formats.mdx rename to docs/source/ko/using-diffusers/other-formats.md diff --git a/docs/source/ko/using-diffusers/pipeline_overview.mdx b/docs/source/ko/using-diffusers/pipeline_overview.md similarity index 100% rename from docs/source/ko/using-diffusers/pipeline_overview.mdx rename to docs/source/ko/using-diffusers/pipeline_overview.md diff --git a/docs/source/ko/using-diffusers/reusing_seeds.mdx b/docs/source/ko/using-diffusers/reusing_seeds.md similarity index 100% rename from docs/source/ko/using-diffusers/reusing_seeds.mdx rename to docs/source/ko/using-diffusers/reusing_seeds.md diff --git a/docs/source/ko/using-diffusers/schedulers.mdx b/docs/source/ko/using-diffusers/schedulers.md similarity index 99% rename from docs/source/ko/using-diffusers/schedulers.mdx rename to docs/source/ko/using-diffusers/schedulers.md index b0f34cf1d5..6a8864fbe8 100644 --- a/docs/source/ko/using-diffusers/schedulers.mdx +++ b/docs/source/ko/using-diffusers/schedulers.md @@ -12,7 +12,7 @@ specific language governing permissions and limitations under the License. # 스케줄러 -diffusion 파이프라인은 diffusion 모델, 스케줄러 등의 컴포넌트들로 구성됩니다. 그리고 파이프라인 안의 일부 컴포넌트를 다른 컴포넌트로 교체하는 식의 커스터마이징 역시 가능합니다. 이와 같은 컴포넌트 커스터마이징의 가장 대표적인 예시가 바로 [스케줄러](../api/schedulers/overview.mdx)를 교체하는 것입니다. +diffusion 파이프라인은 diffusion 모델, 스케줄러 등의 컴포넌트들로 구성됩니다. 그리고 파이프라인 안의 일부 컴포넌트를 다른 컴포넌트로 교체하는 식의 커스터마이징 역시 가능합니다. 이와 같은 컴포넌트 커스터마이징의 가장 대표적인 예시가 바로 [스케줄러](../api/schedulers/overview.md)를 교체하는 것입니다. diff --git a/docs/source/ko/using-diffusers/unconditional_image_generation.mdx b/docs/source/ko/using-diffusers/unconditional_image_generation.md similarity index 100% rename from docs/source/ko/using-diffusers/unconditional_image_generation.mdx rename to docs/source/ko/using-diffusers/unconditional_image_generation.md diff --git a/docs/source/ko/using-diffusers/using_safetensors.mdx b/docs/source/ko/using-diffusers/using_safetensors.md similarity index 100% rename from docs/source/ko/using-diffusers/using_safetensors.mdx rename to docs/source/ko/using-diffusers/using_safetensors.md diff --git a/docs/source/ko/using-diffusers/write_own_pipeline.mdx b/docs/source/ko/using-diffusers/write_own_pipeline.md similarity index 100% rename from docs/source/ko/using-diffusers/write_own_pipeline.mdx rename to docs/source/ko/using-diffusers/write_own_pipeline.md diff --git a/docs/source/zh/index.mdx b/docs/source/zh/index.md similarity index 100% rename from docs/source/zh/index.mdx rename to docs/source/zh/index.md diff --git a/docs/source/zh/installation.mdx b/docs/source/zh/installation.md similarity index 100% rename from docs/source/zh/installation.mdx rename to docs/source/zh/installation.md diff --git a/docs/source/zh/quicktour.mdx b/docs/source/zh/quicktour.md similarity index 100% rename from docs/source/zh/quicktour.mdx rename to docs/source/zh/quicktour.md diff --git a/utils/check_repo.py b/utils/check_repo.py index cfd2964f9d..dffbb323f9 100644 --- a/utils/check_repo.py +++ b/utils/check_repo.py @@ -536,7 +536,7 @@ def find_all_documented_objects(): content = f.read() raw_doc_objs = re.findall(r"(?:autoclass|autofunction):: transformers.(\S+)\s+", content) documented_obj += [obj.split(".")[-1] for obj in raw_doc_objs] - for doc_file in Path(PATH_TO_DOC).glob("**/*.mdx"): + for doc_file in Path(PATH_TO_DOC).glob("**/*.md"): with open(doc_file, "r", encoding="utf-8", newline="\n") as f: content = f.read() raw_doc_objs = re.findall("\[\[autodoc\]\]\s+(\S+)\s+", content) @@ -674,7 +674,7 @@ def check_all_objects_are_documented(): def check_model_type_doc_match(): """Check all doc pages have a corresponding model type.""" model_doc_folder = Path(PATH_TO_DOC) / "model_doc" - model_docs = [m.stem for m in model_doc_folder.glob("*.mdx")] + model_docs = [m.stem for m in model_doc_folder.glob("*.md")] model_types = list(diffusers.models.auto.configuration_auto.MODEL_NAMES_MAPPING.keys()) model_types = [MODEL_TYPE_TO_DOC_MAPPING[m] if m in MODEL_TYPE_TO_DOC_MAPPING else m for m in model_types] diff --git a/utils/check_table.py b/utils/check_table.py index 8bd6d9eae9..e9f2909889 100644 --- a/utils/check_table.py +++ b/utils/check_table.py @@ -161,7 +161,7 @@ def get_model_table_from_auto_modules(): def check_model_table(overwrite=False): """Check the model table in the index.rst is consistent with the state of the lib and maybe `overwrite`.""" current_table, start_index, end_index, lines = _find_text_in_file( - filename=os.path.join(PATH_TO_DOCS, "index.mdx"), + filename=os.path.join(PATH_TO_DOCS, "index.md"), start_prompt="", ) @@ -169,11 +169,11 @@ def check_model_table(overwrite=False): if current_table != new_table: if overwrite: - with open(os.path.join(PATH_TO_DOCS, "index.mdx"), "w", encoding="utf-8", newline="\n") as f: + with open(os.path.join(PATH_TO_DOCS, "index.md"), "w", encoding="utf-8", newline="\n") as f: f.writelines(lines[:start_index] + [new_table] + lines[end_index:]) else: raise ValueError( - "The model table in the `index.mdx` has not been updated. Run `make fix-copies` to fix this." + "The model table in the `index.md` has not been updated. Run `make fix-copies` to fix this." )