Upgrading huggingface-hub 0.9 to 0.10
Breaking0.9.1 → 0.10.1Breaking3Deprecated3New12Changed14Fixed12Other3
BreakingUpgrade verdict
3 breaking changes.
In plain terms
- Removes the legacy helper install_lfs_in_userspace.
- Changes the return type of create_commit to return more information.
- Raises HFValidationError when repo_id is invalid, since repo_id is now validated with @validate_hf_hub_args.
- Deprecates clone_from behavior.
Must act Top 5 of 6 that need code or config changes
What you must change
Breaking3
Removes the legacy helper install_lfs_in_userspace.
install_lfs_in_userspaceChanges the return type of create_commit to return more information.
create_commitRaises HFValidationError when repo_id is invalid, since repo_id is now validated with @validate_hf_hub_args.
repo_idvalidate_hf_hub_argsHFValidationErrorDeprecations to plan for
Deprecated3
Deprecates clone_from behavior.
clone_fromDeprecates token in read-only methods of HfApi in favor of use_auth_token.
HfApitokenuse_auth_tokenDeprecates private and repo_type in the Repository class.
Repositoryprivaterepo_typeAPI changes
Generated by DepDelta from published Python source. Not mixed with prose notes.
- added:
export CONFIG_NAME - added:
export CachedFileInfo - added:
export CachedRepoInfo - added:
export CachedRevisionInfo - added:
export CardData - added:
export CommitInfo - added:
export CommitOperation - added:
export CommitOperationAdd - added:
export CommitOperationDelete - added:
export CorruptedCacheException - added:
export DatasetCard - added:
export DatasetCardData - added:
export DatasetFilter - added:
export DatasetSearchArguments - added:
export DeleteCacheStrategy - added:
export Discussion - added:
export DiscussionComment - added:
export DiscussionCommit - added:
export DiscussionEvent - added:
export DiscussionStatusChange - added:
export DiscussionTitleChange - added:
export DiscussionWithDetails - added:
export EvalResult - added:
export FLAX_WEIGHTS_NAME - added:
export HFCacheInfo - added:
export HUGGINGFACE_CO_URL_HOME - added:
export HUGGINGFACE_CO_URL_TEMPLATE - added:
export HfApi - added:
export HfFileMetadata - added:
export HfFolder - added:
export InferenceApi - added:
export KerasModelHubMixin - added:
export ModelCard - added:
export ModelCardData - added:
export ModelFilter - added:
export ModelHubMixin - added:
export ModelSearchArguments - added:
export PYTORCH_WEIGHTS_NAME - added:
export PyTorchModelHubMixin - added:
export REPO_TYPE_DATASET - added:
export REPO_TYPE_MODEL - added:
export REPO_TYPE_SPACE - added:
export Repository - added:
export TF2_WEIGHTS_NAME - added:
export TF_WEIGHTS_NAME - added:
export cached_download - added:
export change_discussion_status - added:
export comment_discussion - added:
export create_commit - added:
export create_discussion - added:
export create_pull_request - added:
export create_repo - added:
export dataset_info - added:
export delete_file - added:
export delete_repo - added:
export edit_discussion_comment - added:
export from_pretrained_fastai - added:
export from_pretrained_keras - added:
export get_dataset_tags - added:
export get_discussion_details - added:
export get_full_repo_name - added:
export get_hf_file_metadata - added:
export get_model_tags - added:
export get_repo_discussions - added:
export hf_hub_download - added:
export hf_hub_url - added:
export list_datasets - added:
export list_metrics - added:
export list_models - added:
export list_repo_files - added:
export logging - added:
export merge_pull_request - added:
export metadata_eval_result - added:
export metadata_load - added:
export metadata_save - added:
export metadata_update - added:
export model_info - added:
export move_repo - added:
export notebook_login - added:
export push_to_hub_fastai - added:
export push_to_hub_keras - added:
export rename_discussion - added:
export repo_type_and_id_from_hf_id - added:
export save_pretrained_keras - added:
export scan_cache_dir - added:
export set_access_token - added:
export snapshot_download - added:
export space_info - added:
export try_to_load_from_cache - added:
export unset_access_token - added:
export update_repo_visibility - added:
export upload_file - added:
export upload_folder - added:
export whoami
- added:
class DeleteCacheCommand(BaseHuggingfaceCLICommand) - added:
constructor DeleteCacheCommand(args) - added:
function require_inquirer_py(fn: Callable) -> Callable - added:
method DeleteCacheCommand.run() - added:
static method DeleteCacheCommand.register_subcommand(parser: ArgumentParser)
- added:
class ScanCacheCommand(BaseHuggingfaceCLICommand) - added:
constructor ScanCacheCommand(args) - added:
method ScanCacheCommand.run() - added:
static method ScanCacheCommand.register_subcommand(parser: ArgumentParser)
- removed:
class ANSI - removed:
function tabulate(rows: List[List[Union[str, int]]], headers: List[str]) -> str - removed:
static method ANSI.bold(s) - removed:
static method ANSI.gray(s) - removed:
static method ANSI.red(s)
- added:
variable HF_HUB_DISABLE_IMPLICIT_TOKEN: bool - added:
variable HF_HUB_DISABLE_SYMLINKS_WARNING: bool - added:
variable default_home
- changed:
function push_to_hub_fastai(learner, repo_id: str, commit_message: Optional[str]=…, private: Optional[bool]=…, token: Optional[str]=…, config: Optional[dict]=…, **kwargs) → function push_to_hub_fastai(learner, *, repo_id: str, commit_message: Optional[str]=…, private: bool=…, token: Optional[str]=…, config: Optional[dict]=…, branch: Optional[str]=…, create_pr: Optional[bool]=…, allow_patterns: Optional[Union[List[str], str]]=…, ignore_patterns: Optional[Union[List[str], str]]=…, api_endpoint: Optional[str]=…, git_user: Optional[str]=…, git_email: Optional[str]=…)
- removed:
function get_fastai_version() - removed:
function get_fastcore_version() - removed:
function get_tf_version() - removed:
function is_fastai_available() - removed:
function is_fastcore_available() - removed:
function is_graphviz_available() - removed:
function is_pydot_available() - removed:
function is_tf_available() - removed:
function is_torch_available() - added:
class HfFileMetadata - added:
field HfFileMetadata.commit_hash: Optional[str] - added:
field HfFileMetadata.etag: Optional[str] - added:
field HfFileMetadata.location: str - added:
function are_symlinks_supported(cache_dir: Union[str, Path, None]=…) -> bool - added:
function get_hf_file_metadata(url: str, use_auth_token: Union[bool, str, None]=…, proxies: Optional[Dict]=…, timeout: Optional[float]=…) -> HfFileMetadata
- removed:
class HfFolder - removed:
field HfFolder.path_token - removed:
static method HfFolder.delete_token() - removed:
static method HfFolder.get_token() -> Optional[str] - removed:
static method HfFolder.save_token(token) - changed:
constructor DatasetInfo(*, id: Optional[str]=…, sha: Optional[str]=…, lastModified: Optional[str]=…, tags: Optional[List[str]]=…, siblings: Optional[List[Dict]]=…, private: Optional[bool]=…, author: Optional[str]=…, description: Optional[str]=…, citation: Optional[str]=…, cardData: Optional[dict]=…, **kwargs) → constructor DatasetInfo(*, id: Optional[str]=…, sha: Optional[str]=…, lastModified: Optional[str]=…, tags: Optional[List[str]]=…, siblings: Optional[List[Dict]]=…, private: bool=…, author: Optional[str]=…, description: Optional[str]=…, citation: Optional[str]=…, cardData: Optional[dict]=…, **kwargs) - changed:
constructor ModelInfo(*, modelId: Optional[str]=…, sha: Optional[str]=…, lastModified: Optional[str]=…, tags: Optional[List[str]]=…, pipeline_tag: Optional[str]=…, siblings: Optional[List[Dict]]=…, private: Optional[bool]=…, author: Optional[str]=…, config: Optional[Dict]=…, **kwargs) → constructor ModelInfo(*, modelId: Optional[str]=…, sha: Optional[str]=…, lastModified: Optional[str]=…, tags: Optional[List[str]]=…, pipeline_tag: Optional[str]=…, siblings: Optional[List[Dict]]=…, private: bool=…, author: Optional[str]=…, config: Optional[Dict]=…, securityStatus: Optional[Dict]=…, **kwargs) - changed:
constructor SpaceInfo(*, id: Optional[str]=…, sha: Optional[str]=…, lastModified: Optional[str]=…, siblings: Optional[List[Dict]]=…, private: Optional[bool]=…, author: Optional[str]=…, **kwargs) → constructor SpaceInfo(*, id: Optional[str]=…, sha: Optional[str]=…, lastModified: Optional[str]=…, siblings: Optional[List[Dict]]=…, private: bool=…, author: Optional[str]=…, **kwargs) - changed:
method HfApi.create_commit(repo_id: str, operations: Iterable[CommitOperation], *, commit_message: str, commit_description: Optional[str]=…, token: Optional[str]=…, repo_type: Optional[str]=…, revision: Optional[str]=…, create_pr: Optional[bool]=…, num_threads: int=…, parent_commit: Optional[str]=…) -> Optional[str] → method HfApi.create_commit(repo_id: str, operations: Iterable[CommitOperation], *, commit_message: str, commit_description: Optional[str]=…, token: Optional[str]=…, repo_type: Optional[str]=…, revision: Optional[str]=…, create_pr: Optional[bool]=…, num_threads: int=…, parent_commit: Optional[str]=…) -> CommitInfo - changed:
method HfApi.create_discussion(repo_id: str, title: str, *, token: str, description: Optional[str]=…, repo_type: Optional[str]=…, pull_request: bool=…) -> DiscussionWithDetails → method HfApi.create_discussion(repo_id: str, title: str, *, token: Optional[str], description: Optional[str]=…, repo_type: Optional[str]=…, pull_request: bool=…) -> DiscussionWithDetails - changed:
method HfApi.create_pull_request(repo_id: str, title: str, *, token: str, description: Optional[str]=…, repo_type: Optional[str]=…) -> DiscussionWithDetails → method HfApi.create_pull_request(repo_id: str, title: str, *, token: Optional[str], description: Optional[str]=…, repo_type: Optional[str]=…) -> DiscussionWithDetails - changed:
method HfApi.create_repo(repo_id: str=…, *, token: Optional[str]=…, organization: Optional[str]=…, private: Optional[bool]=…, repo_type: Optional[str]=…, exist_ok: Optional[bool]=…, space_sdk: Optional[str]=…, name: Optional[str]=…) -> str → method HfApi.create_repo(repo_id: str=…, *, token: Optional[str]=…, organization: Optional[str]=…, private: bool=…, repo_type: Optional[str]=…, exist_ok: Optional[bool]=…, space_sdk: Optional[str]=…, name: Optional[str]=…) -> str - changed:
method HfApi.dataset_info(repo_id: str, *, revision: Optional[str]=…, token: Optional[str]=…, timeout: Optional[float]=…, files_metadata: bool=…) -> DatasetInfo → method HfApi.dataset_info(repo_id: str, *, revision: Optional[str]=…, token: Optional[str]=…, timeout: Optional[float]=…, files_metadata: bool=…, use_auth_token: Optional[Union[bool, str]]=…) -> DatasetInfo - changed:
method HfApi.delete_file(path_in_repo: str, repo_id: str, *, token: Optional[str]=…, repo_type: Optional[str]=…, revision: Optional[str]=…, commit_message: Optional[str]=…, commit_description: Optional[str]=…, create_pr: Optional[bool]=…, parent_commit: Optional[str]=…) → method HfApi.delete_file(path_in_repo: str, repo_id: str, *, token: Optional[str]=…, repo_type: Optional[str]=…, revision: Optional[str]=…, commit_message: Optional[str]=…, commit_description: Optional[str]=…, create_pr: Optional[bool]=…, parent_commit: Optional[str]=…) -> CommitInfo - changed:
method HfApi.get_full_repo_name(model_id: str, *, organization: Optional[str]=…, token: Optional[str]=…) → method HfApi.get_full_repo_name(model_id: str, *, organization: Optional[str]=…, token: Optional[str]=…, use_auth_token: Optional[Union[bool, str]]=…) - changed:
method HfApi.hide_discussion_comment(repo_id: str, discussion_num: int, comment_id: str, *, token: str, repo_type: Optional[str]=…) -> DiscussionComment → method HfApi.hide_discussion_comment(repo_id: str, discussion_num: int, comment_id: str, *, token: Optional[str], repo_type: Optional[str]=…) -> DiscussionComment - changed:
method HfApi.list_repo_files(repo_id: str, *, revision: Optional[str]=…, repo_type: Optional[str]=…, token: Optional[str]=…, timeout: Optional[float]=…) -> List[str] → method HfApi.list_repo_files(repo_id: str, *, revision: Optional[str]=…, repo_type: Optional[str]=…, token: Optional[str]=…, timeout: Optional[float]=…, use_auth_token: Optional[Union[bool, str]]=…) -> List[str] - changed:
method HfApi.merge_pull_request(repo_id: str, discussion_num: int, *, token: str, comment: Optional[str]=…, repo_type: Optional[str]=…) → method HfApi.merge_pull_request(repo_id: str, discussion_num: int, *, token: Optional[str], comment: Optional[str]=…, repo_type: Optional[str]=…) - changed:
method HfApi.model_info(repo_id: str, *, revision: Optional[str]=…, token: Optional[str]=…, timeout: Optional[float]=…, securityStatus: Optional[bool]=…, files_metadata: bool=…) -> ModelInfo → method HfApi.model_info(repo_id: str, *, revision: Optional[str]=…, token: Optional[str]=…, timeout: Optional[float]=…, securityStatus: Optional[bool]=…, files_metadata: bool=…, use_auth_token: Optional[Union[bool, str]]=…) -> ModelInfo - changed:
method HfApi.repo_info(repo_id: str, *, revision: Optional[str]=…, repo_type: Optional[str]=…, token: Optional[str]=…, timeout: Optional[float]=…, files_metadata: bool=…) -> Union[ModelInfo, DatasetInfo, SpaceInfo] → method HfApi.repo_info(repo_id: str, *, revision: Optional[str]=…, repo_type: Optional[str]=…, token: Optional[str]=…, timeout: Optional[float]=…, files_metadata: bool=…, use_auth_token: Optional[Union[bool, str]]=…) -> Union[ModelInfo, DatasetInfo, SpaceInfo] - changed:
method HfApi.space_info(repo_id: str, *, revision: Optional[str]=…, token: Optional[str]=…, timeout: Optional[float]=…, files_metadata: bool=…) -> SpaceInfo → method HfApi.space_info(repo_id: str, *, revision: Optional[str]=…, token: Optional[str]=…, timeout: Optional[float]=…, files_metadata: bool=…, use_auth_token: Optional[Union[bool, str]]=…) -> SpaceInfo - added:
class CommitInfo - added:
field CommitInfo.commit_description: str - added:
field CommitInfo.commit_message: str - added:
field CommitInfo.commit_url: str - added:
field CommitInfo.oid: str - added:
field CommitInfo.pr_num: Optional[str] - added:
field CommitInfo.pr_revision: Optional[str] - added:
field CommitInfo.pr_url: Optional[str]
- changed:
method ModelHubMixin.push_to_hub(*, repo_path_or_name: Optional[str]=…, repo_url: Optional[str]=…, commit_message: Optional[str]=…, organization: Optional[str]=…, private: Optional[bool]=…, api_endpoint: Optional[str]=…, use_auth_token: Optional[Union[bool, str]]=…, git_user: Optional[str]=…, git_email: Optional[str]=…, config: Optional[dict]=…, skip_lfs_files: bool=…, repo_id: Optional[str]=…, t… → method ModelHubMixin.push_to_hub(*, repo_path_or_name: Optional[str]=…, repo_url: Optional[str]=…, commit_message: Optional[str]=…, organization: Optional[str]=…, private: bool=…, api_endpoint: Optional[str]=…, use_auth_token: Optional[Union[bool, str]]=…, git_user: Optional[str]=…, git_email: Optional[str]=…, config: Optional[dict]=…, skip_lfs_files: bool=…, repo_id: Optional[str]=…, token: Opti…
- changed:
function push_to_hub_keras(model, *, repo_path_or_name: Optional[str]=…, repo_url: Optional[str]=…, log_dir: Optional[str]=…, commit_message: Optional[str]=…, organization: Optional[str]=…, private: Optional[bool]=…, api_endpoint: Optional[str]=…, use_auth_token: Optional[Union[bool, str]]=…, git_user: Optional[str]=…, git_email: Optional[str]=…, config: Optional[dict]=…, include_optimizer: Optio… → function push_to_hub_keras(model, *, repo_path_or_name: Optional[str]=…, repo_url: Optional[str]=…, log_dir: Optional[str]=…, commit_message: Optional[str]=…, organization: Optional[str]=…, private: bool=…, api_endpoint: Optional[str]=…, use_auth_token: Optional[Union[bool, str]]=…, git_user: Optional[str]=…, git_email: Optional[str]=…, config: Optional[dict]=…, include_optimizer: Optional[bool]=…
- removed:
function install_lfs_in_userspace() - changed:
function lfs_upload(fileobj: BinaryIO, upload_info: UploadInfo, upload_action: dict, verify_action: Optional[dict], token: str) → function lfs_upload(fileobj: BinaryIO, upload_info: UploadInfo, upload_action: dict, verify_action: Optional[dict], token: Optional[str]) - changed:
function post_lfs_batch_info(upload_infos: Iterable[UploadInfo], token: str, repo_type: str, repo_id: str, endpoint: Optional[str]=…) -> Tuple[List[dict], List[dict]] → function post_lfs_batch_info(upload_infos: Iterable[UploadInfo], token: Optional[str], repo_type: str, repo_id: str, endpoint: Optional[str]=…) -> Tuple[List[dict], List[dict]]
- removed:
variable UNIQUE_METRIC_FEATURES - removed:
variable UNIQUE_RESULT_FEATURES - added:
class DatasetCard(RepoCard) - added:
class ModelCard(RepoCard) - added:
class RepoCard - added:
constructor RepoCard(content: str) - added:
field DatasetCard.card_data_class - added:
field DatasetCard.default_template_path - added:
field DatasetCard.repo_type - added:
field ModelCard.card_data_class - added:
field ModelCard.default_template_path - added:
field ModelCard.repo_type - added:
field RepoCard.card_data_class - added:
field RepoCard.default_template_path - added:
field RepoCard.repo_type - added:
method RepoCard.push_to_hub(repo_id: str, token: Optional[str]=…, repo_type: Optional[str]=…, commit_message: Optional[str]=…, commit_description: Optional[str]=…, revision: Optional[str]=…, create_pr: Optional[bool]=…, parent_commit: Optional[str]=…) - added:
method RepoCard.save(filepath: Union[Path, str]) - added:
method RepoCard.validate(repo_type: Optional[str]=…) - added:
static method DatasetCard.from_template(card_data: DatasetCardData, template_path: Optional[str]=…, **template_kwargs) - added:
static method ModelCard.from_template(card_data: ModelCardData, template_path: Optional[str]=…, **template_kwargs) - added:
static method RepoCard.from_template(card_data: CardData, template_path: Optional[str]=…, **template_kwargs) - added:
static method RepoCard.load(repo_id_or_path: Union[str, Path], repo_type: Optional[str]=…, token: Optional[str]=…) - added:
variable TEMPLATE_DATASETCARD_PATH - added:
variable TEMPLATE_MODELCARD_PATH - added:
variable logger
- added:
class CardData - added:
class DatasetCardData(CardData) - added:
class EvalResult - added:
class ModelCardData(CardData) - added:
constructor CardData(**kwargs) - added:
constructor DatasetCardData(*, language: Optional[Union[str, List[str]]]=…, license: Optional[Union[str, List[str]]]=…, annotations_creators: Optional[Union[str, List[str]]]=…, language_creators: Optional[Union[str, List[str]]]=…, multilinguality: Optional[Union[str, List[str]]]=…, size_categories: Optional[Union[str, List[str]]]=…, source_datasets: Optional[Union[str, List[str]]]=…, task_categor… - added:
constructor ModelCardData(*, language: Optional[Union[str, List[str]]]=…, license: Optional[str]=…, library_name: Optional[str]=…, tags: Optional[List[str]]=…, datasets: Optional[Union[str, List[str]]]=…, metrics: Optional[Union[str, List[str]]]=…, eval_results: Optional[List[EvalResult]]=…, model_name: Optional[str]=…, **kwargs) - added:
field EvalResult.dataset_args: Optional[Dict[str, Any]] - added:
field EvalResult.dataset_config: Optional[str] - added:
field EvalResult.dataset_name: str - added:
field EvalResult.dataset_revision: Optional[str] - added:
field EvalResult.dataset_split: Optional[str] - added:
field EvalResult.dataset_type: str - added:
field EvalResult.metric_args: Optional[Dict[str, Any]] - added:
field EvalResult.metric_config: Optional[str] - added:
field EvalResult.metric_name: Optional[str] - added:
field EvalResult.metric_type: str - added:
field EvalResult.metric_value: Any - added:
field EvalResult.task_name: Optional[str] - added:
field EvalResult.task_type: str - added:
field EvalResult.verified: Optional[bool] - added:
function eval_results_to_model_index(model_name: str, eval_results: List[EvalResult]) -> List[Dict[str, Any]] - added:
function model_index_to_eval_results(model_index: List[Dict[str, Any]]) -> Tuple[str, List[EvalResult]] - added:
method CardData.to_dict() -> Dict[str, Any] - added:
method CardData.to_yaml(line_break=…) -> str - added:
variable logger
- removed:
class ModelIndex - removed:
class SingleMetric - removed:
class SingleResult - removed:
class SingleResultDataset - removed:
class SingleResultTask - removed:
field ModelIndex.name: str - removed:
field ModelIndex.results: List[SingleResult] - removed:
field SingleMetric.args: Any - removed:
field SingleMetric.config: Optional[str] - removed:
field SingleMetric.name: Optional[str] - removed:
field SingleMetric.type: str - removed:
field SingleMetric.value: Any - removed:
field SingleMetric.verified: Optional[bool] - removed:
field SingleResult.dataset: Optional[SingleResultDataset] - removed:
field SingleResult.metrics: List[SingleMetric] - removed:
field SingleResult.task: SingleResultTask - removed:
field SingleResultDataset.args: Any - removed:
field SingleResultDataset.config: Optional[str] - removed:
field SingleResultDataset.name: str - removed:
field SingleResultDataset.revision: Optional[str] - removed:
field SingleResultDataset.split: Optional[str] - removed:
field SingleResultDataset.type: str - removed:
field SingleResultTask.name: Optional[str] - removed:
field SingleResultTask.type: str - removed:
variable ModelIndexSet: TypeAlias
- added:
property Repository.private -> Optional[str] - added:
property Repository.repo_type -> Optional[str]
- added:
export BadRequestError - added:
export CachedFileInfo - added:
export CachedRepoInfo - added:
export CachedRevisionInfo - added:
export CorruptedCacheException - added:
export DeleteCacheStrategy - added:
export HFCacheInfo - added:
export HFValidationError - added:
export HfFolder - added:
export HfHubHTTPError - added:
export build_hf_headers - added:
export get_fastai_version - added:
export get_fastcore_version - added:
export get_graphviz_version - added:
export get_hf_hub_version - added:
export get_jinja_version - added:
export get_pydot_version - added:
export get_python_version - added:
export get_tf_version - added:
export get_token_to_send - added:
export get_torch_version - added:
export hf_raise_for_status - added:
export http_backoff - added:
export is_fastai_available - added:
export is_fastcore_available - added:
export is_graphviz_available - added:
export is_jinja_available - added:
export is_pydot_available - added:
export is_tf_available - added:
export is_torch_available - added:
export scan_cache_dir - added:
export validate_hf_hub_args - added:
export validate_repo_id - added:
export yaml_dump