Document more list repos behavior #1823
Conversation
|
The documentation is not available anymore as the PR was closed or merged. |
|
Hi @Wauplin , thanks for addressing the issue! I guess know it is more clear 🙌 |
|
Good, thanks for the feedback @ademait :) |
| In general, the more specific the query, the more information is returned. On the contrary, when listing models | ||
| using [`list_models`] only a subset of the attributes are returned. |
There was a problem hiding this comment.
Not really seeing how mentioning list_models is connected to ModelInfo. Are you maybe trying to compare their usage (broad model search vs more narrow and specific model details)?
| In general, the more specific the query, the more information is returned. On the contrary, when listing models | |
| using [`list_models`] only a subset of the attributes are returned. | |
| In general, the more specific the query, the more information is returned. |
There was a problem hiding this comment.
ModelInfo is the class returned by list_models (get info from many) and model_info (get info from one) but is not really meant to be used/instantiated outside of this scope. That's why I took the liberty to tie the documentation of ModelInfo to list_models.
There was a problem hiding this comment.
Ah ok, thanks for the clarification. In that case, feel free to ignore this comment! :)
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
|
Thanks for the reviews! ❤️ |
|
Thanks @Wauplin! |
Related to #1814.
This PR updates the documentation of
ModelInfo,DatasetInfo,SpaceInfoandRepoSiblingsto let the users know they should not expect all attributes to exist. @ademait could you have a look and let me know what you think? I kept the wording a bit vague on purpose as I don't want to be too specific on things that we might change server-side in the future (all those objects are built in a way that is future-compatible, on purpose). (EDIT: I'm not saying that we will remove attributes in the future, but we might potentially add news ones and/or improve default behaviors).