Skip to content

[docs] refactor model skill#13334

Open
stevhliu wants to merge 3 commits intohuggingface:mainfrom
stevhliu:ai-skills
Open

[docs] refactor model skill#13334
stevhliu wants to merge 3 commits intohuggingface:mainfrom
stevhliu:ai-skills

Conversation

@stevhliu
Copy link
Member

follow up to #13297:

  • created models.md, a shared reference for holding model coding style, dependencies, common conventions, attention patterns, gotchas, etc.
  • updated AGENTS.md, model-integration/SKILL.md, and review-rules.md to point to new models.md

Copy link
Collaborator

@yiyixuxu yiyixuxu left a comment

Choose a reason for hiding this comment

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

I left one feedback
looking great!

- Support `generator` parameter for reproducibility
- Use `self.progress_bar(timesteps)` for progress tracking

## Gotchas
Copy link
Member

Choose a reason for hiding this comment

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

Same.

.ai/models.md Outdated
## Common diffusers conventions

- Models use `ModelMixin` with `register_to_config` for config serialization
- Pipelines inherit from `DiffusionPipeline`
Copy link
Member

Choose a reason for hiding this comment

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

It's not a model thing, though.

Copy link
Member Author

Choose a reason for hiding this comment

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

lmk what you think of this:

  • rename to ## Common model conventions and only keep the model relevant convention
  • move these conventions under a new ### Pipelines & Schedulers section in AGENTS.md (we could also create a new pipeline-scheduler.md file if you prefer)

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