"git@developer.sourcefind.cn:OpenDAS/torchaudio.git" did not exist on "c5b965589e187b75d7fc51fa544c27111b201244"
Unverified Commit d12e9ebc authored by Patrick von Platen's avatar Patrick von Platen Committed by GitHub
Browse files

[Docs] Add subfolder docs (#500)



* [Docs] Add subfolder docs

* Apply suggestions from code review
Co-authored-by: default avatarPedro Cuenca <pedro@huggingface.co>

* up
Co-authored-by: default avatarPedro Cuenca <pedro@huggingface.co>
parent da7e3994
...@@ -134,10 +134,9 @@ class ConfigMixin: ...@@ -134,10 +134,9 @@ class ConfigMixin:
The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a
git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any
identifier allowed by git. identifier allowed by git.
mirror (`str`, *optional*): subfolder (`str`, *optional*, defaults to `""`):
Mirror source to accelerate downloads in China. If you are from China and have an accessibility In case the relevant files are located inside a subfolder of the model repo (either remote in
problem, you can set this option to resolve it. Note that we do not guarantee the timeliness or safety. huggingface.co or downloaded locally), you can specify the folder name here.
Please refer to the mirror site for more information.
<Tip> <Tip>
...@@ -175,6 +174,7 @@ class ConfigMixin: ...@@ -175,6 +174,7 @@ class ConfigMixin:
use_auth_token = kwargs.pop("use_auth_token", None) use_auth_token = kwargs.pop("use_auth_token", None)
local_files_only = kwargs.pop("local_files_only", False) local_files_only = kwargs.pop("local_files_only", False)
revision = kwargs.pop("revision", None) revision = kwargs.pop("revision", None)
_ = kwargs.pop("mirror", None)
subfolder = kwargs.pop("subfolder", None) subfolder = kwargs.pop("subfolder", None)
user_agent = {"file_type": "config"} user_agent = {"file_type": "config"}
......
...@@ -228,6 +228,10 @@ class ModelMixin(torch.nn.Module): ...@@ -228,6 +228,10 @@ class ModelMixin(torch.nn.Module):
The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a
git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any
identifier allowed by git. identifier allowed by git.
subfolder (`str`, *optional*, defaults to `""`):
In case the relevant files are located inside a subfolder of the model repo (either remote in
huggingface.co or downloaded locally), you can specify the folder name here.
mirror (`str`, *optional*): mirror (`str`, *optional*):
Mirror source to accelerate downloads in China. If you are from China and have an accessibility Mirror source to accelerate downloads in China. If you are from China and have an accessibility
problem, you can set this option to resolve it. Note that we do not guarantee the timeliness or safety. problem, you can set this option to resolve it. Note that we do not guarantee the timeliness or safety.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment