[docs] model testing#45152
Conversation
|
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. |
|
@ydshieh @tarekziade could you do a first pass? Would take a look then, quite a lot to catch up on 😬 |
tarekziade
left a comment
There was a problem hiding this comment.
Great work, thanks a lot! I took a first pass focusing on the CI aspects.
A couple of meta remarks:
It might be better to avoid referring to CircleCI directly in the docs, since where/how we run CI is evolving. Maybe we can use a more generic term like “Hugging Face CI”?
Similarly, the detailed description of CI jobs could become outdated fairly quickly given the changes we’re planning. It might be more useful to emphasize the Makefile targets instead, as we’re aiming to make them the source of truth for both CI and local development.
tarekziade
left a comment
There was a problem hiding this comment.
LGTM just one nit about mlinter
vasqu
left a comment
There was a problem hiding this comment.
Some initial comments from my side, sorry a bit jumbled thoughts here and there. Hope it's clear enough otherwise happy to clarify
| ```bash | ||
| pip install -e ".[dev]" | ||
| ``` | ||
| ## Code quality |
There was a problem hiding this comment.
Should we have a small intro that gives an intro what these subsections are, i.e. referencing the explicit names of our repo checks
There was a problem hiding this comment.
I feel like we are missing a TOC or similar with some short quick intros what they actually refer to
- What you should do as contributor / how can you fix the CI
- Internals
- Each check
- Utilities for each of those, for exampel make style for if only the code quality is failing
vasqu
left a comment
There was a problem hiding this comment.
Looks much better, thank you! One qq: this is now focused on model tests, should we also add sections about (img/video/audio) processors or should we move those out to their own docs?
lets add separate docs for those sections since this one is already pretty big :) |
* draft * update * pr checks * feedback * toctree * feedback * feedback * update trf * feedback
refactors the testing docs to be more contributor-facing organized around writing model tests instead of being a collection of pytest usage examples and CI maintenance. also updates the pr checks doc so contributors are better prepared to pass the checks on first try
testing.mdCausalLMModelTestandVLMModelTestpaths (should use these more often)ModelTesterandModelTestfor non-causal and vlm modelspr_checks.mdmakecommand flowmake check-repodoes# Copied fromsection