From 39299546134b545c1b78b0937147f85aed8fbe4d Mon Sep 17 00:00:00 2001 From: Kadir Nar Date: Mon, 17 Jul 2023 19:25:37 +0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20doc=20with=20more=20des?= =?UTF-8?q?criptive=20title=20and=20filename=20for=20"IF"=20section=20(#40?= =?UTF-8?q?49)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 📝 Update doc with more descriptive title and filename for "IF" section Updated the documentation to provide a more descriptive title and filename for the "IF" section. Previously, having only "IF" as the title was not conveying a clear meaning. By renaming the section to "DeepFloyd IF," we provide users with a more informative and context-specific heading. Thanks! 🙌 * 📝 Update name for "IF" section in 📝 Update name for "IF" section in README Updated the link and name for the "IF" section in the README file to reflect the new heading "DeepFloyd IF." * 📝 Fix broken link for "Instruct Pix2Pix" section in README Fixed the broken link for the "Instruct Pix2Pix" section in the README file. Previously, the link was pointing to an incorrect location due to the presence of "stable_diffusion" in the URL. By removing "stable_diffusion" from the URL, I have corrected the error and ensured that users are directed to the correct section. * 🔧💼 Updated parameters in _toctree.yml file - ✏️ Updated 'local' parameter to 'api/pipelines/deepfloyd_if'. - ✏️ Updated 'title' parameter to 'DeepFloyd IF'. 🎯 These changes aim to improve visibility and accessibility in the documentation of the DeepFloyd IF pipeline. 🚀📚 --- README.md | 4 ++-- docs/source/en/_toctree.yml | 4 ++-- docs/source/en/api/pipelines/{if.mdx => deepfloyd_if.mdx} | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) rename docs/source/en/api/pipelines/{if.mdx => deepfloyd_if.mdx} (99%) diff --git a/README.md b/README.md index 7d98113625..9307df83d7 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,7 @@ just hang out ☕. Text-to-Image - if + DeepFloyd IF DeepFloyd/IF-I-XL-v1.0 @@ -158,7 +158,7 @@ just hang out ☕. Text-guided Image-to-Image - Instruct Pix2Pix + Instruct Pix2Pix timbrooks/instruct-pix2pix diff --git a/docs/source/en/_toctree.yml b/docs/source/en/_toctree.yml index ad1c7c0aab..f695dd3c1d 100644 --- a/docs/source/en/_toctree.yml +++ b/docs/source/en/_toctree.yml @@ -200,8 +200,8 @@ title: DiffEdit - local: api/pipelines/dit title: DiT - - local: api/pipelines/if - title: IF + - local: api/pipelines/deepfloyd_if + title: DeepFloyd IF - local: api/pipelines/pix2pix title: InstructPix2Pix - local: api/pipelines/kandinsky diff --git a/docs/source/en/api/pipelines/if.mdx b/docs/source/en/api/pipelines/deepfloyd_if.mdx similarity index 99% rename from docs/source/en/api/pipelines/if.mdx rename to docs/source/en/api/pipelines/deepfloyd_if.mdx index d79c7035fb..7769b71d38 100644 --- a/docs/source/en/api/pipelines/if.mdx +++ b/docs/source/en/api/pipelines/deepfloyd_if.mdx @@ -10,7 +10,7 @@ an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express o specific language governing permissions and limitations under the License. --> -# IF +# DeepFloyd IF ## Overview