Skip to content

Document .no_exist folder#1308

Merged
Wauplin merged 4 commits intomainfrom
1011-document-no-exist-folder
Jan 25, 2023
Merged

Document .no_exist folder#1308
Wauplin merged 4 commits intomainfrom
1011-document-no-exist-folder

Conversation

@Wauplin
Copy link
Contributor

@Wauplin Wauplin commented Jan 24, 2023

Resolve #1011, following #986 that introduced the .no_exist folder.

It has never been properly documented. Also exposes the _CACHED_NO_EXIST object. Even if it's a "private" object, I think it makes sense to expose it. This feature is quite niche even though it can be really useful (at least for transformers).

cc @sgugger

PR documentation:

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Jan 24, 2023

The documentation is not available anymore as the PR was closed or merged.

Copy link
Contributor

@sgugger sgugger left a comment

Choose a reason for hiding this comment

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

Thanks for documenting those!

@codecov
Copy link

codecov bot commented Jan 24, 2023

Codecov Report

Base: 83.67% // Head: 83.67% // No change to project coverage 👍

Coverage data is based on head (1c3beea) compared to base (bdb9d06).
Patch coverage: 100.00% of modified lines in pull request are covered.

❗ Current head 1c3beea differs from pull request most recent head f43aca6. Consider uploading reports for the commit f43aca6 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1308   +/-   ##
=======================================
  Coverage   83.67%   83.67%           
=======================================
  Files          47       47           
  Lines        4711     4711           
=======================================
  Hits         3942     3942           
  Misses        769      769           
Impacted Files Coverage Δ
src/huggingface_hub/__init__.py 75.75% <ø> (ø)
src/huggingface_hub/file_download.py 86.84% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
@Wauplin
Copy link
Contributor Author

Wauplin commented Jan 25, 2023

Good catch. Thanks for the quick review @sgugger
I'm merging it.

@Wauplin Wauplin merged commit c06efc3 into main Jan 25, 2023
@Wauplin Wauplin deleted the 1011-document-no-exist-folder branch January 25, 2023 11:03
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

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.

Documentation about ".exist" folder in the cache

3 participants