Skip to content

[Modular]add a real quick start guide#13029

Merged
yiyixuxu merged 12 commits intomainfrom
modular-doc
Jan 31, 2026
Merged

[Modular]add a real quick start guide#13029
yiyixuxu merged 12 commits intomainfrom
modular-doc

Conversation

@yiyixuxu
Copy link
Collaborator

@yiyixuxu yiyixuxu commented Jan 26, 2026

some of the workflow stuff is not yet support in main, this is the PR #13028

@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.

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.

very nice and easier to start with!

yiyixuxu and others added 4 commits January 26, 2026 08:26
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
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 cool rewrite!

@@ -12,333 +12,250 @@ specific language governing permissions and limitations under the License.

# Quickstart
Copy link
Member

Choose a reason for hiding this comment

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

@stevhliu @yiyixuxu do you think the introduction to Modular Diffusers (that we have below) should be moved overview.md?

I will understand if that's out of scope for this PR. Maybe in a followup, we can clarify the vision we have for modular?

Copy link
Member

Choose a reason for hiding this comment

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

i think its probably ok to keep an intro in both. you can have a more detailed one in overview.md and keep it brief in the quickstart

dd_auto_blocks = SequentialPipelineBlocks.from_blocks_dict(DIFFDIFF_AUTO_BLOCKS)
dd_pipeline = dd_auto_blocks.init_pipeline("YiYiXu/modular-demo-auto", collection="diffdiff")
dd_pipeline.load_components(torch_dtype=torch.float16)
```
Copy link
Member

Choose a reason for hiding this comment

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

Not strongly opinionated but we could also add the example of prompt upsampling that uses Gemini. This might inspire users to explore a combination of open and closed models -- something that is made quite seamless with Modular.

@yiyixuxu yiyixuxu merged commit 769a1f3 into main Jan 31, 2026
3 checks passed
@yiyixuxu yiyixuxu deleted the modular-doc branch January 31, 2026 19:43
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.

4 participants