Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DDUF documentation #1526

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

DDUF documentation #1526

wants to merge 20 commits into from

Conversation

Wauplin
Copy link
Contributor

@Wauplin Wauplin commented Dec 12, 2024

TODO:

https://moon-ci-docs.huggingface.co/docs/hub/pr_1526/en/dduf

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

docs/hub/dduf.md Outdated Show resolved Hide resolved
Wauplin and others added 2 commits December 12, 2024 14:29
Co-authored-by: Célina <hanouticelina@gmail.com>
docs/hub/_toctree.yml Outdated Show resolved Hide resolved
docs/hub/dduf.md Outdated Show resolved Hide resolved
docs/hub/dduf.md Outdated Show resolved Hide resolved
Wauplin and others added 4 commits December 12, 2024 14:38
Co-authored-by: Julien Chaumond <julien@huggingface.co>
Copy link
Member

@Vaibhavs10 Vaibhavs10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔥

docs/hub/dduf.md Show resolved Hide resolved
docs/hub/dduf.md Show resolved Hide resolved
Wauplin and others added 3 commits December 12, 2024 15:06
Co-authored-by: Julien Chaumond <julien@huggingface.co>
Co-authored-by: vb <vaibhavs10@gmail.com>
Co-authored-by: vb <vaibhavs10@gmail.com>
Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super nice! 👏

docs/hub/dduf.md Show resolved Hide resolved
docs/hub/dduf.md Outdated

## Overview

DDUF (**D**DUF’s **D**iffusion **U**nified **F**ormat) is a file format designed to make storing, distributing, and using diffusion models much easier. Built on the ZIP file format, DDUF offers a standardized, efficient, and flexible way to package all parts of a diffusion model into a single, easy-to-manage file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Diffusion Data Unified Format maybe? Also fine with it as is 😄

docs/hub/dduf.md Outdated Show resolved Hide resolved
docs/hub/dduf.md Outdated Show resolved Hide resolved
docs/hub/dduf.md Outdated Show resolved Hide resolved
docs/hub/dduf.md Outdated Show resolved Hide resolved
docs/hub/dduf.md Outdated Show resolved Hide resolved
docs/hub/dduf.md Outdated Show resolved Hide resolved
docs/hub/dduf.md Outdated Show resolved Hide resolved
docs/hub/dduf.md Outdated Show resolved Hide resolved
Copy link
Member

@sayakpaul sayakpaul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very very detailed! Steven has already taken care of most of the stuff. My comments are quite minor.

docs/hub/dduf.md Outdated Show resolved Hide resolved
docs/hub/dduf.md Outdated Show resolved Hide resolved
Comment on lines +143 to +147
ZIP provides several advantages:
- Universally supported file format
- No additional dependencies for reading
- Built-in file indexing
- Wide language support
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@julien-c should there be any points pertaining to the connection between using ZIP and how that benefits Xet backend?

@Wauplin Wauplin changed the title Start DDUF documentation DDUF documentation Dec 13, 2024
@Wauplin Wauplin requested a review from stevhliu December 13, 2024 09:59
@Wauplin
Copy link
Contributor Author

Wauplin commented Dec 13, 2024

Many thanks for the review! Very useful feedback ❤️ I've not addressed all the comments and added a diffusers example. Close to getting an approval? 🤗

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we'll need to add a Who's using DDUF section which will be one of the most important section of this doc (#community-driven)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, there is a start at the very bottom of the page (could be moved to its own section)

@Wauplin
Copy link
Contributor Author

Wauplin commented Dec 13, 2024

Will merge this once huggingface_hub / diffusers have been released :)

Copy link
Member

@SunMarc SunMarc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice docs ! LGTM !

Copy link
Member

@Vaibhavs10 Vaibhavs10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets gooo


### Which frameworks/apps support DDUFs?

- [Diffusers](https://github.com/huggingface/diffusers)
Copy link
Member

@Vaibhavs10 Vaibhavs10 Dec 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: we might have Eric's diffuse-rs (candle-based) come in by monday too. So we'll have two supported frameworsk on day-0, but we can open a seperate pr for that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants