Deprecate model_name in favor of search in list_models#4112
Merged
Conversation
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 723bdf9. Configure here.
|
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. |
julien-c
approved these changes
Apr 15, 2026
Contributor
|
This PR has been shipped as part of the v1.11.0 release. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
list_models(..., search="...")andlist_models(..., model_name="...")are strictly equivalent in the code (both are passed as?search=...query in the API call. This PR deprecatesmodel_namein favor ofsearch, with a deprecation cycle until 2.0 (it's low prio anyway).This PR doesn't impact the CLI since
hf models listonly accepts--search.cc @julien-c who pinged me about it
Note
Low Risk
Low risk: change is limited to adding a deprecation warning and updating tests, without altering the underlying query parameters sent to the Hub.
Overview
HfApi.list_modelsnow marks themodel_nameargument as deprecated (via_deprecate_arguments, removal targeted for2.0) and updates the docstring to direct users tosearch.Tests are adjusted to use
searchinstead ofmodel_namewhen filtering models, keeping coverage aligned with the new preferred API.Reviewed by Cursor Bugbot for commit 4cb3b6d. Bugbot is set up for automated code reviews on this repo. Configure here.