diff --git a/dev/rate/.buildinfo b/dev/rate/.buildinfo
index 3a75245234..50d53f0595 100644
--- a/dev/rate/.buildinfo
+++ b/dev/rate/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 3e957697947b8949a7d457c03b0ee9d9
+config: a6b7e486e7081da823bddad563caf6ea
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/dev/rate/.doctrees/api_doc/archive/index.doctree b/dev/rate/.doctrees/api_doc/archive/index.doctree
index 3fbf890077..b5dc32caa9 100644
Binary files a/dev/rate/.doctrees/api_doc/archive/index.doctree and b/dev/rate/.doctrees/api_doc/archive/index.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/cache/delete.doctree b/dev/rate/.doctrees/api_doc/cache/delete.doctree
index 42d118c73c..ea1d0e0055 100644
Binary files a/dev/rate/.doctrees/api_doc/cache/delete.doctree and b/dev/rate/.doctrees/api_doc/cache/delete.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/cache/index.doctree b/dev/rate/.doctrees/api_doc/cache/index.doctree
index 02fc14f12b..30064a46c0 100644
Binary files a/dev/rate/.doctrees/api_doc/cache/index.doctree and b/dev/rate/.doctrees/api_doc/cache/index.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/config/index.doctree b/dev/rate/.doctrees/api_doc/config/index.doctree
index 472c668f77..bd01a1e72a 100644
Binary files a/dev/rate/.doctrees/api_doc/config/index.doctree and b/dev/rate/.doctrees/api_doc/config/index.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/config/meta.doctree b/dev/rate/.doctrees/api_doc/config/meta.doctree
index 024f07fbfb..ebf36b0cd0 100644
Binary files a/dev/rate/.doctrees/api_doc/config/meta.doctree and b/dev/rate/.doctrees/api_doc/config/meta.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/entry/base.doctree b/dev/rate/.doctrees/api_doc/entry/base.doctree
index 6b29b19d32..cbb3df11ba 100644
Binary files a/dev/rate/.doctrees/api_doc/entry/base.doctree and b/dev/rate/.doctrees/api_doc/entry/base.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/entry/cli.doctree b/dev/rate/.doctrees/api_doc/entry/cli.doctree
index 97c89d7d6f..fe90926f20 100644
Binary files a/dev/rate/.doctrees/api_doc/entry/cli.doctree and b/dev/rate/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/entry/dispatch.doctree b/dev/rate/.doctrees/api_doc/entry/dispatch.doctree
index 9bf3b3c9ee..6ac01004bb 100644
Binary files a/dev/rate/.doctrees/api_doc/entry/dispatch.doctree and b/dev/rate/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/entry/download.doctree b/dev/rate/.doctrees/api_doc/entry/download.doctree
index aecb85a613..ec7851c09f 100644
Binary files a/dev/rate/.doctrees/api_doc/entry/download.doctree and b/dev/rate/.doctrees/api_doc/entry/download.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/entry/index.doctree b/dev/rate/.doctrees/api_doc/entry/index.doctree
index 19e9a6a84f..c06162b9d3 100644
Binary files a/dev/rate/.doctrees/api_doc/entry/index.doctree and b/dev/rate/.doctrees/api_doc/entry/index.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/entry/ls.doctree b/dev/rate/.doctrees/api_doc/entry/ls.doctree
index 10725f7eb9..c8c1d1d2eb 100644
Binary files a/dev/rate/.doctrees/api_doc/entry/ls.doctree and b/dev/rate/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/entry/ls_repo.doctree b/dev/rate/.doctrees/api_doc/entry/ls_repo.doctree
index 09ce1fb7e8..46e42f1401 100644
Binary files a/dev/rate/.doctrees/api_doc/entry/ls_repo.doctree and b/dev/rate/.doctrees/api_doc/entry/ls_repo.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/entry/upload.doctree b/dev/rate/.doctrees/api_doc/entry/upload.doctree
index 7afa21220a..41063697f4 100644
Binary files a/dev/rate/.doctrees/api_doc/entry/upload.doctree and b/dev/rate/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/entry/whoami.doctree b/dev/rate/.doctrees/api_doc/entry/whoami.doctree
index b2fc19b4e3..99627bf806 100644
Binary files a/dev/rate/.doctrees/api_doc/entry/whoami.doctree and b/dev/rate/.doctrees/api_doc/entry/whoami.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/index/fetch.doctree b/dev/rate/.doctrees/api_doc/index/fetch.doctree
index eefd642254..0aa29883f9 100644
Binary files a/dev/rate/.doctrees/api_doc/index/fetch.doctree and b/dev/rate/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/index/index.doctree b/dev/rate/.doctrees/api_doc/index/index.doctree
index 83d05e7caa..7342f37b64 100644
Binary files a/dev/rate/.doctrees/api_doc/index/index.doctree and b/dev/rate/.doctrees/api_doc/index/index.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/index/make.doctree b/dev/rate/.doctrees/api_doc/index/make.doctree
index 9e025524a3..0ed0889c6e 100644
Binary files a/dev/rate/.doctrees/api_doc/index/make.doctree and b/dev/rate/.doctrees/api_doc/index/make.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/index/validate.doctree b/dev/rate/.doctrees/api_doc/index/validate.doctree
index 450aefc070..fdb60c073a 100644
Binary files a/dev/rate/.doctrees/api_doc/index/validate.doctree and b/dev/rate/.doctrees/api_doc/index/validate.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/operate/base.doctree b/dev/rate/.doctrees/api_doc/operate/base.doctree
index 29174bbff6..8a6588aaab 100644
Binary files a/dev/rate/.doctrees/api_doc/operate/base.doctree and b/dev/rate/.doctrees/api_doc/operate/base.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/operate/download.doctree b/dev/rate/.doctrees/api_doc/operate/download.doctree
index ce5af2764f..2ed44a2c49 100644
Binary files a/dev/rate/.doctrees/api_doc/operate/download.doctree and b/dev/rate/.doctrees/api_doc/operate/download.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/operate/index.doctree b/dev/rate/.doctrees/api_doc/operate/index.doctree
index ccdf333900..1293dd4d8e 100644
Binary files a/dev/rate/.doctrees/api_doc/operate/index.doctree and b/dev/rate/.doctrees/api_doc/operate/index.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/operate/upload.doctree b/dev/rate/.doctrees/api_doc/operate/upload.doctree
index 11eef4713d..fc50ce0481 100644
Binary files a/dev/rate/.doctrees/api_doc/operate/upload.doctree and b/dev/rate/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/operate/validate.doctree b/dev/rate/.doctrees/api_doc/operate/validate.doctree
index c2d19c0624..6e2d278e55 100644
Binary files a/dev/rate/.doctrees/api_doc/operate/validate.doctree and b/dev/rate/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/utils/binary.doctree b/dev/rate/.doctrees/api_doc/utils/binary.doctree
index 26d4b25a0c..8002c7bc61 100644
Binary files a/dev/rate/.doctrees/api_doc/utils/binary.doctree and b/dev/rate/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/utils/download.doctree b/dev/rate/.doctrees/api_doc/utils/download.doctree
index 292f2a0d4e..ab69bfb643 100644
Binary files a/dev/rate/.doctrees/api_doc/utils/download.doctree and b/dev/rate/.doctrees/api_doc/utils/download.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/utils/index.doctree b/dev/rate/.doctrees/api_doc/utils/index.doctree
index 6d8718e7cf..787b149d8e 100644
Binary files a/dev/rate/.doctrees/api_doc/utils/index.doctree and b/dev/rate/.doctrees/api_doc/utils/index.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/utils/path.doctree b/dev/rate/.doctrees/api_doc/utils/path.doctree
index 12a17c98f2..e8f123f450 100644
Binary files a/dev/rate/.doctrees/api_doc/utils/path.doctree and b/dev/rate/.doctrees/api_doc/utils/path.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/utils/tqdm_.doctree b/dev/rate/.doctrees/api_doc/utils/tqdm_.doctree
index 28445cd426..253e1b64c7 100644
Binary files a/dev/rate/.doctrees/api_doc/utils/tqdm_.doctree and b/dev/rate/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/dev/rate/.doctrees/api_doc/utils/walk.doctree b/dev/rate/.doctrees/api_doc/utils/walk.doctree
index ab4ce33bde..6a5d3d6917 100644
Binary files a/dev/rate/.doctrees/api_doc/utils/walk.doctree and b/dev/rate/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/dev/rate/.doctrees/environment.pickle b/dev/rate/.doctrees/environment.pickle
index 626fdd845c..3d0ede8411 100644
Binary files a/dev/rate/.doctrees/environment.pickle and b/dev/rate/.doctrees/environment.pickle differ
diff --git a/dev/rate/.doctrees/index.doctree b/dev/rate/.doctrees/index.doctree
index 26e44186c7..41495a7f99 100644
Binary files a/dev/rate/.doctrees/index.doctree and b/dev/rate/.doctrees/index.doctree differ
diff --git a/dev/rate/.doctrees/information/environment.doctree b/dev/rate/.doctrees/information/environment.doctree
index afd4164503..e5c828453b 100644
Binary files a/dev/rate/.doctrees/information/environment.doctree and b/dev/rate/.doctrees/information/environment.doctree differ
diff --git a/dev/rate/.doctrees/information/environment.result.doctree b/dev/rate/.doctrees/information/environment.result.doctree
index 69bdf492ec..8cef2156af 100644
Binary files a/dev/rate/.doctrees/information/environment.result.doctree and b/dev/rate/.doctrees/information/environment.result.doctree differ
diff --git a/dev/rate/.doctrees/nbsphinx/information/environment.ipynb b/dev/rate/.doctrees/nbsphinx/information/environment.ipynb
index 7dd8d582a3..41e2894ecc 100644
--- a/dev/rate/.doctrees/nbsphinx/information/environment.ipynb
+++ b/dev/rate/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:14:41.452315Z",
-     "iopub.status.busy": "2024-07-23T18:14:41.452118Z",
-     "iopub.status.idle": "2024-07-23T18:14:42.617966Z",
-     "shell.execute_reply": "2024-07-23T18:14:42.617281Z"
+     "iopub.execute_input": "2024-07-23T18:21:43.467210Z",
+     "iopub.status.busy": "2024-07-23T18:21:43.467002Z",
+     "iopub.status.idle": "2024-07-23T18:21:44.636627Z",
+     "shell.execute_reply": "2024-07-23T18:21:44.635875Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2917.4900000000002 MHz\n",
+      "CPU Freq: 2981.7025 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/dev/rate/.doctrees/nbsphinx/information/environment.result.ipynb b/dev/rate/.doctrees/nbsphinx/information/environment.result.ipynb
index 6ab0517f4f..99bcfc52f4 100644
--- a/dev/rate/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/dev/rate/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:19:58.739915Z",
-     "iopub.status.busy": "2024-07-23T17:19:58.739723Z",
-     "iopub.status.idle": "2024-07-23T17:19:59.917050Z",
-     "shell.execute_reply": "2024-07-23T17:19:59.916314Z"
+     "iopub.execute_input": "2024-07-23T17:25:59.376899Z",
+     "iopub.status.busy": "2024-07-23T17:25:59.376694Z",
+     "iopub.status.idle": "2024-07-23T17:26:00.553914Z",
+     "shell.execute_reply": "2024-07-23T17:26:00.553160Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2945.5315 MHz\n",
+      "CPU Freq: 2953.17375 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/dev/rate/.doctrees/tutorials/installation/index.doctree b/dev/rate/.doctrees/tutorials/installation/index.doctree
index 08c9aba226..aafa110e4d 100644
Binary files a/dev/rate/.doctrees/tutorials/installation/index.doctree and b/dev/rate/.doctrees/tutorials/installation/index.doctree differ
diff --git a/dev/rate/.doctrees/tutorials/quick_start/index.doctree b/dev/rate/.doctrees/tutorials/quick_start/index.doctree
index 6792c6c8d4..44ffa253ee 100644
Binary files a/dev/rate/.doctrees/tutorials/quick_start/index.doctree and b/dev/rate/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/dev/rate/_sources/information/environment.result.ipynb.txt b/dev/rate/_sources/information/environment.result.ipynb.txt
index 6ab0517f4f..99bcfc52f4 100644
--- a/dev/rate/_sources/information/environment.result.ipynb.txt
+++ b/dev/rate/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:19:58.739915Z",
-     "iopub.status.busy": "2024-07-23T17:19:58.739723Z",
-     "iopub.status.idle": "2024-07-23T17:19:59.917050Z",
-     "shell.execute_reply": "2024-07-23T17:19:59.916314Z"
+     "iopub.execute_input": "2024-07-23T17:25:59.376899Z",
+     "iopub.status.busy": "2024-07-23T17:25:59.376694Z",
+     "iopub.status.idle": "2024-07-23T17:26:00.553914Z",
+     "shell.execute_reply": "2024-07-23T17:26:00.553160Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2945.5315 MHz\n",
+      "CPU Freq: 2953.17375 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/dev/rate/information/environment.html b/dev/rate/information/environment.html
index 07936cd528..dd7711dc13 100644
--- a/dev/rate/information/environment.html
+++ b/dev/rate/information/environment.html
@@ -127,11 +127,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2917.4900000000002 MHz
+CPU Freq: 2981.7025 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/dev/rate/information/environment.ipynb b/dev/rate/information/environment.ipynb
index 7dd8d582a3..41e2894ecc 100644
--- a/dev/rate/information/environment.ipynb
+++ b/dev/rate/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:14:41.452315Z",
-     "iopub.status.busy": "2024-07-23T18:14:41.452118Z",
-     "iopub.status.idle": "2024-07-23T18:14:42.617966Z",
-     "shell.execute_reply": "2024-07-23T18:14:42.617281Z"
+     "iopub.execute_input": "2024-07-23T18:21:43.467210Z",
+     "iopub.status.busy": "2024-07-23T18:21:43.467002Z",
+     "iopub.status.idle": "2024-07-23T18:21:44.636627Z",
+     "shell.execute_reply": "2024-07-23T18:21:44.635875Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2917.4900000000002 MHz\n",
+      "CPU Freq: 2981.7025 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/dev/rate/information/environment.result.html b/dev/rate/information/environment.result.html
index 382e024817..d22cbb7d61 100644
--- a/dev/rate/information/environment.result.html
+++ b/dev/rate/information/environment.result.html
@@ -129,11 +129,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2945.5315 MHz
+CPU Freq: 2953.17375 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/dev/rate/information/environment.result.ipynb b/dev/rate/information/environment.result.ipynb
index 6ab0517f4f..99bcfc52f4 100644
--- a/dev/rate/information/environment.result.ipynb
+++ b/dev/rate/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:19:58.739915Z",
-     "iopub.status.busy": "2024-07-23T17:19:58.739723Z",
-     "iopub.status.idle": "2024-07-23T17:19:59.917050Z",
-     "shell.execute_reply": "2024-07-23T17:19:59.916314Z"
+     "iopub.execute_input": "2024-07-23T17:25:59.376899Z",
+     "iopub.status.busy": "2024-07-23T17:25:59.376694Z",
+     "iopub.status.idle": "2024-07-23T17:26:00.553914Z",
+     "shell.execute_reply": "2024-07-23T17:26:00.553160Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2945.5315 MHz\n",
+      "CPU Freq: 2953.17375 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/dev/rate/searchindex.js b/dev/rate/searchindex.js
index f5988fd739..462fe75e44 100644
--- a/dev/rate/searchindex.js
+++ b/dev/rate/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/cache/delete", "api_doc/cache/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/cache/delete.rst", "api_doc/cache/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.cache.delete", "hfutils.cache", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2, 4], "pack": 0, "unpack": 0, "manag": [0, 2], "support": 0, "format": 0, "extens": 0, "name": [0, 5], "7z": 0, "bztar": 0, "tar": [0, 14, 16, 17], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 1, 5, 17, 19, 21, 24, 26, 27], "you": [0, 14, 32], "requir": [0, 32], "simpli": [0, 32], "instal": [0, 29], "us": [0, 1, 5, 14, 16, 17, 18, 19, 21, 24, 29, 32], "follow": [0, 10, 32], "code": [0, 5, 8, 12], "pip": [0, 32], "The": [0, 1, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28, 32], "creation": 0, "file": [0, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 28], "i": [0, 1, 8, 11, 12, 14, 16, 17, 19, 22, 23, 26, 29, 30, 31, 32], "we": 0, "util": [0, 29, 32], "rarfil": 0, "librari": [0, 24], "which": [0, 14, 30, 31, 32], "doe": [0, 14], "offer": 0, "function": [0, 5, 14, 16, 17, 23, 24, 27], "creat": [0, 16], "str": [0, 1, 5, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28], "ext": 0, "list": [0, 5, 10, 14, 18, 19, 21], "fn_pack": 0, "callabl": [0, 5], "fn_unpack": 0, "sourc": [0, 1, 5, 7, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "regist": 0, "custom": [0, 5, 8, 12], "type": [0, 1, 5, 10, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "associ": 0, "paramet": [0, 1, 5, 7, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "A": [0, 18], "take": 0, "directori": [0, 1, 10, 16, 17, 19, 21, 28], "an": [0, 14, 16, 17, 19, 21, 24, 27, 28], "filenam": [0, 24, 26], "input": 0, "extract": [0, 19], "type_nam": 0, "archive_fil": 0, "silent": [0, 16, 19, 21, 24, 27], "bool": [0, 7, 14, 16, 17, 19, 21, 22, 23, 24, 27], "fals": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "clear": [0, 21], "specifi": [0, 1, 17, 21, 24], "result": 0, "true": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "suppress": [0, 16, 19, 21, 24], "warn": [0, 5], "dure": 0, "process": 0, "remov": [0, 21], "exist": [0, 14, 19], "when": [0, 11, 14, 16, 19], "return": [0, 5, 14, 16, 17, 18, 22, 23, 24, 26, 27, 28], "path": [0, 8, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 25, 28, 29], "password": [0, 19], "none": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26], "content": [0, 27], "option": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26, 27], "determin": 0, "base": [0, 9, 10, 17, 20, 29], "rais": [0, 11, 14, 17, 26], "valueerror": [0, 26], "ani": [0, 1, 7, 23, 26], "get": [0, 14, 16, 18, 24, 26], "repo_id": [1, 14, 16, 17, 18, 19, 21, 22, 26], "repo_typ": [1, 14, 16, 17, 18, 19, 21, 22, 26], "cache_dir": 1, "all": [1, 14, 19, 28], "detach": 1, "revis": [1, 14, 16, 17, 18, 19, 21, 22, 26], "from": [1, 5, 14, 16, 17, 18, 19, 24, 30, 31, 32], "match": [1, 14, 17, 22], "repositori": [1, 8, 12, 14, 16, 17, 18, 19, 21, 22, 26], "id": [1, 17, 26], "where": [1, 17, 24], "store": [1, 17], "default": [1, 16, 17, 19, 22, 26], "huggingfac": [2, 17, 18, 19, 21, 26, 29, 32], "local": [2, 11, 14, 16, 19, 21, 22, 24, 30, 31], "can": [2, 14, 17, 32], "quickli": 2, "make": [2, 15, 17, 29], "disk": 2, "space": [2, 14, 16, 17, 18, 19, 21, 22, 26], "under": [2, 32], "control": 2, "delet": [2, 29], "delete_detached_cach": 2, "delete_cach": 2, "meta": [3, 14, 29, 32], "__title__": [3, 32], "__version__": [3, 32], "__description__": [3, 32], "__author__": [3, 32], "__author_email__": 3, "inform": [4, 5, 7, 14, 16, 17], "packag": 4, "titl": 4, "thi": [4, 5, 8, 12, 14, 16, 17, 23, 24, 26, 27, 30, 31], "project": 4, "should": [4, 24, 32], "version": [4, 7, 27, 32], "short": 4, "descript": [4, 24], "includ": [4, 5, 14, 16], "setup": 4, "py": 4, "author": 4, "email": 4, "help_option_nam": 5, "h": 5, "help": 5, "dict": [5, 14, 16], "new": 5, "empti": 5, "dictionari": [5, 14], "map": 5, "initi": 5, "object": [5, 10, 14, 18, 19, 21, 24], "": [5, 7, 14], "kei": [5, 14], "valu": [5, 7, 10, 16], "pair": 5, "iter": [5, 28], "via": 5, "d": 5, "k": 5, "v": 5, "kwarg": [5, 7, 24, 27], "keyword": [5, 24, 27], "argument": [5, 14, 24, 27], "For": 5, "exampl": [5, 14], "one": 5, "1": [5, 10, 16, 17, 30, 31], "two": 5, "2": [5, 10, 32], "class": [5, 8, 10, 11, 12, 14, 26], "messag": [5, 8, 11, 12, 16, 21], "except": [5, 8, 11, 12, 14], "displai": [5, 8, 12, 24, 27], "yellow": 5, "color": 5, "error": [5, 8, 12], "exit_cod": [5, 8, 12], "exit": [5, 8, 12], "show": [5, 8, 12], "io": [5, 8, 12, 32], "write": [5, 8, 12], "output": [5, 8, 12, 19, 21, 24, 27, 32], "red": [5, 8, 12], "err": 5, "baseexcept": 5, "print": [5, 7, 30, 31, 32], "traceback": 5, "provid": [5, 24], "built": 5, "msg": 5, "handl": 5, "keyboard": 5, "interrupt": 5, "__init__": 5, "7": 5, "decor": 5, "wrap": 5, "click": [5, 7], "command": [5, 32], "catch": 5, "consist": 5, "group": 6, "hfutilcli": [6, 9], "ctx": 7, "context": 7, "param": 7, "cli": [7, 9, 29], "current": [7, 30, 31, 32], "metadata": 7, "arg": [7, 27], "indic": [8, 12], "remot": [8, 12], "assign": [8, 12, 14, 18, 19, 21], "17": 8, "context_set": 9, "clickwarningexcept": 9, "clickerrorexcept": 9, "print_except": 9, "keyboardinterrupt": 9, "command_wrap": 9, "dispatch": [9, 29], "print_vers": 9, "download": [9, 14, 17, 20, 25, 29], "noremotepathassignedwithdownload": 9, "l": [9, 29], "listitemtyp": 9, "listitem": 9, "ls_repo": [9, 29], "nolocalauthent": 9, "upload": [9, 16, 20, 29], "noremotepathassignedwithupload": 9, "whoami": [9, 29], "enum": 10, "repres": [10, 14], "differ": [10, 14, 30, 31], "item": [10, 17], "valid": [10, 15, 20, 29], "ar": [10, 14], "folder": 10, "imag": [10, 14], "3": [10, 30, 31, 32], "archiv": [10, 14, 16, 17, 19, 21, 29], "4": [10, 30, 31], "model": [10, 14, 16, 17, 18, 19, 21, 22, 26], "5": [10, 19, 30, 31], "data": [10, 14, 30, 31], "6": [10, 30, 31], "repofold": 10, "repofil": [10, 17], "base_dir": 10, "union": [10, 14], "authent": [11, 17], "token": [11, 14, 16, 17, 18, 19, 21, 22], "33": 12, "standalon": 14, "incomplet": 14, "hash": [14, 16, 17, 18, 19, 21], "archive_in_repo": [14, 16, 17, 21], "liter": [14, 16, 17, 18, 19, 21, 22, 26], "dataset": [14, 16, 17, 18, 19, 21, 22, 26], "main": [14, 16, 17, 18, 19, 21, 22, 32], "idx_repo_id": [14, 16, 17], "idx_file_in_repo": [14, 16, 17], "idx_repo_typ": [14, 16, 17], "idx_revis": [14, 16, 17], "hf_token": [14, 16, 17, 18, 19, 21, 22], "hug": [14, 16, 17, 18, 19, 21, 22], "face": [14, 16, 17, 18, 19, 21, 22], "identifi": [14, 16, 18, 19, 21, 22], "repotypetyp": [14, 16, 17, 18, 19, 21, 22, 26], "access": [14, 16], "import": [14, 30, 31, 32], "idx": 14, "deepgh": [14, 32], "danbooru_newest": 14, "0000": 14, "dict_kei": 14, "files": 14, "hash_lf": [14, 17], "7507000": 14, "jpg": 14, "7506000": 14, "7505000": 14, "besid": 14, "also": [14, 24, 32], "explicitli": 14, "nyanko7": 14, "danbooru2023": 14, "danbooru2023_index": 14, "origin": 14, "1000": 14, "png": 14, "10000": 14, "100000": 14, "insid": 14, "file_in_arch": 14, "check": [14, 17, 22, 23, 24, 32], "otherwis": [14, 17, 22, 24], "17506000": 14, "10000000001000": 14, "int": [14, 16, 17, 19, 24], "size": [14, 16, 17, 24, 30, 31], "integ": 14, "filenotfounderror": 14, "435671": 14, "11966": 14, "detail": 14, "offset": 14, "sha256": 14, "265728": 14, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 14, "1024": [14, 23], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 14, "local_fil": [14, 19, 21, 22], "proxi": 14, "user_ag": 14, "header": 14, "endpoint": 14, "save": [14, 16, 19, 24], "http": [14, 32], "request": [14, 24], "user": 14, "agent": 14, "addit": [14, 24, 27], "api": [14, 17, 18, 19, 21, 22], "test_exampl": 14, "destin": 14, "given": [14, 18, 23, 24, 26], "fetch": [15, 29], "archivestandalonefileincompletedownload": 15, "archivestandalonefilehashnotmatch": 15, "hf_tar_get_index": 15, "hf_tar_list_fil": 15, "hf_tar_file_exist": 15, "hf_tar_file_s": 15, "hf_tar_file_info": 15, "hf_tar_file_download": 15, "tar_create_index": 15, "hf_tar_create_index": [15, 17], "tar_get_index_info": 15, "hf_tar_create_from_directori": 15, "hf_tar_item_valid": 15, "hf_tar_valid": 15, "src_tar_fil": 16, "dst_index_fil": 16, "chunk_for_hash": 16, "1048576": 16, "with_hash": 16, "chunk": 16, "20": 16, "mb": 16, "whether": 16, "progress": [16, 19, 21, 24, 27], "bar": [16, 19, 21, 24, 27], "log": 16, "skip_when_sync": 16, "skip": 16, "sync": 16, "readi": [16, 22], "directli": 16, "json": [16, 17], "local_directori": [16, 19, 21], "file_item": 17, "hash_": 17, "expect": [17, 24], "sha": 17, "256": 17, "lf": 17, "entrynotfounderror": 17, "entri": [17, 29], "found": 17, "isadirectoryerror": 17, "mean": [17, 32], "expir": 17, "need": 17, "re": 17, "gener": 17, "so": 17, "togeth": 17, "gracefulli": 17, "refresh": 17, "hfapi": 18, "client": [18, 19, 21], "variabl": [18, 19, 21], "hffilesystem": 18, "system": 18, "subdir": 18, "ignore_pattern": [18, 19, 21], "subdirectori": 18, "e": [18, 19, 21], "g": [18, 19, 21], "branch": [18, 19, 21], "tag": [18, 19, 21], "commit": [18, 19, 21], "pattern": [18, 19, 21], "ignor": [18, 19, 21], "file_in_repo": [19, 21, 22], "resume_download": 19, "within": [19, 21], "resum": 19, "dir_in_repo": 19, "max_work": 19, "8": [19, 30, 31, 32], "max_retri": 19, "max": 19, "worker": 19, "retri": 19, "time": 19, "get_hf_client": 20, "get_hf_f": 20, "list_files_in_repositori": 20, "download_file_to_fil": 20, "download_archive_as_directori": 20, "download_directory_as_directori": 20, "upload_file_to_fil": 20, "upload_directory_as_arch": 20, "upload_directory_as_directori": 20, "is_local_file_readi": 20, "path_in_repo": 21, "time_suffix": 21, "its": 21, "append": 21, "timestamp": 21, "present": 21, "compar": 22, "hub": 22, "read": 23, "first": 23, "byte": [23, 24], "contain": 23, "non": 23, "text": 23, "charact": 23, "url": 24, "expected_s": 24, "desc": 24, "session": 24, "tqdm": [24, 25, 29], "It": [24, 32], "perform": [24, 30, 31], "ensur": 24, "ha": [24, 30, 31], "pass": [24, 27], "binari": [25, 29], "is_binary_fil": 25, "download_fil": 25, "hf_normpath": 25, "hf_fs_path": 25, "parse_hf_fs_path": 25, "hffilesystempath": 25, "walk": [25, 29], "walk_fil": 25, "normal": 26, "filesystem": 26, "pars": 26, "invalid": 26, "tqdm_": 27, "enhanc": 27, "silenc": 27, "modifi": 27, "behavior": 27, "allow": 27, "posit": 27, "std": 27, "recurs": 28, "through": [28, 32], "yield": 28, "rel": 28, "root": 28, "start": [28, 29], "modul": 29, "quick": 29, "run": 29, "environ": 29, "register_archive_typ": 29, "archive_pack": 29, "archive_unpack": 29, "get_archive_typ": 29, "get_archive_extnam": 29, "cach": 29, "config": [29, 32], "index": [29, 32], "oper": 29, "here": [30, 31], "o": [30, 31], "platform": [30, 31], "shutil": [30, 31], "cpuinfo": [30, 31], "psutil": [30, 31], "hbutil": [30, 31], "scale": [30, 31], "size_to_bytes_str": [30, 31], "python": [30, 31, 32], "python_implement": [30, 31], "python_vers": [30, 31], "cpu": [30, 31], "brand": [30, 31], "get_cpu_info": [30, 31], "brand_raw": [30, 31], "count": [30, 31], "cpu_count": [30, 31], "freq": [30, 31], "cpu_freq": [30, 31], "mhz": [30, 31], "memori": [30, 31], "virtual_memori": [30, 31], "total": [30, 31], "precis": [30, 31], "cuda": [30, 31], "ye": [30, 31], "nvidia": [30, 31], "smi": [30, 31], "els": [30, 31], "No": [30, 31], "linux": [30, 31], "0": [30, 31, 32], "1023": [30, 31], "azur": [30, 31], "x86_64": [30, 31], "glibc2": [30, 31], "34": [30, 31], "cpython": [30, 31], "18": [30, 31], "amd": [30, 31], "epyc": [30, 31], "7763": [30, 31], "64": [30, 31], "core": [30, 31], "processor": [30, 31], "2917": 30, "4900000000002": 30, "15": [30, 31], "606": [30, 31], "gib": [30, 31], "pleas": [30, 31], "note": [30, 31], "deploi": [30, 31], "document": [30, 31, 32], "automat": [30, 31], "execut": [30, 31], "github": [30, 31, 32], "action": [30, 31], "therefor": [30, 31], "some": [30, 31], "mai": [30, 31], "your": [30, 31, 32], "2945": 31, "5315": 31, "hfutil": 32, "host": 32, "pypi": 32, "newest": 32, "u": 32, "git": 32, "com": 32, "script": 32, "__name__": 32, "__main__": 32, "develop": 32, "maintain": 32, "like": 32, "below": 32, "success": 32, "11": 32, "narugo1992": 32, "still": 32, "out": 32, "stabl": 32, "html": 32, "faq": 33}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [2, 0, 0, "-", "cache"], [3, 0, 0, "-", "config"], [9, 0, 0, "-", "entry"], [15, 0, 0, "-", "index"], [20, 0, 0, "-", "operate"], [25, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.cache": [[1, 0, 0, "-", "delete"]], "hfutils.cache.delete": [[1, 1, 1, "", "delete_cache"], [1, 1, 1, "", "delete_detached_cache"]], "hfutils.config": [[4, 0, 0, "-", "meta"]], "hfutils.config.meta": [[4, 2, 1, "", "__AUTHOR_EMAIL__"], [4, 2, 1, "", "__AUTHOR__"], [4, 2, 1, "", "__DESCRIPTION__"], [4, 2, 1, "", "__TITLE__"], [4, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[5, 0, 0, "-", "base"], [6, 0, 0, "-", "cli"], [7, 0, 0, "-", "dispatch"], [8, 0, 0, "-", "download"], [10, 0, 0, "-", "ls"], [11, 0, 0, "-", "ls_repo"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[5, 2, 1, "", "CONTEXT_SETTINGS"], [5, 3, 1, "", "ClickErrorException"], [5, 3, 1, "", "ClickWarningException"], [5, 3, 1, "", "KeyboardInterrupted"], [5, 1, 1, "", "command_wrap"], [5, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[5, 5, 1, "", "__init__"], [5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.cli": [[6, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[7, 1, 1, "", "hfutilcli"], [7, 1, 1, "", "print_version"]], "hfutils.entry.download": [[8, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.entry.ls": [[10, 3, 1, "", "ListItem"], [10, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[10, 4, 1, "", "ARCHIVE"], [10, 4, 1, "", "DATA"], [10, 4, 1, "", "FILE"], [10, 4, 1, "", "FOLDER"], [10, 4, 1, "", "IMAGE"], [10, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[11, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[12, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[12, 4, 1, "", "exit_code"], [12, 5, 1, "", "show"]], "hfutils.index": [[14, 0, 0, "-", "fetch"], [16, 0, 0, "-", "make"], [17, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[14, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [14, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [14, 1, 1, "", "hf_tar_file_download"], [14, 1, 1, "", "hf_tar_file_exists"], [14, 1, 1, "", "hf_tar_file_info"], [14, 1, 1, "", "hf_tar_file_size"], [14, 1, 1, "", "hf_tar_get_index"], [14, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[16, 1, 1, "", "hf_tar_create_from_directory"], [16, 1, 1, "", "hf_tar_create_index"], [16, 1, 1, "", "tar_create_index"], [16, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[17, 1, 1, "", "hf_tar_item_validate"], [17, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[18, 0, 0, "-", "base"], [19, 0, 0, "-", "download"], [21, 0, 0, "-", "upload"], [22, 0, 0, "-", "validate"]], "hfutils.operate.base": [[18, 1, 1, "", "get_hf_client"], [18, 1, 1, "", "get_hf_fs"], [18, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[19, 1, 1, "", "download_archive_as_directory"], [19, 1, 1, "", "download_directory_as_directory"], [19, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[21, 1, 1, "", "upload_directory_as_archive"], [21, 1, 1, "", "upload_directory_as_directory"], [21, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[22, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[23, 0, 0, "-", "binary"], [24, 0, 0, "-", "download"], [26, 0, 0, "-", "path"], [27, 0, 0, "-", "tqdm_"], [28, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[23, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[24, 1, 1, "", "download_file"]], "hfutils.utils.path": [[26, 3, 1, "", "HfFileSystemPath"], [26, 1, 1, "", "hf_fs_path"], [26, 1, 1, "", "hf_normpath"], [26, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[28, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "cach": [1, 2], "delet": 1, "delete_detached_cach": 1, "delete_cach": 1, "config": [3, 4], "meta": 4, "__title__": 4, "__version__": 4, "__description__": 4, "__author__": 4, "__author_email__": 4, "entri": [5, 6, 7, 8, 9, 10, 11, 12, 13], "base": [5, 18], "context_set": 5, "clickwarningexcept": 5, "clickerrorexcept": 5, "print_except": 5, "keyboardinterrupt": 5, "command_wrap": 5, "cli": 6, "dispatch": 7, "print_vers": 7, "hfutilcli": 7, "download": [8, 19, 24], "noremotepathassignedwithdownload": 8, "l": 10, "listitemtyp": 10, "listitem": 10, "ls_repo": 11, "nolocalauthent": 11, "upload": [12, 21], "noremotepathassignedwithupload": 12, "whoami": 13, "index": [14, 15, 16, 17], "fetch": 14, "archivestandalonefileincompletedownload": 14, "archivestandalonefilehashnotmatch": 14, "hf_tar_get_index": 14, "hf_tar_list_fil": 14, "hf_tar_file_exist": 14, "hf_tar_file_s": 14, "hf_tar_file_info": 14, "hf_tar_file_download": 14, "make": 16, "tar_create_index": 16, "hf_tar_create_index": 16, "tar_get_index_info": 16, "hf_tar_create_from_directori": 16, "valid": [17, 22], "hf_tar_item_valid": 17, "hf_tar_valid": 17, "oper": [18, 19, 20, 21, 22], "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 19, "download_archive_as_directori": 19, "download_directory_as_directori": 19, "upload_file_to_fil": 21, "upload_directory_as_arch": 21, "upload_directory_as_directori": 21, "is_local_file_readi": 22, "util": [23, 24, 25, 26, 27, 28], "binari": 23, "is_binary_fil": 23, "download_fil": 24, "path": 26, "hf_normpath": 26, "hf_fs_path": 26, "parse_hf_fs_path": 26, "hffilesystempath": 26, "tqdm": 27, "walk": 28, "walk_fil": 28, "welcom": 29, "": 29, "document": 29, "overview": 29, "tutori": 29, "inform": [29, 30, 31], "api": 29, "run": [30, 31], "environ": [30, 31], "instal": 32, "quick": 33, "start": 33}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "delete_detached_cache": [[1, "delete-detached-cache"]], "delete_cache": [[1, "delete-cache"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "__TITLE__": [[4, "title"]], "__VERSION__": [[4, "version"]], "__DESCRIPTION__": [[4, "description"]], "__AUTHOR__": [[4, "author"]], "__AUTHOR_EMAIL__": [[4, "author-email"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[5, "context-settings"]], "ClickWarningException": [[5, "clickwarningexception"]], "ClickErrorException": [[5, "clickerrorexception"]], "print_exception": [[5, "print-exception"]], "KeyboardInterrupted": [[5, "keyboardinterrupted"]], "command_wrap": [[5, "command-wrap"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "cli": [[6, "cli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version": [[7, "print-version"]], "hfutilcli": [[7, "hfutilcli"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[8, "noremotepathassignedwithdownload"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "ListItemType": [[10, "listitemtype"]], "ListItem": [[10, "listitem"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[11, "nolocalauthentication"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[12, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[14, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[14, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[14, "hf-tar-get-index"]], "hf_tar_list_files": [[14, "hf-tar-list-files"]], "hf_tar_file_exists": [[14, "hf-tar-file-exists"]], "hf_tar_file_size": [[14, "hf-tar-file-size"]], "hf_tar_file_info": [[14, "hf-tar-file-info"]], "hf_tar_file_download": [[14, "hf-tar-file-download"]], "hfutils.index": [[15, "module-hfutils.index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index": [[16, "tar-create-index"]], "hf_tar_create_index": [[16, "hf-tar-create-index"]], "tar_get_index_info": [[16, "tar-get-index-info"]], "hf_tar_create_from_directory": [[16, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[17, "hf-tar-item-validate"]], "hf_tar_validate": [[17, "hf-tar-validate"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "get_hf_client": [[18, "get-hf-client"]], "get_hf_fs": [[18, "get-hf-fs"]], "list_files_in_repository": [[18, "list-files-in-repository"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "download_file_to_file": [[19, "download-file-to-file"]], "download_archive_as_directory": [[19, "download-archive-as-directory"]], "download_directory_as_directory": [[19, "download-directory-as-directory"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_file_to_file": [[21, "upload-file-to-file"]], "upload_directory_as_archive": [[21, "upload-directory-as-archive"]], "upload_directory_as_directory": [[21, "upload-directory-as-directory"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready": [[22, "is-local-file-ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file": [[23, "is-binary-file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "download_file": [[24, "download-file"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "hf_normpath": [[26, "hf-normpath"]], "hf_fs_path": [[26, "hf-fs-path"]], "parse_hf_fs_path": [[26, "parse-hf-fs-path"]], "HfFileSystemPath": [[26, "hffilesystempath"]], "hfutils.utils.tqdm": [[27, "module-hfutils.utils.tqdm_"]], "tqdm": [[27, "tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files": [[28, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[29, "welcome-to-hfutils-s-documentation"]], "Overview": [[29, "overview"]], "Tutorials": [[29, null]], "Information": [[29, null]], "API Documentation": [[29, null]], "Run Environment Information": [[30, "Run-Environment-Information"], [31, "Run-Environment-Information"]], "Installation": [[32, "installation"]], "Quick Start": [[33, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.cache.delete"], [2, "module-hfutils.cache"], [3, "module-hfutils.config"], [4, "module-hfutils.config.meta"], [5, "module-hfutils.entry.base"], [6, "module-hfutils.entry.cli"], [7, "module-hfutils.entry.dispatch"], [8, "module-hfutils.entry.download"], [9, "module-hfutils.entry"], [10, "module-hfutils.entry.ls"], [11, "module-hfutils.entry.ls_repo"], [12, "module-hfutils.entry.upload"], [13, "module-hfutils.entry.whoami"], [14, "module-hfutils.index.fetch"], [15, "module-hfutils.index"], [16, "module-hfutils.index.make"], [17, "module-hfutils.index.validate"], [18, "module-hfutils.operate.base"], [19, "module-hfutils.operate.download"], [20, "module-hfutils.operate"], [21, "module-hfutils.operate.upload"], [22, "module-hfutils.operate.validate"], [23, "module-hfutils.utils.binary"], [24, "module-hfutils.utils.download"], [25, "module-hfutils.utils"], [26, "module-hfutils.utils.path"], [27, "module-hfutils.utils.tqdm_"], [28, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "delete_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_cache"]], "delete_detached_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_detached_cache"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[5, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[5, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[5, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[5, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[5, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[5, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[5, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[6, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[10, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[11, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "hfutils.index": [[15, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[22, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[23, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[24, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[26, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[27, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[28, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/cache/delete", "api_doc/cache/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/cache/delete.rst", "api_doc/cache/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.cache.delete", "hfutils.cache", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2, 4], "pack": 0, "unpack": 0, "manag": [0, 2], "support": 0, "format": 0, "extens": 0, "name": [0, 5], "7z": 0, "bztar": 0, "tar": [0, 14, 16, 17], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 1, 5, 17, 19, 21, 24, 26, 27], "you": [0, 14, 32], "requir": [0, 32], "simpli": [0, 32], "instal": [0, 29], "us": [0, 1, 5, 14, 16, 17, 18, 19, 21, 24, 29, 32], "follow": [0, 10, 32], "code": [0, 5, 8, 12], "pip": [0, 32], "The": [0, 1, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28, 32], "creation": 0, "file": [0, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 28], "i": [0, 1, 8, 11, 12, 14, 16, 17, 19, 22, 23, 26, 29, 30, 31, 32], "we": 0, "util": [0, 29, 32], "rarfil": 0, "librari": [0, 24], "which": [0, 14, 30, 31, 32], "doe": [0, 14], "offer": 0, "function": [0, 5, 14, 16, 17, 23, 24, 27], "creat": [0, 16], "str": [0, 1, 5, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28], "ext": 0, "list": [0, 5, 10, 14, 18, 19, 21], "fn_pack": 0, "callabl": [0, 5], "fn_unpack": 0, "sourc": [0, 1, 5, 7, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "regist": 0, "custom": [0, 5, 8, 12], "type": [0, 1, 5, 10, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "associ": 0, "paramet": [0, 1, 5, 7, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "A": [0, 18], "take": 0, "directori": [0, 1, 10, 16, 17, 19, 21, 28], "an": [0, 14, 16, 17, 19, 21, 24, 27, 28], "filenam": [0, 24, 26], "input": 0, "extract": [0, 19], "type_nam": 0, "archive_fil": 0, "silent": [0, 16, 19, 21, 24, 27], "bool": [0, 7, 14, 16, 17, 19, 21, 22, 23, 24, 27], "fals": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "clear": [0, 21], "specifi": [0, 1, 17, 21, 24], "result": 0, "true": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "suppress": [0, 16, 19, 21, 24], "warn": [0, 5], "dure": 0, "process": 0, "remov": [0, 21], "exist": [0, 14, 19], "when": [0, 11, 14, 16, 19], "return": [0, 5, 14, 16, 17, 18, 22, 23, 24, 26, 27, 28], "path": [0, 8, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 25, 28, 29], "password": [0, 19], "none": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26], "content": [0, 27], "option": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26, 27], "determin": 0, "base": [0, 9, 10, 17, 20, 29], "rais": [0, 11, 14, 17, 26], "valueerror": [0, 26], "ani": [0, 1, 7, 23, 26], "get": [0, 14, 16, 18, 24, 26], "repo_id": [1, 14, 16, 17, 18, 19, 21, 22, 26], "repo_typ": [1, 14, 16, 17, 18, 19, 21, 22, 26], "cache_dir": 1, "all": [1, 14, 19, 28], "detach": 1, "revis": [1, 14, 16, 17, 18, 19, 21, 22, 26], "from": [1, 5, 14, 16, 17, 18, 19, 24, 30, 31, 32], "match": [1, 14, 17, 22], "repositori": [1, 8, 12, 14, 16, 17, 18, 19, 21, 22, 26], "id": [1, 17, 26], "where": [1, 17, 24], "store": [1, 17], "default": [1, 16, 17, 19, 22, 26], "huggingfac": [2, 17, 18, 19, 21, 26, 29, 32], "local": [2, 11, 14, 16, 19, 21, 22, 24, 30, 31], "can": [2, 14, 17, 32], "quickli": 2, "make": [2, 15, 17, 29], "disk": 2, "space": [2, 14, 16, 17, 18, 19, 21, 22, 26], "under": [2, 32], "control": 2, "delet": [2, 29], "delete_detached_cach": 2, "delete_cach": 2, "meta": [3, 14, 29, 32], "__title__": [3, 32], "__version__": [3, 32], "__description__": [3, 32], "__author__": [3, 32], "__author_email__": 3, "inform": [4, 5, 7, 14, 16, 17], "packag": 4, "titl": 4, "thi": [4, 5, 8, 12, 14, 16, 17, 23, 24, 26, 27, 30, 31], "project": 4, "should": [4, 24, 32], "version": [4, 7, 27, 32], "short": 4, "descript": [4, 24], "includ": [4, 5, 14, 16], "setup": 4, "py": 4, "author": 4, "email": 4, "help_option_nam": 5, "h": 5, "help": 5, "dict": [5, 14, 16], "new": 5, "empti": 5, "dictionari": [5, 14], "map": 5, "initi": 5, "object": [5, 10, 14, 18, 19, 21, 24], "": [5, 7, 14], "kei": [5, 14], "valu": [5, 7, 10, 16], "pair": 5, "iter": [5, 28], "via": 5, "d": 5, "k": 5, "v": 5, "kwarg": [5, 7, 24, 27], "keyword": [5, 24, 27], "argument": [5, 14, 24, 27], "For": 5, "exampl": [5, 14], "one": 5, "1": [5, 10, 16, 17, 30, 31], "two": 5, "2": [5, 10, 32], "class": [5, 8, 10, 11, 12, 14, 26], "messag": [5, 8, 11, 12, 16, 21], "except": [5, 8, 11, 12, 14], "displai": [5, 8, 12, 24, 27], "yellow": 5, "color": 5, "error": [5, 8, 12], "exit_cod": [5, 8, 12], "exit": [5, 8, 12], "show": [5, 8, 12], "io": [5, 8, 12, 32], "write": [5, 8, 12], "output": [5, 8, 12, 19, 21, 24, 27, 32], "red": [5, 8, 12], "err": 5, "baseexcept": 5, "print": [5, 7, 30, 31, 32], "traceback": 5, "provid": [5, 24], "built": 5, "msg": 5, "handl": 5, "keyboard": 5, "interrupt": 5, "__init__": 5, "7": 5, "decor": 5, "wrap": 5, "click": [5, 7], "command": [5, 32], "catch": 5, "consist": 5, "group": 6, "hfutilcli": [6, 9], "ctx": 7, "context": 7, "param": 7, "cli": [7, 9, 29], "current": [7, 30, 31, 32], "metadata": 7, "arg": [7, 27], "indic": [8, 12], "remot": [8, 12], "assign": [8, 12, 14, 18, 19, 21], "17": 8, "context_set": 9, "clickwarningexcept": 9, "clickerrorexcept": 9, "print_except": 9, "keyboardinterrupt": 9, "command_wrap": 9, "dispatch": [9, 29], "print_vers": 9, "download": [9, 14, 17, 20, 25, 29], "noremotepathassignedwithdownload": 9, "l": [9, 29], "listitemtyp": 9, "listitem": 9, "ls_repo": [9, 29], "nolocalauthent": 9, "upload": [9, 16, 20, 29], "noremotepathassignedwithupload": 9, "whoami": [9, 29], "enum": 10, "repres": [10, 14], "differ": [10, 14, 30, 31], "item": [10, 17], "valid": [10, 15, 20, 29], "ar": [10, 14], "folder": 10, "imag": [10, 14], "3": [10, 30, 31, 32], "archiv": [10, 14, 16, 17, 19, 21, 29], "4": [10, 30, 31], "model": [10, 14, 16, 17, 18, 19, 21, 22, 26], "5": [10, 19, 30, 31], "data": [10, 14, 30, 31], "6": [10, 30, 31], "repofold": 10, "repofil": [10, 17], "base_dir": 10, "union": [10, 14], "authent": [11, 17], "token": [11, 14, 16, 17, 18, 19, 21, 22], "33": 12, "standalon": 14, "incomplet": 14, "hash": [14, 16, 17, 18, 19, 21], "archive_in_repo": [14, 16, 17, 21], "liter": [14, 16, 17, 18, 19, 21, 22, 26], "dataset": [14, 16, 17, 18, 19, 21, 22, 26], "main": [14, 16, 17, 18, 19, 21, 22, 32], "idx_repo_id": [14, 16, 17], "idx_file_in_repo": [14, 16, 17], "idx_repo_typ": [14, 16, 17], "idx_revis": [14, 16, 17], "hf_token": [14, 16, 17, 18, 19, 21, 22], "hug": [14, 16, 17, 18, 19, 21, 22], "face": [14, 16, 17, 18, 19, 21, 22], "identifi": [14, 16, 18, 19, 21, 22], "repotypetyp": [14, 16, 17, 18, 19, 21, 22, 26], "access": [14, 16], "import": [14, 30, 31, 32], "idx": 14, "deepgh": [14, 32], "danbooru_newest": 14, "0000": 14, "dict_kei": 14, "files": 14, "hash_lf": [14, 17], "7507000": 14, "jpg": 14, "7506000": 14, "7505000": 14, "besid": 14, "also": [14, 24, 32], "explicitli": 14, "nyanko7": 14, "danbooru2023": 14, "danbooru2023_index": 14, "origin": 14, "1000": 14, "png": 14, "10000": 14, "100000": 14, "insid": 14, "file_in_arch": 14, "check": [14, 17, 22, 23, 24, 32], "otherwis": [14, 17, 22, 24], "17506000": 14, "10000000001000": 14, "int": [14, 16, 17, 19, 24], "size": [14, 16, 17, 24, 30, 31], "integ": 14, "filenotfounderror": 14, "435671": 14, "11966": 14, "detail": 14, "offset": 14, "sha256": 14, "265728": 14, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 14, "1024": [14, 23, 30, 31], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 14, "local_fil": [14, 19, 21, 22], "proxi": 14, "user_ag": 14, "header": 14, "endpoint": 14, "save": [14, 16, 19, 24], "http": [14, 32], "request": [14, 24], "user": 14, "agent": 14, "addit": [14, 24, 27], "api": [14, 17, 18, 19, 21, 22], "test_exampl": 14, "destin": 14, "given": [14, 18, 23, 24, 26], "fetch": [15, 29], "archivestandalonefileincompletedownload": 15, "archivestandalonefilehashnotmatch": 15, "hf_tar_get_index": 15, "hf_tar_list_fil": 15, "hf_tar_file_exist": 15, "hf_tar_file_s": 15, "hf_tar_file_info": 15, "hf_tar_file_download": 15, "tar_create_index": 15, "hf_tar_create_index": [15, 17], "tar_get_index_info": 15, "hf_tar_create_from_directori": 15, "hf_tar_item_valid": 15, "hf_tar_valid": 15, "src_tar_fil": 16, "dst_index_fil": 16, "chunk_for_hash": 16, "1048576": 16, "with_hash": 16, "chunk": 16, "20": 16, "mb": 16, "whether": 16, "progress": [16, 19, 21, 24, 27], "bar": [16, 19, 21, 24, 27], "log": 16, "skip_when_sync": 16, "skip": 16, "sync": 16, "readi": [16, 22], "directli": 16, "json": [16, 17], "local_directori": [16, 19, 21], "file_item": 17, "hash_": 17, "expect": [17, 24], "sha": 17, "256": 17, "lf": 17, "entrynotfounderror": 17, "entri": [17, 29], "found": 17, "isadirectoryerror": 17, "mean": [17, 32], "expir": 17, "need": 17, "re": 17, "gener": 17, "so": 17, "togeth": 17, "gracefulli": 17, "refresh": 17, "hfapi": 18, "client": [18, 19, 21], "variabl": [18, 19, 21], "hffilesystem": 18, "system": 18, "subdir": 18, "ignore_pattern": [18, 19, 21], "subdirectori": 18, "e": [18, 19, 21], "g": [18, 19, 21], "branch": [18, 19, 21], "tag": [18, 19, 21], "commit": [18, 19, 21], "pattern": [18, 19, 21], "ignor": [18, 19, 21], "file_in_repo": [19, 21, 22], "resume_download": 19, "within": [19, 21], "resum": 19, "dir_in_repo": 19, "max_work": 19, "8": [19, 30, 31, 32], "max_retri": 19, "max": 19, "worker": 19, "retri": 19, "time": 19, "get_hf_client": 20, "get_hf_f": 20, "list_files_in_repositori": 20, "download_file_to_fil": 20, "download_archive_as_directori": 20, "download_directory_as_directori": 20, "upload_file_to_fil": 20, "upload_directory_as_arch": 20, "upload_directory_as_directori": 20, "is_local_file_readi": 20, "path_in_repo": 21, "time_suffix": 21, "its": 21, "append": 21, "timestamp": 21, "present": 21, "compar": 22, "hub": 22, "read": 23, "first": 23, "byte": [23, 24], "contain": 23, "non": 23, "text": 23, "charact": 23, "url": 24, "expected_s": 24, "desc": 24, "session": 24, "tqdm": [24, 25, 29], "It": [24, 32], "perform": [24, 30, 31], "ensur": 24, "ha": [24, 30, 31], "pass": [24, 27], "binari": [25, 29], "is_binary_fil": 25, "download_fil": 25, "hf_normpath": 25, "hf_fs_path": 25, "parse_hf_fs_path": 25, "hffilesystempath": 25, "walk": [25, 29], "walk_fil": 25, "normal": 26, "filesystem": 26, "pars": 26, "invalid": 26, "tqdm_": 27, "enhanc": 27, "silenc": 27, "modifi": 27, "behavior": 27, "allow": 27, "posit": 27, "std": 27, "recurs": 28, "through": [28, 32], "yield": 28, "rel": 28, "root": 28, "start": [28, 29], "modul": 29, "quick": 29, "run": 29, "environ": 29, "register_archive_typ": 29, "archive_pack": 29, "archive_unpack": 29, "get_archive_typ": 29, "get_archive_extnam": 29, "cach": 29, "config": [29, 32], "index": [29, 32], "oper": 29, "here": [30, 31], "o": [30, 31], "platform": [30, 31], "shutil": [30, 31], "cpuinfo": [30, 31], "psutil": [30, 31], "hbutil": [30, 31], "scale": [30, 31], "size_to_bytes_str": [30, 31], "python": [30, 31, 32], "python_implement": [30, 31], "python_vers": [30, 31], "cpu": [30, 31], "brand": [30, 31], "get_cpu_info": [30, 31], "brand_raw": [30, 31], "count": [30, 31], "cpu_count": [30, 31], "freq": [30, 31], "cpu_freq": [30, 31], "mhz": [30, 31], "memori": [30, 31], "virtual_memori": [30, 31], "total": [30, 31], "precis": [30, 31], "cuda": [30, 31], "ye": [30, 31], "nvidia": [30, 31], "smi": [30, 31], "els": [30, 31], "No": [30, 31], "linux": [30, 31], "0": [30, 31, 32], "azur": [30, 31], "x86_64": [30, 31], "glibc2": [30, 31], "34": [30, 31], "cpython": [30, 31], "18": [30, 31], "amd": [30, 31], "epyc": [30, 31], "7763": [30, 31], "64": [30, 31], "core": [30, 31], "processor": [30, 31], "2981": 30, "7025": 30, "15": [30, 31], "606": [30, 31], "gib": [30, 31], "pleas": [30, 31], "note": [30, 31], "deploi": [30, 31], "document": [30, 31, 32], "automat": [30, 31], "execut": [30, 31], "github": [30, 31, 32], "action": [30, 31], "therefor": [30, 31], "some": [30, 31], "mai": [30, 31], "your": [30, 31, 32], "2953": 31, "17375": 31, "hfutil": 32, "host": 32, "pypi": 32, "newest": 32, "u": 32, "git": 32, "com": 32, "script": 32, "__name__": 32, "__main__": 32, "develop": 32, "maintain": 32, "like": 32, "below": 32, "success": 32, "11": 32, "narugo1992": 32, "still": 32, "out": 32, "stabl": 32, "html": 32, "faq": 33}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [2, 0, 0, "-", "cache"], [3, 0, 0, "-", "config"], [9, 0, 0, "-", "entry"], [15, 0, 0, "-", "index"], [20, 0, 0, "-", "operate"], [25, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.cache": [[1, 0, 0, "-", "delete"]], "hfutils.cache.delete": [[1, 1, 1, "", "delete_cache"], [1, 1, 1, "", "delete_detached_cache"]], "hfutils.config": [[4, 0, 0, "-", "meta"]], "hfutils.config.meta": [[4, 2, 1, "", "__AUTHOR_EMAIL__"], [4, 2, 1, "", "__AUTHOR__"], [4, 2, 1, "", "__DESCRIPTION__"], [4, 2, 1, "", "__TITLE__"], [4, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[5, 0, 0, "-", "base"], [6, 0, 0, "-", "cli"], [7, 0, 0, "-", "dispatch"], [8, 0, 0, "-", "download"], [10, 0, 0, "-", "ls"], [11, 0, 0, "-", "ls_repo"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[5, 2, 1, "", "CONTEXT_SETTINGS"], [5, 3, 1, "", "ClickErrorException"], [5, 3, 1, "", "ClickWarningException"], [5, 3, 1, "", "KeyboardInterrupted"], [5, 1, 1, "", "command_wrap"], [5, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[5, 5, 1, "", "__init__"], [5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.cli": [[6, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[7, 1, 1, "", "hfutilcli"], [7, 1, 1, "", "print_version"]], "hfutils.entry.download": [[8, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.entry.ls": [[10, 3, 1, "", "ListItem"], [10, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[10, 4, 1, "", "ARCHIVE"], [10, 4, 1, "", "DATA"], [10, 4, 1, "", "FILE"], [10, 4, 1, "", "FOLDER"], [10, 4, 1, "", "IMAGE"], [10, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[11, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[12, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[12, 4, 1, "", "exit_code"], [12, 5, 1, "", "show"]], "hfutils.index": [[14, 0, 0, "-", "fetch"], [16, 0, 0, "-", "make"], [17, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[14, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [14, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [14, 1, 1, "", "hf_tar_file_download"], [14, 1, 1, "", "hf_tar_file_exists"], [14, 1, 1, "", "hf_tar_file_info"], [14, 1, 1, "", "hf_tar_file_size"], [14, 1, 1, "", "hf_tar_get_index"], [14, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[16, 1, 1, "", "hf_tar_create_from_directory"], [16, 1, 1, "", "hf_tar_create_index"], [16, 1, 1, "", "tar_create_index"], [16, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[17, 1, 1, "", "hf_tar_item_validate"], [17, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[18, 0, 0, "-", "base"], [19, 0, 0, "-", "download"], [21, 0, 0, "-", "upload"], [22, 0, 0, "-", "validate"]], "hfutils.operate.base": [[18, 1, 1, "", "get_hf_client"], [18, 1, 1, "", "get_hf_fs"], [18, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[19, 1, 1, "", "download_archive_as_directory"], [19, 1, 1, "", "download_directory_as_directory"], [19, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[21, 1, 1, "", "upload_directory_as_archive"], [21, 1, 1, "", "upload_directory_as_directory"], [21, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[22, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[23, 0, 0, "-", "binary"], [24, 0, 0, "-", "download"], [26, 0, 0, "-", "path"], [27, 0, 0, "-", "tqdm_"], [28, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[23, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[24, 1, 1, "", "download_file"]], "hfutils.utils.path": [[26, 3, 1, "", "HfFileSystemPath"], [26, 1, 1, "", "hf_fs_path"], [26, 1, 1, "", "hf_normpath"], [26, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[28, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "cach": [1, 2], "delet": 1, "delete_detached_cach": 1, "delete_cach": 1, "config": [3, 4], "meta": 4, "__title__": 4, "__version__": 4, "__description__": 4, "__author__": 4, "__author_email__": 4, "entri": [5, 6, 7, 8, 9, 10, 11, 12, 13], "base": [5, 18], "context_set": 5, "clickwarningexcept": 5, "clickerrorexcept": 5, "print_except": 5, "keyboardinterrupt": 5, "command_wrap": 5, "cli": 6, "dispatch": 7, "print_vers": 7, "hfutilcli": 7, "download": [8, 19, 24], "noremotepathassignedwithdownload": 8, "l": 10, "listitemtyp": 10, "listitem": 10, "ls_repo": 11, "nolocalauthent": 11, "upload": [12, 21], "noremotepathassignedwithupload": 12, "whoami": 13, "index": [14, 15, 16, 17], "fetch": 14, "archivestandalonefileincompletedownload": 14, "archivestandalonefilehashnotmatch": 14, "hf_tar_get_index": 14, "hf_tar_list_fil": 14, "hf_tar_file_exist": 14, "hf_tar_file_s": 14, "hf_tar_file_info": 14, "hf_tar_file_download": 14, "make": 16, "tar_create_index": 16, "hf_tar_create_index": 16, "tar_get_index_info": 16, "hf_tar_create_from_directori": 16, "valid": [17, 22], "hf_tar_item_valid": 17, "hf_tar_valid": 17, "oper": [18, 19, 20, 21, 22], "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 19, "download_archive_as_directori": 19, "download_directory_as_directori": 19, "upload_file_to_fil": 21, "upload_directory_as_arch": 21, "upload_directory_as_directori": 21, "is_local_file_readi": 22, "util": [23, 24, 25, 26, 27, 28], "binari": 23, "is_binary_fil": 23, "download_fil": 24, "path": 26, "hf_normpath": 26, "hf_fs_path": 26, "parse_hf_fs_path": 26, "hffilesystempath": 26, "tqdm": 27, "walk": 28, "walk_fil": 28, "welcom": 29, "": 29, "document": 29, "overview": 29, "tutori": 29, "inform": [29, 30, 31], "api": 29, "run": [30, 31], "environ": [30, 31], "instal": 32, "quick": 33, "start": 33}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "delete_detached_cache": [[1, "delete-detached-cache"]], "delete_cache": [[1, "delete-cache"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "__TITLE__": [[4, "title"]], "__VERSION__": [[4, "version"]], "__DESCRIPTION__": [[4, "description"]], "__AUTHOR__": [[4, "author"]], "__AUTHOR_EMAIL__": [[4, "author-email"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[5, "context-settings"]], "ClickWarningException": [[5, "clickwarningexception"]], "ClickErrorException": [[5, "clickerrorexception"]], "print_exception": [[5, "print-exception"]], "KeyboardInterrupted": [[5, "keyboardinterrupted"]], "command_wrap": [[5, "command-wrap"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "cli": [[6, "cli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version": [[7, "print-version"]], "hfutilcli": [[7, "hfutilcli"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[8, "noremotepathassignedwithdownload"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "ListItemType": [[10, "listitemtype"]], "ListItem": [[10, "listitem"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[11, "nolocalauthentication"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[12, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[14, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[14, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[14, "hf-tar-get-index"]], "hf_tar_list_files": [[14, "hf-tar-list-files"]], "hf_tar_file_exists": [[14, "hf-tar-file-exists"]], "hf_tar_file_size": [[14, "hf-tar-file-size"]], "hf_tar_file_info": [[14, "hf-tar-file-info"]], "hf_tar_file_download": [[14, "hf-tar-file-download"]], "hfutils.index": [[15, "module-hfutils.index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index": [[16, "tar-create-index"]], "hf_tar_create_index": [[16, "hf-tar-create-index"]], "tar_get_index_info": [[16, "tar-get-index-info"]], "hf_tar_create_from_directory": [[16, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[17, "hf-tar-item-validate"]], "hf_tar_validate": [[17, "hf-tar-validate"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "get_hf_client": [[18, "get-hf-client"]], "get_hf_fs": [[18, "get-hf-fs"]], "list_files_in_repository": [[18, "list-files-in-repository"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "download_file_to_file": [[19, "download-file-to-file"]], "download_archive_as_directory": [[19, "download-archive-as-directory"]], "download_directory_as_directory": [[19, "download-directory-as-directory"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_file_to_file": [[21, "upload-file-to-file"]], "upload_directory_as_archive": [[21, "upload-directory-as-archive"]], "upload_directory_as_directory": [[21, "upload-directory-as-directory"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready": [[22, "is-local-file-ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file": [[23, "is-binary-file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "download_file": [[24, "download-file"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "hf_normpath": [[26, "hf-normpath"]], "hf_fs_path": [[26, "hf-fs-path"]], "parse_hf_fs_path": [[26, "parse-hf-fs-path"]], "HfFileSystemPath": [[26, "hffilesystempath"]], "hfutils.utils.tqdm": [[27, "module-hfutils.utils.tqdm_"]], "tqdm": [[27, "tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files": [[28, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[29, "welcome-to-hfutils-s-documentation"]], "Overview": [[29, "overview"]], "Tutorials": [[29, null]], "Information": [[29, null]], "API Documentation": [[29, null]], "Run Environment Information": [[30, "Run-Environment-Information"], [31, "Run-Environment-Information"]], "Installation": [[32, "installation"]], "Quick Start": [[33, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.cache.delete"], [2, "module-hfutils.cache"], [3, "module-hfutils.config"], [4, "module-hfutils.config.meta"], [5, "module-hfutils.entry.base"], [6, "module-hfutils.entry.cli"], [7, "module-hfutils.entry.dispatch"], [8, "module-hfutils.entry.download"], [9, "module-hfutils.entry"], [10, "module-hfutils.entry.ls"], [11, "module-hfutils.entry.ls_repo"], [12, "module-hfutils.entry.upload"], [13, "module-hfutils.entry.whoami"], [14, "module-hfutils.index.fetch"], [15, "module-hfutils.index"], [16, "module-hfutils.index.make"], [17, "module-hfutils.index.validate"], [18, "module-hfutils.operate.base"], [19, "module-hfutils.operate.download"], [20, "module-hfutils.operate"], [21, "module-hfutils.operate.upload"], [22, "module-hfutils.operate.validate"], [23, "module-hfutils.utils.binary"], [24, "module-hfutils.utils.download"], [25, "module-hfutils.utils"], [26, "module-hfutils.utils.path"], [27, "module-hfutils.utils.tqdm_"], [28, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "delete_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_cache"]], "delete_detached_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_detached_cache"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[5, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[5, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[5, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[5, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[5, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[5, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[5, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[6, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[10, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[11, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "hfutils.index": [[15, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[22, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[23, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[24, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[26, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[27, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[28, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/main/.buildinfo b/main/.buildinfo
index 9a218ec853..c3992ef544 100644
--- a/main/.buildinfo
+++ b/main/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 9d6348ac015677183e8ab44182b87b6c
+config: 45195b550a334114c9154b46530817b7
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/main/.doctrees/api_doc/archive/index.doctree b/main/.doctrees/api_doc/archive/index.doctree
index 6ba9002786..62d1b04e68 100644
Binary files a/main/.doctrees/api_doc/archive/index.doctree and b/main/.doctrees/api_doc/archive/index.doctree differ
diff --git a/main/.doctrees/api_doc/cache/delete.doctree b/main/.doctrees/api_doc/cache/delete.doctree
index d5407e7f76..60a1b25fe9 100644
Binary files a/main/.doctrees/api_doc/cache/delete.doctree and b/main/.doctrees/api_doc/cache/delete.doctree differ
diff --git a/main/.doctrees/api_doc/cache/index.doctree b/main/.doctrees/api_doc/cache/index.doctree
index eb16f1ad83..73126d0ae4 100644
Binary files a/main/.doctrees/api_doc/cache/index.doctree and b/main/.doctrees/api_doc/cache/index.doctree differ
diff --git a/main/.doctrees/api_doc/config/index.doctree b/main/.doctrees/api_doc/config/index.doctree
index 7147a68c13..0c7c36a0d2 100644
Binary files a/main/.doctrees/api_doc/config/index.doctree and b/main/.doctrees/api_doc/config/index.doctree differ
diff --git a/main/.doctrees/api_doc/config/meta.doctree b/main/.doctrees/api_doc/config/meta.doctree
index 8071cf7417..7e5d3ca484 100644
Binary files a/main/.doctrees/api_doc/config/meta.doctree and b/main/.doctrees/api_doc/config/meta.doctree differ
diff --git a/main/.doctrees/api_doc/entry/base.doctree b/main/.doctrees/api_doc/entry/base.doctree
index c260543b5d..6116f18857 100644
Binary files a/main/.doctrees/api_doc/entry/base.doctree and b/main/.doctrees/api_doc/entry/base.doctree differ
diff --git a/main/.doctrees/api_doc/entry/cli.doctree b/main/.doctrees/api_doc/entry/cli.doctree
index d9ef91d59a..b5cb1a984b 100644
Binary files a/main/.doctrees/api_doc/entry/cli.doctree and b/main/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/main/.doctrees/api_doc/entry/clone.doctree b/main/.doctrees/api_doc/entry/clone.doctree
index 7f5cdb1461..3ef57d962c 100644
Binary files a/main/.doctrees/api_doc/entry/clone.doctree and b/main/.doctrees/api_doc/entry/clone.doctree differ
diff --git a/main/.doctrees/api_doc/entry/dispatch.doctree b/main/.doctrees/api_doc/entry/dispatch.doctree
index dbd45fcf4d..c55eceed11 100644
Binary files a/main/.doctrees/api_doc/entry/dispatch.doctree and b/main/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/main/.doctrees/api_doc/entry/download.doctree b/main/.doctrees/api_doc/entry/download.doctree
index 6579a30608..985038a685 100644
Binary files a/main/.doctrees/api_doc/entry/download.doctree and b/main/.doctrees/api_doc/entry/download.doctree differ
diff --git a/main/.doctrees/api_doc/entry/index.doctree b/main/.doctrees/api_doc/entry/index.doctree
index 839aeb6329..391b1ad9f7 100644
Binary files a/main/.doctrees/api_doc/entry/index.doctree and b/main/.doctrees/api_doc/entry/index.doctree differ
diff --git a/main/.doctrees/api_doc/entry/index_.doctree b/main/.doctrees/api_doc/entry/index_.doctree
index c6bf62a674..63cd71191f 100644
Binary files a/main/.doctrees/api_doc/entry/index_.doctree and b/main/.doctrees/api_doc/entry/index_.doctree differ
diff --git a/main/.doctrees/api_doc/entry/ls.doctree b/main/.doctrees/api_doc/entry/ls.doctree
index 5f1c9b8be3..f9b00a82e5 100644
Binary files a/main/.doctrees/api_doc/entry/ls.doctree and b/main/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/main/.doctrees/api_doc/entry/ls_repo.doctree b/main/.doctrees/api_doc/entry/ls_repo.doctree
index b6cf055371..204f885878 100644
Binary files a/main/.doctrees/api_doc/entry/ls_repo.doctree and b/main/.doctrees/api_doc/entry/ls_repo.doctree differ
diff --git a/main/.doctrees/api_doc/entry/rollback.doctree b/main/.doctrees/api_doc/entry/rollback.doctree
index 835c80dcf7..ba3d106a89 100644
Binary files a/main/.doctrees/api_doc/entry/rollback.doctree and b/main/.doctrees/api_doc/entry/rollback.doctree differ
diff --git a/main/.doctrees/api_doc/entry/upload.doctree b/main/.doctrees/api_doc/entry/upload.doctree
index bfcb4926ea..961dd2bca7 100644
Binary files a/main/.doctrees/api_doc/entry/upload.doctree and b/main/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/main/.doctrees/api_doc/entry/whoami.doctree b/main/.doctrees/api_doc/entry/whoami.doctree
index 7450097250..8019740444 100644
Binary files a/main/.doctrees/api_doc/entry/whoami.doctree and b/main/.doctrees/api_doc/entry/whoami.doctree differ
diff --git a/main/.doctrees/api_doc/index/fetch.doctree b/main/.doctrees/api_doc/index/fetch.doctree
index 356e6ad6f3..e89bba441c 100644
Binary files a/main/.doctrees/api_doc/index/fetch.doctree and b/main/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/main/.doctrees/api_doc/index/index.doctree b/main/.doctrees/api_doc/index/index.doctree
index a30bfb29e8..b8d8016f64 100644
Binary files a/main/.doctrees/api_doc/index/index.doctree and b/main/.doctrees/api_doc/index/index.doctree differ
diff --git a/main/.doctrees/api_doc/index/make.doctree b/main/.doctrees/api_doc/index/make.doctree
index 280850d512..a4da427cdb 100644
Binary files a/main/.doctrees/api_doc/index/make.doctree and b/main/.doctrees/api_doc/index/make.doctree differ
diff --git a/main/.doctrees/api_doc/index/validate.doctree b/main/.doctrees/api_doc/index/validate.doctree
index d1081cfa42..1bc2ffde30 100644
Binary files a/main/.doctrees/api_doc/index/validate.doctree and b/main/.doctrees/api_doc/index/validate.doctree differ
diff --git a/main/.doctrees/api_doc/operate/base.doctree b/main/.doctrees/api_doc/operate/base.doctree
index 59cc48578a..0dadc395af 100644
Binary files a/main/.doctrees/api_doc/operate/base.doctree and b/main/.doctrees/api_doc/operate/base.doctree differ
diff --git a/main/.doctrees/api_doc/operate/download.doctree b/main/.doctrees/api_doc/operate/download.doctree
index d6939d251b..ec66f5e8fc 100644
Binary files a/main/.doctrees/api_doc/operate/download.doctree and b/main/.doctrees/api_doc/operate/download.doctree differ
diff --git a/main/.doctrees/api_doc/operate/index.doctree b/main/.doctrees/api_doc/operate/index.doctree
index 162ac08f61..55310fc9c8 100644
Binary files a/main/.doctrees/api_doc/operate/index.doctree and b/main/.doctrees/api_doc/operate/index.doctree differ
diff --git a/main/.doctrees/api_doc/operate/upload.doctree b/main/.doctrees/api_doc/operate/upload.doctree
index ccb213f7cb..47e991d559 100644
Binary files a/main/.doctrees/api_doc/operate/upload.doctree and b/main/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/main/.doctrees/api_doc/operate/validate.doctree b/main/.doctrees/api_doc/operate/validate.doctree
index 00093307c8..bfc46253a4 100644
Binary files a/main/.doctrees/api_doc/operate/validate.doctree and b/main/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/main/.doctrees/api_doc/repository/base.doctree b/main/.doctrees/api_doc/repository/base.doctree
index c349459752..0572f09dd4 100644
Binary files a/main/.doctrees/api_doc/repository/base.doctree and b/main/.doctrees/api_doc/repository/base.doctree differ
diff --git a/main/.doctrees/api_doc/repository/clone.doctree b/main/.doctrees/api_doc/repository/clone.doctree
index c1166fb4b7..1fa7119199 100644
Binary files a/main/.doctrees/api_doc/repository/clone.doctree and b/main/.doctrees/api_doc/repository/clone.doctree differ
diff --git a/main/.doctrees/api_doc/repository/index.doctree b/main/.doctrees/api_doc/repository/index.doctree
index 11cfb2b5d5..24abc4d78a 100644
Binary files a/main/.doctrees/api_doc/repository/index.doctree and b/main/.doctrees/api_doc/repository/index.doctree differ
diff --git a/main/.doctrees/api_doc/repository/rollback.doctree b/main/.doctrees/api_doc/repository/rollback.doctree
index c67c76fb41..695dcbc581 100644
Binary files a/main/.doctrees/api_doc/repository/rollback.doctree and b/main/.doctrees/api_doc/repository/rollback.doctree differ
diff --git a/main/.doctrees/api_doc/utils/binary.doctree b/main/.doctrees/api_doc/utils/binary.doctree
index 9f578efd3b..4a6d2adc7f 100644
Binary files a/main/.doctrees/api_doc/utils/binary.doctree and b/main/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/main/.doctrees/api_doc/utils/download.doctree b/main/.doctrees/api_doc/utils/download.doctree
index c3e007732f..3f9aef735d 100644
Binary files a/main/.doctrees/api_doc/utils/download.doctree and b/main/.doctrees/api_doc/utils/download.doctree differ
diff --git a/main/.doctrees/api_doc/utils/index.doctree b/main/.doctrees/api_doc/utils/index.doctree
index 0cf053168d..7d34c8bb68 100644
Binary files a/main/.doctrees/api_doc/utils/index.doctree and b/main/.doctrees/api_doc/utils/index.doctree differ
diff --git a/main/.doctrees/api_doc/utils/path.doctree b/main/.doctrees/api_doc/utils/path.doctree
index 61b1d39d85..fba9409654 100644
Binary files a/main/.doctrees/api_doc/utils/path.doctree and b/main/.doctrees/api_doc/utils/path.doctree differ
diff --git a/main/.doctrees/api_doc/utils/tqdm_.doctree b/main/.doctrees/api_doc/utils/tqdm_.doctree
index 6e3729f3b5..23aaa6e7c4 100644
Binary files a/main/.doctrees/api_doc/utils/tqdm_.doctree and b/main/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/main/.doctrees/api_doc/utils/walk.doctree b/main/.doctrees/api_doc/utils/walk.doctree
index 9e2148dfd2..c685478974 100644
Binary files a/main/.doctrees/api_doc/utils/walk.doctree and b/main/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle
index 1e7bce468c..9fae7c69c7 100644
Binary files a/main/.doctrees/environment.pickle and b/main/.doctrees/environment.pickle differ
diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree
index 38e66d8ed0..3606d7ffc7 100644
Binary files a/main/.doctrees/index.doctree and b/main/.doctrees/index.doctree differ
diff --git a/main/.doctrees/information/environment.doctree b/main/.doctrees/information/environment.doctree
index 6695c64de3..7dedb338bc 100644
Binary files a/main/.doctrees/information/environment.doctree and b/main/.doctrees/information/environment.doctree differ
diff --git a/main/.doctrees/information/environment.result.doctree b/main/.doctrees/information/environment.result.doctree
index a503e30539..244f60651c 100644
Binary files a/main/.doctrees/information/environment.result.doctree and b/main/.doctrees/information/environment.result.doctree differ
diff --git a/main/.doctrees/nbsphinx/information/environment.ipynb b/main/.doctrees/nbsphinx/information/environment.ipynb
index 97f48e7f88..25c6c8dedf 100644
--- a/main/.doctrees/nbsphinx/information/environment.ipynb
+++ b/main/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:23:15.462724Z",
-     "iopub.status.busy": "2024-07-23T17:23:15.462505Z",
-     "iopub.status.idle": "2024-07-23T17:23:16.630470Z",
-     "shell.execute_reply": "2024-07-23T17:23:16.629722Z"
+     "iopub.execute_input": "2024-07-23T17:29:18.909314Z",
+     "iopub.status.busy": "2024-07-23T17:29:18.909107Z",
+     "iopub.status.idle": "2024-07-23T17:29:20.080810Z",
+     "shell.execute_reply": "2024-07-23T17:29:20.080019Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2765.9309999999996 MHz\n",
+      "CPU Freq: 2750.777 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/main/.doctrees/nbsphinx/information/environment.result.ipynb b/main/.doctrees/nbsphinx/information/environment.result.ipynb
index 39e864ff6e..8202308c17 100644
--- a/main/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/main/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:54:11.807613Z",
-     "iopub.status.busy": "2024-07-23T16:54:11.807055Z",
-     "iopub.status.idle": "2024-07-23T16:54:12.982423Z",
-     "shell.execute_reply": "2024-07-23T16:54:12.981655Z"
+     "iopub.execute_input": "2024-07-23T16:59:34.145407Z",
+     "iopub.status.busy": "2024-07-23T16:59:34.145196Z",
+     "iopub.status.idle": "2024-07-23T16:59:35.321111Z",
+     "shell.execute_reply": "2024-07-23T16:59:35.320354Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2906.48125 MHz\n",
+      "CPU Freq: 2914.123 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/main/.doctrees/tutorials/installation/index.doctree b/main/.doctrees/tutorials/installation/index.doctree
index df7f3624cd..ee78e3fd12 100644
Binary files a/main/.doctrees/tutorials/installation/index.doctree and b/main/.doctrees/tutorials/installation/index.doctree differ
diff --git a/main/.doctrees/tutorials/quick_start/index.doctree b/main/.doctrees/tutorials/quick_start/index.doctree
index 7cc5ab86d1..94c4ea1770 100644
Binary files a/main/.doctrees/tutorials/quick_start/index.doctree and b/main/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/main/_modules/hfutils/archive/base.html b/main/_modules/hfutils/archive/base.html
index 466559983e..f642a8818f 100644
--- a/main/_modules/hfutils/archive/base.html
+++ b/main/_modules/hfutils/archive/base.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.archive.base &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.archive.base &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/cache/delete.html b/main/_modules/hfutils/cache/delete.html
index 16643d14be..937264747b 100644
--- a/main/_modules/hfutils/cache/delete.html
+++ b/main/_modules/hfutils/cache/delete.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.cache.delete &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.cache.delete &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/entry/base.html b/main/_modules/hfutils/entry/base.html
index 1733f3157e..7ca6188d49 100644
--- a/main/_modules/hfutils/entry/base.html
+++ b/main/_modules/hfutils/entry/base.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.base &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.base &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/entry/dispatch.html b/main/_modules/hfutils/entry/dispatch.html
index 6fcf37c8de..d68586dfd0 100644
--- a/main/_modules/hfutils/entry/dispatch.html
+++ b/main/_modules/hfutils/entry/dispatch.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.dispatch &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.dispatch &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/entry/download.html b/main/_modules/hfutils/entry/download.html
index b1c31df449..4a21f50b40 100644
--- a/main/_modules/hfutils/entry/download.html
+++ b/main/_modules/hfutils/entry/download.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.download &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.download &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/entry/ls.html b/main/_modules/hfutils/entry/ls.html
index a239662034..3fbc09a004 100644
--- a/main/_modules/hfutils/entry/ls.html
+++ b/main/_modules/hfutils/entry/ls.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.ls &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.ls &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/entry/ls_repo.html b/main/_modules/hfutils/entry/ls_repo.html
index 28b34be950..cc911fdeb2 100644
--- a/main/_modules/hfutils/entry/ls_repo.html
+++ b/main/_modules/hfutils/entry/ls_repo.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.ls_repo &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.ls_repo &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/entry/upload.html b/main/_modules/hfutils/entry/upload.html
index 0065606f03..406ebd7555 100644
--- a/main/_modules/hfutils/entry/upload.html
+++ b/main/_modules/hfutils/entry/upload.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.upload &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.upload &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/index/fetch.html b/main/_modules/hfutils/index/fetch.html
index b47716b9c6..353a735a6f 100644
--- a/main/_modules/hfutils/index/fetch.html
+++ b/main/_modules/hfutils/index/fetch.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.index.fetch &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.index.fetch &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/index/make.html b/main/_modules/hfutils/index/make.html
index 59db917aa4..9f2561c9e4 100644
--- a/main/_modules/hfutils/index/make.html
+++ b/main/_modules/hfutils/index/make.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.index.make &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.index.make &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/index/validate.html b/main/_modules/hfutils/index/validate.html
index 2bcc2ba68f..e02b86a69c 100644
--- a/main/_modules/hfutils/index/validate.html
+++ b/main/_modules/hfutils/index/validate.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.index.validate &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.index.validate &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/operate/base.html b/main/_modules/hfutils/operate/base.html
index 5bc4001126..40e2cb45bd 100644
--- a/main/_modules/hfutils/operate/base.html
+++ b/main/_modules/hfutils/operate/base.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.operate.base &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.operate.base &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/operate/download.html b/main/_modules/hfutils/operate/download.html
index a39b3034ae..e13d98c98b 100644
--- a/main/_modules/hfutils/operate/download.html
+++ b/main/_modules/hfutils/operate/download.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.operate.download &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.operate.download &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/operate/upload.html b/main/_modules/hfutils/operate/upload.html
index 9b6b68a628..feb7ff9b8e 100644
--- a/main/_modules/hfutils/operate/upload.html
+++ b/main/_modules/hfutils/operate/upload.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.operate.upload &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.operate.upload &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/operate/validate.html b/main/_modules/hfutils/operate/validate.html
index 32ffab0ce1..ef73a5281c 100644
--- a/main/_modules/hfutils/operate/validate.html
+++ b/main/_modules/hfutils/operate/validate.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.operate.validate &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.operate.validate &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/repository/base.html b/main/_modules/hfutils/repository/base.html
index 95a1cc4da5..a303703c90 100644
--- a/main/_modules/hfutils/repository/base.html
+++ b/main/_modules/hfutils/repository/base.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.repository.base &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.repository.base &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/repository/clone.html b/main/_modules/hfutils/repository/clone.html
index 511599e7ad..1ae8032c88 100644
--- a/main/_modules/hfutils/repository/clone.html
+++ b/main/_modules/hfutils/repository/clone.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.repository.clone &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.repository.clone &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/repository/rollback.html b/main/_modules/hfutils/repository/rollback.html
index bf104d2829..b9f3be1fd0 100644
--- a/main/_modules/hfutils/repository/rollback.html
+++ b/main/_modules/hfutils/repository/rollback.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.repository.rollback &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.repository.rollback &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/utils/binary.html b/main/_modules/hfutils/utils/binary.html
index 990b07f91b..f73d42bc2e 100644
--- a/main/_modules/hfutils/utils/binary.html
+++ b/main/_modules/hfutils/utils/binary.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.utils.binary &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.utils.binary &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/utils/download.html b/main/_modules/hfutils/utils/download.html
index 753ef44017..39d695e9e6 100644
--- a/main/_modules/hfutils/utils/download.html
+++ b/main/_modules/hfutils/utils/download.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.utils.download &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.utils.download &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/utils/path.html b/main/_modules/hfutils/utils/path.html
index 14a2d20f21..8030032d93 100644
--- a/main/_modules/hfutils/utils/path.html
+++ b/main/_modules/hfutils/utils/path.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.utils.path &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.utils.path &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/utils/tqdm_.html b/main/_modules/hfutils/utils/tqdm_.html
index 20969c23e6..0e2257760a 100644
--- a/main/_modules/hfutils/utils/tqdm_.html
+++ b/main/_modules/hfutils/utils/tqdm_.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.utils.tqdm_ &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.utils.tqdm_ &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/hfutils/utils/walk.html b/main/_modules/hfutils/utils/walk.html
index e8a8b145c4..2830125dd7 100644
--- a/main/_modules/hfutils/utils/walk.html
+++ b/main/_modules/hfutils/utils/walk.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.utils.walk &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.utils.walk &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
diff --git a/main/_modules/index.html b/main/_modules/index.html
index a49318ce45..1384d54d8f 100644
--- a/main/_modules/index.html
+++ b/main/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; hfutils 0.3.0 documentation</title>
+  <title>Overview: module code &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../_static/doctools.js?v=888ff710"></script>
         <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
diff --git a/main/_sources/information/environment.result.ipynb.txt b/main/_sources/information/environment.result.ipynb.txt
index 39e864ff6e..8202308c17 100644
--- a/main/_sources/information/environment.result.ipynb.txt
+++ b/main/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:54:11.807613Z",
-     "iopub.status.busy": "2024-07-23T16:54:11.807055Z",
-     "iopub.status.idle": "2024-07-23T16:54:12.982423Z",
-     "shell.execute_reply": "2024-07-23T16:54:12.981655Z"
+     "iopub.execute_input": "2024-07-23T16:59:34.145407Z",
+     "iopub.status.busy": "2024-07-23T16:59:34.145196Z",
+     "iopub.status.idle": "2024-07-23T16:59:35.321111Z",
+     "shell.execute_reply": "2024-07-23T16:59:35.320354Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2906.48125 MHz\n",
+      "CPU Freq: 2914.123 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/main/_static/documentation_options.js b/main/_static/documentation_options.js
index 44e148822a..c2ad124477 100644
--- a/main/_static/documentation_options.js
+++ b/main/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.3.0',
+    VERSION: '0.3.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',
diff --git a/main/api_doc/archive/index.html b/main/api_doc/archive/index.html
index e9c1ea9071..a156d6a072 100644
--- a/main/api_doc/archive/index.html
+++ b/main/api_doc/archive/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.archive &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.archive &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/cache/delete.html b/main/api_doc/cache/delete.html
index e2003bb8da..ad5c9c41b9 100644
--- a/main/api_doc/cache/delete.html
+++ b/main/api_doc/cache/delete.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.cache.delete &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.cache.delete &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/cache/index.html b/main/api_doc/cache/index.html
index 16e651524c..8678413cbb 100644
--- a/main/api_doc/cache/index.html
+++ b/main/api_doc/cache/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.cache &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.cache &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/config/index.html b/main/api_doc/config/index.html
index 5ef9029669..7f3501c398 100644
--- a/main/api_doc/config/index.html
+++ b/main/api_doc/config/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.config &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.config &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/config/meta.html b/main/api_doc/config/meta.html
index dcdd53de53..5a6f473813 100644
--- a/main/api_doc/config/meta.html
+++ b/main/api_doc/config/meta.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.config.meta &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.config.meta &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/entry/base.html b/main/api_doc/entry/base.html
index 836ffffaed..0c7d89acf2 100644
--- a/main/api_doc/entry/base.html
+++ b/main/api_doc/entry/base.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.base &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.base &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/entry/cli.html b/main/api_doc/entry/cli.html
index af57990f8e..250a51a75c 100644
--- a/main/api_doc/entry/cli.html
+++ b/main/api_doc/entry/cli.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.cli &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.cli &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/entry/clone.html b/main/api_doc/entry/clone.html
index e537a82ce1..a60707cadd 100644
--- a/main/api_doc/entry/clone.html
+++ b/main/api_doc/entry/clone.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.clone &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.clone &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/entry/dispatch.html b/main/api_doc/entry/dispatch.html
index 6f18eb739e..1b0d1f0de0 100644
--- a/main/api_doc/entry/dispatch.html
+++ b/main/api_doc/entry/dispatch.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.dispatch &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.dispatch &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/entry/download.html b/main/api_doc/entry/download.html
index 29539af3ad..d24c173df8 100644
--- a/main/api_doc/entry/download.html
+++ b/main/api_doc/entry/download.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.download &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.download &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/entry/index.html b/main/api_doc/entry/index.html
index a22e059e4c..9de4c825bc 100644
--- a/main/api_doc/entry/index.html
+++ b/main/api_doc/entry/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/entry/index_.html b/main/api_doc/entry/index_.html
index f47a505d68..4e06bbbfe5 100644
--- a/main/api_doc/entry/index_.html
+++ b/main/api_doc/entry/index_.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.index &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.index &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/entry/ls.html b/main/api_doc/entry/ls.html
index 957f3cee13..3d9e7714be 100644
--- a/main/api_doc/entry/ls.html
+++ b/main/api_doc/entry/ls.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.ls &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.ls &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/entry/ls_repo.html b/main/api_doc/entry/ls_repo.html
index 769e2317a3..441f4f91e3 100644
--- a/main/api_doc/entry/ls_repo.html
+++ b/main/api_doc/entry/ls_repo.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.ls_repo &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.ls_repo &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/entry/rollback.html b/main/api_doc/entry/rollback.html
index 104d36bdbb..28ad7d35d7 100644
--- a/main/api_doc/entry/rollback.html
+++ b/main/api_doc/entry/rollback.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.rollback &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.rollback &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/entry/upload.html b/main/api_doc/entry/upload.html
index c14900ab8e..d76a4afe5c 100644
--- a/main/api_doc/entry/upload.html
+++ b/main/api_doc/entry/upload.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.upload &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.upload &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/entry/whoami.html b/main/api_doc/entry/whoami.html
index 0adb06f258..f27c27e670 100644
--- a/main/api_doc/entry/whoami.html
+++ b/main/api_doc/entry/whoami.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.entry.whoami &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.entry.whoami &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/index/fetch.html b/main/api_doc/index/fetch.html
index 95ecbe109a..f9a341d021 100644
--- a/main/api_doc/index/fetch.html
+++ b/main/api_doc/index/fetch.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.index.fetch &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.index.fetch &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/index/index.html b/main/api_doc/index/index.html
index 9c0a1473b2..c75762ce37 100644
--- a/main/api_doc/index/index.html
+++ b/main/api_doc/index/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.index &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.index &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/index/make.html b/main/api_doc/index/make.html
index c43d8e3220..82485b97d3 100644
--- a/main/api_doc/index/make.html
+++ b/main/api_doc/index/make.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.index.make &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.index.make &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/index/validate.html b/main/api_doc/index/validate.html
index 370bb51835..a9ad343bae 100644
--- a/main/api_doc/index/validate.html
+++ b/main/api_doc/index/validate.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.index.validate &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.index.validate &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/operate/base.html b/main/api_doc/operate/base.html
index 5b1fab1377..1dc70a8363 100644
--- a/main/api_doc/operate/base.html
+++ b/main/api_doc/operate/base.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.operate.base &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.operate.base &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/operate/download.html b/main/api_doc/operate/download.html
index 924e0f3dc2..0907521494 100644
--- a/main/api_doc/operate/download.html
+++ b/main/api_doc/operate/download.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.operate.download &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.operate.download &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/operate/index.html b/main/api_doc/operate/index.html
index cd07b98811..2d904965f5 100644
--- a/main/api_doc/operate/index.html
+++ b/main/api_doc/operate/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.operate &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.operate &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/operate/upload.html b/main/api_doc/operate/upload.html
index 0c21793c8f..556ed4a650 100644
--- a/main/api_doc/operate/upload.html
+++ b/main/api_doc/operate/upload.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.operate.upload &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.operate.upload &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/operate/validate.html b/main/api_doc/operate/validate.html
index 93d23c75f6..9b381ecbe4 100644
--- a/main/api_doc/operate/validate.html
+++ b/main/api_doc/operate/validate.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.operate.validate &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.operate.validate &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/repository/base.html b/main/api_doc/repository/base.html
index 87843e39c4..c7ac70636f 100644
--- a/main/api_doc/repository/base.html
+++ b/main/api_doc/repository/base.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.repository.base &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.repository.base &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/repository/clone.html b/main/api_doc/repository/clone.html
index 22e79e094e..fa65d852a9 100644
--- a/main/api_doc/repository/clone.html
+++ b/main/api_doc/repository/clone.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.repository.clone &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.repository.clone &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/repository/index.html b/main/api_doc/repository/index.html
index 24038a19d8..4df407d5be 100644
--- a/main/api_doc/repository/index.html
+++ b/main/api_doc/repository/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.repository &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.repository &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/repository/rollback.html b/main/api_doc/repository/rollback.html
index a04f3ff072..91bc9af029 100644
--- a/main/api_doc/repository/rollback.html
+++ b/main/api_doc/repository/rollback.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.repository.rollback &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.repository.rollback &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/utils/binary.html b/main/api_doc/utils/binary.html
index 61350fd632..cdaa5ff199 100644
--- a/main/api_doc/utils/binary.html
+++ b/main/api_doc/utils/binary.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.utils.binary &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.utils.binary &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/utils/download.html b/main/api_doc/utils/download.html
index 625163526c..a3cceff241 100644
--- a/main/api_doc/utils/download.html
+++ b/main/api_doc/utils/download.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.utils.download &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.utils.download &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/utils/index.html b/main/api_doc/utils/index.html
index 9c64af13c7..1f0957fd78 100644
--- a/main/api_doc/utils/index.html
+++ b/main/api_doc/utils/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.utils &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.utils &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/utils/path.html b/main/api_doc/utils/path.html
index 175aecd116..c72b194fd2 100644
--- a/main/api_doc/utils/path.html
+++ b/main/api_doc/utils/path.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.utils.path &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.utils.path &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/utils/tqdm_.html b/main/api_doc/utils/tqdm_.html
index 05570187a5..cd30458390 100644
--- a/main/api_doc/utils/tqdm_.html
+++ b/main/api_doc/utils/tqdm_.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.utils.tqdm &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.utils.tqdm &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/api_doc/utils/walk.html b/main/api_doc/utils/walk.html
index da6d6f2d22..9a0373589e 100644
--- a/main/api_doc/utils/walk.html
+++ b/main/api_doc/utils/walk.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hfutils.utils.walk &mdash; hfutils 0.3.0 documentation</title>
+  <title>hfutils.utils.walk &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -39,7 +39,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/main/genindex.html b/main/genindex.html
index cc2ddfeb48..a9b232e767 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; hfutils 0.3.0 documentation</title>
+  <title>Index &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=645b84c4"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -37,7 +37,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
diff --git a/main/index.html b/main/index.html
index 765b272304..8c1b38a5ff 100644
--- a/main/index.html
+++ b/main/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Welcome to hfutils’s Documentation &mdash; hfutils 0.3.0 documentation</title>
+  <title>Welcome to hfutils’s Documentation &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=645b84c4"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -39,7 +39,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
diff --git a/main/information/environment.html b/main/information/environment.html
index edd8e67603..302b9f1aea 100644
--- a/main/information/environment.html
+++ b/main/information/environment.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Run Environment Information &mdash; hfutils 0.3.0 documentation</title>
+  <title>Run Environment Information &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
@@ -18,7 +18,7 @@
   
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../_static/doctools.js?v=888ff710"></script>
         <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -41,7 +41,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -128,11 +128,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2765.9309999999996 MHz
+CPU Freq: 2750.777 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/main/information/environment.ipynb b/main/information/environment.ipynb
index 97f48e7f88..25c6c8dedf 100644
--- a/main/information/environment.ipynb
+++ b/main/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:23:15.462724Z",
-     "iopub.status.busy": "2024-07-23T17:23:15.462505Z",
-     "iopub.status.idle": "2024-07-23T17:23:16.630470Z",
-     "shell.execute_reply": "2024-07-23T17:23:16.629722Z"
+     "iopub.execute_input": "2024-07-23T17:29:18.909314Z",
+     "iopub.status.busy": "2024-07-23T17:29:18.909107Z",
+     "iopub.status.idle": "2024-07-23T17:29:20.080810Z",
+     "shell.execute_reply": "2024-07-23T17:29:20.080019Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2765.9309999999996 MHz\n",
+      "CPU Freq: 2750.777 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/main/information/environment.result.html b/main/information/environment.result.html
index 1128c696ff..10294961a5 100644
--- a/main/information/environment.result.html
+++ b/main/information/environment.result.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Run Environment Information &mdash; hfutils 0.3.0 documentation</title>
+  <title>Run Environment Information &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
@@ -18,7 +18,7 @@
   
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../_static/doctools.js?v=888ff710"></script>
         <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -43,7 +43,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -130,11 +130,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2906.48125 MHz
+CPU Freq: 2914.123 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/main/information/environment.result.ipynb b/main/information/environment.result.ipynb
index 39e864ff6e..8202308c17 100644
--- a/main/information/environment.result.ipynb
+++ b/main/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:54:11.807613Z",
-     "iopub.status.busy": "2024-07-23T16:54:11.807055Z",
-     "iopub.status.idle": "2024-07-23T16:54:12.982423Z",
-     "shell.execute_reply": "2024-07-23T16:54:12.981655Z"
+     "iopub.execute_input": "2024-07-23T16:59:34.145407Z",
+     "iopub.status.busy": "2024-07-23T16:59:34.145196Z",
+     "iopub.status.idle": "2024-07-23T16:59:35.321111Z",
+     "shell.execute_reply": "2024-07-23T16:59:35.320354Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2906.48125 MHz\n",
+      "CPU Freq: 2914.123 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/main/objects.inv b/main/objects.inv
index 32e8da8c05..8341b7dc71 100644
Binary files a/main/objects.inv and b/main/objects.inv differ
diff --git a/main/py-modindex.html b/main/py-modindex.html
index 74fd28c593..238c6c0fde 100644
--- a/main/py-modindex.html
+++ b/main/py-modindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Module Index &mdash; hfutils 0.3.0 documentation</title>
+  <title>Python Module Index &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
@@ -16,7 +16,7 @@
   
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=645b84c4"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
diff --git a/main/search.html b/main/search.html
index 6da2d3f2ab..b195c82123 100644
--- a/main/search.html
+++ b/main/search.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Search &mdash; hfutils 0.3.0 documentation</title>
+  <title>Search &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=645b84c4"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="#" method="get">
diff --git a/main/searchindex.js b/main/searchindex.js
index 20ea5f7fe5..8ee70ea44c 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/cache/delete", "api_doc/cache/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/clone", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/index_", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/rollback", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/repository/base", "api_doc/repository/clone", "api_doc/repository/index", "api_doc/repository/rollback", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/cache/delete.rst", "api_doc/cache/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/clone.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/index_.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/rollback.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/repository/base.rst", "api_doc/repository/clone.rst", "api_doc/repository/index.rst", "api_doc/repository/rollback.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.cache.delete", "hfutils.cache", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.clone", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.index", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.rollback", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.repository.base", "hfutils.repository.clone", "hfutils.repository", "hfutils.repository.rollback", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2, 4, 28], "pack": 0, "unpack": 0, "manag": [0, 2, 11], "support": 0, "format": 0, "extens": 0, "name": [0, 5], "7z": 0, "bztar": 0, "tar": [0, 11, 17, 19, 20], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 1, 5, 20, 22, 24, 26, 27, 29, 31, 33, 34], "you": [0, 17, 24, 39], "requir": [0, 29, 39], "simpli": [0, 39], "instal": [0, 26, 29, 36], "us": [0, 1, 5, 11, 17, 19, 20, 21, 22, 24, 26, 27, 29, 31, 36, 39], "follow": [0, 12, 29, 39], "code": [0, 5, 9, 15], "pip": [0, 39], "The": [0, 1, 5, 9, 11, 12, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 35, 39], "creation": [0, 24], "file": [0, 5, 9, 11, 12, 15, 17, 19, 20, 21, 22, 24, 25, 27, 30, 31, 35], "i": [0, 1, 9, 13, 15, 17, 19, 20, 22, 24, 25, 26, 30, 33, 36, 37, 38, 39], "we": 0, "util": [0, 26, 36, 39], "rarfil": 0, "librari": [0, 31], "which": [0, 17, 37, 38, 39], "doe": [0, 17], "offer": 0, "function": [0, 5, 11, 17, 19, 20, 24, 26, 27, 29, 30, 31, 34], "creat": [0, 11, 19, 24, 29], "str": [0, 1, 5, 9, 12, 13, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 35], "ext": 0, "list": [0, 5, 12, 17, 21, 22, 24], "fn_pack": 0, "callabl": [0, 5], "fn_unpack": 0, "sourc": [0, 1, 5, 8, 9, 12, 13, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 34, 35], "regist": 0, "custom": [0, 5, 9, 15], "type": [0, 1, 5, 12, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 34, 35], "associ": 0, "paramet": [0, 1, 5, 8, 9, 12, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 34, 35], "A": [0, 21], "take": 0, "directori": [0, 1, 12, 19, 20, 22, 24, 27, 29, 35], "an": [0, 11, 17, 19, 20, 22, 24, 26, 31, 34, 35], "filenam": [0, 31, 33], "input": 0, "extract": [0, 22], "type_nam": 0, "archive_fil": 0, "silent": [0, 19, 22, 24, 27, 29, 31, 34], "bool": [0, 8, 17, 19, 20, 22, 24, 25, 27, 29, 30, 31, 34], "fals": [0, 17, 19, 20, 22, 24, 25, 27, 29, 30, 31, 34], "clear": [0, 24], "specifi": [0, 1, 11, 20, 24, 26, 29, 31], "result": 0, "true": [0, 17, 19, 20, 22, 24, 25, 27, 29, 30, 31, 34], "suppress": [0, 19, 22, 24, 27, 29, 31], "warn": [0, 5], "dure": [0, 29], "process": [0, 11, 29], "remov": [0, 24], "exist": [0, 17, 22], "when": [0, 13, 17, 19, 22, 24], "return": [0, 5, 17, 19, 20, 21, 25, 26, 30, 31, 33, 34, 35], "path": [0, 9, 15, 17, 19, 20, 21, 22, 24, 25, 27, 30, 31, 32, 35, 36], "password": [0, 22], "none": [0, 1, 5, 8, 9, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 31, 33], "content": [0, 34], "option": [0, 1, 5, 8, 9, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 31, 33, 34], "determin": 0, "base": [0, 10, 12, 20, 23, 28, 36], "rais": [0, 13, 17, 20, 26, 27, 29, 33], "valueerror": [0, 26, 33], "ani": [0, 1, 8, 29, 30, 33], "get": [0, 17, 19, 21, 31, 33], "repo_id": [1, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "repo_typ": [1, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "cache_dir": 1, "all": [1, 17, 22, 24, 27, 35], "detach": 1, "revis": [1, 17, 19, 20, 21, 22, 24, 25, 27, 29, 33], "from": [1, 5, 17, 19, 20, 21, 22, 26, 27, 31, 37, 38, 39], "match": [1, 17, 20, 25], "repositori": [1, 9, 11, 15, 17, 19, 20, 21, 22, 24, 25, 33, 36], "id": [1, 20, 26, 27, 29, 33], "where": [1, 20, 31], "store": [1, 11, 20, 27, 29], "default": [1, 19, 20, 22, 25, 26, 27, 29, 33], "huggingfac": [2, 20, 21, 22, 24, 26, 33, 36, 39], "local": [2, 13, 17, 19, 22, 24, 25, 27, 31, 37, 38], "can": [2, 17, 20, 26, 29, 39], "quickli": 2, "make": [2, 18, 20, 24, 36], "disk": 2, "space": [2, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "under": [2, 39], "control": 2, "delet": [2, 36], "delete_detached_cach": 2, "delete_cach": 2, "meta": [3, 17, 36, 39], "__title__": [3, 39], "__version__": [3, 39], "__description__": [3, 39], "__author__": [3, 39], "__author_email__": 3, "inform": [4, 5, 8, 17, 19, 20], "packag": [4, 26], "titl": 4, "thi": [4, 5, 9, 11, 15, 17, 19, 20, 24, 26, 27, 29, 30, 31, 33, 34, 37, 38], "project": 4, "should": [4, 31, 39], "version": [4, 8, 34, 39], "short": 4, "descript": [4, 31], "includ": [4, 5, 11, 17, 19, 26, 27, 29], "setup": 4, "py": 4, "author": 4, "email": 4, "help_option_nam": 5, "h": 5, "help": 5, "dict": [5, 17, 19], "new": 5, "empti": 5, "dictionari": [5, 17], "map": 5, "initi": 5, "object": [5, 12, 17, 21, 22, 24, 31], "": [5, 8, 17, 24], "kei": [5, 17], "valu": [5, 8, 12, 19, 24], "pair": 5, "iter": [5, 35], "via": 5, "d": 5, "k": 5, "v": 5, "kwarg": [5, 8, 31, 34], "keyword": [5, 31, 34], "argument": [5, 17, 31, 34], "For": 5, "exampl": [5, 17], "one": 5, "1": [5, 12, 19, 20, 37, 38], "two": 5, "2": [5, 12], "class": [5, 9, 12, 13, 15, 17, 33], "messag": [5, 9, 13, 15, 19, 24], "except": [5, 9, 13, 15, 17], "displai": [5, 9, 15, 31, 34], "yellow": 5, "color": 5, "error": [5, 9, 15], "exit_cod": [5, 9, 15], "exit": [5, 9, 15], "show": [5, 9, 15], "io": [5, 9, 15, 39], "write": [5, 9, 15], "output": [5, 9, 15, 22, 24, 27, 29, 31, 34, 39], "red": [5, 9, 15], "err": 5, "baseexcept": 5, "print": [5, 8, 37, 38, 39], "traceback": 5, "provid": [5, 11, 26, 27, 29, 31], "built": 5, "msg": 5, "handl": 5, "keyboard": 5, "interrupt": 5, "__init__": 5, "7": 5, "decor": 5, "wrap": 5, "click": [5, 8, 11], "command": [5, 27, 29, 39], "catch": 5, "consist": 5, "group": 6, "hfutilcli": [6, 10], "ctx": 8, "context": 8, "param": 8, "cli": [8, 10, 11, 36], "current": [8, 37, 38, 39], "metadata": 8, "arg": [8, 34], "indic": [9, 15], "remot": [9, 15, 29], "assign": [9, 15, 17, 21, 22, 24], "17": 9, "context_set": 10, "clickwarningexcept": 10, "clickerrorexcept": 10, "print_except": 10, "keyboardinterrupt": 10, "command_wrap": 10, "clone": [10, 28, 29, 36], "dispatch": [10, 36], "print_vers": 10, "download": [10, 17, 20, 23, 27, 32, 36], "noremotepathassignedwithdownload": 10, "index": [10, 36, 39], "l": [10, 36], "listitemtyp": 10, "listitem": 10, "ls_repo": [10, 36], "nolocalauthent": 10, "upload": [10, 11, 19, 23, 36], "noremotepathassignedwithupload": 10, "whoami": [10, 36], "rollback": [10, 28, 36], "modul": [11, 26, 27, 29, 36], "archiv": [11, 12, 17, 19, 20, 22, 24, 36], "hug": [11, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29], "face": [11, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29], "main": [11, 17, 19, 20, 21, 22, 24, 25, 27, 29, 39], "featur": [11, 24], "ad": 11, "subcommand": 11, "applic": 11, "minimum": 11, "interv": [11, 24], "between": 11, "system": [11, 21, 26], "client": [11, 21, 22, 24], "interact": 11, "enum": 12, "repres": [12, 17], "differ": [12, 17, 37, 38], "item": [12, 20], "valid": [12, 18, 23, 36], "ar": [12, 17], "folder": 12, "imag": [12, 17], "3": [12, 37, 38, 39], "4": [12, 37, 38], "model": [12, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "5": [12, 22, 24, 37, 38], "data": [12, 17, 24, 37, 38], "6": [12, 37, 38], "repofold": 12, "repofil": [12, 20], "base_dir": 12, "union": [12, 17], "authent": [13, 20, 27, 29], "token": [13, 17, 19, 20, 21, 22, 24, 25, 27, 29], "33": 15, "standalon": 17, "incomplet": 17, "hash": [17, 19, 20, 21, 22, 24, 29], "archive_in_repo": [17, 19, 20, 24], "liter": [17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "dataset": [17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "idx_repo_id": [17, 19, 20], "idx_file_in_repo": [17, 19, 20], "idx_repo_typ": [17, 19, 20], "idx_revis": [17, 19, 20], "hf_token": [17, 19, 20, 21, 22, 24, 25, 27, 29], "identifi": [17, 19, 21, 22, 24, 25], "repotypetyp": [17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "access": [17, 19], "import": [17, 37, 38, 39], "idx": 17, "deepgh": [17, 39], "danbooru_newest": 17, "0000": 17, "dict_kei": 17, "files": 17, "hash_lf": [17, 20], "7507000": 17, "jpg": 17, "7506000": 17, "7505000": 17, "besid": 17, "also": [17, 31, 39], "explicitli": 17, "nyanko7": 17, "danbooru2023": 17, "danbooru2023_index": 17, "origin": 17, "1000": 17, "png": 17, "10000": 17, "100000": 17, "insid": 17, "file_in_arch": 17, "check": [17, 20, 25, 26, 29, 30, 31, 39], "otherwis": [17, 20, 25, 31], "17506000": 17, "10000000001000": 17, "int": [17, 19, 20, 22, 24, 27, 31], "size": [17, 19, 20, 24, 31, 37, 38], "integ": 17, "filenotfounderror": 17, "435671": 17, "11966": 17, "detail": 17, "offset": 17, "sha256": 17, "265728": 17, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 17, "1024": [17, 30], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 17, "local_fil": [17, 22, 24, 25], "proxi": 17, "user_ag": 17, "header": 17, "endpoint": [17, 26, 27, 29], "save": [17, 19, 22, 31], "http": [17, 26, 39], "request": [17, 31], "user": 17, "agent": 17, "addit": [17, 31, 34], "api": [17, 20, 21, 22, 24, 25], "test_exampl": 17, "destin": 17, "given": [17, 21, 30, 31, 33], "fetch": [18, 27, 36], "archivestandalonefileincompletedownload": 18, "archivestandalonefilehashnotmatch": 18, "hf_tar_get_index": 18, "hf_tar_list_fil": 18, "hf_tar_file_exist": 18, "hf_tar_file_s": 18, "hf_tar_file_info": 18, "hf_tar_file_download": 18, "tar_create_index": 18, "hf_tar_create_index": [18, 20], "tar_get_index_info": 18, "hf_tar_create_from_directori": 18, "hf_tar_item_valid": 18, "hf_tar_valid": 18, "src_tar_fil": 19, "dst_index_fil": 19, "chunk_for_hash": 19, "1048576": 19, "with_hash": 19, "chunk": [19, 24], "20": 19, "mb": 19, "whether": 19, "progress": [19, 22, 24, 31, 34], "bar": [19, 22, 24, 31, 34], "log": 19, "skip_when_sync": 19, "skip": [19, 27], "sync": 19, "readi": [19, 25], "directli": 19, "json": [19, 20], "local_directori": [19, 22, 24], "file_item": 20, "hash_": 20, "expect": [20, 31], "sha": 20, "256": 20, "lf": [20, 26, 27, 29], "entrynotfounderror": 20, "entri": [20, 36], "found": 20, "isadirectoryerror": 20, "mean": [20, 39], "expir": 20, "need": 20, "re": 20, "gener": [20, 26], "so": [20, 24], "togeth": 20, "gracefulli": 20, "refresh": 20, "hfapi": 21, "variabl": [21, 22, 24], "hffilesystem": 21, "subdir": 21, "ignore_pattern": [21, 22, 24], "subdirectori": 21, "e": [21, 22, 24], "g": [21, 22, 24], "branch": [21, 22, 24, 29], "tag": [21, 22, 24, 29], "commit": [21, 22, 24, 27, 29], "pattern": [21, 22, 24], "ignor": [21, 22, 24], "file_in_repo": [22, 24, 25], "resume_download": 22, "within": [22, 24], "resum": 22, "dir_in_repo": 22, "max_work": 22, "8": [22, 37, 38, 39], "max_retri": 22, "max": 22, "worker": 22, "retri": 22, "time": [22, 24], "get_hf_client": 23, "get_hf_f": 23, "list_files_in_repositori": 23, "download_file_to_fil": 23, "download_archive_as_directori": 23, "download_directory_as_directori": 23, "upload_file_to_fil": 23, "upload_directory_as_arch": 23, "upload_directory_as_directori": 23, "is_local_file_readi": 23, "path_in_repo": 24, "time_suffix": 24, "operation_chunk_s": 24, "upload_timespan": 24, "float": 24, "0": [24, 27, 37, 38, 39], "its": 24, "append": 24, "timestamp": 24, "present": 24, "seper": 24, "multipl": 24, "set": 24, "minim": 24, "enabl": 24, "some": [24, 28, 37, 38], "fail": [24, 27, 29], "roll": 24, "back": [24, 29], "startup": 24, "hf_hub_rollback": [24, 28], "But": 24, "cannot": 24, "guarante": 24, "atom": 24, "your": [24, 37, 38, 39], "thread": 24, "safe": 24, "rate": 24, "limit": 24, "approxim": 24, "120": 24, "hour": 24, "realli": 24, "have": 24, "larg": 24, "number": [24, 27], "pleas": [24, 37, 38], "less": 24, "than": 24, "30": 24, "sure": 24, "compar": 25, "hub": [25, 26, 27, 29], "work": 26, "git": [26, 27, 28, 29, 39], "It": [26, 27, 29, 31, 39], "url": [26, 31], "git_info": 26, "hbutil": [26, 37, 38], "constant": 26, "huggingface_hub": 26, "full": 26, "unknown": 26, "usag": [26, 27, 29], "usernam": [26, 27, 29], "repo": [26, 27, 29], "co": 26, "other": 27, "dst_dir": 27, "no_lf": 27, "max_depth": 27, "specif": [27, 29], "attempt": [27, 29], "credenti": [27, 29], "maximum": 27, "subprocess": [27, 29], "calledprocesserror": [27, 29], "dir": 27, "v1": 27, "oper": [28, 29, 36], "hf_hub_repo_url": 28, "hf_hub_clon": 28, "reset": 29, "forc": 29, "push": 29, "chang": 29, "rollback_to": 29, "refer": 29, "abc123": 29, "perform": [29, 31, 37, 38], "step": 29, "without": 29, "temporari": 29, "hard": 29, "overwrit": 29, "histori": 29, "cancel": 29, "caution": 29, "read": 30, "first": 30, "byte": [30, 31], "contain": 30, "non": 30, "text": 30, "charact": 30, "expected_s": 31, "desc": 31, "session": 31, "tqdm": [31, 32, 36], "ensur": 31, "ha": [31, 37, 38], "pass": [31, 34], "binari": [32, 36], "is_binary_fil": 32, "download_fil": 32, "hf_normpath": 32, "hf_fs_path": 32, "parse_hf_fs_path": 32, "hffilesystempath": 32, "walk": [32, 36], "walk_fil": 32, "normal": 33, "filesystem": 33, "pars": 33, "invalid": 33, "tqdm_": 34, "enhanc": 34, "silenc": 34, "modifi": 34, "behavior": 34, "allow": 34, "posit": 34, "std": 34, "recurs": 35, "through": [35, 39], "yield": 35, "rel": 35, "root": 35, "start": [35, 36], "quick": 36, "run": 36, "environ": 36, "register_archive_typ": 36, "archive_pack": 36, "archive_unpack": 36, "get_archive_typ": 36, "get_archive_extnam": 36, "cach": 36, "config": [36, 39], "here": [37, 38], "o": [37, 38], "platform": [37, 38], "shutil": [37, 38], "cpuinfo": [37, 38], "psutil": [37, 38], "scale": [37, 38], "size_to_bytes_str": [37, 38], "python": [37, 38, 39], "python_implement": [37, 38], "python_vers": [37, 38], "cpu": [37, 38], "brand": [37, 38], "get_cpu_info": [37, 38], "brand_raw": [37, 38], "count": [37, 38], "cpu_count": [37, 38], "freq": [37, 38], "cpu_freq": [37, 38], "mhz": [37, 38], "memori": [37, 38], "virtual_memori": [37, 38], "total": [37, 38], "precis": [37, 38], "cuda": [37, 38], "ye": [37, 38], "nvidia": [37, 38], "smi": [37, 38], "els": [37, 38], "No": [37, 38], "linux": [37, 38], "1023": [37, 38], "azur": [37, 38], "x86_64": [37, 38], "glibc2": [37, 38], "34": [37, 38], "cpython": [37, 38], "18": [37, 38], "amd": [37, 38], "epyc": [37, 38], "7763": [37, 38], "64": [37, 38], "core": [37, 38], "processor": [37, 38], "2765": 37, "9309999999996": 37, "15": [37, 38], "606": [37, 38], "gib": [37, 38], "note": [37, 38], "deploi": [37, 38], "document": [37, 38, 39], "automat": [37, 38], "execut": [37, 38], "github": [37, 38, 39], "action": [37, 38], "therefor": [37, 38], "mai": [37, 38], "2906": 38, "48125": 38, "hfutil": 39, "host": 39, "pypi": 39, "newest": 39, "u": 39, "com": 39, "script": 39, "__name__": 39, "__main__": 39, "develop": 39, "maintain": 39, "like": 39, "below": 39, "success": 39, "narugo1992": 39, "still": 39, "out": 39, "stabl": 39, "html": 39, "faq": 40}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [2, 0, 0, "-", "cache"], [3, 0, 0, "-", "config"], [10, 0, 0, "-", "entry"], [18, 0, 0, "-", "index"], [23, 0, 0, "-", "operate"], [28, 0, 0, "-", "repository"], [32, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.cache": [[1, 0, 0, "-", "delete"]], "hfutils.cache.delete": [[1, 1, 1, "", "delete_cache"], [1, 1, 1, "", "delete_detached_cache"]], "hfutils.config": [[4, 0, 0, "-", "meta"]], "hfutils.config.meta": [[4, 2, 1, "", "__AUTHOR_EMAIL__"], [4, 2, 1, "", "__AUTHOR__"], [4, 2, 1, "", "__DESCRIPTION__"], [4, 2, 1, "", "__TITLE__"], [4, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[5, 0, 0, "-", "base"], [6, 0, 0, "-", "cli"], [7, 0, 0, "-", "clone"], [8, 0, 0, "-", "dispatch"], [9, 0, 0, "-", "download"], [11, 0, 0, "-", "index"], [12, 0, 0, "-", "ls"], [13, 0, 0, "-", "ls_repo"], [14, 0, 0, "-", "rollback"], [15, 0, 0, "-", "upload"], [16, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[5, 2, 1, "", "CONTEXT_SETTINGS"], [5, 3, 1, "", "ClickErrorException"], [5, 3, 1, "", "ClickWarningException"], [5, 3, 1, "", "KeyboardInterrupted"], [5, 1, 1, "", "command_wrap"], [5, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[5, 5, 1, "", "__init__"], [5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.cli": [[6, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[8, 1, 1, "", "hfutilcli"], [8, 1, 1, "", "print_version"]], "hfutils.entry.download": [[9, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.entry.ls": [[12, 3, 1, "", "ListItem"], [12, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[12, 4, 1, "", "ARCHIVE"], [12, 4, 1, "", "DATA"], [12, 4, 1, "", "FILE"], [12, 4, 1, "", "FOLDER"], [12, 4, 1, "", "IMAGE"], [12, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[13, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[15, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[15, 4, 1, "", "exit_code"], [15, 5, 1, "", "show"]], "hfutils.index": [[17, 0, 0, "-", "fetch"], [19, 0, 0, "-", "make"], [20, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[17, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [17, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [17, 1, 1, "", "hf_tar_file_download"], [17, 1, 1, "", "hf_tar_file_exists"], [17, 1, 1, "", "hf_tar_file_info"], [17, 1, 1, "", "hf_tar_file_size"], [17, 1, 1, "", "hf_tar_get_index"], [17, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[19, 1, 1, "", "hf_tar_create_from_directory"], [19, 1, 1, "", "hf_tar_create_index"], [19, 1, 1, "", "tar_create_index"], [19, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[20, 1, 1, "", "hf_tar_item_validate"], [20, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[21, 0, 0, "-", "base"], [22, 0, 0, "-", "download"], [24, 0, 0, "-", "upload"], [25, 0, 0, "-", "validate"]], "hfutils.operate.base": [[21, 1, 1, "", "get_hf_client"], [21, 1, 1, "", "get_hf_fs"], [21, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[22, 1, 1, "", "download_archive_as_directory"], [22, 1, 1, "", "download_directory_as_directory"], [22, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[24, 1, 1, "", "upload_directory_as_archive"], [24, 1, 1, "", "upload_directory_as_directory"], [24, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[25, 1, 1, "", "is_local_file_ready"]], "hfutils.repository": [[26, 0, 0, "-", "base"], [27, 0, 0, "-", "clone"], [29, 0, 0, "-", "rollback"]], "hfutils.repository.base": [[26, 1, 1, "", "hf_hub_repo_url"]], "hfutils.repository.clone": [[27, 1, 1, "", "hf_hub_clone"]], "hfutils.repository.rollback": [[29, 1, 1, "", "hf_hub_rollback"]], "hfutils.utils": [[30, 0, 0, "-", "binary"], [31, 0, 0, "-", "download"], [33, 0, 0, "-", "path"], [34, 0, 0, "-", "tqdm_"], [35, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[30, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[31, 1, 1, "", "download_file"]], "hfutils.utils.path": [[33, 3, 1, "", "HfFileSystemPath"], [33, 1, 1, "", "hf_fs_path"], [33, 1, 1, "", "hf_normpath"], [33, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[34, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[35, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "cach": [1, 2], "delet": 1, "delete_detached_cach": 1, "delete_cach": 1, "config": [3, 4], "meta": 4, "__title__": 4, "__version__": 4, "__description__": 4, "__author__": 4, "__author_email__": 4, "entri": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "base": [5, 21, 26], "context_set": 5, "clickwarningexcept": 5, "clickerrorexcept": 5, "print_except": 5, "keyboardinterrupt": 5, "command_wrap": 5, "cli": 6, "clone": [7, 27], "dispatch": 8, "print_vers": 8, "hfutilcli": 8, "download": [9, 22, 31], "noremotepathassignedwithdownload": 9, "index": [11, 17, 18, 19, 20], "l": 12, "listitemtyp": 12, "listitem": 12, "ls_repo": 13, "nolocalauthent": 13, "rollback": [14, 29], "upload": [15, 24], "noremotepathassignedwithupload": 15, "whoami": 16, "fetch": 17, "archivestandalonefileincompletedownload": 17, "archivestandalonefilehashnotmatch": 17, "hf_tar_get_index": 17, "hf_tar_list_fil": 17, "hf_tar_file_exist": 17, "hf_tar_file_s": 17, "hf_tar_file_info": 17, "hf_tar_file_download": 17, "make": 19, "tar_create_index": 19, "hf_tar_create_index": 19, "tar_get_index_info": 19, "hf_tar_create_from_directori": 19, "valid": [20, 25], "hf_tar_item_valid": 20, "hf_tar_valid": 20, "oper": [21, 22, 23, 24, 25], "get_hf_client": 21, "get_hf_f": 21, "list_files_in_repositori": 21, "download_file_to_fil": 22, "download_archive_as_directori": 22, "download_directory_as_directori": 22, "upload_file_to_fil": 24, "upload_directory_as_arch": 24, "upload_directory_as_directori": 24, "is_local_file_readi": 25, "repositori": [26, 27, 28, 29], "hf_hub_repo_url": 26, "hf_hub_clon": 27, "hf_hub_rollback": 29, "util": [30, 31, 32, 33, 34, 35], "binari": 30, "is_binary_fil": 30, "download_fil": 31, "path": 33, "hf_normpath": 33, "hf_fs_path": 33, "parse_hf_fs_path": 33, "hffilesystempath": 33, "tqdm": 34, "walk": 35, "walk_fil": 35, "welcom": 36, "": 36, "document": 36, "overview": 36, "tutori": 36, "inform": [36, 37, 38], "api": 36, "run": [37, 38], "environ": [37, 38], "instal": 39, "quick": 40, "start": 40}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "delete_detached_cache": [[1, "delete-detached-cache"]], "delete_cache": [[1, "delete-cache"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "__TITLE__": [[4, "title"]], "__VERSION__": [[4, "version"]], "__DESCRIPTION__": [[4, "description"]], "__AUTHOR__": [[4, "author"]], "__AUTHOR_EMAIL__": [[4, "author-email"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[5, "context-settings"]], "ClickWarningException": [[5, "clickwarningexception"]], "ClickErrorException": [[5, "clickerrorexception"]], "print_exception": [[5, "print-exception"]], "KeyboardInterrupted": [[5, "keyboardinterrupted"]], "command_wrap": [[5, "command-wrap"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "cli": [[6, "cli"]], "hfutils.entry.clone": [[7, "module-hfutils.entry.clone"]], "hfutils.entry.dispatch": [[8, "module-hfutils.entry.dispatch"]], "print_version": [[8, "print-version"]], "hfutilcli": [[8, "hfutilcli"]], "hfutils.entry.download": [[9, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[9, "noremotepathassignedwithdownload"]], "hfutils.entry": [[10, "module-hfutils.entry"]], "hfutils.entry.index": [[11, "module-hfutils.entry.index"]], "hfutils.entry.ls": [[12, "module-hfutils.entry.ls"]], "ListItemType": [[12, "listitemtype"]], "ListItem": [[12, "listitem"]], "hfutils.entry.ls_repo": [[13, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[13, "nolocalauthentication"]], "hfutils.entry.rollback": [[14, "module-hfutils.entry.rollback"]], "hfutils.entry.upload": [[15, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[15, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[16, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[17, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[17, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[17, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[17, "hf-tar-get-index"]], "hf_tar_list_files": [[17, "hf-tar-list-files"]], "hf_tar_file_exists": [[17, "hf-tar-file-exists"]], "hf_tar_file_size": [[17, "hf-tar-file-size"]], "hf_tar_file_info": [[17, "hf-tar-file-info"]], "hf_tar_file_download": [[17, "hf-tar-file-download"]], "hfutils.index": [[18, "module-hfutils.index"]], "hfutils.index.make": [[19, "module-hfutils.index.make"]], "tar_create_index": [[19, "tar-create-index"]], "hf_tar_create_index": [[19, "hf-tar-create-index"]], "tar_get_index_info": [[19, "tar-get-index-info"]], "hf_tar_create_from_directory": [[19, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[20, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[20, "hf-tar-item-validate"]], "hf_tar_validate": [[20, "hf-tar-validate"]], "hfutils.operate.base": [[21, "module-hfutils.operate.base"]], "get_hf_client": [[21, "get-hf-client"]], "get_hf_fs": [[21, "get-hf-fs"]], "list_files_in_repository": [[21, "list-files-in-repository"]], "hfutils.operate.download": [[22, "module-hfutils.operate.download"]], "download_file_to_file": [[22, "download-file-to-file"]], "download_archive_as_directory": [[22, "download-archive-as-directory"]], "download_directory_as_directory": [[22, "download-directory-as-directory"]], "hfutils.operate": [[23, "module-hfutils.operate"]], "hfutils.operate.upload": [[24, "module-hfutils.operate.upload"]], "upload_file_to_file": [[24, "upload-file-to-file"]], "upload_directory_as_archive": [[24, "upload-directory-as-archive"]], "upload_directory_as_directory": [[24, "upload-directory-as-directory"]], "hfutils.operate.validate": [[25, "module-hfutils.operate.validate"]], "is_local_file_ready": [[25, "is-local-file-ready"]], "hfutils.repository.base": [[26, "module-hfutils.repository.base"]], "hf_hub_repo_url": [[26, "hf-hub-repo-url"]], "hfutils.repository.clone": [[27, "module-hfutils.repository.clone"]], "hf_hub_clone": [[27, "hf-hub-clone"]], "hfutils.repository": [[28, "module-hfutils.repository"]], "hfutils.repository.rollback": [[29, "module-hfutils.repository.rollback"]], "hf_hub_rollback": [[29, "hf-hub-rollback"]], "hfutils.utils.binary": [[30, "module-hfutils.utils.binary"]], "is_binary_file": [[30, "is-binary-file"]], "hfutils.utils.download": [[31, "module-hfutils.utils.download"]], "download_file": [[31, "download-file"]], "hfutils.utils": [[32, "module-hfutils.utils"]], "hfutils.utils.path": [[33, "module-hfutils.utils.path"]], "hf_normpath": [[33, "hf-normpath"]], "hf_fs_path": [[33, "hf-fs-path"]], "parse_hf_fs_path": [[33, "parse-hf-fs-path"]], "HfFileSystemPath": [[33, "hffilesystempath"]], "hfutils.utils.tqdm": [[34, "module-hfutils.utils.tqdm_"]], "tqdm": [[34, "tqdm"]], "hfutils.utils.walk": [[35, "module-hfutils.utils.walk"]], "walk_files": [[35, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[36, "welcome-to-hfutils-s-documentation"]], "Overview": [[36, "overview"]], "Tutorials": [[36, null]], "Information": [[36, null]], "API Documentation": [[36, null]], "Run Environment Information": [[37, "Run-Environment-Information"], [38, "Run-Environment-Information"]], "Installation": [[39, "installation"]], "Quick Start": [[40, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.cache.delete"], [2, "module-hfutils.cache"], [3, "module-hfutils.config"], [4, "module-hfutils.config.meta"], [5, "module-hfutils.entry.base"], [6, "module-hfutils.entry.cli"], [7, "module-hfutils.entry.clone"], [8, "module-hfutils.entry.dispatch"], [9, "module-hfutils.entry.download"], [10, "module-hfutils.entry"], [11, "module-hfutils.entry.index"], [12, "module-hfutils.entry.ls"], [13, "module-hfutils.entry.ls_repo"], [14, "module-hfutils.entry.rollback"], [15, "module-hfutils.entry.upload"], [16, "module-hfutils.entry.whoami"], [17, "module-hfutils.index.fetch"], [18, "module-hfutils.index"], [19, "module-hfutils.index.make"], [20, "module-hfutils.index.validate"], [21, "module-hfutils.operate.base"], [22, "module-hfutils.operate.download"], [23, "module-hfutils.operate"], [24, "module-hfutils.operate.upload"], [25, "module-hfutils.operate.validate"], [26, "module-hfutils.repository.base"], [27, "module-hfutils.repository.clone"], [28, "module-hfutils.repository"], [29, "module-hfutils.repository.rollback"], [30, "module-hfutils.utils.binary"], [31, "module-hfutils.utils.download"], [32, "module-hfutils.utils"], [33, "module-hfutils.utils.path"], [34, "module-hfutils.utils.tqdm_"], [35, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "delete_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_cache"]], "delete_detached_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_detached_cache"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[5, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[5, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[5, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[5, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[5, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[5, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[5, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[6, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "hfutils.entry.clone": [[7, "module-hfutils.entry.clone"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[8, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[8, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[8, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[9, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[9, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[9, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[9, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[10, "module-hfutils.entry"]], "hfutils.entry.index": [[11, "module-hfutils.entry.index"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[12, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[12, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[13, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[13, "module-hfutils.entry.ls_repo"]], "hfutils.entry.rollback": [[14, "module-hfutils.entry.rollback"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[15, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[15, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[15, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[15, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[16, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[17, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[17, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[17, "module-hfutils.index.fetch"]], "hfutils.index": [[18, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[19, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[19, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[19, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[19, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[19, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[20, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[20, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[20, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[21, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[21, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[21, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[21, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[22, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[22, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[22, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[22, "module-hfutils.operate.download"]], "hfutils.operate": [[23, "module-hfutils.operate"]], "hfutils.operate.upload": [[24, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[24, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[24, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[24, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[25, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[25, "hfutils.operate.validate.is_local_file_ready"]], "hf_hub_repo_url() (in module hfutils.repository.base)": [[26, "hfutils.repository.base.hf_hub_repo_url"]], "hfutils.repository.base": [[26, "module-hfutils.repository.base"]], "hf_hub_clone() (in module hfutils.repository.clone)": [[27, "hfutils.repository.clone.hf_hub_clone"]], "hfutils.repository.clone": [[27, "module-hfutils.repository.clone"]], "hfutils.repository": [[28, "module-hfutils.repository"]], "hf_hub_rollback() (in module hfutils.repository.rollback)": [[29, "hfutils.repository.rollback.hf_hub_rollback"]], "hfutils.repository.rollback": [[29, "module-hfutils.repository.rollback"]], "hfutils.utils.binary": [[30, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[30, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[31, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[31, "module-hfutils.utils.download"]], "hfutils.utils": [[32, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[33, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[33, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[33, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[33, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[33, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[34, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[34, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[35, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[35, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/cache/delete", "api_doc/cache/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/clone", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/index_", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/rollback", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/repository/base", "api_doc/repository/clone", "api_doc/repository/index", "api_doc/repository/rollback", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/cache/delete.rst", "api_doc/cache/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/clone.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/index_.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/rollback.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/repository/base.rst", "api_doc/repository/clone.rst", "api_doc/repository/index.rst", "api_doc/repository/rollback.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.cache.delete", "hfutils.cache", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.clone", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.index", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.rollback", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.repository.base", "hfutils.repository.clone", "hfutils.repository", "hfutils.repository.rollback", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2, 4, 28], "pack": 0, "unpack": 0, "manag": [0, 2, 11], "support": 0, "format": 0, "extens": 0, "name": [0, 5], "7z": 0, "bztar": 0, "tar": [0, 11, 17, 19, 20], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 1, 5, 20, 22, 24, 26, 27, 29, 31, 33, 34], "you": [0, 17, 24, 39], "requir": [0, 29, 39], "simpli": [0, 39], "instal": [0, 26, 29, 36], "us": [0, 1, 5, 11, 17, 19, 20, 21, 22, 24, 26, 27, 29, 31, 36, 39], "follow": [0, 12, 29, 39], "code": [0, 5, 9, 15], "pip": [0, 39], "The": [0, 1, 5, 9, 11, 12, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 35, 39], "creation": [0, 24], "file": [0, 5, 9, 11, 12, 15, 17, 19, 20, 21, 22, 24, 25, 27, 30, 31, 35], "i": [0, 1, 9, 13, 15, 17, 19, 20, 22, 24, 25, 26, 30, 33, 36, 37, 38, 39], "we": 0, "util": [0, 26, 36, 39], "rarfil": 0, "librari": [0, 31], "which": [0, 17, 37, 38, 39], "doe": [0, 17], "offer": 0, "function": [0, 5, 11, 17, 19, 20, 24, 26, 27, 29, 30, 31, 34], "creat": [0, 11, 19, 24, 29], "str": [0, 1, 5, 9, 12, 13, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 35], "ext": 0, "list": [0, 5, 12, 17, 21, 22, 24], "fn_pack": 0, "callabl": [0, 5], "fn_unpack": 0, "sourc": [0, 1, 5, 8, 9, 12, 13, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 34, 35], "regist": 0, "custom": [0, 5, 9, 15], "type": [0, 1, 5, 12, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 34, 35], "associ": 0, "paramet": [0, 1, 5, 8, 9, 12, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 34, 35], "A": [0, 21], "take": 0, "directori": [0, 1, 12, 19, 20, 22, 24, 27, 29, 35], "an": [0, 11, 17, 19, 20, 22, 24, 26, 31, 34, 35], "filenam": [0, 31, 33], "input": 0, "extract": [0, 22], "type_nam": 0, "archive_fil": 0, "silent": [0, 19, 22, 24, 27, 29, 31, 34], "bool": [0, 8, 17, 19, 20, 22, 24, 25, 27, 29, 30, 31, 34], "fals": [0, 17, 19, 20, 22, 24, 25, 27, 29, 30, 31, 34], "clear": [0, 24], "specifi": [0, 1, 11, 20, 24, 26, 29, 31], "result": 0, "true": [0, 17, 19, 20, 22, 24, 25, 27, 29, 30, 31, 34], "suppress": [0, 19, 22, 24, 27, 29, 31], "warn": [0, 5], "dure": [0, 29], "process": [0, 11, 29], "remov": [0, 24], "exist": [0, 17, 22], "when": [0, 13, 17, 19, 22, 24], "return": [0, 5, 17, 19, 20, 21, 25, 26, 30, 31, 33, 34, 35], "path": [0, 9, 15, 17, 19, 20, 21, 22, 24, 25, 27, 30, 31, 32, 35, 36], "password": [0, 22], "none": [0, 1, 5, 8, 9, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 31, 33], "content": [0, 34], "option": [0, 1, 5, 8, 9, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 31, 33, 34], "determin": 0, "base": [0, 10, 12, 20, 23, 28, 36], "rais": [0, 13, 17, 20, 26, 27, 29, 33], "valueerror": [0, 26, 33], "ani": [0, 1, 8, 29, 30, 33], "get": [0, 17, 19, 21, 31, 33], "repo_id": [1, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "repo_typ": [1, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "cache_dir": 1, "all": [1, 17, 22, 24, 27, 35], "detach": 1, "revis": [1, 17, 19, 20, 21, 22, 24, 25, 27, 29, 33], "from": [1, 5, 17, 19, 20, 21, 22, 26, 27, 31, 37, 38, 39], "match": [1, 17, 20, 25], "repositori": [1, 9, 11, 15, 17, 19, 20, 21, 22, 24, 25, 33, 36], "id": [1, 20, 26, 27, 29, 33], "where": [1, 20, 31], "store": [1, 11, 20, 27, 29], "default": [1, 19, 20, 22, 25, 26, 27, 29, 33], "huggingfac": [2, 20, 21, 22, 24, 26, 33, 36, 39], "local": [2, 13, 17, 19, 22, 24, 25, 27, 31, 37, 38], "can": [2, 17, 20, 26, 29, 39], "quickli": 2, "make": [2, 18, 20, 24, 36], "disk": 2, "space": [2, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "under": [2, 39], "control": 2, "delet": [2, 36], "delete_detached_cach": 2, "delete_cach": 2, "meta": [3, 17, 36, 39], "__title__": [3, 39], "__version__": [3, 39], "__description__": [3, 39], "__author__": [3, 39], "__author_email__": 3, "inform": [4, 5, 8, 17, 19, 20], "packag": [4, 26], "titl": 4, "thi": [4, 5, 9, 11, 15, 17, 19, 20, 24, 26, 27, 29, 30, 31, 33, 34, 37, 38], "project": 4, "should": [4, 31, 39], "version": [4, 8, 34, 39], "short": 4, "descript": [4, 31], "includ": [4, 5, 11, 17, 19, 26, 27, 29], "setup": 4, "py": 4, "author": 4, "email": 4, "help_option_nam": 5, "h": 5, "help": 5, "dict": [5, 17, 19], "new": 5, "empti": 5, "dictionari": [5, 17], "map": 5, "initi": 5, "object": [5, 12, 17, 21, 22, 24, 31], "": [5, 8, 17, 24], "kei": [5, 17], "valu": [5, 8, 12, 19, 24], "pair": 5, "iter": [5, 35], "via": 5, "d": 5, "k": 5, "v": 5, "kwarg": [5, 8, 31, 34], "keyword": [5, 31, 34], "argument": [5, 17, 31, 34], "For": 5, "exampl": [5, 17], "one": 5, "1": [5, 12, 19, 20, 37, 38, 39], "two": 5, "2": [5, 12], "class": [5, 9, 12, 13, 15, 17, 33], "messag": [5, 9, 13, 15, 19, 24], "except": [5, 9, 13, 15, 17], "displai": [5, 9, 15, 31, 34], "yellow": 5, "color": 5, "error": [5, 9, 15], "exit_cod": [5, 9, 15], "exit": [5, 9, 15], "show": [5, 9, 15], "io": [5, 9, 15, 39], "write": [5, 9, 15], "output": [5, 9, 15, 22, 24, 27, 29, 31, 34, 39], "red": [5, 9, 15], "err": 5, "baseexcept": 5, "print": [5, 8, 37, 38, 39], "traceback": 5, "provid": [5, 11, 26, 27, 29, 31], "built": 5, "msg": 5, "handl": 5, "keyboard": 5, "interrupt": 5, "__init__": 5, "7": 5, "decor": 5, "wrap": 5, "click": [5, 8, 11], "command": [5, 27, 29, 39], "catch": 5, "consist": 5, "group": 6, "hfutilcli": [6, 10], "ctx": 8, "context": 8, "param": 8, "cli": [8, 10, 11, 36], "current": [8, 37, 38, 39], "metadata": 8, "arg": [8, 34], "indic": [9, 15], "remot": [9, 15, 29], "assign": [9, 15, 17, 21, 22, 24], "17": 9, "context_set": 10, "clickwarningexcept": 10, "clickerrorexcept": 10, "print_except": 10, "keyboardinterrupt": 10, "command_wrap": 10, "clone": [10, 28, 29, 36], "dispatch": [10, 36], "print_vers": 10, "download": [10, 17, 20, 23, 27, 32, 36], "noremotepathassignedwithdownload": 10, "index": [10, 36, 39], "l": [10, 36], "listitemtyp": 10, "listitem": 10, "ls_repo": [10, 36], "nolocalauthent": 10, "upload": [10, 11, 19, 23, 36], "noremotepathassignedwithupload": 10, "whoami": [10, 36], "rollback": [10, 28, 36], "modul": [11, 26, 27, 29, 36], "archiv": [11, 12, 17, 19, 20, 22, 24, 36], "hug": [11, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29], "face": [11, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29], "main": [11, 17, 19, 20, 21, 22, 24, 25, 27, 29, 39], "featur": [11, 24], "ad": 11, "subcommand": 11, "applic": 11, "minimum": 11, "interv": [11, 24], "between": 11, "system": [11, 21, 26], "client": [11, 21, 22, 24], "interact": 11, "enum": 12, "repres": [12, 17], "differ": [12, 17, 37, 38], "item": [12, 20], "valid": [12, 18, 23, 36], "ar": [12, 17], "folder": 12, "imag": [12, 17], "3": [12, 37, 38, 39], "4": [12, 37, 38], "model": [12, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "5": [12, 22, 24, 37, 38], "data": [12, 17, 24, 37, 38], "6": [12, 37, 38], "repofold": 12, "repofil": [12, 20], "base_dir": 12, "union": [12, 17], "authent": [13, 20, 27, 29], "token": [13, 17, 19, 20, 21, 22, 24, 25, 27, 29], "33": 15, "standalon": 17, "incomplet": 17, "hash": [17, 19, 20, 21, 22, 24, 29], "archive_in_repo": [17, 19, 20, 24], "liter": [17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "dataset": [17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "idx_repo_id": [17, 19, 20], "idx_file_in_repo": [17, 19, 20], "idx_repo_typ": [17, 19, 20], "idx_revis": [17, 19, 20], "hf_token": [17, 19, 20, 21, 22, 24, 25, 27, 29], "identifi": [17, 19, 21, 22, 24, 25], "repotypetyp": [17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "access": [17, 19], "import": [17, 37, 38, 39], "idx": 17, "deepgh": [17, 39], "danbooru_newest": 17, "0000": 17, "dict_kei": 17, "files": 17, "hash_lf": [17, 20], "7507000": 17, "jpg": 17, "7506000": 17, "7505000": 17, "besid": 17, "also": [17, 31, 39], "explicitli": 17, "nyanko7": 17, "danbooru2023": 17, "danbooru2023_index": 17, "origin": 17, "1000": 17, "png": 17, "10000": 17, "100000": 17, "insid": 17, "file_in_arch": 17, "check": [17, 20, 25, 26, 29, 30, 31, 39], "otherwis": [17, 20, 25, 31], "17506000": 17, "10000000001000": 17, "int": [17, 19, 20, 22, 24, 27, 31], "size": [17, 19, 20, 24, 31, 37, 38], "integ": 17, "filenotfounderror": 17, "435671": 17, "11966": 17, "detail": 17, "offset": 17, "sha256": 17, "265728": 17, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 17, "1024": [17, 30, 37, 38], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 17, "local_fil": [17, 22, 24, 25], "proxi": 17, "user_ag": 17, "header": 17, "endpoint": [17, 26, 27, 29], "save": [17, 19, 22, 31], "http": [17, 26, 39], "request": [17, 31], "user": 17, "agent": 17, "addit": [17, 31, 34], "api": [17, 20, 21, 22, 24, 25], "test_exampl": 17, "destin": 17, "given": [17, 21, 30, 31, 33], "fetch": [18, 27, 36], "archivestandalonefileincompletedownload": 18, "archivestandalonefilehashnotmatch": 18, "hf_tar_get_index": 18, "hf_tar_list_fil": 18, "hf_tar_file_exist": 18, "hf_tar_file_s": 18, "hf_tar_file_info": 18, "hf_tar_file_download": 18, "tar_create_index": 18, "hf_tar_create_index": [18, 20], "tar_get_index_info": 18, "hf_tar_create_from_directori": 18, "hf_tar_item_valid": 18, "hf_tar_valid": 18, "src_tar_fil": 19, "dst_index_fil": 19, "chunk_for_hash": 19, "1048576": 19, "with_hash": 19, "chunk": [19, 24], "20": 19, "mb": 19, "whether": 19, "progress": [19, 22, 24, 31, 34], "bar": [19, 22, 24, 31, 34], "log": 19, "skip_when_sync": 19, "skip": [19, 27], "sync": 19, "readi": [19, 25], "directli": 19, "json": [19, 20], "local_directori": [19, 22, 24], "file_item": 20, "hash_": 20, "expect": [20, 31], "sha": 20, "256": 20, "lf": [20, 26, 27, 29], "entrynotfounderror": 20, "entri": [20, 36], "found": 20, "isadirectoryerror": 20, "mean": [20, 39], "expir": 20, "need": 20, "re": 20, "gener": [20, 26], "so": [20, 24], "togeth": 20, "gracefulli": 20, "refresh": 20, "hfapi": 21, "variabl": [21, 22, 24], "hffilesystem": 21, "subdir": 21, "ignore_pattern": [21, 22, 24], "subdirectori": 21, "e": [21, 22, 24], "g": [21, 22, 24], "branch": [21, 22, 24, 29], "tag": [21, 22, 24, 29], "commit": [21, 22, 24, 27, 29], "pattern": [21, 22, 24], "ignor": [21, 22, 24], "file_in_repo": [22, 24, 25], "resume_download": 22, "within": [22, 24], "resum": 22, "dir_in_repo": 22, "max_work": 22, "8": [22, 37, 38, 39], "max_retri": 22, "max": 22, "worker": 22, "retri": 22, "time": [22, 24], "get_hf_client": 23, "get_hf_f": 23, "list_files_in_repositori": 23, "download_file_to_fil": 23, "download_archive_as_directori": 23, "download_directory_as_directori": 23, "upload_file_to_fil": 23, "upload_directory_as_arch": 23, "upload_directory_as_directori": 23, "is_local_file_readi": 23, "path_in_repo": 24, "time_suffix": 24, "operation_chunk_s": 24, "upload_timespan": 24, "float": 24, "0": [24, 27, 37, 38, 39], "its": 24, "append": 24, "timestamp": 24, "present": 24, "seper": 24, "multipl": 24, "set": 24, "minim": 24, "enabl": 24, "some": [24, 28, 37, 38], "fail": [24, 27, 29], "roll": 24, "back": [24, 29], "startup": 24, "hf_hub_rollback": [24, 28], "But": 24, "cannot": 24, "guarante": 24, "atom": 24, "your": [24, 37, 38, 39], "thread": 24, "safe": 24, "rate": 24, "limit": 24, "approxim": 24, "120": 24, "hour": 24, "realli": 24, "have": 24, "larg": 24, "number": [24, 27], "pleas": [24, 37, 38], "less": 24, "than": 24, "30": 24, "sure": 24, "compar": 25, "hub": [25, 26, 27, 29], "work": 26, "git": [26, 27, 28, 29, 39], "It": [26, 27, 29, 31, 39], "url": [26, 31], "git_info": 26, "hbutil": [26, 37, 38], "constant": 26, "huggingface_hub": 26, "full": 26, "unknown": 26, "usag": [26, 27, 29], "usernam": [26, 27, 29], "repo": [26, 27, 29], "co": 26, "other": 27, "dst_dir": 27, "no_lf": 27, "max_depth": 27, "specif": [27, 29], "attempt": [27, 29], "credenti": [27, 29], "maximum": 27, "subprocess": [27, 29], "calledprocesserror": [27, 29], "dir": 27, "v1": 27, "oper": [28, 29, 36], "hf_hub_repo_url": 28, "hf_hub_clon": 28, "reset": 29, "forc": 29, "push": 29, "chang": 29, "rollback_to": 29, "refer": 29, "abc123": 29, "perform": [29, 31, 37, 38], "step": 29, "without": 29, "temporari": 29, "hard": 29, "overwrit": 29, "histori": 29, "cancel": 29, "caution": 29, "read": 30, "first": 30, "byte": [30, 31], "contain": 30, "non": 30, "text": 30, "charact": 30, "expected_s": 31, "desc": 31, "session": 31, "tqdm": [31, 32, 36], "ensur": 31, "ha": [31, 37, 38], "pass": [31, 34], "binari": [32, 36], "is_binary_fil": 32, "download_fil": 32, "hf_normpath": 32, "hf_fs_path": 32, "parse_hf_fs_path": 32, "hffilesystempath": 32, "walk": [32, 36], "walk_fil": 32, "normal": 33, "filesystem": 33, "pars": 33, "invalid": 33, "tqdm_": 34, "enhanc": 34, "silenc": 34, "modifi": 34, "behavior": 34, "allow": 34, "posit": 34, "std": 34, "recurs": 35, "through": [35, 39], "yield": 35, "rel": 35, "root": 35, "start": [35, 36], "quick": 36, "run": 36, "environ": 36, "register_archive_typ": 36, "archive_pack": 36, "archive_unpack": 36, "get_archive_typ": 36, "get_archive_extnam": 36, "cach": 36, "config": [36, 39], "here": [37, 38], "o": [37, 38], "platform": [37, 38], "shutil": [37, 38], "cpuinfo": [37, 38], "psutil": [37, 38], "scale": [37, 38], "size_to_bytes_str": [37, 38], "python": [37, 38, 39], "python_implement": [37, 38], "python_vers": [37, 38], "cpu": [37, 38], "brand": [37, 38], "get_cpu_info": [37, 38], "brand_raw": [37, 38], "count": [37, 38], "cpu_count": [37, 38], "freq": [37, 38], "cpu_freq": [37, 38], "mhz": [37, 38], "memori": [37, 38], "virtual_memori": [37, 38], "total": [37, 38], "precis": [37, 38], "cuda": [37, 38], "ye": [37, 38], "nvidia": [37, 38], "smi": [37, 38], "els": [37, 38], "No": [37, 38], "linux": [37, 38], "azur": [37, 38], "x86_64": [37, 38], "glibc2": [37, 38], "34": [37, 38], "cpython": [37, 38], "18": [37, 38], "amd": [37, 38], "epyc": [37, 38], "7763": [37, 38], "64": [37, 38], "core": [37, 38], "processor": [37, 38], "2750": 37, "777": 37, "15": [37, 38], "606": [37, 38], "gib": [37, 38], "note": [37, 38], "deploi": [37, 38], "document": [37, 38, 39], "automat": [37, 38], "execut": [37, 38], "github": [37, 38, 39], "action": [37, 38], "therefor": [37, 38], "mai": [37, 38], "2914": 38, "123": 38, "hfutil": 39, "host": 39, "pypi": 39, "newest": 39, "u": 39, "com": 39, "script": 39, "__name__": 39, "__main__": 39, "develop": 39, "maintain": 39, "like": 39, "below": 39, "success": 39, "narugo1992": 39, "still": 39, "out": 39, "stabl": 39, "html": 39, "faq": 40}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [2, 0, 0, "-", "cache"], [3, 0, 0, "-", "config"], [10, 0, 0, "-", "entry"], [18, 0, 0, "-", "index"], [23, 0, 0, "-", "operate"], [28, 0, 0, "-", "repository"], [32, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.cache": [[1, 0, 0, "-", "delete"]], "hfutils.cache.delete": [[1, 1, 1, "", "delete_cache"], [1, 1, 1, "", "delete_detached_cache"]], "hfutils.config": [[4, 0, 0, "-", "meta"]], "hfutils.config.meta": [[4, 2, 1, "", "__AUTHOR_EMAIL__"], [4, 2, 1, "", "__AUTHOR__"], [4, 2, 1, "", "__DESCRIPTION__"], [4, 2, 1, "", "__TITLE__"], [4, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[5, 0, 0, "-", "base"], [6, 0, 0, "-", "cli"], [7, 0, 0, "-", "clone"], [8, 0, 0, "-", "dispatch"], [9, 0, 0, "-", "download"], [11, 0, 0, "-", "index"], [12, 0, 0, "-", "ls"], [13, 0, 0, "-", "ls_repo"], [14, 0, 0, "-", "rollback"], [15, 0, 0, "-", "upload"], [16, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[5, 2, 1, "", "CONTEXT_SETTINGS"], [5, 3, 1, "", "ClickErrorException"], [5, 3, 1, "", "ClickWarningException"], [5, 3, 1, "", "KeyboardInterrupted"], [5, 1, 1, "", "command_wrap"], [5, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[5, 5, 1, "", "__init__"], [5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.cli": [[6, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[8, 1, 1, "", "hfutilcli"], [8, 1, 1, "", "print_version"]], "hfutils.entry.download": [[9, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.entry.ls": [[12, 3, 1, "", "ListItem"], [12, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[12, 4, 1, "", "ARCHIVE"], [12, 4, 1, "", "DATA"], [12, 4, 1, "", "FILE"], [12, 4, 1, "", "FOLDER"], [12, 4, 1, "", "IMAGE"], [12, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[13, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[15, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[15, 4, 1, "", "exit_code"], [15, 5, 1, "", "show"]], "hfutils.index": [[17, 0, 0, "-", "fetch"], [19, 0, 0, "-", "make"], [20, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[17, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [17, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [17, 1, 1, "", "hf_tar_file_download"], [17, 1, 1, "", "hf_tar_file_exists"], [17, 1, 1, "", "hf_tar_file_info"], [17, 1, 1, "", "hf_tar_file_size"], [17, 1, 1, "", "hf_tar_get_index"], [17, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[19, 1, 1, "", "hf_tar_create_from_directory"], [19, 1, 1, "", "hf_tar_create_index"], [19, 1, 1, "", "tar_create_index"], [19, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[20, 1, 1, "", "hf_tar_item_validate"], [20, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[21, 0, 0, "-", "base"], [22, 0, 0, "-", "download"], [24, 0, 0, "-", "upload"], [25, 0, 0, "-", "validate"]], "hfutils.operate.base": [[21, 1, 1, "", "get_hf_client"], [21, 1, 1, "", "get_hf_fs"], [21, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[22, 1, 1, "", "download_archive_as_directory"], [22, 1, 1, "", "download_directory_as_directory"], [22, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[24, 1, 1, "", "upload_directory_as_archive"], [24, 1, 1, "", "upload_directory_as_directory"], [24, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[25, 1, 1, "", "is_local_file_ready"]], "hfutils.repository": [[26, 0, 0, "-", "base"], [27, 0, 0, "-", "clone"], [29, 0, 0, "-", "rollback"]], "hfutils.repository.base": [[26, 1, 1, "", "hf_hub_repo_url"]], "hfutils.repository.clone": [[27, 1, 1, "", "hf_hub_clone"]], "hfutils.repository.rollback": [[29, 1, 1, "", "hf_hub_rollback"]], "hfutils.utils": [[30, 0, 0, "-", "binary"], [31, 0, 0, "-", "download"], [33, 0, 0, "-", "path"], [34, 0, 0, "-", "tqdm_"], [35, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[30, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[31, 1, 1, "", "download_file"]], "hfutils.utils.path": [[33, 3, 1, "", "HfFileSystemPath"], [33, 1, 1, "", "hf_fs_path"], [33, 1, 1, "", "hf_normpath"], [33, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[34, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[35, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "cach": [1, 2], "delet": 1, "delete_detached_cach": 1, "delete_cach": 1, "config": [3, 4], "meta": 4, "__title__": 4, "__version__": 4, "__description__": 4, "__author__": 4, "__author_email__": 4, "entri": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "base": [5, 21, 26], "context_set": 5, "clickwarningexcept": 5, "clickerrorexcept": 5, "print_except": 5, "keyboardinterrupt": 5, "command_wrap": 5, "cli": 6, "clone": [7, 27], "dispatch": 8, "print_vers": 8, "hfutilcli": 8, "download": [9, 22, 31], "noremotepathassignedwithdownload": 9, "index": [11, 17, 18, 19, 20], "l": 12, "listitemtyp": 12, "listitem": 12, "ls_repo": 13, "nolocalauthent": 13, "rollback": [14, 29], "upload": [15, 24], "noremotepathassignedwithupload": 15, "whoami": 16, "fetch": 17, "archivestandalonefileincompletedownload": 17, "archivestandalonefilehashnotmatch": 17, "hf_tar_get_index": 17, "hf_tar_list_fil": 17, "hf_tar_file_exist": 17, "hf_tar_file_s": 17, "hf_tar_file_info": 17, "hf_tar_file_download": 17, "make": 19, "tar_create_index": 19, "hf_tar_create_index": 19, "tar_get_index_info": 19, "hf_tar_create_from_directori": 19, "valid": [20, 25], "hf_tar_item_valid": 20, "hf_tar_valid": 20, "oper": [21, 22, 23, 24, 25], "get_hf_client": 21, "get_hf_f": 21, "list_files_in_repositori": 21, "download_file_to_fil": 22, "download_archive_as_directori": 22, "download_directory_as_directori": 22, "upload_file_to_fil": 24, "upload_directory_as_arch": 24, "upload_directory_as_directori": 24, "is_local_file_readi": 25, "repositori": [26, 27, 28, 29], "hf_hub_repo_url": 26, "hf_hub_clon": 27, "hf_hub_rollback": 29, "util": [30, 31, 32, 33, 34, 35], "binari": 30, "is_binary_fil": 30, "download_fil": 31, "path": 33, "hf_normpath": 33, "hf_fs_path": 33, "parse_hf_fs_path": 33, "hffilesystempath": 33, "tqdm": 34, "walk": 35, "walk_fil": 35, "welcom": 36, "": 36, "document": 36, "overview": 36, "tutori": 36, "inform": [36, 37, 38], "api": 36, "run": [37, 38], "environ": [37, 38], "instal": 39, "quick": 40, "start": 40}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "delete_detached_cache": [[1, "delete-detached-cache"]], "delete_cache": [[1, "delete-cache"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "__TITLE__": [[4, "title"]], "__VERSION__": [[4, "version"]], "__DESCRIPTION__": [[4, "description"]], "__AUTHOR__": [[4, "author"]], "__AUTHOR_EMAIL__": [[4, "author-email"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[5, "context-settings"]], "ClickWarningException": [[5, "clickwarningexception"]], "ClickErrorException": [[5, "clickerrorexception"]], "print_exception": [[5, "print-exception"]], "KeyboardInterrupted": [[5, "keyboardinterrupted"]], "command_wrap": [[5, "command-wrap"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "cli": [[6, "cli"]], "hfutils.entry.clone": [[7, "module-hfutils.entry.clone"]], "hfutils.entry.dispatch": [[8, "module-hfutils.entry.dispatch"]], "print_version": [[8, "print-version"]], "hfutilcli": [[8, "hfutilcli"]], "hfutils.entry.download": [[9, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[9, "noremotepathassignedwithdownload"]], "hfutils.entry": [[10, "module-hfutils.entry"]], "hfutils.entry.index": [[11, "module-hfutils.entry.index"]], "hfutils.entry.ls": [[12, "module-hfutils.entry.ls"]], "ListItemType": [[12, "listitemtype"]], "ListItem": [[12, "listitem"]], "hfutils.entry.ls_repo": [[13, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[13, "nolocalauthentication"]], "hfutils.entry.rollback": [[14, "module-hfutils.entry.rollback"]], "hfutils.entry.upload": [[15, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[15, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[16, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[17, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[17, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[17, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[17, "hf-tar-get-index"]], "hf_tar_list_files": [[17, "hf-tar-list-files"]], "hf_tar_file_exists": [[17, "hf-tar-file-exists"]], "hf_tar_file_size": [[17, "hf-tar-file-size"]], "hf_tar_file_info": [[17, "hf-tar-file-info"]], "hf_tar_file_download": [[17, "hf-tar-file-download"]], "hfutils.index": [[18, "module-hfutils.index"]], "hfutils.index.make": [[19, "module-hfutils.index.make"]], "tar_create_index": [[19, "tar-create-index"]], "hf_tar_create_index": [[19, "hf-tar-create-index"]], "tar_get_index_info": [[19, "tar-get-index-info"]], "hf_tar_create_from_directory": [[19, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[20, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[20, "hf-tar-item-validate"]], "hf_tar_validate": [[20, "hf-tar-validate"]], "hfutils.operate.base": [[21, "module-hfutils.operate.base"]], "get_hf_client": [[21, "get-hf-client"]], "get_hf_fs": [[21, "get-hf-fs"]], "list_files_in_repository": [[21, "list-files-in-repository"]], "hfutils.operate.download": [[22, "module-hfutils.operate.download"]], "download_file_to_file": [[22, "download-file-to-file"]], "download_archive_as_directory": [[22, "download-archive-as-directory"]], "download_directory_as_directory": [[22, "download-directory-as-directory"]], "hfutils.operate": [[23, "module-hfutils.operate"]], "hfutils.operate.upload": [[24, "module-hfutils.operate.upload"]], "upload_file_to_file": [[24, "upload-file-to-file"]], "upload_directory_as_archive": [[24, "upload-directory-as-archive"]], "upload_directory_as_directory": [[24, "upload-directory-as-directory"]], "hfutils.operate.validate": [[25, "module-hfutils.operate.validate"]], "is_local_file_ready": [[25, "is-local-file-ready"]], "hfutils.repository.base": [[26, "module-hfutils.repository.base"]], "hf_hub_repo_url": [[26, "hf-hub-repo-url"]], "hfutils.repository.clone": [[27, "module-hfutils.repository.clone"]], "hf_hub_clone": [[27, "hf-hub-clone"]], "hfutils.repository": [[28, "module-hfutils.repository"]], "hfutils.repository.rollback": [[29, "module-hfutils.repository.rollback"]], "hf_hub_rollback": [[29, "hf-hub-rollback"]], "hfutils.utils.binary": [[30, "module-hfutils.utils.binary"]], "is_binary_file": [[30, "is-binary-file"]], "hfutils.utils.download": [[31, "module-hfutils.utils.download"]], "download_file": [[31, "download-file"]], "hfutils.utils": [[32, "module-hfutils.utils"]], "hfutils.utils.path": [[33, "module-hfutils.utils.path"]], "hf_normpath": [[33, "hf-normpath"]], "hf_fs_path": [[33, "hf-fs-path"]], "parse_hf_fs_path": [[33, "parse-hf-fs-path"]], "HfFileSystemPath": [[33, "hffilesystempath"]], "hfutils.utils.tqdm": [[34, "module-hfutils.utils.tqdm_"]], "tqdm": [[34, "tqdm"]], "hfutils.utils.walk": [[35, "module-hfutils.utils.walk"]], "walk_files": [[35, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[36, "welcome-to-hfutils-s-documentation"]], "Overview": [[36, "overview"]], "Tutorials": [[36, null]], "Information": [[36, null]], "API Documentation": [[36, null]], "Run Environment Information": [[37, "Run-Environment-Information"], [38, "Run-Environment-Information"]], "Installation": [[39, "installation"]], "Quick Start": [[40, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.cache.delete"], [2, "module-hfutils.cache"], [3, "module-hfutils.config"], [4, "module-hfutils.config.meta"], [5, "module-hfutils.entry.base"], [6, "module-hfutils.entry.cli"], [7, "module-hfutils.entry.clone"], [8, "module-hfutils.entry.dispatch"], [9, "module-hfutils.entry.download"], [10, "module-hfutils.entry"], [11, "module-hfutils.entry.index"], [12, "module-hfutils.entry.ls"], [13, "module-hfutils.entry.ls_repo"], [14, "module-hfutils.entry.rollback"], [15, "module-hfutils.entry.upload"], [16, "module-hfutils.entry.whoami"], [17, "module-hfutils.index.fetch"], [18, "module-hfutils.index"], [19, "module-hfutils.index.make"], [20, "module-hfutils.index.validate"], [21, "module-hfutils.operate.base"], [22, "module-hfutils.operate.download"], [23, "module-hfutils.operate"], [24, "module-hfutils.operate.upload"], [25, "module-hfutils.operate.validate"], [26, "module-hfutils.repository.base"], [27, "module-hfutils.repository.clone"], [28, "module-hfutils.repository"], [29, "module-hfutils.repository.rollback"], [30, "module-hfutils.utils.binary"], [31, "module-hfutils.utils.download"], [32, "module-hfutils.utils"], [33, "module-hfutils.utils.path"], [34, "module-hfutils.utils.tqdm_"], [35, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "delete_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_cache"]], "delete_detached_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_detached_cache"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[5, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[5, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[5, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[5, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[5, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[5, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[5, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[6, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "hfutils.entry.clone": [[7, "module-hfutils.entry.clone"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[8, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[8, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[8, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[9, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[9, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[9, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[9, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[10, "module-hfutils.entry"]], "hfutils.entry.index": [[11, "module-hfutils.entry.index"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[12, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[12, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[13, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[13, "module-hfutils.entry.ls_repo"]], "hfutils.entry.rollback": [[14, "module-hfutils.entry.rollback"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[15, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[15, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[15, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[15, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[16, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[17, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[17, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[17, "module-hfutils.index.fetch"]], "hfutils.index": [[18, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[19, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[19, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[19, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[19, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[19, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[20, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[20, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[20, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[21, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[21, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[21, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[21, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[22, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[22, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[22, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[22, "module-hfutils.operate.download"]], "hfutils.operate": [[23, "module-hfutils.operate"]], "hfutils.operate.upload": [[24, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[24, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[24, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[24, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[25, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[25, "hfutils.operate.validate.is_local_file_ready"]], "hf_hub_repo_url() (in module hfutils.repository.base)": [[26, "hfutils.repository.base.hf_hub_repo_url"]], "hfutils.repository.base": [[26, "module-hfutils.repository.base"]], "hf_hub_clone() (in module hfutils.repository.clone)": [[27, "hfutils.repository.clone.hf_hub_clone"]], "hfutils.repository.clone": [[27, "module-hfutils.repository.clone"]], "hfutils.repository": [[28, "module-hfutils.repository"]], "hf_hub_rollback() (in module hfutils.repository.rollback)": [[29, "hfutils.repository.rollback.hf_hub_rollback"]], "hfutils.repository.rollback": [[29, "module-hfutils.repository.rollback"]], "hfutils.utils.binary": [[30, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[30, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[31, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[31, "module-hfutils.utils.download"]], "hfutils.utils": [[32, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[33, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[33, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[33, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[33, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[33, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[34, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[34, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[35, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[35, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/main/tutorials/installation/index.html b/main/tutorials/installation/index.html
index 923afac465..cc47de5e01 100644
--- a/main/tutorials/installation/index.html
+++ b/main/tutorials/installation/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Installation &mdash; hfutils 0.3.0 documentation</title>
+  <title>Installation &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -118,7 +118,7 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
 </pre></div>
 </div>
 <p>The output should be like below, which means your installation is successful.</p>
-<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span>hfutils 0.3.0
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span>hfutils 0.3.1
 <span class="linenos">2</span>Developed and maintained by narugo1992
 <span class="linenos">3</span>Useful utilities for huggingface
 </pre></div>
diff --git a/main/tutorials/quick_start/index.html b/main/tutorials/quick_start/index.html
index 6330175c96..b478aa3efa 100644
--- a/main/tutorials/quick_start/index.html
+++ b/main/tutorials/quick_start/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Quick Start &mdash; hfutils 0.3.0 documentation</title>
+  <title>Quick Start &mdash; hfutils 0.3.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
@@ -17,7 +17,7 @@
   
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=c02300dd"></script>
+        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=645b84c4"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -40,7 +40,7 @@
             hfutils
           </a>
               <div class="version">
-                0.3.0
+                0.3.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
diff --git a/v0.0.1/.buildinfo b/v0.0.1/.buildinfo
index 6ea1f8d337..3c5022cb61 100644
--- a/v0.0.1/.buildinfo
+++ b/v0.0.1/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: ef879a6a559c3df0dde2dbb1d03fbdfd
+config: e8028bb9aad52f186b58d46765315067
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.0.1/.doctrees/api_doc/archive/index.doctree b/v0.0.1/.doctrees/api_doc/archive/index.doctree
index f5374e6985..818910f6df 100644
Binary files a/v0.0.1/.doctrees/api_doc/archive/index.doctree and b/v0.0.1/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/config/index.doctree b/v0.0.1/.doctrees/api_doc/config/index.doctree
index 1f48d3af0a..8414e78fc4 100644
Binary files a/v0.0.1/.doctrees/api_doc/config/index.doctree and b/v0.0.1/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/config/meta.doctree b/v0.0.1/.doctrees/api_doc/config/meta.doctree
index ceedccb24f..18d3fb3f52 100644
Binary files a/v0.0.1/.doctrees/api_doc/config/meta.doctree and b/v0.0.1/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/entry/base.doctree b/v0.0.1/.doctrees/api_doc/entry/base.doctree
index 87ed3dd580..ef8631d564 100644
Binary files a/v0.0.1/.doctrees/api_doc/entry/base.doctree and b/v0.0.1/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/entry/cli.doctree b/v0.0.1/.doctrees/api_doc/entry/cli.doctree
index 76b8386b85..6739260654 100644
Binary files a/v0.0.1/.doctrees/api_doc/entry/cli.doctree and b/v0.0.1/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/entry/dispatch.doctree b/v0.0.1/.doctrees/api_doc/entry/dispatch.doctree
index 1dabdd3cce..381ea7dcbd 100644
Binary files a/v0.0.1/.doctrees/api_doc/entry/dispatch.doctree and b/v0.0.1/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/entry/download.doctree b/v0.0.1/.doctrees/api_doc/entry/download.doctree
index f99bd7b687..1a5867392b 100644
Binary files a/v0.0.1/.doctrees/api_doc/entry/download.doctree and b/v0.0.1/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/entry/index.doctree b/v0.0.1/.doctrees/api_doc/entry/index.doctree
index 6db785c6d3..c84928968a 100644
Binary files a/v0.0.1/.doctrees/api_doc/entry/index.doctree and b/v0.0.1/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/entry/upload.doctree b/v0.0.1/.doctrees/api_doc/entry/upload.doctree
index db6e39ce34..31fb5f52ca 100644
Binary files a/v0.0.1/.doctrees/api_doc/entry/upload.doctree and b/v0.0.1/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/operate/base.doctree b/v0.0.1/.doctrees/api_doc/operate/base.doctree
index ec42928118..188053ec03 100644
Binary files a/v0.0.1/.doctrees/api_doc/operate/base.doctree and b/v0.0.1/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/operate/download.doctree b/v0.0.1/.doctrees/api_doc/operate/download.doctree
index 131da7aaf6..e0eb9fd707 100644
Binary files a/v0.0.1/.doctrees/api_doc/operate/download.doctree and b/v0.0.1/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/operate/index.doctree b/v0.0.1/.doctrees/api_doc/operate/index.doctree
index a1679d174f..65596864d5 100644
Binary files a/v0.0.1/.doctrees/api_doc/operate/index.doctree and b/v0.0.1/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/operate/upload.doctree b/v0.0.1/.doctrees/api_doc/operate/upload.doctree
index cdd1cbfb73..a69b150655 100644
Binary files a/v0.0.1/.doctrees/api_doc/operate/upload.doctree and b/v0.0.1/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/utils/binary.doctree b/v0.0.1/.doctrees/api_doc/utils/binary.doctree
index 132bc16308..1cf2c52dc8 100644
Binary files a/v0.0.1/.doctrees/api_doc/utils/binary.doctree and b/v0.0.1/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/utils/download.doctree b/v0.0.1/.doctrees/api_doc/utils/download.doctree
index d89be94bde..c074880b38 100644
Binary files a/v0.0.1/.doctrees/api_doc/utils/download.doctree and b/v0.0.1/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/utils/index.doctree b/v0.0.1/.doctrees/api_doc/utils/index.doctree
index 0bcf22c841..9f4afe9a1c 100644
Binary files a/v0.0.1/.doctrees/api_doc/utils/index.doctree and b/v0.0.1/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/utils/tqdm_.doctree b/v0.0.1/.doctrees/api_doc/utils/tqdm_.doctree
index 1b6ae283fe..eb7c63ac92 100644
Binary files a/v0.0.1/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.0.1/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.0.1/.doctrees/api_doc/utils/walk.doctree b/v0.0.1/.doctrees/api_doc/utils/walk.doctree
index 71948b63df..5fe9cd12bf 100644
Binary files a/v0.0.1/.doctrees/api_doc/utils/walk.doctree and b/v0.0.1/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.0.1/.doctrees/environment.pickle b/v0.0.1/.doctrees/environment.pickle
index d0e9aa8adf..2cf0bbaf58 100644
Binary files a/v0.0.1/.doctrees/environment.pickle and b/v0.0.1/.doctrees/environment.pickle differ
diff --git a/v0.0.1/.doctrees/index.doctree b/v0.0.1/.doctrees/index.doctree
index 287d99c90f..0a4f6f1c80 100644
Binary files a/v0.0.1/.doctrees/index.doctree and b/v0.0.1/.doctrees/index.doctree differ
diff --git a/v0.0.1/.doctrees/information/environment.doctree b/v0.0.1/.doctrees/information/environment.doctree
index ee60fda8fb..e08bab9bbc 100644
Binary files a/v0.0.1/.doctrees/information/environment.doctree and b/v0.0.1/.doctrees/information/environment.doctree differ
diff --git a/v0.0.1/.doctrees/information/environment.result.doctree b/v0.0.1/.doctrees/information/environment.result.doctree
index 1129897aa7..baa74b7ae2 100644
Binary files a/v0.0.1/.doctrees/information/environment.result.doctree and b/v0.0.1/.doctrees/information/environment.result.doctree differ
diff --git a/v0.0.1/.doctrees/nbsphinx/information/environment.ipynb b/v0.0.1/.doctrees/nbsphinx/information/environment.ipynb
index 4dda8c8eee..18852261c1 100644
--- a/v0.0.1/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.0.1/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:25:25.760244Z",
-     "iopub.status.busy": "2024-07-23T17:25:25.760039Z",
-     "iopub.status.idle": "2024-07-23T17:25:26.929670Z",
-     "shell.execute_reply": "2024-07-23T17:25:26.928912Z"
+     "iopub.execute_input": "2024-07-23T17:31:32.275997Z",
+     "iopub.status.busy": "2024-07-23T17:31:32.275780Z",
+     "iopub.status.idle": "2024-07-23T17:31:33.451667Z",
+     "shell.execute_reply": "2024-07-23T17:31:33.450897Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2898.4179999999997 MHz\n",
+      "CPU Freq: 2900.37975 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.1/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.0.1/.doctrees/nbsphinx/information/environment.result.ipynb
index 8b557838d7..4c03f33415 100644
--- a/v0.0.1/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.0.1/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:55:16.269187Z",
-     "iopub.status.busy": "2024-07-23T16:55:16.268980Z",
-     "iopub.status.idle": "2024-07-23T16:55:17.445906Z",
-     "shell.execute_reply": "2024-07-23T16:55:17.445104Z"
+     "iopub.execute_input": "2024-07-23T17:00:40.146448Z",
+     "iopub.status.busy": "2024-07-23T17:00:40.146217Z",
+     "iopub.status.idle": "2024-07-23T17:00:41.325201Z",
+     "shell.execute_reply": "2024-07-23T17:00:41.324417Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2736.5725 MHz\n",
+      "CPU Freq: 3172.7845 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.1/.doctrees/tutorials/installation/index.doctree b/v0.0.1/.doctrees/tutorials/installation/index.doctree
index c8e1de435c..a71397b2c9 100644
Binary files a/v0.0.1/.doctrees/tutorials/installation/index.doctree and b/v0.0.1/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.0.1/.doctrees/tutorials/quick_start/index.doctree b/v0.0.1/.doctrees/tutorials/quick_start/index.doctree
index 15887dc273..76767cd828 100644
Binary files a/v0.0.1/.doctrees/tutorials/quick_start/index.doctree and b/v0.0.1/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.0.1/_sources/information/environment.result.ipynb.txt b/v0.0.1/_sources/information/environment.result.ipynb.txt
index 8b557838d7..4c03f33415 100644
--- a/v0.0.1/_sources/information/environment.result.ipynb.txt
+++ b/v0.0.1/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:55:16.269187Z",
-     "iopub.status.busy": "2024-07-23T16:55:16.268980Z",
-     "iopub.status.idle": "2024-07-23T16:55:17.445906Z",
-     "shell.execute_reply": "2024-07-23T16:55:17.445104Z"
+     "iopub.execute_input": "2024-07-23T17:00:40.146448Z",
+     "iopub.status.busy": "2024-07-23T17:00:40.146217Z",
+     "iopub.status.idle": "2024-07-23T17:00:41.325201Z",
+     "shell.execute_reply": "2024-07-23T17:00:41.324417Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2736.5725 MHz\n",
+      "CPU Freq: 3172.7845 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.1/information/environment.html b/v0.0.1/information/environment.html
index 37fb243324..799ac804dc 100644
--- a/v0.0.1/information/environment.html
+++ b/v0.0.1/information/environment.html
@@ -125,11 +125,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2898.4179999999997 MHz
+CPU Freq: 2900.37975 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.0.1/information/environment.ipynb b/v0.0.1/information/environment.ipynb
index 4dda8c8eee..18852261c1 100644
--- a/v0.0.1/information/environment.ipynb
+++ b/v0.0.1/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:25:25.760244Z",
-     "iopub.status.busy": "2024-07-23T17:25:25.760039Z",
-     "iopub.status.idle": "2024-07-23T17:25:26.929670Z",
-     "shell.execute_reply": "2024-07-23T17:25:26.928912Z"
+     "iopub.execute_input": "2024-07-23T17:31:32.275997Z",
+     "iopub.status.busy": "2024-07-23T17:31:32.275780Z",
+     "iopub.status.idle": "2024-07-23T17:31:33.451667Z",
+     "shell.execute_reply": "2024-07-23T17:31:33.450897Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2898.4179999999997 MHz\n",
+      "CPU Freq: 2900.37975 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.1/information/environment.result.html b/v0.0.1/information/environment.result.html
index eba819f1cb..ea2a188de0 100644
--- a/v0.0.1/information/environment.result.html
+++ b/v0.0.1/information/environment.result.html
@@ -127,11 +127,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2736.5725 MHz
+CPU Freq: 3172.7845 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.0.1/information/environment.result.ipynb b/v0.0.1/information/environment.result.ipynb
index 8b557838d7..4c03f33415 100644
--- a/v0.0.1/information/environment.result.ipynb
+++ b/v0.0.1/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:55:16.269187Z",
-     "iopub.status.busy": "2024-07-23T16:55:16.268980Z",
-     "iopub.status.idle": "2024-07-23T16:55:17.445906Z",
-     "shell.execute_reply": "2024-07-23T16:55:17.445104Z"
+     "iopub.execute_input": "2024-07-23T17:00:40.146448Z",
+     "iopub.status.busy": "2024-07-23T17:00:40.146217Z",
+     "iopub.status.idle": "2024-07-23T17:00:41.325201Z",
+     "shell.execute_reply": "2024-07-23T17:00:41.324417Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2736.5725 MHz\n",
+      "CPU Freq: 3172.7845 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.1/searchindex.js b/v0.0.1/searchindex.js
index 19e4744195..ebf233f602 100644
--- a/v0.0.1/searchindex.js
+++ b/v0.0.1/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": [0, 18], "support": 0, "format": 0, "extens": 0, "name": [0, 3], "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 16, 17], "associ": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 18], "function": [0, 3, 13, 14, 16], "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 21], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 17], "an": [0, 10, 12, 14, 16, 17], "filenam": [0, 14], "input": 0, "creat": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 14, 16], "bool": [0, 5, 10, 12, 13, 14, 16], "fals": [0, 10, 12, 13, 14, 16], "us": [0, 3, 14, 21], "specifi": [0, 12, 14], "result": 0, "If": [0, 3, 10, 12, 14, 16], "true": [0, 10, 12, 13, 14, 16], "suppress": [0, 10, 12, 14], "warn": [0, 3], "dure": 0, "process": 0, "return": [0, 3, 9, 13, 14, 16, 17], "path": [0, 6, 8, 9, 10, 12, 13, 14, 17], "content": [0, 16], "determin": 0, "base": [0, 7, 11, 18], "rais": 0, "valueerror": 0, "i": [0, 6, 8, 13, 18, 19, 20, 21], "ani": [0, 5, 13], "get": [0, 9, 14], "meta": [1, 18, 21], "__title__": [1, 21], "__version__": [1, 21], "__description__": [1, 21], "__author__": [1, 21], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 13, 14, 16, 19, 20], "project": 2, "should": [2, 14, 21], "version": [2, 5, 16, 18, 21], "short": 2, "descript": [2, 14], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 14, 19, 20, 21], "object": [3, 9, 10, 12, 14], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 17], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 14, 16], "keyword": [3, 14, 16], "argument": [3, 14, 16], "For": 3, "exampl": 3, "one": 3, "1": [3, 19, 20, 21], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 14, 16], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "code": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 21], "none": [3, 5, 6, 8, 12, 14], "option": [3, 5, 6, 8, 12, 14, 16], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 14, 16, 21], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 19, 20, 21], "traceback": 3, "provid": [3, 14], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 21], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 18], "current": [5, 19, 20, 21], "metadata": 5, "arg": [5, 16], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12], "assign": [6, 8], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 18], "print_vers": 7, "download": [7, 11, 15, 18], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 18], "noremotepathassignedwithupload": 7, "33": 8, "hfapi": 9, "hug": [9, 10, 12], "face": [9, 10, 12], "api": 9, "client": 9, "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12], "repo_typ": [9, 10, 12], "liter": [9, 10, 12], "dataset": [9, 10, 12], "model": [9, 10, 12], "space": [9, 10, 12], "subdir": 9, "revis": [9, 10, 12], "main": [9, 10, 12, 21], "ignore_pattern": [9, 10, 12], "given": [9, 13, 14], "identifi": [9, 10, 12], "repotypetyp": [9, 10, 12], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12], "file_in_repo": [10, 12], "save": [10, 14], "local": [10, 12, 14, 19, 20], "within": [10, 12], "progress": [10, 12, 14, 16], "bar": [10, 12, 14, 16], "local_directori": [10, 12], "archiv": [10, 12, 18], "dir_in_repo": 10, "all": [10, 17], "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "clear": 12, "its": 12, "append": 12, "timestamp": 12, "remov": 12, "present": 12, "check": [13, 14, 21], "read": 13, "first": 13, "1024": 13, "byte": [13, 14], "contain": 13, "non": 13, "text": 13, "charact": 13, "url": 14, "expected_s": 14, "int": 14, "desc": 14, "session": 14, "request": 14, "librari": 14, "tqdm": [14, 15, 18], "It": [14, 21], "also": [14, 21], "perform": [14, 19, 20], "ensur": 14, "ha": [14, 19, 20], "expect": 14, "size": [14, 19, 20], "where": 14, "otherwis": 14, "addit": [14, 16], "pass": [14, 16], "binari": [15, 18], "is_binary_fil": 15, "download_fil": 15, "walk": [15, 18], "walk_fil": 15, "tqdm_": 16, "enhanc": 16, "silenc": 16, "modifi": 16, "behavior": 16, "allow": 16, "posit": 16, "std": 16, "recurs": 17, "through": [17, 21], "yield": 17, "rel": 17, "root": 17, "start": [17, 18], "modul": 18, "which": [18, 19, 20, 21], "can": [18, 21], "pars": 18, "configur": 18, "structur": 18, "instal": 18, "quick": 18, "run": 18, "environ": 18, "register_archive_typ": 18, "archive_pack": 18, "archive_unpack": 18, "get_archive_typ": 18, "get_archive_extnam": 18, "config": [18, 21], "entri": 18, "oper": 18, "util": [18, 21], "here": [19, 20], "import": [19, 20, 21], "o": [19, 20], "platform": [19, 20], "shutil": [19, 20], "cpuinfo": [19, 20], "psutil": [19, 20], "hbutil": [19, 20], "scale": [19, 20], "size_to_bytes_str": [19, 20], "python": [19, 20, 21], "python_implement": [19, 20], "python_vers": [19, 20], "cpu": [19, 20], "brand": [19, 20], "get_cpu_info": [19, 20], "brand_raw": [19, 20], "count": [19, 20], "cpu_count": [19, 20], "freq": [19, 20], "cpu_freq": [19, 20], "mhz": [19, 20], "memori": [19, 20], "virtual_memori": [19, 20], "total": [19, 20], "precis": [19, 20], "3": [19, 20, 21], "cuda": [19, 20], "ye": [19, 20], "nvidia": [19, 20], "smi": [19, 20], "els": [19, 20], "No": [19, 20], "linux": [19, 20], "6": [19, 20], "5": [19, 20], "0": [19, 20, 21], "1023": [19, 20], "azur": [19, 20], "x86_64": [19, 20], "glibc2": [19, 20], "34": [19, 20], "cpython": [19, 20], "8": [19, 20, 21], "18": [19, 20], "amd": [19, 20], "epyc": [19, 20], "7763": [19, 20], "64": [19, 20], "core": [19, 20], "processor": [19, 20], "4": [19, 20], "2898": 19, "4179999999997": 19, "15": [19, 20], "606": [19, 20], "gib": [19, 20], "pleas": [19, 20], "note": [19, 20], "deploi": [19, 20], "document": [19, 20, 21], "automat": [19, 20], "execut": [19, 20], "github": [19, 20, 21], "action": [19, 20], "therefor": [19, 20], "some": [19, 20], "data": [19, 20], "mai": [19, 20], "differ": [19, 20], "your": [19, 20, 21], "2736": 20, "5725": 20, "hfutil": 21, "host": 21, "pypi": 21, "requir": 21, "you": 21, "simpli": 21, "follow": 21, "pip": 21, "newest": 21, "u": 21, "git": 21, "http": 21, "com": 21, "deepgh": 21, "script": 21, "__name__": 21, "__main__": 21, "develop": 21, "maintain": 21, "like": 21, "below": 21, "mean": 21, "success": 21, "narugo1992": 21, "huggingfac": 21, "still": 21, "under": 21, "out": 21, "stabl": 21, "index": 21, "html": 21, "faq": 22}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [15, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.utils": [[13, 0, 0, "-", "binary"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "tqdm_"], [17, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[13, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[14, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[16, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[17, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 14], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "util": [13, 14, 15, 16, 17], "binari": 13, "is_binary_fil": 13, "download_fil": 14, "tqdm": 16, "walk": 17, "walk_fil": 17, "welcom": 18, "": 18, "document": 18, "overview": 18, "tutori": 18, "inform": [18, 19, 20], "api": 18, "run": [19, 20], "environ": [19, 20], "instal": 21, "quick": 22, "start": 22}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file": [[13, "is-binary-file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "download_file": [[14, "download-file"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[16, "module-hfutils.utils.tqdm_"]], "tqdm": [[16, "tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files": [[17, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[18, "welcome-to-hfutils-s-documentation"]], "Overview": [[18, "overview"]], "Tutorials": [[18, null]], "Information": [[18, null]], "API Documentation": [[18, null]], "Run Environment Information": [[19, "Run-Environment-Information"], [20, "Run-Environment-Information"]], "Installation": [[21, "installation"]], "Quick Start": [[22, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.utils.binary"], [14, "module-hfutils.utils.download"], [15, "module-hfutils.utils"], [16, "module-hfutils.utils.tqdm_"], [17, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[13, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[14, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[16, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[16, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[17, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": [0, 18], "support": 0, "format": 0, "extens": 0, "name": [0, 3], "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 16, 17], "associ": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 18], "function": [0, 3, 13, 14, 16], "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 21], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 17], "an": [0, 10, 12, 14, 16, 17], "filenam": [0, 14], "input": 0, "creat": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 14, 16], "bool": [0, 5, 10, 12, 13, 14, 16], "fals": [0, 10, 12, 13, 14, 16], "us": [0, 3, 14, 21], "specifi": [0, 12, 14], "result": 0, "If": [0, 3, 10, 12, 14, 16], "true": [0, 10, 12, 13, 14, 16], "suppress": [0, 10, 12, 14], "warn": [0, 3], "dure": 0, "process": 0, "return": [0, 3, 9, 13, 14, 16, 17], "path": [0, 6, 8, 9, 10, 12, 13, 14, 17], "content": [0, 16], "determin": 0, "base": [0, 7, 11, 18], "rais": 0, "valueerror": 0, "i": [0, 6, 8, 13, 18, 19, 20, 21], "ani": [0, 5, 13], "get": [0, 9, 14], "meta": [1, 18, 21], "__title__": [1, 21], "__version__": [1, 21], "__description__": [1, 21], "__author__": [1, 21], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 13, 14, 16, 19, 20], "project": 2, "should": [2, 14, 21], "version": [2, 5, 16, 18, 21], "short": 2, "descript": [2, 14], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 14, 19, 20, 21], "object": [3, 9, 10, 12, 14], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 17], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 14, 16], "keyword": [3, 14, 16], "argument": [3, 14, 16], "For": 3, "exampl": 3, "one": 3, "1": [3, 19, 20, 21], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 14, 16], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "code": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 21], "none": [3, 5, 6, 8, 12, 14], "option": [3, 5, 6, 8, 12, 14, 16], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 14, 16, 21], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 19, 20, 21], "traceback": 3, "provid": [3, 14], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 21], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 18], "current": [5, 19, 20, 21], "metadata": 5, "arg": [5, 16], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12], "assign": [6, 8], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 18], "print_vers": 7, "download": [7, 11, 15, 18], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 18], "noremotepathassignedwithupload": 7, "33": 8, "hfapi": 9, "hug": [9, 10, 12], "face": [9, 10, 12], "api": 9, "client": 9, "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12], "repo_typ": [9, 10, 12], "liter": [9, 10, 12], "dataset": [9, 10, 12], "model": [9, 10, 12], "space": [9, 10, 12], "subdir": 9, "revis": [9, 10, 12], "main": [9, 10, 12, 21], "ignore_pattern": [9, 10, 12], "given": [9, 13, 14], "identifi": [9, 10, 12], "repotypetyp": [9, 10, 12], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12], "file_in_repo": [10, 12], "save": [10, 14], "local": [10, 12, 14, 19, 20], "within": [10, 12], "progress": [10, 12, 14, 16], "bar": [10, 12, 14, 16], "local_directori": [10, 12], "archiv": [10, 12, 18], "dir_in_repo": 10, "all": [10, 17], "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "clear": 12, "its": 12, "append": 12, "timestamp": 12, "remov": 12, "present": 12, "check": [13, 14, 21], "read": 13, "first": 13, "1024": [13, 19, 20], "byte": [13, 14], "contain": 13, "non": 13, "text": 13, "charact": 13, "url": 14, "expected_s": 14, "int": 14, "desc": 14, "session": 14, "request": 14, "librari": 14, "tqdm": [14, 15, 18], "It": [14, 21], "also": [14, 21], "perform": [14, 19, 20], "ensur": 14, "ha": [14, 19, 20], "expect": 14, "size": [14, 19, 20], "where": 14, "otherwis": 14, "addit": [14, 16], "pass": [14, 16], "binari": [15, 18], "is_binary_fil": 15, "download_fil": 15, "walk": [15, 18], "walk_fil": 15, "tqdm_": 16, "enhanc": 16, "silenc": 16, "modifi": 16, "behavior": 16, "allow": 16, "posit": 16, "std": 16, "recurs": 17, "through": [17, 21], "yield": 17, "rel": 17, "root": 17, "start": [17, 18], "modul": 18, "which": [18, 19, 20, 21], "can": [18, 21], "pars": 18, "configur": 18, "structur": 18, "instal": 18, "quick": 18, "run": 18, "environ": 18, "register_archive_typ": 18, "archive_pack": 18, "archive_unpack": 18, "get_archive_typ": 18, "get_archive_extnam": 18, "config": [18, 21], "entri": 18, "oper": 18, "util": [18, 21], "here": [19, 20], "import": [19, 20, 21], "o": [19, 20], "platform": [19, 20], "shutil": [19, 20], "cpuinfo": [19, 20], "psutil": [19, 20], "hbutil": [19, 20], "scale": [19, 20], "size_to_bytes_str": [19, 20], "python": [19, 20, 21], "python_implement": [19, 20], "python_vers": [19, 20], "cpu": [19, 20], "brand": [19, 20], "get_cpu_info": [19, 20], "brand_raw": [19, 20], "count": [19, 20], "cpu_count": [19, 20], "freq": [19, 20], "cpu_freq": [19, 20], "mhz": [19, 20], "memori": [19, 20], "virtual_memori": [19, 20], "total": [19, 20], "precis": [19, 20], "3": [19, 20, 21], "cuda": [19, 20], "ye": [19, 20], "nvidia": [19, 20], "smi": [19, 20], "els": [19, 20], "No": [19, 20], "linux": [19, 20], "6": [19, 20], "5": [19, 20], "0": [19, 20, 21], "azur": [19, 20], "x86_64": [19, 20], "glibc2": [19, 20], "34": [19, 20], "cpython": [19, 20], "8": [19, 20, 21], "18": [19, 20], "amd": [19, 20], "epyc": [19, 20], "7763": [19, 20], "64": [19, 20], "core": [19, 20], "processor": [19, 20], "4": [19, 20], "2900": 19, "37975": 19, "15": [19, 20], "606": [19, 20], "gib": [19, 20], "pleas": [19, 20], "note": [19, 20], "deploi": [19, 20], "document": [19, 20, 21], "automat": [19, 20], "execut": [19, 20], "github": [19, 20, 21], "action": [19, 20], "therefor": [19, 20], "some": [19, 20], "data": [19, 20], "mai": [19, 20], "differ": [19, 20], "your": [19, 20, 21], "3172": 20, "7845": 20, "hfutil": 21, "host": 21, "pypi": 21, "requir": 21, "you": 21, "simpli": 21, "follow": 21, "pip": 21, "newest": 21, "u": 21, "git": 21, "http": 21, "com": 21, "deepgh": 21, "script": 21, "__name__": 21, "__main__": 21, "develop": 21, "maintain": 21, "like": 21, "below": 21, "mean": 21, "success": 21, "narugo1992": 21, "huggingfac": 21, "still": 21, "under": 21, "out": 21, "stabl": 21, "index": 21, "html": 21, "faq": 22}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [15, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.utils": [[13, 0, 0, "-", "binary"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "tqdm_"], [17, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[13, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[14, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[16, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[17, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 14], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "util": [13, 14, 15, 16, 17], "binari": 13, "is_binary_fil": 13, "download_fil": 14, "tqdm": 16, "walk": 17, "walk_fil": 17, "welcom": 18, "": 18, "document": 18, "overview": 18, "tutori": 18, "inform": [18, 19, 20], "api": 18, "run": [19, 20], "environ": [19, 20], "instal": 21, "quick": 22, "start": 22}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file": [[13, "is-binary-file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "download_file": [[14, "download-file"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[16, "module-hfutils.utils.tqdm_"]], "tqdm": [[16, "tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files": [[17, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[18, "welcome-to-hfutils-s-documentation"]], "Overview": [[18, "overview"]], "Tutorials": [[18, null]], "Information": [[18, null]], "API Documentation": [[18, null]], "Run Environment Information": [[19, "Run-Environment-Information"], [20, "Run-Environment-Information"]], "Installation": [[21, "installation"]], "Quick Start": [[22, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.utils.binary"], [14, "module-hfutils.utils.download"], [15, "module-hfutils.utils"], [16, "module-hfutils.utils.tqdm_"], [17, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[13, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[14, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[16, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[16, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[17, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.0.2/.buildinfo b/v0.0.2/.buildinfo
index 78fa0d3374..41900e5bf6 100644
--- a/v0.0.2/.buildinfo
+++ b/v0.0.2/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 71ad5dee0dde9a727d16cc1ba8a1c584
+config: a9b6bd57e769f692e6a906615315f311
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.0.2/.doctrees/api_doc/archive/index.doctree b/v0.0.2/.doctrees/api_doc/archive/index.doctree
index 992c5e1dff..69cdaf9825 100644
Binary files a/v0.0.2/.doctrees/api_doc/archive/index.doctree and b/v0.0.2/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/config/index.doctree b/v0.0.2/.doctrees/api_doc/config/index.doctree
index ea8feda61a..00b73740d5 100644
Binary files a/v0.0.2/.doctrees/api_doc/config/index.doctree and b/v0.0.2/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/config/meta.doctree b/v0.0.2/.doctrees/api_doc/config/meta.doctree
index 238ed4dd15..8886e545e8 100644
Binary files a/v0.0.2/.doctrees/api_doc/config/meta.doctree and b/v0.0.2/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/entry/base.doctree b/v0.0.2/.doctrees/api_doc/entry/base.doctree
index 8e6ff474ad..3e8ed44956 100644
Binary files a/v0.0.2/.doctrees/api_doc/entry/base.doctree and b/v0.0.2/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/entry/cli.doctree b/v0.0.2/.doctrees/api_doc/entry/cli.doctree
index ebbdf2f157..f6f79f92bb 100644
Binary files a/v0.0.2/.doctrees/api_doc/entry/cli.doctree and b/v0.0.2/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/entry/dispatch.doctree b/v0.0.2/.doctrees/api_doc/entry/dispatch.doctree
index 912abe1d98..2e9a581e9a 100644
Binary files a/v0.0.2/.doctrees/api_doc/entry/dispatch.doctree and b/v0.0.2/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/entry/download.doctree b/v0.0.2/.doctrees/api_doc/entry/download.doctree
index de0a55b9da..e99df49a9c 100644
Binary files a/v0.0.2/.doctrees/api_doc/entry/download.doctree and b/v0.0.2/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/entry/index.doctree b/v0.0.2/.doctrees/api_doc/entry/index.doctree
index 2d6a2b64d7..d09da4c44a 100644
Binary files a/v0.0.2/.doctrees/api_doc/entry/index.doctree and b/v0.0.2/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/entry/upload.doctree b/v0.0.2/.doctrees/api_doc/entry/upload.doctree
index 0e81be6c87..a6093af383 100644
Binary files a/v0.0.2/.doctrees/api_doc/entry/upload.doctree and b/v0.0.2/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/operate/base.doctree b/v0.0.2/.doctrees/api_doc/operate/base.doctree
index 2cd9873cf2..1af7865037 100644
Binary files a/v0.0.2/.doctrees/api_doc/operate/base.doctree and b/v0.0.2/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/operate/download.doctree b/v0.0.2/.doctrees/api_doc/operate/download.doctree
index 71ee5cae9c..69d2e314a2 100644
Binary files a/v0.0.2/.doctrees/api_doc/operate/download.doctree and b/v0.0.2/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/operate/index.doctree b/v0.0.2/.doctrees/api_doc/operate/index.doctree
index bf970588db..3c495ddb05 100644
Binary files a/v0.0.2/.doctrees/api_doc/operate/index.doctree and b/v0.0.2/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/operate/upload.doctree b/v0.0.2/.doctrees/api_doc/operate/upload.doctree
index 0e0729195c..6463fcf540 100644
Binary files a/v0.0.2/.doctrees/api_doc/operate/upload.doctree and b/v0.0.2/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/utils/binary.doctree b/v0.0.2/.doctrees/api_doc/utils/binary.doctree
index 542ecde3dd..fce7f69753 100644
Binary files a/v0.0.2/.doctrees/api_doc/utils/binary.doctree and b/v0.0.2/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/utils/download.doctree b/v0.0.2/.doctrees/api_doc/utils/download.doctree
index f52c5510ed..9200a28718 100644
Binary files a/v0.0.2/.doctrees/api_doc/utils/download.doctree and b/v0.0.2/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/utils/index.doctree b/v0.0.2/.doctrees/api_doc/utils/index.doctree
index d5f99d1080..9dbb946f23 100644
Binary files a/v0.0.2/.doctrees/api_doc/utils/index.doctree and b/v0.0.2/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/utils/tqdm_.doctree b/v0.0.2/.doctrees/api_doc/utils/tqdm_.doctree
index 7d8b03f97d..0bb799b634 100644
Binary files a/v0.0.2/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.0.2/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.0.2/.doctrees/api_doc/utils/walk.doctree b/v0.0.2/.doctrees/api_doc/utils/walk.doctree
index 75125ec83b..159c9b4125 100644
Binary files a/v0.0.2/.doctrees/api_doc/utils/walk.doctree and b/v0.0.2/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.0.2/.doctrees/environment.pickle b/v0.0.2/.doctrees/environment.pickle
index 40186220b6..c8fd79f4b0 100644
Binary files a/v0.0.2/.doctrees/environment.pickle and b/v0.0.2/.doctrees/environment.pickle differ
diff --git a/v0.0.2/.doctrees/index.doctree b/v0.0.2/.doctrees/index.doctree
index fa9cc8f041..c1285826b9 100644
Binary files a/v0.0.2/.doctrees/index.doctree and b/v0.0.2/.doctrees/index.doctree differ
diff --git a/v0.0.2/.doctrees/information/environment.doctree b/v0.0.2/.doctrees/information/environment.doctree
index 50ae208b93..5644a87111 100644
Binary files a/v0.0.2/.doctrees/information/environment.doctree and b/v0.0.2/.doctrees/information/environment.doctree differ
diff --git a/v0.0.2/.doctrees/information/environment.result.doctree b/v0.0.2/.doctrees/information/environment.result.doctree
index 4d38d9d4a2..d7cc0ad916 100644
Binary files a/v0.0.2/.doctrees/information/environment.result.doctree and b/v0.0.2/.doctrees/information/environment.result.doctree differ
diff --git a/v0.0.2/.doctrees/nbsphinx/information/environment.ipynb b/v0.0.2/.doctrees/nbsphinx/information/environment.ipynb
index 4d3b7ad8b3..371243830e 100644
--- a/v0.0.2/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.0.2/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:27:38.422595Z",
-     "iopub.status.busy": "2024-07-23T17:27:38.422397Z",
-     "iopub.status.idle": "2024-07-23T17:27:39.596694Z",
-     "shell.execute_reply": "2024-07-23T17:27:39.595863Z"
+     "iopub.execute_input": "2024-07-23T17:33:50.123278Z",
+     "iopub.status.busy": "2024-07-23T17:33:50.122860Z",
+     "iopub.status.idle": "2024-07-23T17:33:51.303986Z",
+     "shell.execute_reply": "2024-07-23T17:33:51.303183Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2945.0805 MHz\n",
+      "CPU Freq: 3133.226 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.2/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.0.2/.doctrees/nbsphinx/information/environment.result.ipynb
index b836ef1ff2..644a4ffe8b 100644
--- a/v0.0.2/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.0.2/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:56:21.046594Z",
-     "iopub.status.busy": "2024-07-23T16:56:21.046067Z",
-     "iopub.status.idle": "2024-07-23T16:56:22.222185Z",
-     "shell.execute_reply": "2024-07-23T16:56:22.221385Z"
+     "iopub.execute_input": "2024-07-23T17:01:47.099073Z",
+     "iopub.status.busy": "2024-07-23T17:01:47.098847Z",
+     "iopub.status.idle": "2024-07-23T17:01:48.286181Z",
+     "shell.execute_reply": "2024-07-23T17:01:48.285278Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2920.27075 MHz\n",
+      "CPU Freq: 2967.9514999999997 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.2/.doctrees/tutorials/installation/index.doctree b/v0.0.2/.doctrees/tutorials/installation/index.doctree
index 092f30318e..64d00310b4 100644
Binary files a/v0.0.2/.doctrees/tutorials/installation/index.doctree and b/v0.0.2/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.0.2/.doctrees/tutorials/quick_start/index.doctree b/v0.0.2/.doctrees/tutorials/quick_start/index.doctree
index c214624dfc..d76b35f94b 100644
Binary files a/v0.0.2/.doctrees/tutorials/quick_start/index.doctree and b/v0.0.2/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.0.2/_sources/information/environment.result.ipynb.txt b/v0.0.2/_sources/information/environment.result.ipynb.txt
index b836ef1ff2..644a4ffe8b 100644
--- a/v0.0.2/_sources/information/environment.result.ipynb.txt
+++ b/v0.0.2/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:56:21.046594Z",
-     "iopub.status.busy": "2024-07-23T16:56:21.046067Z",
-     "iopub.status.idle": "2024-07-23T16:56:22.222185Z",
-     "shell.execute_reply": "2024-07-23T16:56:22.221385Z"
+     "iopub.execute_input": "2024-07-23T17:01:47.099073Z",
+     "iopub.status.busy": "2024-07-23T17:01:47.098847Z",
+     "iopub.status.idle": "2024-07-23T17:01:48.286181Z",
+     "shell.execute_reply": "2024-07-23T17:01:48.285278Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2920.27075 MHz\n",
+      "CPU Freq: 2967.9514999999997 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.2/information/environment.html b/v0.0.2/information/environment.html
index 0120d5fbbb..ffd9bde1c4 100644
--- a/v0.0.2/information/environment.html
+++ b/v0.0.2/information/environment.html
@@ -125,11 +125,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2945.0805 MHz
+CPU Freq: 3133.226 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.0.2/information/environment.ipynb b/v0.0.2/information/environment.ipynb
index 4d3b7ad8b3..371243830e 100644
--- a/v0.0.2/information/environment.ipynb
+++ b/v0.0.2/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:27:38.422595Z",
-     "iopub.status.busy": "2024-07-23T17:27:38.422397Z",
-     "iopub.status.idle": "2024-07-23T17:27:39.596694Z",
-     "shell.execute_reply": "2024-07-23T17:27:39.595863Z"
+     "iopub.execute_input": "2024-07-23T17:33:50.123278Z",
+     "iopub.status.busy": "2024-07-23T17:33:50.122860Z",
+     "iopub.status.idle": "2024-07-23T17:33:51.303986Z",
+     "shell.execute_reply": "2024-07-23T17:33:51.303183Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2945.0805 MHz\n",
+      "CPU Freq: 3133.226 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.2/information/environment.result.html b/v0.0.2/information/environment.result.html
index 31dcb7e3fc..4ffd6b7434 100644
--- a/v0.0.2/information/environment.result.html
+++ b/v0.0.2/information/environment.result.html
@@ -127,11 +127,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2920.27075 MHz
+CPU Freq: 2967.9514999999997 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.0.2/information/environment.result.ipynb b/v0.0.2/information/environment.result.ipynb
index b836ef1ff2..644a4ffe8b 100644
--- a/v0.0.2/information/environment.result.ipynb
+++ b/v0.0.2/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:56:21.046594Z",
-     "iopub.status.busy": "2024-07-23T16:56:21.046067Z",
-     "iopub.status.idle": "2024-07-23T16:56:22.222185Z",
-     "shell.execute_reply": "2024-07-23T16:56:22.221385Z"
+     "iopub.execute_input": "2024-07-23T17:01:47.099073Z",
+     "iopub.status.busy": "2024-07-23T17:01:47.098847Z",
+     "iopub.status.idle": "2024-07-23T17:01:48.286181Z",
+     "shell.execute_reply": "2024-07-23T17:01:48.285278Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2920.27075 MHz\n",
+      "CPU Freq: 2967.9514999999997 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.2/searchindex.js b/v0.0.2/searchindex.js
index bcb2a9d915..2840b35a52 100644
--- a/v0.0.2/searchindex.js
+++ b/v0.0.2/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": [0, 18], "support": 0, "format": 0, "extens": 0, "name": [0, 3], "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 16, 17], "associ": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 18], "function": [0, 3, 13, 14, 16], "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 21], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 17], "an": [0, 10, 12, 14, 16, 17], "filenam": [0, 14], "input": 0, "creat": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 14, 16], "bool": [0, 5, 10, 12, 13, 14, 16], "fals": [0, 10, 12, 13, 14, 16], "us": [0, 3, 14, 21], "specifi": [0, 12, 14], "result": 0, "If": [0, 3, 10, 12, 14, 16], "true": [0, 10, 12, 13, 14, 16], "suppress": [0, 10, 12, 14], "warn": [0, 3], "dure": 0, "process": 0, "return": [0, 3, 9, 13, 14, 16, 17], "path": [0, 6, 8, 9, 10, 12, 13, 14, 17], "content": [0, 16], "determin": 0, "base": [0, 7, 11, 18], "rais": 0, "valueerror": 0, "i": [0, 6, 8, 13, 18, 19, 20, 21], "ani": [0, 5, 13], "get": [0, 9, 14], "meta": [1, 18, 21], "__title__": [1, 21], "__version__": [1, 21], "__description__": [1, 21], "__author__": [1, 21], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 13, 14, 16, 19, 20], "project": 2, "should": [2, 14, 21], "version": [2, 5, 16, 18, 21], "short": 2, "descript": [2, 14], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 14, 19, 20, 21], "object": [3, 9, 10, 12, 14], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 17], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 14, 16], "keyword": [3, 14, 16], "argument": [3, 14, 16], "For": 3, "exampl": 3, "one": 3, "1": [3, 19, 20], "two": 3, "2": [3, 21], "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 14, 16], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "code": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 21], "none": [3, 5, 6, 8, 12, 14], "option": [3, 5, 6, 8, 12, 14, 16], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 14, 16, 21], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 19, 20, 21], "traceback": 3, "provid": [3, 14], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 21], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 18], "current": [5, 19, 20, 21], "metadata": 5, "arg": [5, 16], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12], "assign": [6, 8], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 18], "print_vers": 7, "download": [7, 11, 15, 18], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 18], "noremotepathassignedwithupload": 7, "33": 8, "hfapi": 9, "hug": [9, 10, 12], "face": [9, 10, 12], "api": 9, "client": 9, "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12], "repo_typ": [9, 10, 12], "liter": [9, 10, 12], "dataset": [9, 10, 12], "model": [9, 10, 12], "space": [9, 10, 12], "subdir": 9, "revis": [9, 10, 12], "main": [9, 10, 12, 21], "ignore_pattern": [9, 10, 12], "given": [9, 13, 14], "identifi": [9, 10, 12], "repotypetyp": [9, 10, 12], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12], "file_in_repo": [10, 12], "save": [10, 14], "local": [10, 12, 14, 19, 20], "within": [10, 12], "progress": [10, 12, 14, 16], "bar": [10, 12, 14, 16], "local_directori": [10, 12], "archiv": [10, 12, 18], "dir_in_repo": 10, "all": [10, 17], "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "clear": 12, "its": 12, "append": 12, "timestamp": 12, "remov": 12, "present": 12, "check": [13, 14, 21], "read": 13, "first": 13, "1024": 13, "byte": [13, 14], "contain": 13, "non": 13, "text": 13, "charact": 13, "url": 14, "expected_s": 14, "int": 14, "desc": 14, "session": 14, "request": 14, "librari": 14, "tqdm": [14, 15, 18], "It": [14, 21], "also": [14, 21], "perform": [14, 19, 20], "ensur": 14, "ha": [14, 19, 20], "expect": 14, "size": [14, 19, 20], "where": 14, "otherwis": 14, "addit": [14, 16], "pass": [14, 16], "binari": [15, 18], "is_binary_fil": 15, "download_fil": 15, "walk": [15, 18], "walk_fil": 15, "tqdm_": 16, "enhanc": 16, "silenc": 16, "modifi": 16, "behavior": 16, "allow": 16, "posit": 16, "std": 16, "recurs": 17, "through": [17, 21], "yield": 17, "rel": 17, "root": 17, "start": [17, 18], "modul": 18, "which": [18, 19, 20, 21], "can": [18, 21], "pars": 18, "configur": 18, "structur": 18, "instal": 18, "quick": 18, "run": 18, "environ": 18, "register_archive_typ": 18, "archive_pack": 18, "archive_unpack": 18, "get_archive_typ": 18, "get_archive_extnam": 18, "config": [18, 21], "entri": 18, "oper": 18, "util": [18, 21], "here": [19, 20], "import": [19, 20, 21], "o": [19, 20], "platform": [19, 20], "shutil": [19, 20], "cpuinfo": [19, 20], "psutil": [19, 20], "hbutil": [19, 20], "scale": [19, 20], "size_to_bytes_str": [19, 20], "python": [19, 20, 21], "python_implement": [19, 20], "python_vers": [19, 20], "cpu": [19, 20], "brand": [19, 20], "get_cpu_info": [19, 20], "brand_raw": [19, 20], "count": [19, 20], "cpu_count": [19, 20], "freq": [19, 20], "cpu_freq": [19, 20], "mhz": [19, 20], "memori": [19, 20], "virtual_memori": [19, 20], "total": [19, 20], "precis": [19, 20], "3": [19, 20, 21], "cuda": [19, 20], "ye": [19, 20], "nvidia": [19, 20], "smi": [19, 20], "els": [19, 20], "No": [19, 20], "linux": [19, 20], "6": [19, 20], "5": [19, 20], "0": [19, 20, 21], "1023": [19, 20], "azur": [19, 20], "x86_64": [19, 20], "glibc2": [19, 20], "34": [19, 20], "cpython": [19, 20], "8": [19, 20, 21], "18": [19, 20], "amd": [19, 20], "epyc": [19, 20], "7763": [19, 20], "64": [19, 20], "core": [19, 20], "processor": [19, 20], "4": [19, 20], "2945": 19, "0805": 19, "15": [19, 20], "606": [19, 20], "gib": [19, 20], "pleas": [19, 20], "note": [19, 20], "deploi": [19, 20], "document": [19, 20, 21], "automat": [19, 20], "execut": [19, 20], "github": [19, 20, 21], "action": [19, 20], "therefor": [19, 20], "some": [19, 20], "data": [19, 20], "mai": [19, 20], "differ": [19, 20], "your": [19, 20, 21], "2920": 20, "27075": 20, "hfutil": 21, "host": 21, "pypi": 21, "requir": 21, "you": 21, "simpli": 21, "follow": 21, "pip": 21, "newest": 21, "u": 21, "git": 21, "http": 21, "com": 21, "deepgh": 21, "script": 21, "__name__": 21, "__main__": 21, "develop": 21, "maintain": 21, "like": 21, "below": 21, "mean": 21, "success": 21, "narugo1992": 21, "huggingfac": 21, "still": 21, "under": 21, "out": 21, "stabl": 21, "index": 21, "html": 21, "faq": 22}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [15, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.utils": [[13, 0, 0, "-", "binary"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "tqdm_"], [17, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[13, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[14, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[16, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[17, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 14], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "util": [13, 14, 15, 16, 17], "binari": 13, "is_binary_fil": 13, "download_fil": 14, "tqdm": 16, "walk": 17, "walk_fil": 17, "welcom": 18, "": 18, "document": 18, "overview": 18, "tutori": 18, "inform": [18, 19, 20], "api": 18, "run": [19, 20], "environ": [19, 20], "instal": 21, "quick": 22, "start": 22}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file": [[13, "is-binary-file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "download_file": [[14, "download-file"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[16, "module-hfutils.utils.tqdm_"]], "tqdm": [[16, "tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files": [[17, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[18, "welcome-to-hfutils-s-documentation"]], "Overview": [[18, "overview"]], "Tutorials": [[18, null]], "Information": [[18, null]], "API Documentation": [[18, null]], "Run Environment Information": [[19, "Run-Environment-Information"], [20, "Run-Environment-Information"]], "Installation": [[21, "installation"]], "Quick Start": [[22, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.utils.binary"], [14, "module-hfutils.utils.download"], [15, "module-hfutils.utils"], [16, "module-hfutils.utils.tqdm_"], [17, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[13, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[14, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[16, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[16, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[17, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": [0, 18], "support": 0, "format": 0, "extens": 0, "name": [0, 3], "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 16, 17], "associ": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 18], "function": [0, 3, 13, 14, 16], "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 21], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 17], "an": [0, 10, 12, 14, 16, 17], "filenam": [0, 14], "input": 0, "creat": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 14, 16], "bool": [0, 5, 10, 12, 13, 14, 16], "fals": [0, 10, 12, 13, 14, 16], "us": [0, 3, 14, 21], "specifi": [0, 12, 14], "result": 0, "If": [0, 3, 10, 12, 14, 16], "true": [0, 10, 12, 13, 14, 16], "suppress": [0, 10, 12, 14], "warn": [0, 3], "dure": 0, "process": 0, "return": [0, 3, 9, 13, 14, 16, 17], "path": [0, 6, 8, 9, 10, 12, 13, 14, 17], "content": [0, 16], "determin": 0, "base": [0, 7, 11, 18], "rais": 0, "valueerror": 0, "i": [0, 6, 8, 13, 18, 19, 20, 21], "ani": [0, 5, 13], "get": [0, 9, 14], "meta": [1, 18, 21], "__title__": [1, 21], "__version__": [1, 21], "__description__": [1, 21], "__author__": [1, 21], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 13, 14, 16, 19, 20], "project": 2, "should": [2, 14, 21], "version": [2, 5, 16, 18, 21], "short": 2, "descript": [2, 14], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 14, 19, 20, 21], "object": [3, 9, 10, 12, 14], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 17], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 14, 16], "keyword": [3, 14, 16], "argument": [3, 14, 16], "For": 3, "exampl": 3, "one": 3, "1": [3, 19, 20], "two": 3, "2": [3, 21], "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 14, 16], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "code": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 21], "none": [3, 5, 6, 8, 12, 14], "option": [3, 5, 6, 8, 12, 14, 16], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 14, 16, 21], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 19, 20, 21], "traceback": 3, "provid": [3, 14], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 21], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 18], "current": [5, 19, 20, 21], "metadata": 5, "arg": [5, 16], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12], "assign": [6, 8], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 18], "print_vers": 7, "download": [7, 11, 15, 18], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 18], "noremotepathassignedwithupload": 7, "33": 8, "hfapi": 9, "hug": [9, 10, 12], "face": [9, 10, 12], "api": 9, "client": 9, "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12], "repo_typ": [9, 10, 12], "liter": [9, 10, 12], "dataset": [9, 10, 12], "model": [9, 10, 12], "space": [9, 10, 12], "subdir": 9, "revis": [9, 10, 12], "main": [9, 10, 12, 21], "ignore_pattern": [9, 10, 12], "given": [9, 13, 14], "identifi": [9, 10, 12], "repotypetyp": [9, 10, 12], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12], "file_in_repo": [10, 12], "save": [10, 14], "local": [10, 12, 14, 19, 20], "within": [10, 12], "progress": [10, 12, 14, 16], "bar": [10, 12, 14, 16], "local_directori": [10, 12], "archiv": [10, 12, 18], "dir_in_repo": 10, "all": [10, 17], "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "clear": 12, "its": 12, "append": 12, "timestamp": 12, "remov": 12, "present": 12, "check": [13, 14, 21], "read": 13, "first": 13, "1024": [13, 19, 20], "byte": [13, 14], "contain": 13, "non": 13, "text": 13, "charact": 13, "url": 14, "expected_s": 14, "int": 14, "desc": 14, "session": 14, "request": 14, "librari": 14, "tqdm": [14, 15, 18], "It": [14, 21], "also": [14, 21], "perform": [14, 19, 20], "ensur": 14, "ha": [14, 19, 20], "expect": 14, "size": [14, 19, 20], "where": 14, "otherwis": 14, "addit": [14, 16], "pass": [14, 16], "binari": [15, 18], "is_binary_fil": 15, "download_fil": 15, "walk": [15, 18], "walk_fil": 15, "tqdm_": 16, "enhanc": 16, "silenc": 16, "modifi": 16, "behavior": 16, "allow": 16, "posit": 16, "std": 16, "recurs": 17, "through": [17, 21], "yield": 17, "rel": 17, "root": 17, "start": [17, 18], "modul": 18, "which": [18, 19, 20, 21], "can": [18, 21], "pars": 18, "configur": 18, "structur": 18, "instal": 18, "quick": 18, "run": 18, "environ": 18, "register_archive_typ": 18, "archive_pack": 18, "archive_unpack": 18, "get_archive_typ": 18, "get_archive_extnam": 18, "config": [18, 21], "entri": 18, "oper": 18, "util": [18, 21], "here": [19, 20], "import": [19, 20, 21], "o": [19, 20], "platform": [19, 20], "shutil": [19, 20], "cpuinfo": [19, 20], "psutil": [19, 20], "hbutil": [19, 20], "scale": [19, 20], "size_to_bytes_str": [19, 20], "python": [19, 20, 21], "python_implement": [19, 20], "python_vers": [19, 20], "cpu": [19, 20], "brand": [19, 20], "get_cpu_info": [19, 20], "brand_raw": [19, 20], "count": [19, 20], "cpu_count": [19, 20], "freq": [19, 20], "cpu_freq": [19, 20], "mhz": [19, 20], "memori": [19, 20], "virtual_memori": [19, 20], "total": [19, 20], "precis": [19, 20], "3": [19, 20, 21], "cuda": [19, 20], "ye": [19, 20], "nvidia": [19, 20], "smi": [19, 20], "els": [19, 20], "No": [19, 20], "linux": [19, 20], "6": [19, 20], "5": [19, 20], "0": [19, 20, 21], "azur": [19, 20], "x86_64": [19, 20], "glibc2": [19, 20], "34": [19, 20], "cpython": [19, 20], "8": [19, 20, 21], "18": [19, 20], "amd": [19, 20], "epyc": [19, 20], "7763": [19, 20], "64": [19, 20], "core": [19, 20], "processor": [19, 20], "4": [19, 20], "3133": 19, "226": 19, "15": [19, 20], "606": [19, 20], "gib": [19, 20], "pleas": [19, 20], "note": [19, 20], "deploi": [19, 20], "document": [19, 20, 21], "automat": [19, 20], "execut": [19, 20], "github": [19, 20, 21], "action": [19, 20], "therefor": [19, 20], "some": [19, 20], "data": [19, 20], "mai": [19, 20], "differ": [19, 20], "your": [19, 20, 21], "2967": 20, "9514999999997": 20, "hfutil": 21, "host": 21, "pypi": 21, "requir": 21, "you": 21, "simpli": 21, "follow": 21, "pip": 21, "newest": 21, "u": 21, "git": 21, "http": 21, "com": 21, "deepgh": 21, "script": 21, "__name__": 21, "__main__": 21, "develop": 21, "maintain": 21, "like": 21, "below": 21, "mean": 21, "success": 21, "narugo1992": 21, "huggingfac": 21, "still": 21, "under": 21, "out": 21, "stabl": 21, "index": 21, "html": 21, "faq": 22}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [15, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.utils": [[13, 0, 0, "-", "binary"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "tqdm_"], [17, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[13, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[14, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[16, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[17, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 14], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "util": [13, 14, 15, 16, 17], "binari": 13, "is_binary_fil": 13, "download_fil": 14, "tqdm": 16, "walk": 17, "walk_fil": 17, "welcom": 18, "": 18, "document": 18, "overview": 18, "tutori": 18, "inform": [18, 19, 20], "api": 18, "run": [19, 20], "environ": [19, 20], "instal": 21, "quick": 22, "start": 22}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file": [[13, "is-binary-file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "download_file": [[14, "download-file"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[16, "module-hfutils.utils.tqdm_"]], "tqdm": [[16, "tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files": [[17, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[18, "welcome-to-hfutils-s-documentation"]], "Overview": [[18, "overview"]], "Tutorials": [[18, null]], "Information": [[18, null]], "API Documentation": [[18, null]], "Run Environment Information": [[19, "Run-Environment-Information"], [20, "Run-Environment-Information"]], "Installation": [[21, "installation"]], "Quick Start": [[22, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.utils.binary"], [14, "module-hfutils.utils.download"], [15, "module-hfutils.utils"], [16, "module-hfutils.utils.tqdm_"], [17, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[13, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[14, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[16, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[16, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[17, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.0.3/.buildinfo b/v0.0.3/.buildinfo
index 2a8f1c948b..4df519dbd4 100644
--- a/v0.0.3/.buildinfo
+++ b/v0.0.3/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 89d8e0429bc162c373d6e045e4bae719
+config: 2af0c3b381cf762029e38e7c10f0477f
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.0.3/.doctrees/api_doc/archive/index.doctree b/v0.0.3/.doctrees/api_doc/archive/index.doctree
index e2884af4b8..911c96973e 100644
Binary files a/v0.0.3/.doctrees/api_doc/archive/index.doctree and b/v0.0.3/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/config/index.doctree b/v0.0.3/.doctrees/api_doc/config/index.doctree
index 9bb7f547be..2042328386 100644
Binary files a/v0.0.3/.doctrees/api_doc/config/index.doctree and b/v0.0.3/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/config/meta.doctree b/v0.0.3/.doctrees/api_doc/config/meta.doctree
index f785805f4a..3ad284fd83 100644
Binary files a/v0.0.3/.doctrees/api_doc/config/meta.doctree and b/v0.0.3/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/entry/base.doctree b/v0.0.3/.doctrees/api_doc/entry/base.doctree
index 12f21efa46..a5cec60c38 100644
Binary files a/v0.0.3/.doctrees/api_doc/entry/base.doctree and b/v0.0.3/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/entry/cli.doctree b/v0.0.3/.doctrees/api_doc/entry/cli.doctree
index 28202cb4ec..04f5a7f3ac 100644
Binary files a/v0.0.3/.doctrees/api_doc/entry/cli.doctree and b/v0.0.3/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/entry/dispatch.doctree b/v0.0.3/.doctrees/api_doc/entry/dispatch.doctree
index 57658f9073..7925e2dad7 100644
Binary files a/v0.0.3/.doctrees/api_doc/entry/dispatch.doctree and b/v0.0.3/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/entry/download.doctree b/v0.0.3/.doctrees/api_doc/entry/download.doctree
index a1ddec5ae8..e96343706f 100644
Binary files a/v0.0.3/.doctrees/api_doc/entry/download.doctree and b/v0.0.3/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/entry/index.doctree b/v0.0.3/.doctrees/api_doc/entry/index.doctree
index 935b6b6626..9bb02c187a 100644
Binary files a/v0.0.3/.doctrees/api_doc/entry/index.doctree and b/v0.0.3/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/entry/upload.doctree b/v0.0.3/.doctrees/api_doc/entry/upload.doctree
index 447c2e2d71..4a64f6506e 100644
Binary files a/v0.0.3/.doctrees/api_doc/entry/upload.doctree and b/v0.0.3/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/operate/base.doctree b/v0.0.3/.doctrees/api_doc/operate/base.doctree
index bcad483556..8175b4b27b 100644
Binary files a/v0.0.3/.doctrees/api_doc/operate/base.doctree and b/v0.0.3/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/operate/download.doctree b/v0.0.3/.doctrees/api_doc/operate/download.doctree
index 626eddff16..811f1a47ae 100644
Binary files a/v0.0.3/.doctrees/api_doc/operate/download.doctree and b/v0.0.3/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/operate/index.doctree b/v0.0.3/.doctrees/api_doc/operate/index.doctree
index cfcc22e33f..1629606b43 100644
Binary files a/v0.0.3/.doctrees/api_doc/operate/index.doctree and b/v0.0.3/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/operate/upload.doctree b/v0.0.3/.doctrees/api_doc/operate/upload.doctree
index 078d5a1c94..e1727c15c0 100644
Binary files a/v0.0.3/.doctrees/api_doc/operate/upload.doctree and b/v0.0.3/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/utils/binary.doctree b/v0.0.3/.doctrees/api_doc/utils/binary.doctree
index d2eb0f367a..aa8e255f3d 100644
Binary files a/v0.0.3/.doctrees/api_doc/utils/binary.doctree and b/v0.0.3/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/utils/download.doctree b/v0.0.3/.doctrees/api_doc/utils/download.doctree
index ba254ee7f0..2dba59e1d6 100644
Binary files a/v0.0.3/.doctrees/api_doc/utils/download.doctree and b/v0.0.3/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/utils/index.doctree b/v0.0.3/.doctrees/api_doc/utils/index.doctree
index 0009c1c2a3..3fbfd4a1b3 100644
Binary files a/v0.0.3/.doctrees/api_doc/utils/index.doctree and b/v0.0.3/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/utils/tqdm_.doctree b/v0.0.3/.doctrees/api_doc/utils/tqdm_.doctree
index 151991a68f..a2af3d3765 100644
Binary files a/v0.0.3/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.0.3/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.0.3/.doctrees/api_doc/utils/walk.doctree b/v0.0.3/.doctrees/api_doc/utils/walk.doctree
index 4b03d44e2b..e670b2e692 100644
Binary files a/v0.0.3/.doctrees/api_doc/utils/walk.doctree and b/v0.0.3/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.0.3/.doctrees/environment.pickle b/v0.0.3/.doctrees/environment.pickle
index ea5ab8833d..17cdbdf5eb 100644
Binary files a/v0.0.3/.doctrees/environment.pickle and b/v0.0.3/.doctrees/environment.pickle differ
diff --git a/v0.0.3/.doctrees/index.doctree b/v0.0.3/.doctrees/index.doctree
index d58bff7e4d..ed7c299ca8 100644
Binary files a/v0.0.3/.doctrees/index.doctree and b/v0.0.3/.doctrees/index.doctree differ
diff --git a/v0.0.3/.doctrees/information/environment.doctree b/v0.0.3/.doctrees/information/environment.doctree
index e90bea18b6..d5a3d70e06 100644
Binary files a/v0.0.3/.doctrees/information/environment.doctree and b/v0.0.3/.doctrees/information/environment.doctree differ
diff --git a/v0.0.3/.doctrees/information/environment.result.doctree b/v0.0.3/.doctrees/information/environment.result.doctree
index 4be2431ce6..1b102ca33e 100644
Binary files a/v0.0.3/.doctrees/information/environment.result.doctree and b/v0.0.3/.doctrees/information/environment.result.doctree differ
diff --git a/v0.0.3/.doctrees/nbsphinx/information/environment.ipynb b/v0.0.3/.doctrees/nbsphinx/information/environment.ipynb
index 00bc74412d..4a84ceccc8 100644
--- a/v0.0.3/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.0.3/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:29:54.191670Z",
-     "iopub.status.busy": "2024-07-23T17:29:54.191472Z",
-     "iopub.status.idle": "2024-07-23T17:29:55.364218Z",
-     "shell.execute_reply": "2024-07-23T17:29:55.363366Z"
+     "iopub.execute_input": "2024-07-23T17:36:04.488664Z",
+     "iopub.status.busy": "2024-07-23T17:36:04.488187Z",
+     "iopub.status.idle": "2024-07-23T17:36:05.656808Z",
+     "shell.execute_reply": "2024-07-23T17:36:05.656052Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2915.277 MHz\n",
+      "CPU Freq: 2763.21475 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.3/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.0.3/.doctrees/nbsphinx/information/environment.result.ipynb
index 3ca35e5c35..140a9558e6 100644
--- a/v0.0.3/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.0.3/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:57:29.160461Z",
-     "iopub.status.busy": "2024-07-23T16:57:29.160261Z",
-     "iopub.status.idle": "2024-07-23T16:57:30.335192Z",
-     "shell.execute_reply": "2024-07-23T16:57:30.334431Z"
+     "iopub.execute_input": "2024-07-23T17:02:56.388295Z",
+     "iopub.status.busy": "2024-07-23T17:02:56.387710Z",
+     "iopub.status.idle": "2024-07-23T17:02:57.564066Z",
+     "shell.execute_reply": "2024-07-23T17:02:57.563320Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 3111.18725 MHz\n",
+      "CPU Freq: 2778.7972499999996 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.3/.doctrees/tutorials/installation/index.doctree b/v0.0.3/.doctrees/tutorials/installation/index.doctree
index 1af6e56553..9160ab2502 100644
Binary files a/v0.0.3/.doctrees/tutorials/installation/index.doctree and b/v0.0.3/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.0.3/.doctrees/tutorials/quick_start/index.doctree b/v0.0.3/.doctrees/tutorials/quick_start/index.doctree
index d331fcca85..11733f98bf 100644
Binary files a/v0.0.3/.doctrees/tutorials/quick_start/index.doctree and b/v0.0.3/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.0.3/_sources/information/environment.result.ipynb.txt b/v0.0.3/_sources/information/environment.result.ipynb.txt
index 3ca35e5c35..140a9558e6 100644
--- a/v0.0.3/_sources/information/environment.result.ipynb.txt
+++ b/v0.0.3/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:57:29.160461Z",
-     "iopub.status.busy": "2024-07-23T16:57:29.160261Z",
-     "iopub.status.idle": "2024-07-23T16:57:30.335192Z",
-     "shell.execute_reply": "2024-07-23T16:57:30.334431Z"
+     "iopub.execute_input": "2024-07-23T17:02:56.388295Z",
+     "iopub.status.busy": "2024-07-23T17:02:56.387710Z",
+     "iopub.status.idle": "2024-07-23T17:02:57.564066Z",
+     "shell.execute_reply": "2024-07-23T17:02:57.563320Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 3111.18725 MHz\n",
+      "CPU Freq: 2778.7972499999996 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.3/information/environment.html b/v0.0.3/information/environment.html
index 797d6deb3d..4ca7640e75 100644
--- a/v0.0.3/information/environment.html
+++ b/v0.0.3/information/environment.html
@@ -125,11 +125,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2915.277 MHz
+CPU Freq: 2763.21475 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.0.3/information/environment.ipynb b/v0.0.3/information/environment.ipynb
index 00bc74412d..4a84ceccc8 100644
--- a/v0.0.3/information/environment.ipynb
+++ b/v0.0.3/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:29:54.191670Z",
-     "iopub.status.busy": "2024-07-23T17:29:54.191472Z",
-     "iopub.status.idle": "2024-07-23T17:29:55.364218Z",
-     "shell.execute_reply": "2024-07-23T17:29:55.363366Z"
+     "iopub.execute_input": "2024-07-23T17:36:04.488664Z",
+     "iopub.status.busy": "2024-07-23T17:36:04.488187Z",
+     "iopub.status.idle": "2024-07-23T17:36:05.656808Z",
+     "shell.execute_reply": "2024-07-23T17:36:05.656052Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2915.277 MHz\n",
+      "CPU Freq: 2763.21475 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.3/information/environment.result.html b/v0.0.3/information/environment.result.html
index c916acc0e4..0ba151ec71 100644
--- a/v0.0.3/information/environment.result.html
+++ b/v0.0.3/information/environment.result.html
@@ -127,11 +127,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 3111.18725 MHz
+CPU Freq: 2778.7972499999996 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.0.3/information/environment.result.ipynb b/v0.0.3/information/environment.result.ipynb
index 3ca35e5c35..140a9558e6 100644
--- a/v0.0.3/information/environment.result.ipynb
+++ b/v0.0.3/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:57:29.160461Z",
-     "iopub.status.busy": "2024-07-23T16:57:29.160261Z",
-     "iopub.status.idle": "2024-07-23T16:57:30.335192Z",
-     "shell.execute_reply": "2024-07-23T16:57:30.334431Z"
+     "iopub.execute_input": "2024-07-23T17:02:56.388295Z",
+     "iopub.status.busy": "2024-07-23T17:02:56.387710Z",
+     "iopub.status.idle": "2024-07-23T17:02:57.564066Z",
+     "shell.execute_reply": "2024-07-23T17:02:57.563320Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 3111.18725 MHz\n",
+      "CPU Freq: 2778.7972499999996 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.3/searchindex.js b/v0.0.3/searchindex.js
index 49b34d8eb6..cda15b0c25 100644
--- a/v0.0.3/searchindex.js
+++ b/v0.0.3/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": [0, 18], "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 14, 16], "you": [0, 21], "requir": [0, 21], "simpli": [0, 21], "instal": [0, 18], "us": [0, 3, 14, 21], "follow": [0, 21], "code": [0, 3, 6, 8], "pip": [0, 21], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 21], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 18], "i": [0, 6, 8, 10, 13, 18, 19, 20, 21], "we": 0, "util": [0, 18, 21], "rarfil": 0, "librari": [0, 14], "which": [0, 18, 19, 20, 21], "doe": 0, "offer": 0, "function": [0, 3, 13, 14, 16], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 16, 17], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 17], "an": [0, 10, 12, 14, 16, 17], "filenam": [0, 14], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 14, 16], "bool": [0, 5, 10, 12, 13, 14, 16], "fals": [0, 10, 12, 13, 14, 16], "specifi": [0, 12, 14], "result": 0, "true": [0, 10, 12, 13, 14, 16], "suppress": [0, 10, 12, 14], "warn": [0, 3], "dure": 0, "process": 0, "return": [0, 3, 9, 13, 14, 16, 17], "path": [0, 6, 8, 9, 10, 12, 13, 14, 17], "content": [0, 16], "determin": 0, "base": [0, 7, 11, 18], "rais": 0, "valueerror": 0, "ani": [0, 5, 13], "get": [0, 9, 14], "meta": [1, 18, 21], "__title__": [1, 21], "__version__": [1, 21], "__description__": [1, 21], "__author__": [1, 21], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 13, 14, 16, 19, 20], "project": 2, "should": [2, 14, 21], "version": [2, 5, 16, 18, 21], "short": 2, "descript": [2, 14], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 14, 19, 20, 21], "object": [3, 9, 10, 12, 14], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 17], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 14, 16], "keyword": [3, 14, 16], "argument": [3, 14, 16], "For": 3, "exampl": 3, "one": 3, "1": [3, 19, 20], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 14, 16], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 21], "none": [3, 5, 6, 8, 12, 14], "option": [3, 5, 6, 8, 12, 14, 16], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 14, 16, 21], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 19, 20, 21], "traceback": 3, "provid": [3, 14], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 21], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 18], "current": [5, 19, 20, 21], "metadata": 5, "arg": [5, 16], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12], "assign": [6, 8], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 18], "print_vers": 7, "download": [7, 11, 15, 18], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 18], "noremotepathassignedwithupload": 7, "33": 8, "hfapi": 9, "hug": [9, 10, 12], "face": [9, 10, 12], "api": 9, "client": 9, "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12], "repo_typ": [9, 10, 12], "liter": [9, 10, 12], "dataset": [9, 10, 12], "model": [9, 10, 12], "space": [9, 10, 12], "subdir": 9, "revis": [9, 10, 12], "main": [9, 10, 12, 21], "ignore_pattern": [9, 10, 12], "given": [9, 13, 14], "identifi": [9, 10, 12], "repotypetyp": [9, 10, 12], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12], "file_in_repo": [10, 12], "resume_download": 10, "save": [10, 14], "local": [10, 12, 14, 19, 20], "within": [10, 12], "resum": 10, "exist": 10, "local_directori": [10, 12], "archiv": [10, 12, 18], "dir_in_repo": 10, "max_work": 10, "int": [10, 14], "8": [10, 19, 20, 21], "all": [10, 17], "progress": [10, 12, 14, 16], "bar": [10, 12, 14, 16], "max": 10, "worker": 10, "when": 10, "default": 10, "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "clear": 12, "its": 12, "append": 12, "timestamp": 12, "remov": 12, "present": 12, "check": [13, 14, 21], "read": 13, "first": 13, "1024": 13, "byte": [13, 14], "contain": 13, "non": 13, "text": 13, "charact": 13, "url": 14, "expected_s": 14, "desc": 14, "session": 14, "request": 14, "tqdm": [14, 15, 18], "It": [14, 21], "also": [14, 21], "perform": [14, 19, 20], "ensur": 14, "ha": [14, 19, 20], "expect": 14, "size": [14, 19, 20], "where": 14, "otherwis": 14, "addit": [14, 16], "pass": [14, 16], "binari": [15, 18], "is_binary_fil": 15, "download_fil": 15, "walk": [15, 18], "walk_fil": 15, "tqdm_": 16, "enhanc": 16, "silenc": 16, "modifi": 16, "behavior": 16, "allow": 16, "posit": 16, "std": 16, "recurs": 17, "through": [17, 21], "yield": 17, "rel": 17, "root": 17, "start": [17, 18], "modul": 18, "can": [18, 21], "pars": 18, "configur": 18, "structur": 18, "quick": 18, "run": 18, "environ": 18, "register_archive_typ": 18, "archive_pack": 18, "archive_unpack": 18, "get_archive_typ": 18, "get_archive_extnam": 18, "config": [18, 21], "entri": 18, "oper": 18, "here": [19, 20], "import": [19, 20, 21], "o": [19, 20], "platform": [19, 20], "shutil": [19, 20], "cpuinfo": [19, 20], "psutil": [19, 20], "hbutil": [19, 20], "scale": [19, 20], "size_to_bytes_str": [19, 20], "python": [19, 20, 21], "python_implement": [19, 20], "python_vers": [19, 20], "cpu": [19, 20], "brand": [19, 20], "get_cpu_info": [19, 20], "brand_raw": [19, 20], "count": [19, 20], "cpu_count": [19, 20], "freq": [19, 20], "cpu_freq": [19, 20], "mhz": [19, 20], "memori": [19, 20], "virtual_memori": [19, 20], "total": [19, 20], "precis": [19, 20], "3": [19, 20, 21], "cuda": [19, 20], "ye": [19, 20], "nvidia": [19, 20], "smi": [19, 20], "els": [19, 20], "No": [19, 20], "linux": [19, 20], "6": [19, 20], "5": [19, 20], "0": [19, 20, 21], "1023": [19, 20], "azur": [19, 20], "x86_64": [19, 20], "glibc2": [19, 20], "34": [19, 20], "cpython": [19, 20], "18": [19, 20], "amd": [19, 20], "epyc": [19, 20], "7763": [19, 20], "64": [19, 20], "core": [19, 20], "processor": [19, 20], "4": [19, 20], "2915": 19, "277": 19, "15": [19, 20], "606": [19, 20], "gib": [19, 20], "pleas": [19, 20], "note": [19, 20], "deploi": [19, 20], "document": [19, 20, 21], "automat": [19, 20], "execut": [19, 20], "github": [19, 20, 21], "action": [19, 20], "therefor": [19, 20], "some": [19, 20], "data": [19, 20], "mai": [19, 20], "differ": [19, 20], "your": [19, 20, 21], "3111": 20, "18725": 20, "hfutil": 21, "host": 21, "pypi": 21, "newest": 21, "u": 21, "git": 21, "http": 21, "com": 21, "deepgh": 21, "script": 21, "__name__": 21, "__main__": 21, "develop": 21, "maintain": 21, "like": 21, "below": 21, "mean": 21, "success": 21, "narugo1992": 21, "huggingfac": 21, "still": 21, "under": 21, "out": 21, "stabl": 21, "index": 21, "html": 21, "faq": 22}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [15, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.utils": [[13, 0, 0, "-", "binary"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "tqdm_"], [17, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[13, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[14, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[16, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[17, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 14], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "util": [13, 14, 15, 16, 17], "binari": 13, "is_binary_fil": 13, "download_fil": 14, "tqdm": 16, "walk": 17, "walk_fil": 17, "welcom": 18, "": 18, "document": 18, "overview": 18, "tutori": 18, "inform": [18, 19, 20], "api": 18, "run": [19, 20], "environ": [19, 20], "instal": 21, "quick": 22, "start": 22}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file": [[13, "is-binary-file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "download_file": [[14, "download-file"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[16, "module-hfutils.utils.tqdm_"]], "tqdm": [[16, "tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files": [[17, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[18, "welcome-to-hfutils-s-documentation"]], "Overview": [[18, "overview"]], "Tutorials": [[18, null]], "Information": [[18, null]], "API Documentation": [[18, null]], "Run Environment Information": [[19, "Run-Environment-Information"], [20, "Run-Environment-Information"]], "Installation": [[21, "installation"]], "Quick Start": [[22, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.utils.binary"], [14, "module-hfutils.utils.download"], [15, "module-hfutils.utils"], [16, "module-hfutils.utils.tqdm_"], [17, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[13, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[14, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[16, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[16, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[17, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": [0, 18], "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 14, 16], "you": [0, 21], "requir": [0, 21], "simpli": [0, 21], "instal": [0, 18], "us": [0, 3, 14, 21], "follow": [0, 21], "code": [0, 3, 6, 8], "pip": [0, 21], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 21], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 18], "i": [0, 6, 8, 10, 13, 18, 19, 20, 21], "we": 0, "util": [0, 18, 21], "rarfil": 0, "librari": [0, 14], "which": [0, 18, 19, 20, 21], "doe": 0, "offer": 0, "function": [0, 3, 13, 14, 16], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 16, 17], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 17], "an": [0, 10, 12, 14, 16, 17], "filenam": [0, 14], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 14, 16], "bool": [0, 5, 10, 12, 13, 14, 16], "fals": [0, 10, 12, 13, 14, 16], "specifi": [0, 12, 14], "result": 0, "true": [0, 10, 12, 13, 14, 16], "suppress": [0, 10, 12, 14], "warn": [0, 3], "dure": 0, "process": 0, "return": [0, 3, 9, 13, 14, 16, 17], "path": [0, 6, 8, 9, 10, 12, 13, 14, 17], "content": [0, 16], "determin": 0, "base": [0, 7, 11, 18], "rais": 0, "valueerror": 0, "ani": [0, 5, 13], "get": [0, 9, 14], "meta": [1, 18, 21], "__title__": [1, 21], "__version__": [1, 21], "__description__": [1, 21], "__author__": [1, 21], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 13, 14, 16, 19, 20], "project": 2, "should": [2, 14, 21], "version": [2, 5, 16, 18, 21], "short": 2, "descript": [2, 14], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 14, 19, 20, 21], "object": [3, 9, 10, 12, 14], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 17], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 14, 16], "keyword": [3, 14, 16], "argument": [3, 14, 16], "For": 3, "exampl": 3, "one": 3, "1": [3, 19, 20], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 14, 16], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 21], "none": [3, 5, 6, 8, 12, 14], "option": [3, 5, 6, 8, 12, 14, 16], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 14, 16, 21], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 19, 20, 21], "traceback": 3, "provid": [3, 14], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 21], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 18], "current": [5, 19, 20, 21], "metadata": 5, "arg": [5, 16], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12], "assign": [6, 8], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 18], "print_vers": 7, "download": [7, 11, 15, 18], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 18], "noremotepathassignedwithupload": 7, "33": 8, "hfapi": 9, "hug": [9, 10, 12], "face": [9, 10, 12], "api": 9, "client": 9, "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12], "repo_typ": [9, 10, 12], "liter": [9, 10, 12], "dataset": [9, 10, 12], "model": [9, 10, 12], "space": [9, 10, 12], "subdir": 9, "revis": [9, 10, 12], "main": [9, 10, 12, 21], "ignore_pattern": [9, 10, 12], "given": [9, 13, 14], "identifi": [9, 10, 12], "repotypetyp": [9, 10, 12], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12], "file_in_repo": [10, 12], "resume_download": 10, "save": [10, 14], "local": [10, 12, 14, 19, 20], "within": [10, 12], "resum": 10, "exist": 10, "local_directori": [10, 12], "archiv": [10, 12, 18], "dir_in_repo": 10, "max_work": 10, "int": [10, 14], "8": [10, 19, 20, 21], "all": [10, 17], "progress": [10, 12, 14, 16], "bar": [10, 12, 14, 16], "max": 10, "worker": 10, "when": 10, "default": 10, "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "clear": 12, "its": 12, "append": 12, "timestamp": 12, "remov": 12, "present": 12, "check": [13, 14, 21], "read": 13, "first": 13, "1024": [13, 19, 20], "byte": [13, 14], "contain": 13, "non": 13, "text": 13, "charact": 13, "url": 14, "expected_s": 14, "desc": 14, "session": 14, "request": 14, "tqdm": [14, 15, 18], "It": [14, 21], "also": [14, 21], "perform": [14, 19, 20], "ensur": 14, "ha": [14, 19, 20], "expect": 14, "size": [14, 19, 20], "where": 14, "otherwis": 14, "addit": [14, 16], "pass": [14, 16], "binari": [15, 18], "is_binary_fil": 15, "download_fil": 15, "walk": [15, 18], "walk_fil": 15, "tqdm_": 16, "enhanc": 16, "silenc": 16, "modifi": 16, "behavior": 16, "allow": 16, "posit": 16, "std": 16, "recurs": 17, "through": [17, 21], "yield": 17, "rel": 17, "root": 17, "start": [17, 18], "modul": 18, "can": [18, 21], "pars": 18, "configur": 18, "structur": 18, "quick": 18, "run": 18, "environ": 18, "register_archive_typ": 18, "archive_pack": 18, "archive_unpack": 18, "get_archive_typ": 18, "get_archive_extnam": 18, "config": [18, 21], "entri": 18, "oper": 18, "here": [19, 20], "import": [19, 20, 21], "o": [19, 20], "platform": [19, 20], "shutil": [19, 20], "cpuinfo": [19, 20], "psutil": [19, 20], "hbutil": [19, 20], "scale": [19, 20], "size_to_bytes_str": [19, 20], "python": [19, 20, 21], "python_implement": [19, 20], "python_vers": [19, 20], "cpu": [19, 20], "brand": [19, 20], "get_cpu_info": [19, 20], "brand_raw": [19, 20], "count": [19, 20], "cpu_count": [19, 20], "freq": [19, 20], "cpu_freq": [19, 20], "mhz": [19, 20], "memori": [19, 20], "virtual_memori": [19, 20], "total": [19, 20], "precis": [19, 20], "3": [19, 20, 21], "cuda": [19, 20], "ye": [19, 20], "nvidia": [19, 20], "smi": [19, 20], "els": [19, 20], "No": [19, 20], "linux": [19, 20], "6": [19, 20], "5": [19, 20], "0": [19, 20, 21], "azur": [19, 20], "x86_64": [19, 20], "glibc2": [19, 20], "34": [19, 20], "cpython": [19, 20], "18": [19, 20], "amd": [19, 20], "epyc": [19, 20], "7763": [19, 20], "64": [19, 20], "core": [19, 20], "processor": [19, 20], "4": [19, 20], "2763": 19, "21475": 19, "15": [19, 20], "606": [19, 20], "gib": [19, 20], "pleas": [19, 20], "note": [19, 20], "deploi": [19, 20], "document": [19, 20, 21], "automat": [19, 20], "execut": [19, 20], "github": [19, 20, 21], "action": [19, 20], "therefor": [19, 20], "some": [19, 20], "data": [19, 20], "mai": [19, 20], "differ": [19, 20], "your": [19, 20, 21], "2778": 20, "7972499999996": 20, "hfutil": 21, "host": 21, "pypi": 21, "newest": 21, "u": 21, "git": 21, "http": 21, "com": 21, "deepgh": 21, "script": 21, "__name__": 21, "__main__": 21, "develop": 21, "maintain": 21, "like": 21, "below": 21, "mean": 21, "success": 21, "narugo1992": 21, "huggingfac": 21, "still": 21, "under": 21, "out": 21, "stabl": 21, "index": 21, "html": 21, "faq": 22}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [15, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.utils": [[13, 0, 0, "-", "binary"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "tqdm_"], [17, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[13, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[14, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[16, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[17, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 14], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "util": [13, 14, 15, 16, 17], "binari": 13, "is_binary_fil": 13, "download_fil": 14, "tqdm": 16, "walk": 17, "walk_fil": 17, "welcom": 18, "": 18, "document": 18, "overview": 18, "tutori": 18, "inform": [18, 19, 20], "api": 18, "run": [19, 20], "environ": [19, 20], "instal": 21, "quick": 22, "start": 22}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file": [[13, "is-binary-file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "download_file": [[14, "download-file"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[16, "module-hfutils.utils.tqdm_"]], "tqdm": [[16, "tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files": [[17, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[18, "welcome-to-hfutils-s-documentation"]], "Overview": [[18, "overview"]], "Tutorials": [[18, null]], "Information": [[18, null]], "API Documentation": [[18, null]], "Run Environment Information": [[19, "Run-Environment-Information"], [20, "Run-Environment-Information"]], "Installation": [[21, "installation"]], "Quick Start": [[22, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.utils.binary"], [14, "module-hfutils.utils.download"], [15, "module-hfutils.utils"], [16, "module-hfutils.utils.tqdm_"], [17, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[13, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[14, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[16, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[16, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[17, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.0.4/.buildinfo b/v0.0.4/.buildinfo
index 30c22e9aec..1ca98e6356 100644
--- a/v0.0.4/.buildinfo
+++ b/v0.0.4/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 29eb4960980c61cbd65cd23944383e29
+config: 62de88040d3b633abe8933cfcbdeafe9
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.0.4/.doctrees/api_doc/archive/index.doctree b/v0.0.4/.doctrees/api_doc/archive/index.doctree
index 1b6bb2c25a..a7624bf6a5 100644
Binary files a/v0.0.4/.doctrees/api_doc/archive/index.doctree and b/v0.0.4/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/config/index.doctree b/v0.0.4/.doctrees/api_doc/config/index.doctree
index 240dd0482d..4a99e03909 100644
Binary files a/v0.0.4/.doctrees/api_doc/config/index.doctree and b/v0.0.4/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/config/meta.doctree b/v0.0.4/.doctrees/api_doc/config/meta.doctree
index c7f1e762fe..c4cb9ef0d1 100644
Binary files a/v0.0.4/.doctrees/api_doc/config/meta.doctree and b/v0.0.4/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/entry/base.doctree b/v0.0.4/.doctrees/api_doc/entry/base.doctree
index d629d3d218..2b07a254a5 100644
Binary files a/v0.0.4/.doctrees/api_doc/entry/base.doctree and b/v0.0.4/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/entry/cli.doctree b/v0.0.4/.doctrees/api_doc/entry/cli.doctree
index 648050713d..5ecd34f716 100644
Binary files a/v0.0.4/.doctrees/api_doc/entry/cli.doctree and b/v0.0.4/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/entry/dispatch.doctree b/v0.0.4/.doctrees/api_doc/entry/dispatch.doctree
index f0b94480af..7a7e7e04d0 100644
Binary files a/v0.0.4/.doctrees/api_doc/entry/dispatch.doctree and b/v0.0.4/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/entry/download.doctree b/v0.0.4/.doctrees/api_doc/entry/download.doctree
index 588443b697..fcb92feff2 100644
Binary files a/v0.0.4/.doctrees/api_doc/entry/download.doctree and b/v0.0.4/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/entry/index.doctree b/v0.0.4/.doctrees/api_doc/entry/index.doctree
index aa741029ac..39487fd280 100644
Binary files a/v0.0.4/.doctrees/api_doc/entry/index.doctree and b/v0.0.4/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/entry/upload.doctree b/v0.0.4/.doctrees/api_doc/entry/upload.doctree
index 681498b159..1505a06740 100644
Binary files a/v0.0.4/.doctrees/api_doc/entry/upload.doctree and b/v0.0.4/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/operate/base.doctree b/v0.0.4/.doctrees/api_doc/operate/base.doctree
index 6bd4bc8a39..2f40acdcaa 100644
Binary files a/v0.0.4/.doctrees/api_doc/operate/base.doctree and b/v0.0.4/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/operate/download.doctree b/v0.0.4/.doctrees/api_doc/operate/download.doctree
index d68a2d88d6..c06e215b5a 100644
Binary files a/v0.0.4/.doctrees/api_doc/operate/download.doctree and b/v0.0.4/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/operate/index.doctree b/v0.0.4/.doctrees/api_doc/operate/index.doctree
index 99888c26f3..935fbf5ad5 100644
Binary files a/v0.0.4/.doctrees/api_doc/operate/index.doctree and b/v0.0.4/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/operate/upload.doctree b/v0.0.4/.doctrees/api_doc/operate/upload.doctree
index 2cddf1b991..aa6a946af0 100644
Binary files a/v0.0.4/.doctrees/api_doc/operate/upload.doctree and b/v0.0.4/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/utils/binary.doctree b/v0.0.4/.doctrees/api_doc/utils/binary.doctree
index 0561b904a0..b482dc8271 100644
Binary files a/v0.0.4/.doctrees/api_doc/utils/binary.doctree and b/v0.0.4/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/utils/download.doctree b/v0.0.4/.doctrees/api_doc/utils/download.doctree
index 78e3cd5b01..0cbffc2913 100644
Binary files a/v0.0.4/.doctrees/api_doc/utils/download.doctree and b/v0.0.4/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/utils/index.doctree b/v0.0.4/.doctrees/api_doc/utils/index.doctree
index ad13e67e7a..92b97c18af 100644
Binary files a/v0.0.4/.doctrees/api_doc/utils/index.doctree and b/v0.0.4/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/utils/tqdm_.doctree b/v0.0.4/.doctrees/api_doc/utils/tqdm_.doctree
index 9e86774b25..371fa27bb1 100644
Binary files a/v0.0.4/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.0.4/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.0.4/.doctrees/api_doc/utils/walk.doctree b/v0.0.4/.doctrees/api_doc/utils/walk.doctree
index f6d9e82931..17770e3916 100644
Binary files a/v0.0.4/.doctrees/api_doc/utils/walk.doctree and b/v0.0.4/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.0.4/.doctrees/environment.pickle b/v0.0.4/.doctrees/environment.pickle
index bdadf441d4..9e6233a2e2 100644
Binary files a/v0.0.4/.doctrees/environment.pickle and b/v0.0.4/.doctrees/environment.pickle differ
diff --git a/v0.0.4/.doctrees/index.doctree b/v0.0.4/.doctrees/index.doctree
index f4c73c0ee0..6884fd913a 100644
Binary files a/v0.0.4/.doctrees/index.doctree and b/v0.0.4/.doctrees/index.doctree differ
diff --git a/v0.0.4/.doctrees/information/environment.doctree b/v0.0.4/.doctrees/information/environment.doctree
index 6efd58b0be..1989799c5b 100644
Binary files a/v0.0.4/.doctrees/information/environment.doctree and b/v0.0.4/.doctrees/information/environment.doctree differ
diff --git a/v0.0.4/.doctrees/information/environment.result.doctree b/v0.0.4/.doctrees/information/environment.result.doctree
index d2c714c6bb..1e2d544eac 100644
Binary files a/v0.0.4/.doctrees/information/environment.result.doctree and b/v0.0.4/.doctrees/information/environment.result.doctree differ
diff --git a/v0.0.4/.doctrees/nbsphinx/information/environment.ipynb b/v0.0.4/.doctrees/nbsphinx/information/environment.ipynb
index 497b872d4e..b5b2dcaea5 100644
--- a/v0.0.4/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.0.4/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:32:11.557733Z",
-     "iopub.status.busy": "2024-07-23T17:32:11.557528Z",
-     "iopub.status.idle": "2024-07-23T17:32:12.733302Z",
-     "shell.execute_reply": "2024-07-23T17:32:12.732467Z"
+     "iopub.execute_input": "2024-07-23T17:38:19.049185Z",
+     "iopub.status.busy": "2024-07-23T17:38:19.048700Z",
+     "iopub.status.idle": "2024-07-23T17:38:20.219567Z",
+     "shell.execute_reply": "2024-07-23T17:38:20.218794Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2712.0215 MHz\n",
+      "CPU Freq: 2919.152 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.4/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.0.4/.doctrees/nbsphinx/information/environment.result.ipynb
index 06ebae7ee2..8b1f131db9 100644
--- a/v0.0.4/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.0.4/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:58:36.895393Z",
-     "iopub.status.busy": "2024-07-23T16:58:36.895194Z",
-     "iopub.status.idle": "2024-07-23T16:58:38.066086Z",
-     "shell.execute_reply": "2024-07-23T16:58:38.065403Z"
+     "iopub.execute_input": "2024-07-23T17:04:04.883816Z",
+     "iopub.status.busy": "2024-07-23T17:04:04.883604Z",
+     "iopub.status.idle": "2024-07-23T17:04:06.058426Z",
+     "shell.execute_reply": "2024-07-23T17:04:06.057609Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2997.6805 MHz\n",
+      "CPU Freq: 2801.194 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.4/.doctrees/tutorials/installation/index.doctree b/v0.0.4/.doctrees/tutorials/installation/index.doctree
index 8865faa568..77e071e41c 100644
Binary files a/v0.0.4/.doctrees/tutorials/installation/index.doctree and b/v0.0.4/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.0.4/.doctrees/tutorials/quick_start/index.doctree b/v0.0.4/.doctrees/tutorials/quick_start/index.doctree
index 380de6296c..866e2cca41 100644
Binary files a/v0.0.4/.doctrees/tutorials/quick_start/index.doctree and b/v0.0.4/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.0.4/_sources/information/environment.result.ipynb.txt b/v0.0.4/_sources/information/environment.result.ipynb.txt
index 06ebae7ee2..8b1f131db9 100644
--- a/v0.0.4/_sources/information/environment.result.ipynb.txt
+++ b/v0.0.4/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:58:36.895393Z",
-     "iopub.status.busy": "2024-07-23T16:58:36.895194Z",
-     "iopub.status.idle": "2024-07-23T16:58:38.066086Z",
-     "shell.execute_reply": "2024-07-23T16:58:38.065403Z"
+     "iopub.execute_input": "2024-07-23T17:04:04.883816Z",
+     "iopub.status.busy": "2024-07-23T17:04:04.883604Z",
+     "iopub.status.idle": "2024-07-23T17:04:06.058426Z",
+     "shell.execute_reply": "2024-07-23T17:04:06.057609Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2997.6805 MHz\n",
+      "CPU Freq: 2801.194 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.4/information/environment.html b/v0.0.4/information/environment.html
index cd6e7334ba..19473d47e6 100644
--- a/v0.0.4/information/environment.html
+++ b/v0.0.4/information/environment.html
@@ -125,11 +125,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2712.0215 MHz
+CPU Freq: 2919.152 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.0.4/information/environment.ipynb b/v0.0.4/information/environment.ipynb
index 497b872d4e..b5b2dcaea5 100644
--- a/v0.0.4/information/environment.ipynb
+++ b/v0.0.4/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:32:11.557733Z",
-     "iopub.status.busy": "2024-07-23T17:32:11.557528Z",
-     "iopub.status.idle": "2024-07-23T17:32:12.733302Z",
-     "shell.execute_reply": "2024-07-23T17:32:12.732467Z"
+     "iopub.execute_input": "2024-07-23T17:38:19.049185Z",
+     "iopub.status.busy": "2024-07-23T17:38:19.048700Z",
+     "iopub.status.idle": "2024-07-23T17:38:20.219567Z",
+     "shell.execute_reply": "2024-07-23T17:38:20.218794Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2712.0215 MHz\n",
+      "CPU Freq: 2919.152 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.4/information/environment.result.html b/v0.0.4/information/environment.result.html
index 3cd9bcdfc2..67711bcef2 100644
--- a/v0.0.4/information/environment.result.html
+++ b/v0.0.4/information/environment.result.html
@@ -127,11 +127,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2997.6805 MHz
+CPU Freq: 2801.194 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.0.4/information/environment.result.ipynb b/v0.0.4/information/environment.result.ipynb
index 06ebae7ee2..8b1f131db9 100644
--- a/v0.0.4/information/environment.result.ipynb
+++ b/v0.0.4/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:58:36.895393Z",
-     "iopub.status.busy": "2024-07-23T16:58:36.895194Z",
-     "iopub.status.idle": "2024-07-23T16:58:38.066086Z",
-     "shell.execute_reply": "2024-07-23T16:58:38.065403Z"
+     "iopub.execute_input": "2024-07-23T17:04:04.883816Z",
+     "iopub.status.busy": "2024-07-23T17:04:04.883604Z",
+     "iopub.status.idle": "2024-07-23T17:04:06.058426Z",
+     "shell.execute_reply": "2024-07-23T17:04:06.057609Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2997.6805 MHz\n",
+      "CPU Freq: 2801.194 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.4/searchindex.js b/v0.0.4/searchindex.js
index c62a175010..509c0365d4 100644
--- a/v0.0.4/searchindex.js
+++ b/v0.0.4/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": [0, 18], "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 14, 16], "you": [0, 21], "requir": [0, 21], "simpli": [0, 21], "instal": [0, 18], "us": [0, 3, 14, 21], "follow": [0, 21], "code": [0, 3, 6, 8], "pip": [0, 21], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 21], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 18], "i": [0, 6, 8, 10, 13, 18, 19, 20, 21], "we": 0, "util": [0, 18, 21], "rarfil": 0, "librari": [0, 14], "which": [0, 18, 19, 20, 21], "doe": 0, "offer": 0, "function": [0, 3, 13, 14, 16], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 16, 17], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 17], "an": [0, 10, 12, 14, 16, 17], "filenam": [0, 14], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 14, 16], "bool": [0, 5, 10, 12, 13, 14, 16], "fals": [0, 10, 12, 13, 14, 16], "specifi": [0, 12, 14], "result": 0, "true": [0, 10, 12, 13, 14, 16], "suppress": [0, 10, 12, 14], "warn": [0, 3], "dure": 0, "process": 0, "return": [0, 3, 9, 13, 14, 16, 17], "path": [0, 6, 8, 9, 10, 12, 13, 14, 17], "content": [0, 16], "determin": 0, "base": [0, 7, 11, 18], "rais": 0, "valueerror": 0, "ani": [0, 5, 13], "get": [0, 9, 14], "meta": [1, 18, 21], "__title__": [1, 21], "__version__": [1, 21], "__description__": [1, 21], "__author__": [1, 21], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 13, 14, 16, 19, 20], "project": 2, "should": [2, 14, 21], "version": [2, 5, 16, 18, 21], "short": 2, "descript": [2, 14], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 14, 19, 20, 21], "object": [3, 9, 10, 12, 14], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 17], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 14, 16], "keyword": [3, 14, 16], "argument": [3, 14, 16], "For": 3, "exampl": 3, "one": 3, "1": [3, 19, 20], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 14, 16], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 21], "none": [3, 5, 6, 8, 12, 14], "option": [3, 5, 6, 8, 12, 14, 16], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 14, 16, 21], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 19, 20, 21], "traceback": 3, "provid": [3, 14], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 21], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 18], "current": [5, 19, 20, 21], "metadata": 5, "arg": [5, 16], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12], "assign": [6, 8], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 18], "print_vers": 7, "download": [7, 11, 15, 18], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 18], "noremotepathassignedwithupload": 7, "33": 8, "hfapi": 9, "hug": [9, 10, 12], "face": [9, 10, 12], "api": 9, "client": 9, "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12], "repo_typ": [9, 10, 12], "liter": [9, 10, 12], "dataset": [9, 10, 12], "model": [9, 10, 12], "space": [9, 10, 12], "subdir": 9, "revis": [9, 10, 12], "main": [9, 10, 12, 21], "ignore_pattern": [9, 10, 12], "given": [9, 13, 14], "identifi": [9, 10, 12], "repotypetyp": [9, 10, 12], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12], "file_in_repo": [10, 12], "resume_download": 10, "save": [10, 14], "local": [10, 12, 14, 19, 20], "within": [10, 12], "resum": 10, "exist": 10, "local_directori": [10, 12], "archiv": [10, 12, 18], "dir_in_repo": 10, "max_work": 10, "int": [10, 14], "8": [10, 19, 20, 21], "all": [10, 17], "progress": [10, 12, 14, 16], "bar": [10, 12, 14, 16], "max": 10, "worker": 10, "when": 10, "default": 10, "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "clear": 12, "its": 12, "append": 12, "timestamp": 12, "remov": 12, "present": 12, "check": [13, 14, 21], "read": 13, "first": 13, "1024": 13, "byte": [13, 14], "contain": 13, "non": 13, "text": 13, "charact": 13, "url": 14, "expected_s": 14, "desc": 14, "session": 14, "request": 14, "tqdm": [14, 15, 18], "It": [14, 21], "also": [14, 21], "perform": [14, 19, 20], "ensur": 14, "ha": [14, 19, 20], "expect": 14, "size": [14, 19, 20], "where": 14, "otherwis": 14, "addit": [14, 16], "pass": [14, 16], "binari": [15, 18], "is_binary_fil": 15, "download_fil": 15, "walk": [15, 18], "walk_fil": 15, "tqdm_": 16, "enhanc": 16, "silenc": 16, "modifi": 16, "behavior": 16, "allow": 16, "posit": 16, "std": 16, "recurs": 17, "through": [17, 21], "yield": 17, "rel": 17, "root": 17, "start": [17, 18], "modul": 18, "can": [18, 21], "pars": 18, "configur": 18, "structur": 18, "quick": 18, "run": 18, "environ": 18, "register_archive_typ": 18, "archive_pack": 18, "archive_unpack": 18, "get_archive_typ": 18, "get_archive_extnam": 18, "config": [18, 21], "entri": 18, "oper": 18, "here": [19, 20], "import": [19, 20, 21], "o": [19, 20], "platform": [19, 20], "shutil": [19, 20], "cpuinfo": [19, 20], "psutil": [19, 20], "hbutil": [19, 20], "scale": [19, 20], "size_to_bytes_str": [19, 20], "python": [19, 20, 21], "python_implement": [19, 20], "python_vers": [19, 20], "cpu": [19, 20], "brand": [19, 20], "get_cpu_info": [19, 20], "brand_raw": [19, 20], "count": [19, 20], "cpu_count": [19, 20], "freq": [19, 20], "cpu_freq": [19, 20], "mhz": [19, 20], "memori": [19, 20], "virtual_memori": [19, 20], "total": [19, 20], "precis": [19, 20], "3": [19, 20, 21], "cuda": [19, 20], "ye": [19, 20], "nvidia": [19, 20], "smi": [19, 20], "els": [19, 20], "No": [19, 20], "linux": [19, 20], "6": [19, 20], "5": [19, 20], "0": [19, 20, 21], "1023": [19, 20], "azur": [19, 20], "x86_64": [19, 20], "glibc2": [19, 20], "34": [19, 20], "cpython": [19, 20], "18": [19, 20], "amd": [19, 20], "epyc": [19, 20], "7763": [19, 20], "64": [19, 20], "core": [19, 20], "processor": [19, 20], "4": [19, 20, 21], "2712": 19, "0215": 19, "15": [19, 20], "606": [19, 20], "gib": [19, 20], "pleas": [19, 20], "note": [19, 20], "deploi": [19, 20], "document": [19, 20, 21], "automat": [19, 20], "execut": [19, 20], "github": [19, 20, 21], "action": [19, 20], "therefor": [19, 20], "some": [19, 20], "data": [19, 20], "mai": [19, 20], "differ": [19, 20], "your": [19, 20, 21], "2997": 20, "6805": 20, "hfutil": 21, "host": 21, "pypi": 21, "newest": 21, "u": 21, "git": 21, "http": 21, "com": 21, "deepgh": 21, "script": 21, "__name__": 21, "__main__": 21, "develop": 21, "maintain": 21, "like": 21, "below": 21, "mean": 21, "success": 21, "narugo1992": 21, "huggingfac": 21, "still": 21, "under": 21, "out": 21, "stabl": 21, "index": 21, "html": 21, "faq": 22}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [15, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.utils": [[13, 0, 0, "-", "binary"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "tqdm_"], [17, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[13, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[14, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[16, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[17, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 14], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "util": [13, 14, 15, 16, 17], "binari": 13, "is_binary_fil": 13, "download_fil": 14, "tqdm": 16, "walk": 17, "walk_fil": 17, "welcom": 18, "": 18, "document": 18, "overview": 18, "tutori": 18, "inform": [18, 19, 20], "api": 18, "run": [19, 20], "environ": [19, 20], "instal": 21, "quick": 22, "start": 22}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file": [[13, "is-binary-file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "download_file": [[14, "download-file"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[16, "module-hfutils.utils.tqdm_"]], "tqdm": [[16, "tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files": [[17, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[18, "welcome-to-hfutils-s-documentation"]], "Overview": [[18, "overview"]], "Tutorials": [[18, null]], "Information": [[18, null]], "API Documentation": [[18, null]], "Run Environment Information": [[19, "Run-Environment-Information"], [20, "Run-Environment-Information"]], "Installation": [[21, "installation"]], "Quick Start": [[22, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.utils.binary"], [14, "module-hfutils.utils.download"], [15, "module-hfutils.utils"], [16, "module-hfutils.utils.tqdm_"], [17, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[13, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[14, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[16, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[16, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[17, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": [0, 18], "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 14, 16], "you": [0, 21], "requir": [0, 21], "simpli": [0, 21], "instal": [0, 18], "us": [0, 3, 14, 21], "follow": [0, 21], "code": [0, 3, 6, 8], "pip": [0, 21], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 21], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 18], "i": [0, 6, 8, 10, 13, 18, 19, 20, 21], "we": 0, "util": [0, 18, 21], "rarfil": 0, "librari": [0, 14], "which": [0, 18, 19, 20, 21], "doe": 0, "offer": 0, "function": [0, 3, 13, 14, 16], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 16, 17], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 17], "an": [0, 10, 12, 14, 16, 17], "filenam": [0, 14], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 14, 16], "bool": [0, 5, 10, 12, 13, 14, 16], "fals": [0, 10, 12, 13, 14, 16], "specifi": [0, 12, 14], "result": 0, "true": [0, 10, 12, 13, 14, 16], "suppress": [0, 10, 12, 14], "warn": [0, 3], "dure": 0, "process": 0, "return": [0, 3, 9, 13, 14, 16, 17], "path": [0, 6, 8, 9, 10, 12, 13, 14, 17], "content": [0, 16], "determin": 0, "base": [0, 7, 11, 18], "rais": 0, "valueerror": 0, "ani": [0, 5, 13], "get": [0, 9, 14], "meta": [1, 18, 21], "__title__": [1, 21], "__version__": [1, 21], "__description__": [1, 21], "__author__": [1, 21], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 13, 14, 16, 19, 20], "project": 2, "should": [2, 14, 21], "version": [2, 5, 16, 18, 21], "short": 2, "descript": [2, 14], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 14, 19, 20, 21], "object": [3, 9, 10, 12, 14], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 17], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 14, 16], "keyword": [3, 14, 16], "argument": [3, 14, 16], "For": 3, "exampl": 3, "one": 3, "1": [3, 19, 20], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 14, 16], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 21], "none": [3, 5, 6, 8, 12, 14], "option": [3, 5, 6, 8, 12, 14, 16], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 14, 16, 21], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 19, 20, 21], "traceback": 3, "provid": [3, 14], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 21], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 18], "current": [5, 19, 20, 21], "metadata": 5, "arg": [5, 16], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12], "assign": [6, 8], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 18], "print_vers": 7, "download": [7, 11, 15, 18], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 18], "noremotepathassignedwithupload": 7, "33": 8, "hfapi": 9, "hug": [9, 10, 12], "face": [9, 10, 12], "api": 9, "client": 9, "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12], "repo_typ": [9, 10, 12], "liter": [9, 10, 12], "dataset": [9, 10, 12], "model": [9, 10, 12], "space": [9, 10, 12], "subdir": 9, "revis": [9, 10, 12], "main": [9, 10, 12, 21], "ignore_pattern": [9, 10, 12], "given": [9, 13, 14], "identifi": [9, 10, 12], "repotypetyp": [9, 10, 12], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12], "file_in_repo": [10, 12], "resume_download": 10, "save": [10, 14], "local": [10, 12, 14, 19, 20], "within": [10, 12], "resum": 10, "exist": 10, "local_directori": [10, 12], "archiv": [10, 12, 18], "dir_in_repo": 10, "max_work": 10, "int": [10, 14], "8": [10, 19, 20, 21], "all": [10, 17], "progress": [10, 12, 14, 16], "bar": [10, 12, 14, 16], "max": 10, "worker": 10, "when": 10, "default": 10, "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "clear": 12, "its": 12, "append": 12, "timestamp": 12, "remov": 12, "present": 12, "check": [13, 14, 21], "read": 13, "first": 13, "1024": [13, 19, 20], "byte": [13, 14], "contain": 13, "non": 13, "text": 13, "charact": 13, "url": 14, "expected_s": 14, "desc": 14, "session": 14, "request": 14, "tqdm": [14, 15, 18], "It": [14, 21], "also": [14, 21], "perform": [14, 19, 20], "ensur": 14, "ha": [14, 19, 20], "expect": 14, "size": [14, 19, 20], "where": 14, "otherwis": 14, "addit": [14, 16], "pass": [14, 16], "binari": [15, 18], "is_binary_fil": 15, "download_fil": 15, "walk": [15, 18], "walk_fil": 15, "tqdm_": 16, "enhanc": 16, "silenc": 16, "modifi": 16, "behavior": 16, "allow": 16, "posit": 16, "std": 16, "recurs": 17, "through": [17, 21], "yield": 17, "rel": 17, "root": 17, "start": [17, 18], "modul": 18, "can": [18, 21], "pars": 18, "configur": 18, "structur": 18, "quick": 18, "run": 18, "environ": 18, "register_archive_typ": 18, "archive_pack": 18, "archive_unpack": 18, "get_archive_typ": 18, "get_archive_extnam": 18, "config": [18, 21], "entri": 18, "oper": 18, "here": [19, 20], "import": [19, 20, 21], "o": [19, 20], "platform": [19, 20], "shutil": [19, 20], "cpuinfo": [19, 20], "psutil": [19, 20], "hbutil": [19, 20], "scale": [19, 20], "size_to_bytes_str": [19, 20], "python": [19, 20, 21], "python_implement": [19, 20], "python_vers": [19, 20], "cpu": [19, 20], "brand": [19, 20], "get_cpu_info": [19, 20], "brand_raw": [19, 20], "count": [19, 20], "cpu_count": [19, 20], "freq": [19, 20], "cpu_freq": [19, 20], "mhz": [19, 20], "memori": [19, 20], "virtual_memori": [19, 20], "total": [19, 20], "precis": [19, 20], "3": [19, 20, 21], "cuda": [19, 20], "ye": [19, 20], "nvidia": [19, 20], "smi": [19, 20], "els": [19, 20], "No": [19, 20], "linux": [19, 20], "6": [19, 20], "5": [19, 20], "0": [19, 20, 21], "azur": [19, 20], "x86_64": [19, 20], "glibc2": [19, 20], "34": [19, 20], "cpython": [19, 20], "18": [19, 20], "amd": [19, 20], "epyc": [19, 20], "7763": [19, 20], "64": [19, 20], "core": [19, 20], "processor": [19, 20], "4": [19, 20, 21], "2919": 19, "152": 19, "15": [19, 20], "606": [19, 20], "gib": [19, 20], "pleas": [19, 20], "note": [19, 20], "deploi": [19, 20], "document": [19, 20, 21], "automat": [19, 20], "execut": [19, 20], "github": [19, 20, 21], "action": [19, 20], "therefor": [19, 20], "some": [19, 20], "data": [19, 20], "mai": [19, 20], "differ": [19, 20], "your": [19, 20, 21], "2801": 20, "194": 20, "hfutil": 21, "host": 21, "pypi": 21, "newest": 21, "u": 21, "git": 21, "http": 21, "com": 21, "deepgh": 21, "script": 21, "__name__": 21, "__main__": 21, "develop": 21, "maintain": 21, "like": 21, "below": 21, "mean": 21, "success": 21, "narugo1992": 21, "huggingfac": 21, "still": 21, "under": 21, "out": 21, "stabl": 21, "index": 21, "html": 21, "faq": 22}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [15, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.utils": [[13, 0, 0, "-", "binary"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "tqdm_"], [17, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[13, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[14, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[16, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[17, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 14], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "util": [13, 14, 15, 16, 17], "binari": 13, "is_binary_fil": 13, "download_fil": 14, "tqdm": 16, "walk": 17, "walk_fil": 17, "welcom": 18, "": 18, "document": 18, "overview": 18, "tutori": 18, "inform": [18, 19, 20], "api": 18, "run": [19, 20], "environ": [19, 20], "instal": 21, "quick": 22, "start": 22}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file": [[13, "is-binary-file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "download_file": [[14, "download-file"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[16, "module-hfutils.utils.tqdm_"]], "tqdm": [[16, "tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files": [[17, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[18, "welcome-to-hfutils-s-documentation"]], "Overview": [[18, "overview"]], "Tutorials": [[18, null]], "Information": [[18, null]], "API Documentation": [[18, null]], "Run Environment Information": [[19, "Run-Environment-Information"], [20, "Run-Environment-Information"]], "Installation": [[21, "installation"]], "Quick Start": [[22, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.utils.binary"], [14, "module-hfutils.utils.download"], [15, "module-hfutils.utils"], [16, "module-hfutils.utils.tqdm_"], [17, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[13, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[14, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[16, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[16, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[17, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.0.5/.buildinfo b/v0.0.5/.buildinfo
index b6ceb6e40f..784d665572 100644
--- a/v0.0.5/.buildinfo
+++ b/v0.0.5/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d970182c3df78b3b2631e1eba9c8fd1a
+config: 10f02a2f25ef7ed23dd4ecb5bcde1180
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.0.5/.doctrees/api_doc/archive/index.doctree b/v0.0.5/.doctrees/api_doc/archive/index.doctree
index 7e6425d234..b81543a779 100644
Binary files a/v0.0.5/.doctrees/api_doc/archive/index.doctree and b/v0.0.5/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/config/index.doctree b/v0.0.5/.doctrees/api_doc/config/index.doctree
index 6c68eeb62d..725c7ae2c7 100644
Binary files a/v0.0.5/.doctrees/api_doc/config/index.doctree and b/v0.0.5/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/config/meta.doctree b/v0.0.5/.doctrees/api_doc/config/meta.doctree
index 9397fbc419..a5034fa63f 100644
Binary files a/v0.0.5/.doctrees/api_doc/config/meta.doctree and b/v0.0.5/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/entry/base.doctree b/v0.0.5/.doctrees/api_doc/entry/base.doctree
index 75393ce166..15aa861800 100644
Binary files a/v0.0.5/.doctrees/api_doc/entry/base.doctree and b/v0.0.5/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/entry/cli.doctree b/v0.0.5/.doctrees/api_doc/entry/cli.doctree
index 4755d2e314..e7680caef5 100644
Binary files a/v0.0.5/.doctrees/api_doc/entry/cli.doctree and b/v0.0.5/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/entry/dispatch.doctree b/v0.0.5/.doctrees/api_doc/entry/dispatch.doctree
index c632bffff1..a3d7a3544e 100644
Binary files a/v0.0.5/.doctrees/api_doc/entry/dispatch.doctree and b/v0.0.5/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/entry/download.doctree b/v0.0.5/.doctrees/api_doc/entry/download.doctree
index 6eeeb450c2..c4389f85f2 100644
Binary files a/v0.0.5/.doctrees/api_doc/entry/download.doctree and b/v0.0.5/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/entry/index.doctree b/v0.0.5/.doctrees/api_doc/entry/index.doctree
index 2dcf8cca0e..7f2512b3d4 100644
Binary files a/v0.0.5/.doctrees/api_doc/entry/index.doctree and b/v0.0.5/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/entry/upload.doctree b/v0.0.5/.doctrees/api_doc/entry/upload.doctree
index 068a1d2960..3c4f2cc4f5 100644
Binary files a/v0.0.5/.doctrees/api_doc/entry/upload.doctree and b/v0.0.5/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/operate/base.doctree b/v0.0.5/.doctrees/api_doc/operate/base.doctree
index 064efefe04..552ff2b1a5 100644
Binary files a/v0.0.5/.doctrees/api_doc/operate/base.doctree and b/v0.0.5/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/operate/download.doctree b/v0.0.5/.doctrees/api_doc/operate/download.doctree
index 7284d989c3..fde7624a47 100644
Binary files a/v0.0.5/.doctrees/api_doc/operate/download.doctree and b/v0.0.5/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/operate/index.doctree b/v0.0.5/.doctrees/api_doc/operate/index.doctree
index 4a496e7f4e..eadc039c9a 100644
Binary files a/v0.0.5/.doctrees/api_doc/operate/index.doctree and b/v0.0.5/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/operate/upload.doctree b/v0.0.5/.doctrees/api_doc/operate/upload.doctree
index ff112434bc..05626c53b1 100644
Binary files a/v0.0.5/.doctrees/api_doc/operate/upload.doctree and b/v0.0.5/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/utils/binary.doctree b/v0.0.5/.doctrees/api_doc/utils/binary.doctree
index 8ffc62b04d..c5b05485e4 100644
Binary files a/v0.0.5/.doctrees/api_doc/utils/binary.doctree and b/v0.0.5/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/utils/download.doctree b/v0.0.5/.doctrees/api_doc/utils/download.doctree
index eafcf810ca..107cf991b1 100644
Binary files a/v0.0.5/.doctrees/api_doc/utils/download.doctree and b/v0.0.5/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/utils/index.doctree b/v0.0.5/.doctrees/api_doc/utils/index.doctree
index af0ff62255..30cf21f454 100644
Binary files a/v0.0.5/.doctrees/api_doc/utils/index.doctree and b/v0.0.5/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/utils/tqdm_.doctree b/v0.0.5/.doctrees/api_doc/utils/tqdm_.doctree
index 870909fead..b5ee24f85b 100644
Binary files a/v0.0.5/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.0.5/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.0.5/.doctrees/api_doc/utils/walk.doctree b/v0.0.5/.doctrees/api_doc/utils/walk.doctree
index 5c9975bf4a..60882142dd 100644
Binary files a/v0.0.5/.doctrees/api_doc/utils/walk.doctree and b/v0.0.5/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.0.5/.doctrees/environment.pickle b/v0.0.5/.doctrees/environment.pickle
index a31ac04780..4b0a6b1d49 100644
Binary files a/v0.0.5/.doctrees/environment.pickle and b/v0.0.5/.doctrees/environment.pickle differ
diff --git a/v0.0.5/.doctrees/index.doctree b/v0.0.5/.doctrees/index.doctree
index 70c58ddcf1..ecd4e8499a 100644
Binary files a/v0.0.5/.doctrees/index.doctree and b/v0.0.5/.doctrees/index.doctree differ
diff --git a/v0.0.5/.doctrees/information/environment.doctree b/v0.0.5/.doctrees/information/environment.doctree
index 028be33503..09a7cf4cc2 100644
Binary files a/v0.0.5/.doctrees/information/environment.doctree and b/v0.0.5/.doctrees/information/environment.doctree differ
diff --git a/v0.0.5/.doctrees/information/environment.result.doctree b/v0.0.5/.doctrees/information/environment.result.doctree
index 74315767a1..2e1575d76b 100644
Binary files a/v0.0.5/.doctrees/information/environment.result.doctree and b/v0.0.5/.doctrees/information/environment.result.doctree differ
diff --git a/v0.0.5/.doctrees/nbsphinx/information/environment.ipynb b/v0.0.5/.doctrees/nbsphinx/information/environment.ipynb
index 21d8624b2e..47e8492443 100644
--- a/v0.0.5/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.0.5/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:34:28.116286Z",
-     "iopub.status.busy": "2024-07-23T17:34:28.115863Z",
-     "iopub.status.idle": "2024-07-23T17:34:29.281318Z",
-     "shell.execute_reply": "2024-07-23T17:34:29.280529Z"
+     "iopub.execute_input": "2024-07-23T17:40:33.728668Z",
+     "iopub.status.busy": "2024-07-23T17:40:33.728460Z",
+     "iopub.status.idle": "2024-07-23T17:40:34.897430Z",
+     "shell.execute_reply": "2024-07-23T17:40:34.896592Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2923.8280000000004 MHz\n",
+      "CPU Freq: 2919.3250000000003 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.5/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.0.5/.doctrees/nbsphinx/information/environment.result.ipynb
index 894dd1d995..75a5284b1d 100644
--- a/v0.0.5/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.0.5/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:59:44.025544Z",
-     "iopub.status.busy": "2024-07-23T16:59:44.024942Z",
-     "iopub.status.idle": "2024-07-23T16:59:45.199479Z",
-     "shell.execute_reply": "2024-07-23T16:59:45.198748Z"
+     "iopub.execute_input": "2024-07-23T17:05:13.655955Z",
+     "iopub.status.busy": "2024-07-23T17:05:13.655397Z",
+     "iopub.status.idle": "2024-07-23T17:05:14.832128Z",
+     "shell.execute_reply": "2024-07-23T17:05:14.831368Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2736.407 MHz\n",
+      "CPU Freq: 2915.2210000000005 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.5/.doctrees/tutorials/installation/index.doctree b/v0.0.5/.doctrees/tutorials/installation/index.doctree
index 3a5f6659a4..076dfddd91 100644
Binary files a/v0.0.5/.doctrees/tutorials/installation/index.doctree and b/v0.0.5/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.0.5/.doctrees/tutorials/quick_start/index.doctree b/v0.0.5/.doctrees/tutorials/quick_start/index.doctree
index 91bfa1c0d9..6c707e9348 100644
Binary files a/v0.0.5/.doctrees/tutorials/quick_start/index.doctree and b/v0.0.5/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.0.5/_sources/information/environment.result.ipynb.txt b/v0.0.5/_sources/information/environment.result.ipynb.txt
index 894dd1d995..75a5284b1d 100644
--- a/v0.0.5/_sources/information/environment.result.ipynb.txt
+++ b/v0.0.5/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:59:44.025544Z",
-     "iopub.status.busy": "2024-07-23T16:59:44.024942Z",
-     "iopub.status.idle": "2024-07-23T16:59:45.199479Z",
-     "shell.execute_reply": "2024-07-23T16:59:45.198748Z"
+     "iopub.execute_input": "2024-07-23T17:05:13.655955Z",
+     "iopub.status.busy": "2024-07-23T17:05:13.655397Z",
+     "iopub.status.idle": "2024-07-23T17:05:14.832128Z",
+     "shell.execute_reply": "2024-07-23T17:05:14.831368Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2736.407 MHz\n",
+      "CPU Freq: 2915.2210000000005 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.5/information/environment.html b/v0.0.5/information/environment.html
index 943c735173..28b6c0406d 100644
--- a/v0.0.5/information/environment.html
+++ b/v0.0.5/information/environment.html
@@ -125,11 +125,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2923.8280000000004 MHz
+CPU Freq: 2919.3250000000003 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.0.5/information/environment.ipynb b/v0.0.5/information/environment.ipynb
index 21d8624b2e..47e8492443 100644
--- a/v0.0.5/information/environment.ipynb
+++ b/v0.0.5/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:34:28.116286Z",
-     "iopub.status.busy": "2024-07-23T17:34:28.115863Z",
-     "iopub.status.idle": "2024-07-23T17:34:29.281318Z",
-     "shell.execute_reply": "2024-07-23T17:34:29.280529Z"
+     "iopub.execute_input": "2024-07-23T17:40:33.728668Z",
+     "iopub.status.busy": "2024-07-23T17:40:33.728460Z",
+     "iopub.status.idle": "2024-07-23T17:40:34.897430Z",
+     "shell.execute_reply": "2024-07-23T17:40:34.896592Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2923.8280000000004 MHz\n",
+      "CPU Freq: 2919.3250000000003 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.5/information/environment.result.html b/v0.0.5/information/environment.result.html
index cca3551e46..d5ece76c46 100644
--- a/v0.0.5/information/environment.result.html
+++ b/v0.0.5/information/environment.result.html
@@ -127,11 +127,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2736.407 MHz
+CPU Freq: 2915.2210000000005 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.0.5/information/environment.result.ipynb b/v0.0.5/information/environment.result.ipynb
index 894dd1d995..75a5284b1d 100644
--- a/v0.0.5/information/environment.result.ipynb
+++ b/v0.0.5/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T16:59:44.025544Z",
-     "iopub.status.busy": "2024-07-23T16:59:44.024942Z",
-     "iopub.status.idle": "2024-07-23T16:59:45.199479Z",
-     "shell.execute_reply": "2024-07-23T16:59:45.198748Z"
+     "iopub.execute_input": "2024-07-23T17:05:13.655955Z",
+     "iopub.status.busy": "2024-07-23T17:05:13.655397Z",
+     "iopub.status.idle": "2024-07-23T17:05:14.832128Z",
+     "shell.execute_reply": "2024-07-23T17:05:14.831368Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2736.407 MHz\n",
+      "CPU Freq: 2915.2210000000005 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.5/searchindex.js b/v0.0.5/searchindex.js
index 3484f1c5d9..80d820dc8c 100644
--- a/v0.0.5/searchindex.js
+++ b/v0.0.5/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 14, 16], "you": [0, 21], "requir": [0, 21], "simpli": [0, 21], "instal": [0, 18], "us": [0, 3, 9, 10, 12, 14, 18, 21], "follow": [0, 21], "code": [0, 3, 6, 8], "pip": [0, 21], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 21], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "i": [0, 6, 8, 10, 13, 18, 19, 20, 21], "we": 0, "util": [0, 18, 21], "rarfil": 0, "librari": [0, 14], "which": [0, 19, 20, 21], "doe": 0, "offer": 0, "function": [0, 3, 13, 14, 16], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 16, 17], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 17], "an": [0, 10, 12, 14, 16, 17], "filenam": [0, 14], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 14, 16], "bool": [0, 5, 10, 12, 13, 14, 16], "fals": [0, 10, 12, 13, 14, 16], "specifi": [0, 12, 14], "result": 0, "true": [0, 10, 12, 13, 14, 16], "suppress": [0, 10, 12, 14], "warn": [0, 3], "dure": 0, "process": 0, "return": [0, 3, 9, 13, 14, 16, 17], "path": [0, 6, 8, 9, 10, 12, 13, 14, 17], "password": [0, 10], "none": [0, 3, 5, 6, 8, 9, 10, 12, 14], "content": [0, 16], "option": [0, 3, 5, 6, 8, 9, 10, 12, 14, 16], "determin": 0, "base": [0, 7, 11, 18], "rais": 0, "valueerror": 0, "ani": [0, 5, 13], "get": [0, 9, 14], "meta": [1, 18, 21], "__title__": [1, 21], "__version__": [1, 21], "__description__": [1, 21], "__author__": [1, 21], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 13, 14, 16, 19, 20], "project": 2, "should": [2, 14, 21], "version": [2, 5, 16, 21], "short": 2, "descript": [2, 14], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 14, 19, 20, 21], "object": [3, 9, 10, 12, 14], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 17], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 14, 16], "keyword": [3, 14, 16], "argument": [3, 14, 16], "For": 3, "exampl": 3, "one": 3, "1": [3, 19, 20], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 14, 16], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 21], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 14, 16, 21], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 19, 20, 21], "traceback": 3, "provid": [3, 14], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 21], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 18], "current": [5, 19, 20, 21], "metadata": 5, "arg": [5, 16], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12], "assign": [6, 8, 9, 10, 12], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 18], "print_vers": 7, "download": [7, 11, 15, 18], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 18], "noremotepathassignedwithupload": 7, "33": 8, "hf_token": [9, 10, 12], "hfapi": 9, "hug": [9, 10, 12], "face": [9, 10, 12], "api": [9, 10, 12], "client": [9, 10, 12], "huggingfac": [9, 10, 12, 18, 21], "token": [9, 10, 12], "variabl": [9, 10, 12], "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12], "repo_typ": [9, 10, 12], "liter": [9, 10, 12], "dataset": [9, 10, 12], "model": [9, 10, 12], "space": [9, 10, 12], "subdir": 9, "revis": [9, 10, 12], "main": [9, 10, 12, 21], "ignore_pattern": [9, 10, 12], "given": [9, 13, 14], "identifi": [9, 10, 12], "repotypetyp": [9, 10, 12], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12], "file_in_repo": [10, 12], "resume_download": 10, "save": [10, 14], "local": [10, 12, 14, 19, 20], "within": [10, 12], "resum": 10, "exist": 10, "local_directori": [10, 12], "archiv": [10, 12, 18], "dir_in_repo": 10, "max_work": 10, "int": [10, 14], "8": [10, 19, 20, 21], "all": [10, 17], "progress": [10, 12, 14, 16], "bar": [10, 12, 14, 16], "max": 10, "worker": 10, "when": 10, "default": 10, "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "clear": 12, "its": 12, "append": 12, "timestamp": 12, "remov": 12, "present": 12, "check": [13, 14, 21], "read": 13, "first": 13, "1024": 13, "byte": [13, 14], "contain": 13, "non": 13, "text": 13, "charact": 13, "url": 14, "expected_s": 14, "desc": 14, "session": 14, "request": 14, "tqdm": [14, 15, 18], "It": [14, 21], "also": [14, 21], "perform": [14, 19, 20], "ensur": 14, "ha": [14, 19, 20], "expect": 14, "size": [14, 19, 20], "where": 14, "otherwis": 14, "addit": [14, 16], "pass": [14, 16], "binari": [15, 18], "is_binary_fil": 15, "download_fil": 15, "walk": [15, 18], "walk_fil": 15, "tqdm_": 16, "enhanc": 16, "silenc": 16, "modifi": 16, "behavior": 16, "allow": 16, "posit": 16, "std": 16, "recurs": 17, "through": [17, 21], "yield": 17, "rel": 17, "root": 17, "start": [17, 18], "modul": 18, "quick": 18, "run": 18, "environ": 18, "register_archive_typ": 18, "archive_pack": 18, "archive_unpack": 18, "get_archive_typ": 18, "get_archive_extnam": 18, "config": [18, 21], "entri": 18, "oper": 18, "here": [19, 20], "import": [19, 20, 21], "o": [19, 20], "platform": [19, 20], "shutil": [19, 20], "cpuinfo": [19, 20], "psutil": [19, 20], "hbutil": [19, 20], "scale": [19, 20], "size_to_bytes_str": [19, 20], "python": [19, 20, 21], "python_implement": [19, 20], "python_vers": [19, 20], "cpu": [19, 20], "brand": [19, 20], "get_cpu_info": [19, 20], "brand_raw": [19, 20], "count": [19, 20], "cpu_count": [19, 20], "freq": [19, 20], "cpu_freq": [19, 20], "mhz": [19, 20], "memori": [19, 20], "virtual_memori": [19, 20], "total": [19, 20], "precis": [19, 20], "3": [19, 20, 21], "cuda": [19, 20], "ye": [19, 20], "nvidia": [19, 20], "smi": [19, 20], "els": [19, 20], "No": [19, 20], "linux": [19, 20], "6": [19, 20], "5": [19, 20, 21], "0": [19, 20, 21], "1023": [19, 20], "azur": [19, 20], "x86_64": [19, 20], "glibc2": [19, 20], "34": [19, 20], "cpython": [19, 20], "18": [19, 20], "amd": [19, 20], "epyc": [19, 20], "7763": [19, 20], "64": [19, 20], "core": [19, 20], "processor": [19, 20], "4": [19, 20], "2923": 19, "8280000000004": 19, "15": [19, 20], "606": [19, 20], "gib": [19, 20], "pleas": [19, 20], "note": [19, 20], "deploi": [19, 20], "document": [19, 20, 21], "automat": [19, 20], "execut": [19, 20], "github": [19, 20, 21], "action": [19, 20], "therefor": [19, 20], "some": [19, 20], "data": [19, 20], "mai": [19, 20], "differ": [19, 20], "your": [19, 20, 21], "2736": 20, "407": 20, "hfutil": 21, "host": 21, "pypi": 21, "can": 21, "newest": 21, "u": 21, "git": 21, "http": 21, "com": 21, "deepgh": 21, "script": 21, "__name__": 21, "__main__": 21, "develop": 21, "maintain": 21, "like": 21, "below": 21, "mean": 21, "success": 21, "narugo1992": 21, "still": 21, "under": 21, "out": 21, "stabl": 21, "index": 21, "html": 21, "faq": 22}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [15, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.utils": [[13, 0, 0, "-", "binary"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "tqdm_"], [17, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[13, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[14, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[16, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[17, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 14], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "util": [13, 14, 15, 16, 17], "binari": 13, "is_binary_fil": 13, "download_fil": 14, "tqdm": 16, "walk": 17, "walk_fil": 17, "welcom": 18, "": 18, "document": 18, "overview": 18, "tutori": 18, "inform": [18, 19, 20], "api": 18, "run": [19, 20], "environ": [19, 20], "instal": 21, "quick": 22, "start": 22}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file": [[13, "is-binary-file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "download_file": [[14, "download-file"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[16, "module-hfutils.utils.tqdm_"]], "tqdm": [[16, "tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files": [[17, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[18, "welcome-to-hfutils-s-documentation"]], "Overview": [[18, "overview"]], "Tutorials": [[18, null]], "Information": [[18, null]], "API Documentation": [[18, null]], "Run Environment Information": [[19, "Run-Environment-Information"], [20, "Run-Environment-Information"]], "Installation": [[21, "installation"]], "Quick Start": [[22, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.utils.binary"], [14, "module-hfutils.utils.download"], [15, "module-hfutils.utils"], [16, "module-hfutils.utils.tqdm_"], [17, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[13, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[14, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[16, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[16, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[17, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 14, 16], "you": [0, 21], "requir": [0, 21], "simpli": [0, 21], "instal": [0, 18], "us": [0, 3, 9, 10, 12, 14, 18, 21], "follow": [0, 21], "code": [0, 3, 6, 8], "pip": [0, 21], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 21], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "i": [0, 6, 8, 10, 13, 18, 19, 20, 21], "we": 0, "util": [0, 18, 21], "rarfil": 0, "librari": [0, 14], "which": [0, 19, 20, 21], "doe": 0, "offer": 0, "function": [0, 3, 13, 14, 16], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 16, 17], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 17], "an": [0, 10, 12, 14, 16, 17], "filenam": [0, 14], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 14, 16], "bool": [0, 5, 10, 12, 13, 14, 16], "fals": [0, 10, 12, 13, 14, 16], "specifi": [0, 12, 14], "result": 0, "true": [0, 10, 12, 13, 14, 16], "suppress": [0, 10, 12, 14], "warn": [0, 3], "dure": 0, "process": 0, "return": [0, 3, 9, 13, 14, 16, 17], "path": [0, 6, 8, 9, 10, 12, 13, 14, 17], "password": [0, 10], "none": [0, 3, 5, 6, 8, 9, 10, 12, 14], "content": [0, 16], "option": [0, 3, 5, 6, 8, 9, 10, 12, 14, 16], "determin": 0, "base": [0, 7, 11, 18], "rais": 0, "valueerror": 0, "ani": [0, 5, 13], "get": [0, 9, 14], "meta": [1, 18, 21], "__title__": [1, 21], "__version__": [1, 21], "__description__": [1, 21], "__author__": [1, 21], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 13, 14, 16, 19, 20], "project": 2, "should": [2, 14, 21], "version": [2, 5, 16, 21], "short": 2, "descript": [2, 14], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 14, 19, 20, 21], "object": [3, 9, 10, 12, 14], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 17], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 14, 16], "keyword": [3, 14, 16], "argument": [3, 14, 16], "For": 3, "exampl": 3, "one": 3, "1": [3, 19, 20], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 14, 16], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 21], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 14, 16, 21], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 19, 20, 21], "traceback": 3, "provid": [3, 14], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 21], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 18], "current": [5, 19, 20, 21], "metadata": 5, "arg": [5, 16], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12], "assign": [6, 8, 9, 10, 12], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 18], "print_vers": 7, "download": [7, 11, 15, 18], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 18], "noremotepathassignedwithupload": 7, "33": 8, "hf_token": [9, 10, 12], "hfapi": 9, "hug": [9, 10, 12], "face": [9, 10, 12], "api": [9, 10, 12], "client": [9, 10, 12], "huggingfac": [9, 10, 12, 18, 21], "token": [9, 10, 12], "variabl": [9, 10, 12], "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12], "repo_typ": [9, 10, 12], "liter": [9, 10, 12], "dataset": [9, 10, 12], "model": [9, 10, 12], "space": [9, 10, 12], "subdir": 9, "revis": [9, 10, 12], "main": [9, 10, 12, 21], "ignore_pattern": [9, 10, 12], "given": [9, 13, 14], "identifi": [9, 10, 12], "repotypetyp": [9, 10, 12], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12], "file_in_repo": [10, 12], "resume_download": 10, "save": [10, 14], "local": [10, 12, 14, 19, 20], "within": [10, 12], "resum": 10, "exist": 10, "local_directori": [10, 12], "archiv": [10, 12, 18], "dir_in_repo": 10, "max_work": 10, "int": [10, 14], "8": [10, 19, 20, 21], "all": [10, 17], "progress": [10, 12, 14, 16], "bar": [10, 12, 14, 16], "max": 10, "worker": 10, "when": 10, "default": 10, "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "clear": 12, "its": 12, "append": 12, "timestamp": 12, "remov": 12, "present": 12, "check": [13, 14, 21], "read": 13, "first": 13, "1024": [13, 19, 20], "byte": [13, 14], "contain": 13, "non": 13, "text": 13, "charact": 13, "url": 14, "expected_s": 14, "desc": 14, "session": 14, "request": 14, "tqdm": [14, 15, 18], "It": [14, 21], "also": [14, 21], "perform": [14, 19, 20], "ensur": 14, "ha": [14, 19, 20], "expect": 14, "size": [14, 19, 20], "where": 14, "otherwis": 14, "addit": [14, 16], "pass": [14, 16], "binari": [15, 18], "is_binary_fil": 15, "download_fil": 15, "walk": [15, 18], "walk_fil": 15, "tqdm_": 16, "enhanc": 16, "silenc": 16, "modifi": 16, "behavior": 16, "allow": 16, "posit": 16, "std": 16, "recurs": 17, "through": [17, 21], "yield": 17, "rel": 17, "root": 17, "start": [17, 18], "modul": 18, "quick": 18, "run": 18, "environ": 18, "register_archive_typ": 18, "archive_pack": 18, "archive_unpack": 18, "get_archive_typ": 18, "get_archive_extnam": 18, "config": [18, 21], "entri": 18, "oper": 18, "here": [19, 20], "import": [19, 20, 21], "o": [19, 20], "platform": [19, 20], "shutil": [19, 20], "cpuinfo": [19, 20], "psutil": [19, 20], "hbutil": [19, 20], "scale": [19, 20], "size_to_bytes_str": [19, 20], "python": [19, 20, 21], "python_implement": [19, 20], "python_vers": [19, 20], "cpu": [19, 20], "brand": [19, 20], "get_cpu_info": [19, 20], "brand_raw": [19, 20], "count": [19, 20], "cpu_count": [19, 20], "freq": [19, 20], "cpu_freq": [19, 20], "mhz": [19, 20], "memori": [19, 20], "virtual_memori": [19, 20], "total": [19, 20], "precis": [19, 20], "3": [19, 20, 21], "cuda": [19, 20], "ye": [19, 20], "nvidia": [19, 20], "smi": [19, 20], "els": [19, 20], "No": [19, 20], "linux": [19, 20], "6": [19, 20], "5": [19, 20, 21], "0": [19, 20, 21], "azur": [19, 20], "x86_64": [19, 20], "glibc2": [19, 20], "34": [19, 20], "cpython": [19, 20], "18": [19, 20], "amd": [19, 20], "epyc": [19, 20], "7763": [19, 20], "64": [19, 20], "core": [19, 20], "processor": [19, 20], "4": [19, 20], "2919": 19, "3250000000003": 19, "15": [19, 20], "606": [19, 20], "gib": [19, 20], "pleas": [19, 20], "note": [19, 20], "deploi": [19, 20], "document": [19, 20, 21], "automat": [19, 20], "execut": [19, 20], "github": [19, 20, 21], "action": [19, 20], "therefor": [19, 20], "some": [19, 20], "data": [19, 20], "mai": [19, 20], "differ": [19, 20], "your": [19, 20, 21], "2915": 20, "2210000000005": 20, "hfutil": 21, "host": 21, "pypi": 21, "can": 21, "newest": 21, "u": 21, "git": 21, "http": 21, "com": 21, "deepgh": 21, "script": 21, "__name__": 21, "__main__": 21, "develop": 21, "maintain": 21, "like": 21, "below": 21, "mean": 21, "success": 21, "narugo1992": 21, "still": 21, "under": 21, "out": 21, "stabl": 21, "index": 21, "html": 21, "faq": 22}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [15, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.utils": [[13, 0, 0, "-", "binary"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "tqdm_"], [17, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[13, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[14, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[16, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[17, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 14], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "util": [13, 14, 15, 16, 17], "binari": 13, "is_binary_fil": 13, "download_fil": 14, "tqdm": 16, "walk": 17, "walk_fil": 17, "welcom": 18, "": 18, "document": 18, "overview": 18, "tutori": 18, "inform": [18, 19, 20], "api": 18, "run": [19, 20], "environ": [19, 20], "instal": 21, "quick": 22, "start": 22}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file": [[13, "is-binary-file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "download_file": [[14, "download-file"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[16, "module-hfutils.utils.tqdm_"]], "tqdm": [[16, "tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files": [[17, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[18, "welcome-to-hfutils-s-documentation"]], "Overview": [[18, "overview"]], "Tutorials": [[18, null]], "Information": [[18, null]], "API Documentation": [[18, null]], "Run Environment Information": [[19, "Run-Environment-Information"], [20, "Run-Environment-Information"]], "Installation": [[21, "installation"]], "Quick Start": [[22, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.utils.binary"], [14, "module-hfutils.utils.download"], [15, "module-hfutils.utils"], [16, "module-hfutils.utils.tqdm_"], [17, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[13, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[14, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[16, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[16, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[17, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.0.6/.buildinfo b/v0.0.6/.buildinfo
index cc734e421e..ed06ab12a8 100644
--- a/v0.0.6/.buildinfo
+++ b/v0.0.6/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f1ba150b2c1465ee98ec1189ff80e131
+config: 0a3391f9d3a7d5a67ee1484e4fc36ce3
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.0.6/.doctrees/api_doc/archive/index.doctree b/v0.0.6/.doctrees/api_doc/archive/index.doctree
index c36d5d1ce3..532d031718 100644
Binary files a/v0.0.6/.doctrees/api_doc/archive/index.doctree and b/v0.0.6/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/config/index.doctree b/v0.0.6/.doctrees/api_doc/config/index.doctree
index 8fc4b9b09e..4c866efa6e 100644
Binary files a/v0.0.6/.doctrees/api_doc/config/index.doctree and b/v0.0.6/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/config/meta.doctree b/v0.0.6/.doctrees/api_doc/config/meta.doctree
index fb17354b9e..dc6d4d1f01 100644
Binary files a/v0.0.6/.doctrees/api_doc/config/meta.doctree and b/v0.0.6/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/entry/base.doctree b/v0.0.6/.doctrees/api_doc/entry/base.doctree
index 4278f44871..490f9441e0 100644
Binary files a/v0.0.6/.doctrees/api_doc/entry/base.doctree and b/v0.0.6/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/entry/cli.doctree b/v0.0.6/.doctrees/api_doc/entry/cli.doctree
index 50b447a491..c5e4a90c50 100644
Binary files a/v0.0.6/.doctrees/api_doc/entry/cli.doctree and b/v0.0.6/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/entry/dispatch.doctree b/v0.0.6/.doctrees/api_doc/entry/dispatch.doctree
index 0d0a3b0b78..b48a5241cc 100644
Binary files a/v0.0.6/.doctrees/api_doc/entry/dispatch.doctree and b/v0.0.6/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/entry/download.doctree b/v0.0.6/.doctrees/api_doc/entry/download.doctree
index 8f5a4d3615..854a7cf6bf 100644
Binary files a/v0.0.6/.doctrees/api_doc/entry/download.doctree and b/v0.0.6/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/entry/index.doctree b/v0.0.6/.doctrees/api_doc/entry/index.doctree
index 1888994923..693114f787 100644
Binary files a/v0.0.6/.doctrees/api_doc/entry/index.doctree and b/v0.0.6/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/entry/upload.doctree b/v0.0.6/.doctrees/api_doc/entry/upload.doctree
index 897ba6363f..d4471b175f 100644
Binary files a/v0.0.6/.doctrees/api_doc/entry/upload.doctree and b/v0.0.6/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/operate/base.doctree b/v0.0.6/.doctrees/api_doc/operate/base.doctree
index 53f1635fd7..f4d9b75b5f 100644
Binary files a/v0.0.6/.doctrees/api_doc/operate/base.doctree and b/v0.0.6/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/operate/download.doctree b/v0.0.6/.doctrees/api_doc/operate/download.doctree
index 9cba7dfe34..262b67f330 100644
Binary files a/v0.0.6/.doctrees/api_doc/operate/download.doctree and b/v0.0.6/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/operate/index.doctree b/v0.0.6/.doctrees/api_doc/operate/index.doctree
index 5155fc18dc..f4928aa3db 100644
Binary files a/v0.0.6/.doctrees/api_doc/operate/index.doctree and b/v0.0.6/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/operate/upload.doctree b/v0.0.6/.doctrees/api_doc/operate/upload.doctree
index bdea098324..54d537961e 100644
Binary files a/v0.0.6/.doctrees/api_doc/operate/upload.doctree and b/v0.0.6/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/utils/binary.doctree b/v0.0.6/.doctrees/api_doc/utils/binary.doctree
index 091bd05c18..c582dcf87a 100644
Binary files a/v0.0.6/.doctrees/api_doc/utils/binary.doctree and b/v0.0.6/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/utils/download.doctree b/v0.0.6/.doctrees/api_doc/utils/download.doctree
index 60336ced43..62d50c61cf 100644
Binary files a/v0.0.6/.doctrees/api_doc/utils/download.doctree and b/v0.0.6/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/utils/index.doctree b/v0.0.6/.doctrees/api_doc/utils/index.doctree
index aea2508cf4..3315657ea1 100644
Binary files a/v0.0.6/.doctrees/api_doc/utils/index.doctree and b/v0.0.6/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/utils/tqdm_.doctree b/v0.0.6/.doctrees/api_doc/utils/tqdm_.doctree
index dc37ded2e8..ae5fdd6043 100644
Binary files a/v0.0.6/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.0.6/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.0.6/.doctrees/api_doc/utils/walk.doctree b/v0.0.6/.doctrees/api_doc/utils/walk.doctree
index c8d3571312..facfc55bfa 100644
Binary files a/v0.0.6/.doctrees/api_doc/utils/walk.doctree and b/v0.0.6/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.0.6/.doctrees/environment.pickle b/v0.0.6/.doctrees/environment.pickle
index 84e9a29fb8..d0918ce4e9 100644
Binary files a/v0.0.6/.doctrees/environment.pickle and b/v0.0.6/.doctrees/environment.pickle differ
diff --git a/v0.0.6/.doctrees/index.doctree b/v0.0.6/.doctrees/index.doctree
index dca7c7390c..3be38e8770 100644
Binary files a/v0.0.6/.doctrees/index.doctree and b/v0.0.6/.doctrees/index.doctree differ
diff --git a/v0.0.6/.doctrees/information/environment.doctree b/v0.0.6/.doctrees/information/environment.doctree
index c9bfe71b0c..f590f22062 100644
Binary files a/v0.0.6/.doctrees/information/environment.doctree and b/v0.0.6/.doctrees/information/environment.doctree differ
diff --git a/v0.0.6/.doctrees/information/environment.result.doctree b/v0.0.6/.doctrees/information/environment.result.doctree
index 81cbc06543..249ab9fb47 100644
Binary files a/v0.0.6/.doctrees/information/environment.result.doctree and b/v0.0.6/.doctrees/information/environment.result.doctree differ
diff --git a/v0.0.6/.doctrees/nbsphinx/information/environment.ipynb b/v0.0.6/.doctrees/nbsphinx/information/environment.ipynb
index c102c5d2cd..288d76b980 100644
--- a/v0.0.6/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.0.6/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:36:39.846361Z",
-     "iopub.status.busy": "2024-07-23T17:36:39.845892Z",
-     "iopub.status.idle": "2024-07-23T17:36:41.013116Z",
-     "shell.execute_reply": "2024-07-23T17:36:41.012299Z"
+     "iopub.execute_input": "2024-07-23T17:42:48.264881Z",
+     "iopub.status.busy": "2024-07-23T17:42:48.264333Z",
+     "iopub.status.idle": "2024-07-23T17:42:49.435482Z",
+     "shell.execute_reply": "2024-07-23T17:42:49.434714Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 3184.40625 MHz\n",
+      "CPU Freq: 2929.74525 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.6/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.0.6/.doctrees/nbsphinx/information/environment.result.ipynb
index c0f5a75d3a..9a330c9fc4 100644
--- a/v0.0.6/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.0.6/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:00:51.045613Z",
-     "iopub.status.busy": "2024-07-23T17:00:51.044987Z",
-     "iopub.status.idle": "2024-07-23T17:00:52.219371Z",
-     "shell.execute_reply": "2024-07-23T17:00:52.218582Z"
+     "iopub.execute_input": "2024-07-23T17:06:22.050846Z",
+     "iopub.status.busy": "2024-07-23T17:06:22.050641Z",
+     "iopub.status.idle": "2024-07-23T17:06:23.226949Z",
+     "shell.execute_reply": "2024-07-23T17:06:23.226184Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2962.746 MHz\n",
+      "CPU Freq: 2927.3052499999994 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.6/.doctrees/tutorials/installation/index.doctree b/v0.0.6/.doctrees/tutorials/installation/index.doctree
index ee2091cc72..26e2ce8000 100644
Binary files a/v0.0.6/.doctrees/tutorials/installation/index.doctree and b/v0.0.6/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.0.6/.doctrees/tutorials/quick_start/index.doctree b/v0.0.6/.doctrees/tutorials/quick_start/index.doctree
index 2f92791c53..34dbdf4388 100644
Binary files a/v0.0.6/.doctrees/tutorials/quick_start/index.doctree and b/v0.0.6/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.0.6/_sources/information/environment.result.ipynb.txt b/v0.0.6/_sources/information/environment.result.ipynb.txt
index c0f5a75d3a..9a330c9fc4 100644
--- a/v0.0.6/_sources/information/environment.result.ipynb.txt
+++ b/v0.0.6/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:00:51.045613Z",
-     "iopub.status.busy": "2024-07-23T17:00:51.044987Z",
-     "iopub.status.idle": "2024-07-23T17:00:52.219371Z",
-     "shell.execute_reply": "2024-07-23T17:00:52.218582Z"
+     "iopub.execute_input": "2024-07-23T17:06:22.050846Z",
+     "iopub.status.busy": "2024-07-23T17:06:22.050641Z",
+     "iopub.status.idle": "2024-07-23T17:06:23.226949Z",
+     "shell.execute_reply": "2024-07-23T17:06:23.226184Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2962.746 MHz\n",
+      "CPU Freq: 2927.3052499999994 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.6/information/environment.html b/v0.0.6/information/environment.html
index 18893f38d2..23b8e53222 100644
--- a/v0.0.6/information/environment.html
+++ b/v0.0.6/information/environment.html
@@ -125,11 +125,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 3184.40625 MHz
+CPU Freq: 2929.74525 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.0.6/information/environment.ipynb b/v0.0.6/information/environment.ipynb
index c102c5d2cd..288d76b980 100644
--- a/v0.0.6/information/environment.ipynb
+++ b/v0.0.6/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:36:39.846361Z",
-     "iopub.status.busy": "2024-07-23T17:36:39.845892Z",
-     "iopub.status.idle": "2024-07-23T17:36:41.013116Z",
-     "shell.execute_reply": "2024-07-23T17:36:41.012299Z"
+     "iopub.execute_input": "2024-07-23T17:42:48.264881Z",
+     "iopub.status.busy": "2024-07-23T17:42:48.264333Z",
+     "iopub.status.idle": "2024-07-23T17:42:49.435482Z",
+     "shell.execute_reply": "2024-07-23T17:42:49.434714Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 3184.40625 MHz\n",
+      "CPU Freq: 2929.74525 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.6/information/environment.result.html b/v0.0.6/information/environment.result.html
index 7468c3f6ef..c3c49b9d50 100644
--- a/v0.0.6/information/environment.result.html
+++ b/v0.0.6/information/environment.result.html
@@ -127,11 +127,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2962.746 MHz
+CPU Freq: 2927.3052499999994 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.0.6/information/environment.result.ipynb b/v0.0.6/information/environment.result.ipynb
index c0f5a75d3a..9a330c9fc4 100644
--- a/v0.0.6/information/environment.result.ipynb
+++ b/v0.0.6/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:00:51.045613Z",
-     "iopub.status.busy": "2024-07-23T17:00:51.044987Z",
-     "iopub.status.idle": "2024-07-23T17:00:52.219371Z",
-     "shell.execute_reply": "2024-07-23T17:00:52.218582Z"
+     "iopub.execute_input": "2024-07-23T17:06:22.050846Z",
+     "iopub.status.busy": "2024-07-23T17:06:22.050641Z",
+     "iopub.status.idle": "2024-07-23T17:06:23.226949Z",
+     "shell.execute_reply": "2024-07-23T17:06:23.226184Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2962.746 MHz\n",
+      "CPU Freq: 2927.3052499999994 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.0.6/searchindex.js b/v0.0.6/searchindex.js
index 87ea1bb4cf..7177b3d529 100644
--- a/v0.0.6/searchindex.js
+++ b/v0.0.6/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 14, 16], "you": [0, 21], "requir": [0, 21], "simpli": [0, 21], "instal": [0, 18], "us": [0, 3, 9, 10, 12, 14, 18, 21], "follow": [0, 21], "code": [0, 3, 6, 8], "pip": [0, 21], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 21], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "i": [0, 6, 8, 10, 13, 18, 19, 20, 21], "we": 0, "util": [0, 18, 21], "rarfil": 0, "librari": [0, 14], "which": [0, 19, 20, 21], "doe": 0, "offer": 0, "function": [0, 3, 13, 14, 16], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 16, 17], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 17], "an": [0, 10, 12, 14, 16, 17], "filenam": [0, 14], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 14, 16], "bool": [0, 5, 10, 12, 13, 14, 16], "fals": [0, 10, 12, 13, 14, 16], "clear": [0, 12], "specifi": [0, 12, 14], "result": 0, "true": [0, 10, 12, 13, 14, 16], "suppress": [0, 10, 12, 14], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 12], "exist": [0, 10], "when": [0, 10], "return": [0, 3, 9, 13, 14, 16, 17], "path": [0, 6, 8, 9, 10, 12, 13, 14, 17], "password": [0, 10], "none": [0, 3, 5, 6, 8, 9, 10, 12, 14], "content": [0, 16], "option": [0, 3, 5, 6, 8, 9, 10, 12, 14, 16], "determin": 0, "base": [0, 7, 11, 18], "rais": 0, "valueerror": 0, "ani": [0, 5, 13], "get": [0, 9, 14], "meta": [1, 18, 21], "__title__": [1, 21], "__version__": [1, 21], "__description__": [1, 21], "__author__": [1, 21], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 13, 14, 16, 19, 20], "project": 2, "should": [2, 14, 21], "version": [2, 5, 16, 21], "short": 2, "descript": [2, 14], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 14, 19, 20, 21], "object": [3, 9, 10, 12, 14], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 17], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 14, 16], "keyword": [3, 14, 16], "argument": [3, 14, 16], "For": 3, "exampl": 3, "one": 3, "1": [3, 19, 20], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 14, 16], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 21], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 14, 16, 21], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 19, 20, 21], "traceback": 3, "provid": [3, 14], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 21], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 18], "current": [5, 19, 20, 21], "metadata": 5, "arg": [5, 16], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12], "assign": [6, 8, 9, 10, 12], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 18], "print_vers": 7, "download": [7, 11, 15, 18], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 18], "noremotepathassignedwithupload": 7, "33": 8, "hf_token": [9, 10, 12], "hfapi": 9, "hug": [9, 10, 12], "face": [9, 10, 12], "api": [9, 10, 12], "client": [9, 10, 12], "huggingfac": [9, 10, 12, 18, 21], "token": [9, 10, 12], "variabl": [9, 10, 12], "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12], "repo_typ": [9, 10, 12], "liter": [9, 10, 12], "dataset": [9, 10, 12], "model": [9, 10, 12], "space": [9, 10, 12], "subdir": 9, "revis": [9, 10, 12], "main": [9, 10, 12, 21], "ignore_pattern": [9, 10, 12], "given": [9, 13, 14], "identifi": [9, 10, 12], "repotypetyp": [9, 10, 12], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12], "file_in_repo": [10, 12], "resume_download": 10, "save": [10, 14], "local": [10, 12, 14, 19, 20], "within": [10, 12], "resum": 10, "local_directori": [10, 12], "archiv": [10, 12, 18], "dir_in_repo": 10, "max_work": 10, "int": [10, 14], "8": [10, 19, 20, 21], "all": [10, 17], "progress": [10, 12, 14, 16], "bar": [10, 12, 14, 16], "max": 10, "worker": 10, "default": 10, "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "its": 12, "append": 12, "timestamp": 12, "present": 12, "check": [13, 14, 21], "read": 13, "first": 13, "1024": 13, "byte": [13, 14], "contain": 13, "non": 13, "text": 13, "charact": 13, "url": 14, "expected_s": 14, "desc": 14, "session": 14, "request": 14, "tqdm": [14, 15, 18], "It": [14, 21], "also": [14, 21], "perform": [14, 19, 20], "ensur": 14, "ha": [14, 19, 20], "expect": 14, "size": [14, 19, 20], "where": 14, "otherwis": 14, "addit": [14, 16], "pass": [14, 16], "binari": [15, 18], "is_binary_fil": 15, "download_fil": 15, "walk": [15, 18], "walk_fil": 15, "tqdm_": 16, "enhanc": 16, "silenc": 16, "modifi": 16, "behavior": 16, "allow": 16, "posit": 16, "std": 16, "recurs": 17, "through": [17, 21], "yield": 17, "rel": 17, "root": 17, "start": [17, 18], "modul": 18, "quick": 18, "run": 18, "environ": 18, "register_archive_typ": 18, "archive_pack": 18, "archive_unpack": 18, "get_archive_typ": 18, "get_archive_extnam": 18, "config": [18, 21], "entri": 18, "oper": 18, "here": [19, 20], "import": [19, 20, 21], "o": [19, 20], "platform": [19, 20], "shutil": [19, 20], "cpuinfo": [19, 20], "psutil": [19, 20], "hbutil": [19, 20], "scale": [19, 20], "size_to_bytes_str": [19, 20], "python": [19, 20, 21], "python_implement": [19, 20], "python_vers": [19, 20], "cpu": [19, 20], "brand": [19, 20], "get_cpu_info": [19, 20], "brand_raw": [19, 20], "count": [19, 20], "cpu_count": [19, 20], "freq": [19, 20], "cpu_freq": [19, 20], "mhz": [19, 20], "memori": [19, 20], "virtual_memori": [19, 20], "total": [19, 20], "precis": [19, 20], "3": [19, 20, 21], "cuda": [19, 20], "ye": [19, 20], "nvidia": [19, 20], "smi": [19, 20], "els": [19, 20], "No": [19, 20], "linux": [19, 20], "6": [19, 20, 21], "5": [19, 20], "0": [19, 20, 21], "1023": [19, 20], "azur": [19, 20], "x86_64": [19, 20], "glibc2": [19, 20], "34": [19, 20], "cpython": [19, 20], "18": [19, 20], "amd": [19, 20], "epyc": [19, 20], "7763": [19, 20], "64": [19, 20], "core": [19, 20], "processor": [19, 20], "4": [19, 20], "3184": 19, "40625": 19, "15": [19, 20], "606": [19, 20], "gib": [19, 20], "pleas": [19, 20], "note": [19, 20], "deploi": [19, 20], "document": [19, 20, 21], "automat": [19, 20], "execut": [19, 20], "github": [19, 20, 21], "action": [19, 20], "therefor": [19, 20], "some": [19, 20], "data": [19, 20], "mai": [19, 20], "differ": [19, 20], "your": [19, 20, 21], "2962": 20, "746": 20, "hfutil": 21, "host": 21, "pypi": 21, "can": 21, "newest": 21, "u": 21, "git": 21, "http": 21, "com": 21, "deepgh": 21, "script": 21, "__name__": 21, "__main__": 21, "develop": 21, "maintain": 21, "like": 21, "below": 21, "mean": 21, "success": 21, "narugo1992": 21, "still": 21, "under": 21, "out": 21, "stabl": 21, "index": 21, "html": 21, "faq": 22}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [15, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.utils": [[13, 0, 0, "-", "binary"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "tqdm_"], [17, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[13, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[14, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[16, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[17, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 14], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "util": [13, 14, 15, 16, 17], "binari": 13, "is_binary_fil": 13, "download_fil": 14, "tqdm": 16, "walk": 17, "walk_fil": 17, "welcom": 18, "": 18, "document": 18, "overview": 18, "tutori": 18, "inform": [18, 19, 20], "api": 18, "run": [19, 20], "environ": [19, 20], "instal": 21, "quick": 22, "start": 22}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file": [[13, "is-binary-file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "download_file": [[14, "download-file"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[16, "module-hfutils.utils.tqdm_"]], "tqdm": [[16, "tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files": [[17, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[18, "welcome-to-hfutils-s-documentation"]], "Overview": [[18, "overview"]], "Tutorials": [[18, null]], "Information": [[18, null]], "API Documentation": [[18, null]], "Run Environment Information": [[19, "Run-Environment-Information"], [20, "Run-Environment-Information"]], "Installation": [[21, "installation"]], "Quick Start": [[22, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.utils.binary"], [14, "module-hfutils.utils.download"], [15, "module-hfutils.utils"], [16, "module-hfutils.utils.tqdm_"], [17, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[13, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[14, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[16, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[16, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[17, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 14, 16], "you": [0, 21], "requir": [0, 21], "simpli": [0, 21], "instal": [0, 18], "us": [0, 3, 9, 10, 12, 14, 18, 21], "follow": [0, 21], "code": [0, 3, 6, 8], "pip": [0, 21], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17, 21], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "i": [0, 6, 8, 10, 13, 18, 19, 20, 21], "we": 0, "util": [0, 18, 21], "rarfil": 0, "librari": [0, 14], "which": [0, 19, 20, 21], "doe": 0, "offer": 0, "function": [0, 3, 13, 14, 16], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 17], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 16, 17], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 17], "an": [0, 10, 12, 14, 16, 17], "filenam": [0, 14], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 14, 16], "bool": [0, 5, 10, 12, 13, 14, 16], "fals": [0, 10, 12, 13, 14, 16], "clear": [0, 12], "specifi": [0, 12, 14], "result": 0, "true": [0, 10, 12, 13, 14, 16], "suppress": [0, 10, 12, 14], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 12], "exist": [0, 10], "when": [0, 10], "return": [0, 3, 9, 13, 14, 16, 17], "path": [0, 6, 8, 9, 10, 12, 13, 14, 17], "password": [0, 10], "none": [0, 3, 5, 6, 8, 9, 10, 12, 14], "content": [0, 16], "option": [0, 3, 5, 6, 8, 9, 10, 12, 14, 16], "determin": 0, "base": [0, 7, 11, 18], "rais": 0, "valueerror": 0, "ani": [0, 5, 13], "get": [0, 9, 14], "meta": [1, 18, 21], "__title__": [1, 21], "__version__": [1, 21], "__description__": [1, 21], "__author__": [1, 21], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 13, 14, 16, 19, 20], "project": 2, "should": [2, 14, 21], "version": [2, 5, 16, 21], "short": 2, "descript": [2, 14], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 14, 19, 20, 21], "object": [3, 9, 10, 12, 14], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 17], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 14, 16], "keyword": [3, 14, 16], "argument": [3, 14, 16], "For": 3, "exampl": 3, "one": 3, "1": [3, 19, 20], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 14, 16], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 21], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 14, 16, 21], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 19, 20, 21], "traceback": 3, "provid": [3, 14], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 21], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 18], "current": [5, 19, 20, 21], "metadata": 5, "arg": [5, 16], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12], "assign": [6, 8, 9, 10, 12], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 18], "print_vers": 7, "download": [7, 11, 15, 18], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 18], "noremotepathassignedwithupload": 7, "33": 8, "hf_token": [9, 10, 12], "hfapi": 9, "hug": [9, 10, 12], "face": [9, 10, 12], "api": [9, 10, 12], "client": [9, 10, 12], "huggingfac": [9, 10, 12, 18, 21], "token": [9, 10, 12], "variabl": [9, 10, 12], "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12], "repo_typ": [9, 10, 12], "liter": [9, 10, 12], "dataset": [9, 10, 12], "model": [9, 10, 12], "space": [9, 10, 12], "subdir": 9, "revis": [9, 10, 12], "main": [9, 10, 12, 21], "ignore_pattern": [9, 10, 12], "given": [9, 13, 14], "identifi": [9, 10, 12], "repotypetyp": [9, 10, 12], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12], "file_in_repo": [10, 12], "resume_download": 10, "save": [10, 14], "local": [10, 12, 14, 19, 20], "within": [10, 12], "resum": 10, "local_directori": [10, 12], "archiv": [10, 12, 18], "dir_in_repo": 10, "max_work": 10, "int": [10, 14], "8": [10, 19, 20, 21], "all": [10, 17], "progress": [10, 12, 14, 16], "bar": [10, 12, 14, 16], "max": 10, "worker": 10, "default": 10, "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "its": 12, "append": 12, "timestamp": 12, "present": 12, "check": [13, 14, 21], "read": 13, "first": 13, "1024": [13, 19, 20], "byte": [13, 14], "contain": 13, "non": 13, "text": 13, "charact": 13, "url": 14, "expected_s": 14, "desc": 14, "session": 14, "request": 14, "tqdm": [14, 15, 18], "It": [14, 21], "also": [14, 21], "perform": [14, 19, 20], "ensur": 14, "ha": [14, 19, 20], "expect": 14, "size": [14, 19, 20], "where": 14, "otherwis": 14, "addit": [14, 16], "pass": [14, 16], "binari": [15, 18], "is_binary_fil": 15, "download_fil": 15, "walk": [15, 18], "walk_fil": 15, "tqdm_": 16, "enhanc": 16, "silenc": 16, "modifi": 16, "behavior": 16, "allow": 16, "posit": 16, "std": 16, "recurs": 17, "through": [17, 21], "yield": 17, "rel": 17, "root": 17, "start": [17, 18], "modul": 18, "quick": 18, "run": 18, "environ": 18, "register_archive_typ": 18, "archive_pack": 18, "archive_unpack": 18, "get_archive_typ": 18, "get_archive_extnam": 18, "config": [18, 21], "entri": 18, "oper": 18, "here": [19, 20], "import": [19, 20, 21], "o": [19, 20], "platform": [19, 20], "shutil": [19, 20], "cpuinfo": [19, 20], "psutil": [19, 20], "hbutil": [19, 20], "scale": [19, 20], "size_to_bytes_str": [19, 20], "python": [19, 20, 21], "python_implement": [19, 20], "python_vers": [19, 20], "cpu": [19, 20], "brand": [19, 20], "get_cpu_info": [19, 20], "brand_raw": [19, 20], "count": [19, 20], "cpu_count": [19, 20], "freq": [19, 20], "cpu_freq": [19, 20], "mhz": [19, 20], "memori": [19, 20], "virtual_memori": [19, 20], "total": [19, 20], "precis": [19, 20], "3": [19, 20, 21], "cuda": [19, 20], "ye": [19, 20], "nvidia": [19, 20], "smi": [19, 20], "els": [19, 20], "No": [19, 20], "linux": [19, 20], "6": [19, 20, 21], "5": [19, 20], "0": [19, 20, 21], "azur": [19, 20], "x86_64": [19, 20], "glibc2": [19, 20], "34": [19, 20], "cpython": [19, 20], "18": [19, 20], "amd": [19, 20], "epyc": [19, 20], "7763": [19, 20], "64": [19, 20], "core": [19, 20], "processor": [19, 20], "4": [19, 20], "2929": 19, "74525": 19, "15": [19, 20], "606": [19, 20], "gib": [19, 20], "pleas": [19, 20], "note": [19, 20], "deploi": [19, 20], "document": [19, 20, 21], "automat": [19, 20], "execut": [19, 20], "github": [19, 20, 21], "action": [19, 20], "therefor": [19, 20], "some": [19, 20], "data": [19, 20], "mai": [19, 20], "differ": [19, 20], "your": [19, 20, 21], "2927": 20, "3052499999994": 20, "hfutil": 21, "host": 21, "pypi": 21, "can": 21, "newest": 21, "u": 21, "git": 21, "http": 21, "com": 21, "deepgh": 21, "script": 21, "__name__": 21, "__main__": 21, "develop": 21, "maintain": 21, "like": 21, "below": 21, "mean": 21, "success": 21, "narugo1992": 21, "still": 21, "under": 21, "out": 21, "stabl": 21, "index": 21, "html": 21, "faq": 22}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [15, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.utils": [[13, 0, 0, "-", "binary"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "tqdm_"], [17, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[13, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[14, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[16, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[17, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 14], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "util": [13, 14, 15, 16, 17], "binari": 13, "is_binary_fil": 13, "download_fil": 14, "tqdm": 16, "walk": 17, "walk_fil": 17, "welcom": 18, "": 18, "document": 18, "overview": 18, "tutori": 18, "inform": [18, 19, 20], "api": 18, "run": [19, 20], "environ": [19, 20], "instal": 21, "quick": 22, "start": 22}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file": [[13, "is-binary-file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "download_file": [[14, "download-file"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[16, "module-hfutils.utils.tqdm_"]], "tqdm": [[16, "tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files": [[17, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[18, "welcome-to-hfutils-s-documentation"]], "Overview": [[18, "overview"]], "Tutorials": [[18, null]], "Information": [[18, null]], "API Documentation": [[18, null]], "Run Environment Information": [[19, "Run-Environment-Information"], [20, "Run-Environment-Information"]], "Installation": [[21, "installation"]], "Quick Start": [[22, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.utils.binary"], [14, "module-hfutils.utils.download"], [15, "module-hfutils.utils"], [16, "module-hfutils.utils.tqdm_"], [17, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.utils.binary": [[13, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[13, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[14, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[14, "module-hfutils.utils.download"]], "hfutils.utils": [[15, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[16, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[16, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[17, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[17, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.1.0/.buildinfo b/v0.1.0/.buildinfo
index f9b2901bb4..2c1dd53dec 100644
--- a/v0.1.0/.buildinfo
+++ b/v0.1.0/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: a2f042cfad5780a56f1fc4a73ceaa4af
+config: ee480c51c4cba843d8ea7f8d7b72e7a4
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.1.0/.doctrees/api_doc/archive/index.doctree b/v0.1.0/.doctrees/api_doc/archive/index.doctree
index 0e07fab1c3..f347bb716f 100644
Binary files a/v0.1.0/.doctrees/api_doc/archive/index.doctree and b/v0.1.0/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/config/index.doctree b/v0.1.0/.doctrees/api_doc/config/index.doctree
index 1849b374ea..44847a7931 100644
Binary files a/v0.1.0/.doctrees/api_doc/config/index.doctree and b/v0.1.0/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/config/meta.doctree b/v0.1.0/.doctrees/api_doc/config/meta.doctree
index 37340cc528..3ca7b2feb6 100644
Binary files a/v0.1.0/.doctrees/api_doc/config/meta.doctree and b/v0.1.0/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/entry/base.doctree b/v0.1.0/.doctrees/api_doc/entry/base.doctree
index ee950eca0b..012ff29a97 100644
Binary files a/v0.1.0/.doctrees/api_doc/entry/base.doctree and b/v0.1.0/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/entry/cli.doctree b/v0.1.0/.doctrees/api_doc/entry/cli.doctree
index c8ac525447..245fe7d28d 100644
Binary files a/v0.1.0/.doctrees/api_doc/entry/cli.doctree and b/v0.1.0/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/entry/dispatch.doctree b/v0.1.0/.doctrees/api_doc/entry/dispatch.doctree
index 3e57e373d7..597f64dd7f 100644
Binary files a/v0.1.0/.doctrees/api_doc/entry/dispatch.doctree and b/v0.1.0/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/entry/download.doctree b/v0.1.0/.doctrees/api_doc/entry/download.doctree
index 643fd69bb2..bf22e80133 100644
Binary files a/v0.1.0/.doctrees/api_doc/entry/download.doctree and b/v0.1.0/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/entry/index.doctree b/v0.1.0/.doctrees/api_doc/entry/index.doctree
index 1559255abe..30c5550b00 100644
Binary files a/v0.1.0/.doctrees/api_doc/entry/index.doctree and b/v0.1.0/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/entry/upload.doctree b/v0.1.0/.doctrees/api_doc/entry/upload.doctree
index d3711e3941..682454f69d 100644
Binary files a/v0.1.0/.doctrees/api_doc/entry/upload.doctree and b/v0.1.0/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/operate/base.doctree b/v0.1.0/.doctrees/api_doc/operate/base.doctree
index 0655a5172b..0ef0ad8866 100644
Binary files a/v0.1.0/.doctrees/api_doc/operate/base.doctree and b/v0.1.0/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/operate/download.doctree b/v0.1.0/.doctrees/api_doc/operate/download.doctree
index a67c6d3164..70e34d4c3f 100644
Binary files a/v0.1.0/.doctrees/api_doc/operate/download.doctree and b/v0.1.0/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/operate/index.doctree b/v0.1.0/.doctrees/api_doc/operate/index.doctree
index 36c4fa4e2f..5dd5ab5d37 100644
Binary files a/v0.1.0/.doctrees/api_doc/operate/index.doctree and b/v0.1.0/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/operate/upload.doctree b/v0.1.0/.doctrees/api_doc/operate/upload.doctree
index 20679331c7..e0fca84495 100644
Binary files a/v0.1.0/.doctrees/api_doc/operate/upload.doctree and b/v0.1.0/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/operate/validate.doctree b/v0.1.0/.doctrees/api_doc/operate/validate.doctree
index ae93aa7a06..e95acdc94e 100644
Binary files a/v0.1.0/.doctrees/api_doc/operate/validate.doctree and b/v0.1.0/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/utils/binary.doctree b/v0.1.0/.doctrees/api_doc/utils/binary.doctree
index 90d671df46..f95d8e42fc 100644
Binary files a/v0.1.0/.doctrees/api_doc/utils/binary.doctree and b/v0.1.0/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/utils/download.doctree b/v0.1.0/.doctrees/api_doc/utils/download.doctree
index ba965c8744..fbe1d225d2 100644
Binary files a/v0.1.0/.doctrees/api_doc/utils/download.doctree and b/v0.1.0/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/utils/index.doctree b/v0.1.0/.doctrees/api_doc/utils/index.doctree
index 8316516442..a05f8fd15f 100644
Binary files a/v0.1.0/.doctrees/api_doc/utils/index.doctree and b/v0.1.0/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/utils/tqdm_.doctree b/v0.1.0/.doctrees/api_doc/utils/tqdm_.doctree
index 2c56221052..24c991b2e4 100644
Binary files a/v0.1.0/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.1.0/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.1.0/.doctrees/api_doc/utils/walk.doctree b/v0.1.0/.doctrees/api_doc/utils/walk.doctree
index a74486916a..1ebdc9c094 100644
Binary files a/v0.1.0/.doctrees/api_doc/utils/walk.doctree and b/v0.1.0/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.1.0/.doctrees/environment.pickle b/v0.1.0/.doctrees/environment.pickle
index 9ff47c9b45..77fb939cdd 100644
Binary files a/v0.1.0/.doctrees/environment.pickle and b/v0.1.0/.doctrees/environment.pickle differ
diff --git a/v0.1.0/.doctrees/index.doctree b/v0.1.0/.doctrees/index.doctree
index a9cd61973a..29231969b3 100644
Binary files a/v0.1.0/.doctrees/index.doctree and b/v0.1.0/.doctrees/index.doctree differ
diff --git a/v0.1.0/.doctrees/information/environment.doctree b/v0.1.0/.doctrees/information/environment.doctree
index d6252384f5..161248665d 100644
Binary files a/v0.1.0/.doctrees/information/environment.doctree and b/v0.1.0/.doctrees/information/environment.doctree differ
diff --git a/v0.1.0/.doctrees/information/environment.result.doctree b/v0.1.0/.doctrees/information/environment.result.doctree
index b28924a5fb..95cd03f710 100644
Binary files a/v0.1.0/.doctrees/information/environment.result.doctree and b/v0.1.0/.doctrees/information/environment.result.doctree differ
diff --git a/v0.1.0/.doctrees/nbsphinx/information/environment.ipynb b/v0.1.0/.doctrees/nbsphinx/information/environment.ipynb
index e81f06e915..a7813d02a1 100644
--- a/v0.1.0/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.1.0/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:38:52.154649Z",
-     "iopub.status.busy": "2024-07-23T17:38:52.154171Z",
-     "iopub.status.idle": "2024-07-23T17:38:53.320501Z",
-     "shell.execute_reply": "2024-07-23T17:38:53.319643Z"
+     "iopub.execute_input": "2024-07-23T17:45:03.142924Z",
+     "iopub.status.busy": "2024-07-23T17:45:03.142713Z",
+     "iopub.status.idle": "2024-07-23T17:45:04.312567Z",
+     "shell.execute_reply": "2024-07-23T17:45:04.311867Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2734.08375 MHz\n",
+      "CPU Freq: 2717.66775 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.0/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.1.0/.doctrees/nbsphinx/information/environment.result.ipynb
index be5a4d6c1d..29aeaf99e4 100644
--- a/v0.1.0/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.1.0/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:01:57.900684Z",
-     "iopub.status.busy": "2024-07-23T17:01:57.900490Z",
-     "iopub.status.idle": "2024-07-23T17:01:59.072674Z",
-     "shell.execute_reply": "2024-07-23T17:01:59.071895Z"
+     "iopub.execute_input": "2024-07-23T17:07:30.882503Z",
+     "iopub.status.busy": "2024-07-23T17:07:30.882265Z",
+     "iopub.status.idle": "2024-07-23T17:07:32.059464Z",
+     "shell.execute_reply": "2024-07-23T17:07:32.058700Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2727.24975 MHz\n",
+      "CPU Freq: 2928.245 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.0/.doctrees/tutorials/installation/index.doctree b/v0.1.0/.doctrees/tutorials/installation/index.doctree
index 237e0bd82f..2d1bf87090 100644
Binary files a/v0.1.0/.doctrees/tutorials/installation/index.doctree and b/v0.1.0/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.1.0/.doctrees/tutorials/quick_start/index.doctree b/v0.1.0/.doctrees/tutorials/quick_start/index.doctree
index 1691fe229c..a0d01f6bac 100644
Binary files a/v0.1.0/.doctrees/tutorials/quick_start/index.doctree and b/v0.1.0/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.1.0/_sources/information/environment.result.ipynb.txt b/v0.1.0/_sources/information/environment.result.ipynb.txt
index be5a4d6c1d..29aeaf99e4 100644
--- a/v0.1.0/_sources/information/environment.result.ipynb.txt
+++ b/v0.1.0/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:01:57.900684Z",
-     "iopub.status.busy": "2024-07-23T17:01:57.900490Z",
-     "iopub.status.idle": "2024-07-23T17:01:59.072674Z",
-     "shell.execute_reply": "2024-07-23T17:01:59.071895Z"
+     "iopub.execute_input": "2024-07-23T17:07:30.882503Z",
+     "iopub.status.busy": "2024-07-23T17:07:30.882265Z",
+     "iopub.status.idle": "2024-07-23T17:07:32.059464Z",
+     "shell.execute_reply": "2024-07-23T17:07:32.058700Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2727.24975 MHz\n",
+      "CPU Freq: 2928.245 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.0/information/environment.html b/v0.1.0/information/environment.html
index 60b46a9084..dc7b4537ce 100644
--- a/v0.1.0/information/environment.html
+++ b/v0.1.0/information/environment.html
@@ -125,11 +125,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2734.08375 MHz
+CPU Freq: 2717.66775 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.1.0/information/environment.ipynb b/v0.1.0/information/environment.ipynb
index e81f06e915..a7813d02a1 100644
--- a/v0.1.0/information/environment.ipynb
+++ b/v0.1.0/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:38:52.154649Z",
-     "iopub.status.busy": "2024-07-23T17:38:52.154171Z",
-     "iopub.status.idle": "2024-07-23T17:38:53.320501Z",
-     "shell.execute_reply": "2024-07-23T17:38:53.319643Z"
+     "iopub.execute_input": "2024-07-23T17:45:03.142924Z",
+     "iopub.status.busy": "2024-07-23T17:45:03.142713Z",
+     "iopub.status.idle": "2024-07-23T17:45:04.312567Z",
+     "shell.execute_reply": "2024-07-23T17:45:04.311867Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2734.08375 MHz\n",
+      "CPU Freq: 2717.66775 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.0/information/environment.result.html b/v0.1.0/information/environment.result.html
index 2351b2b318..e09a84ae57 100644
--- a/v0.1.0/information/environment.result.html
+++ b/v0.1.0/information/environment.result.html
@@ -127,11 +127,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2727.24975 MHz
+CPU Freq: 2928.245 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.1.0/information/environment.result.ipynb b/v0.1.0/information/environment.result.ipynb
index be5a4d6c1d..29aeaf99e4 100644
--- a/v0.1.0/information/environment.result.ipynb
+++ b/v0.1.0/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:01:57.900684Z",
-     "iopub.status.busy": "2024-07-23T17:01:57.900490Z",
-     "iopub.status.idle": "2024-07-23T17:01:59.072674Z",
-     "shell.execute_reply": "2024-07-23T17:01:59.071895Z"
+     "iopub.execute_input": "2024-07-23T17:07:30.882503Z",
+     "iopub.status.busy": "2024-07-23T17:07:30.882265Z",
+     "iopub.status.idle": "2024-07-23T17:07:32.059464Z",
+     "shell.execute_reply": "2024-07-23T17:07:32.058700Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2727.24975 MHz\n",
+      "CPU Freq: 2928.245 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.0/searchindex.js b/v0.1.0/searchindex.js
index 0eb43f53aa..a51381fd22 100644
--- a/v0.1.0/searchindex.js
+++ b/v0.1.0/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 15, 17], "you": [0, 22], "requir": [0, 22], "simpli": [0, 22], "instal": [0, 19], "us": [0, 3, 9, 10, 12, 15, 19, 22], "follow": [0, 22], "code": [0, 3, 6, 8], "pip": [0, 22], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18, 22], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18], "i": [0, 6, 8, 10, 13, 14, 19, 20, 21, 22], "we": 0, "util": [0, 19, 22], "rarfil": 0, "librari": [0, 15], "which": [0, 20, 21, 22], "doe": 0, "offer": 0, "function": [0, 3, 14, 15, 17], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 15, 17, 18], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 18], "an": [0, 10, 12, 15, 17, 18], "filenam": [0, 15], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 15, 17], "bool": [0, 5, 10, 12, 13, 14, 15, 17], "fals": [0, 10, 12, 13, 14, 15, 17], "clear": [0, 12], "specifi": [0, 12, 15], "result": 0, "true": [0, 10, 12, 13, 14, 15, 17], "suppress": [0, 10, 12, 15], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 12], "exist": [0, 10], "when": [0, 10], "return": [0, 3, 9, 13, 14, 15, 17, 18], "path": [0, 6, 8, 9, 10, 12, 13, 14, 15, 18], "password": [0, 10], "none": [0, 3, 5, 6, 8, 9, 10, 12, 13, 15], "content": [0, 17], "option": [0, 3, 5, 6, 8, 9, 10, 12, 13, 15, 17], "determin": 0, "base": [0, 7, 11, 19], "rais": 0, "valueerror": 0, "ani": [0, 5, 14], "get": [0, 9, 15], "meta": [1, 19, 22], "__title__": [1, 22], "__version__": [1, 22], "__description__": [1, 22], "__author__": [1, 22], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 14, 15, 17, 20, 21], "project": 2, "should": [2, 15, 22], "version": [2, 5, 17, 22], "short": 2, "descript": [2, 15], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 15, 20, 21, 22], "object": [3, 9, 10, 12, 15], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 18], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 15, 17], "keyword": [3, 15, 17], "argument": [3, 15, 17], "For": 3, "exampl": 3, "one": 3, "1": [3, 20, 21, 22], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 15, 17], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 22], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 15, 17, 22], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 20, 21, 22], "traceback": 3, "provid": [3, 15], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 22], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 19], "current": [5, 20, 21, 22], "metadata": 5, "arg": [5, 17], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12, 13], "assign": [6, 8, 9, 10, 12], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 19], "print_vers": 7, "download": [7, 11, 16, 19], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 19], "noremotepathassignedwithupload": 7, "33": 8, "hf_token": [9, 10, 12, 13], "hfapi": 9, "hug": [9, 10, 12, 13], "face": [9, 10, 12, 13], "api": [9, 10, 12, 13], "client": [9, 10, 12], "huggingfac": [9, 10, 12, 19, 22], "token": [9, 10, 12, 13], "variabl": [9, 10, 12], "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12, 13], "repo_typ": [9, 10, 12, 13], "liter": [9, 10, 12, 13], "dataset": [9, 10, 12, 13], "model": [9, 10, 12, 13], "space": [9, 10, 12, 13], "subdir": 9, "revis": [9, 10, 12, 13], "main": [9, 10, 12, 13, 22], "ignore_pattern": [9, 10, 12], "given": [9, 14, 15], "identifi": [9, 10, 12, 13], "repotypetyp": [9, 10, 12, 13], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12, 13], "file_in_repo": [10, 12, 13], "resume_download": 10, "save": [10, 15], "local": [10, 12, 13, 15, 20, 21], "within": [10, 12], "resum": 10, "local_directori": [10, 12], "archiv": [10, 12, 19], "dir_in_repo": 10, "max_work": 10, "int": [10, 15], "8": [10, 20, 21, 22], "all": [10, 18], "progress": [10, 12, 15, 17], "bar": [10, 12, 15, 17], "max": 10, "worker": 10, "default": [10, 13], "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "valid": [11, 19], "is_local_file_readi": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "its": 12, "append": 12, "timestamp": 12, "present": 12, "check": [13, 14, 15, 22], "readi": 13, "compar": 13, "hub": 13, "match": 13, "otherwis": [13, 15], "read": 14, "first": 14, "1024": 14, "byte": [14, 15], "contain": 14, "non": 14, "text": 14, "charact": 14, "url": 15, "expected_s": 15, "desc": 15, "session": 15, "request": 15, "tqdm": [15, 16, 19], "It": [15, 22], "also": [15, 22], "perform": [15, 20, 21], "ensur": 15, "ha": [15, 20, 21], "expect": 15, "size": [15, 20, 21], "where": 15, "addit": [15, 17], "pass": [15, 17], "binari": [16, 19], "is_binary_fil": 16, "download_fil": 16, "walk": [16, 19], "walk_fil": 16, "tqdm_": 17, "enhanc": 17, "silenc": 17, "modifi": 17, "behavior": 17, "allow": 17, "posit": 17, "std": 17, "recurs": 18, "through": [18, 22], "yield": 18, "rel": 18, "root": 18, "start": [18, 19], "modul": 19, "quick": 19, "run": 19, "environ": 19, "register_archive_typ": 19, "archive_pack": 19, "archive_unpack": 19, "get_archive_typ": 19, "get_archive_extnam": 19, "config": [19, 22], "entri": 19, "oper": 19, "here": [20, 21], "import": [20, 21, 22], "o": [20, 21], "platform": [20, 21], "shutil": [20, 21], "cpuinfo": [20, 21], "psutil": [20, 21], "hbutil": [20, 21], "scale": [20, 21], "size_to_bytes_str": [20, 21], "python": [20, 21, 22], "python_implement": [20, 21], "python_vers": [20, 21], "cpu": [20, 21], "brand": [20, 21], "get_cpu_info": [20, 21], "brand_raw": [20, 21], "count": [20, 21], "cpu_count": [20, 21], "freq": [20, 21], "cpu_freq": [20, 21], "mhz": [20, 21], "memori": [20, 21], "virtual_memori": [20, 21], "total": [20, 21], "precis": [20, 21], "3": [20, 21, 22], "cuda": [20, 21], "ye": [20, 21], "nvidia": [20, 21], "smi": [20, 21], "els": [20, 21], "No": [20, 21], "linux": [20, 21], "6": [20, 21], "5": [20, 21], "0": [20, 21, 22], "1023": [20, 21], "azur": [20, 21], "x86_64": [20, 21], "glibc2": [20, 21], "34": [20, 21], "cpython": [20, 21], "18": [20, 21], "amd": [20, 21], "epyc": [20, 21], "7763": [20, 21], "64": [20, 21], "core": [20, 21], "processor": [20, 21], "4": [20, 21], "2734": 20, "08375": 20, "15": [20, 21], "606": [20, 21], "gib": [20, 21], "pleas": [20, 21], "note": [20, 21], "deploi": [20, 21], "document": [20, 21, 22], "automat": [20, 21], "execut": [20, 21], "github": [20, 21, 22], "action": [20, 21], "therefor": [20, 21], "some": [20, 21], "data": [20, 21], "mai": [20, 21], "differ": [20, 21], "your": [20, 21, 22], "2727": 21, "24975": 21, "hfutil": 22, "host": 22, "pypi": 22, "can": 22, "newest": 22, "u": 22, "git": 22, "http": 22, "com": 22, "deepgh": 22, "script": 22, "__name__": 22, "__main__": 22, "develop": 22, "maintain": 22, "like": 22, "below": 22, "mean": 22, "success": 22, "narugo1992": 22, "still": 22, "under": 22, "out": 22, "stabl": 22, "index": 22, "html": 22, "faq": 23}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [16, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "validate"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[13, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[14, 0, 0, "-", "binary"], [15, 0, 0, "-", "download"], [17, 0, 0, "-", "tqdm_"], [18, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[14, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[15, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[17, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[18, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 15], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12, 13], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "valid": 13, "is_local_file_readi": 13, "util": [14, 15, 16, 17, 18], "binari": 14, "is_binary_fil": 14, "download_fil": 15, "tqdm": 17, "walk": 18, "walk_fil": 18, "welcom": 19, "": 19, "document": 19, "overview": 19, "tutori": 19, "inform": [19, 20, 21], "api": 19, "run": [20, 21], "environ": [20, 21], "instal": 22, "quick": 23, "start": 23}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.operate.validate": [[13, "module-hfutils.operate.validate"]], "is_local_file_ready": [[13, "is-local-file-ready"]], "hfutils.utils.binary": [[14, "module-hfutils.utils.binary"]], "is_binary_file": [[14, "is-binary-file"]], "hfutils.utils.download": [[15, "module-hfutils.utils.download"]], "download_file": [[15, "download-file"]], "hfutils.utils": [[16, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[17, "module-hfutils.utils.tqdm_"]], "tqdm": [[17, "tqdm"]], "hfutils.utils.walk": [[18, "module-hfutils.utils.walk"]], "walk_files": [[18, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[19, "welcome-to-hfutils-s-documentation"]], "Overview": [[19, "overview"]], "Tutorials": [[19, null]], "Information": [[19, null]], "API Documentation": [[19, null]], "Run Environment Information": [[20, "Run-Environment-Information"], [21, "Run-Environment-Information"]], "Installation": [[22, "installation"]], "Quick Start": [[23, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.operate.validate"], [14, "module-hfutils.utils.binary"], [15, "module-hfutils.utils.download"], [16, "module-hfutils.utils"], [17, "module-hfutils.utils.tqdm_"], [18, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[13, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[13, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[14, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[14, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[15, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[15, "module-hfutils.utils.download"]], "hfutils.utils": [[16, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[17, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[17, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[18, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[18, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 15, 17], "you": [0, 22], "requir": [0, 22], "simpli": [0, 22], "instal": [0, 19], "us": [0, 3, 9, 10, 12, 15, 19, 22], "follow": [0, 22], "code": [0, 3, 6, 8], "pip": [0, 22], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18, 22], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18], "i": [0, 6, 8, 10, 13, 14, 19, 20, 21, 22], "we": 0, "util": [0, 19, 22], "rarfil": 0, "librari": [0, 15], "which": [0, 20, 21, 22], "doe": 0, "offer": 0, "function": [0, 3, 14, 15, 17], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 15, 17, 18], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 18], "an": [0, 10, 12, 15, 17, 18], "filenam": [0, 15], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 15, 17], "bool": [0, 5, 10, 12, 13, 14, 15, 17], "fals": [0, 10, 12, 13, 14, 15, 17], "clear": [0, 12], "specifi": [0, 12, 15], "result": 0, "true": [0, 10, 12, 13, 14, 15, 17], "suppress": [0, 10, 12, 15], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 12], "exist": [0, 10], "when": [0, 10], "return": [0, 3, 9, 13, 14, 15, 17, 18], "path": [0, 6, 8, 9, 10, 12, 13, 14, 15, 18], "password": [0, 10], "none": [0, 3, 5, 6, 8, 9, 10, 12, 13, 15], "content": [0, 17], "option": [0, 3, 5, 6, 8, 9, 10, 12, 13, 15, 17], "determin": 0, "base": [0, 7, 11, 19], "rais": 0, "valueerror": 0, "ani": [0, 5, 14], "get": [0, 9, 15], "meta": [1, 19, 22], "__title__": [1, 22], "__version__": [1, 22], "__description__": [1, 22], "__author__": [1, 22], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 14, 15, 17, 20, 21], "project": 2, "should": [2, 15, 22], "version": [2, 5, 17, 22], "short": 2, "descript": [2, 15], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 15, 20, 21, 22], "object": [3, 9, 10, 12, 15], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 18], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 15, 17], "keyword": [3, 15, 17], "argument": [3, 15, 17], "For": 3, "exampl": 3, "one": 3, "1": [3, 20, 21, 22], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 15, 17], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 22], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 15, 17, 22], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 20, 21, 22], "traceback": 3, "provid": [3, 15], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 22], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 19], "current": [5, 20, 21, 22], "metadata": 5, "arg": [5, 17], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12, 13], "assign": [6, 8, 9, 10, 12], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 19], "print_vers": 7, "download": [7, 11, 16, 19], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 19], "noremotepathassignedwithupload": 7, "33": 8, "hf_token": [9, 10, 12, 13], "hfapi": 9, "hug": [9, 10, 12, 13], "face": [9, 10, 12, 13], "api": [9, 10, 12, 13], "client": [9, 10, 12], "huggingfac": [9, 10, 12, 19, 22], "token": [9, 10, 12, 13], "variabl": [9, 10, 12], "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12, 13], "repo_typ": [9, 10, 12, 13], "liter": [9, 10, 12, 13], "dataset": [9, 10, 12, 13], "model": [9, 10, 12, 13], "space": [9, 10, 12, 13], "subdir": 9, "revis": [9, 10, 12, 13], "main": [9, 10, 12, 13, 22], "ignore_pattern": [9, 10, 12], "given": [9, 14, 15], "identifi": [9, 10, 12, 13], "repotypetyp": [9, 10, 12, 13], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12, 13], "file_in_repo": [10, 12, 13], "resume_download": 10, "save": [10, 15], "local": [10, 12, 13, 15, 20, 21], "within": [10, 12], "resum": 10, "local_directori": [10, 12], "archiv": [10, 12, 19], "dir_in_repo": 10, "max_work": 10, "int": [10, 15], "8": [10, 20, 21, 22], "all": [10, 18], "progress": [10, 12, 15, 17], "bar": [10, 12, 15, 17], "max": 10, "worker": 10, "default": [10, 13], "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "valid": [11, 19], "is_local_file_readi": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "its": 12, "append": 12, "timestamp": 12, "present": 12, "check": [13, 14, 15, 22], "readi": 13, "compar": 13, "hub": 13, "match": 13, "otherwis": [13, 15], "read": 14, "first": 14, "1024": [14, 20, 21], "byte": [14, 15], "contain": 14, "non": 14, "text": 14, "charact": 14, "url": 15, "expected_s": 15, "desc": 15, "session": 15, "request": 15, "tqdm": [15, 16, 19], "It": [15, 22], "also": [15, 22], "perform": [15, 20, 21], "ensur": 15, "ha": [15, 20, 21], "expect": 15, "size": [15, 20, 21], "where": 15, "addit": [15, 17], "pass": [15, 17], "binari": [16, 19], "is_binary_fil": 16, "download_fil": 16, "walk": [16, 19], "walk_fil": 16, "tqdm_": 17, "enhanc": 17, "silenc": 17, "modifi": 17, "behavior": 17, "allow": 17, "posit": 17, "std": 17, "recurs": 18, "through": [18, 22], "yield": 18, "rel": 18, "root": 18, "start": [18, 19], "modul": 19, "quick": 19, "run": 19, "environ": 19, "register_archive_typ": 19, "archive_pack": 19, "archive_unpack": 19, "get_archive_typ": 19, "get_archive_extnam": 19, "config": [19, 22], "entri": 19, "oper": 19, "here": [20, 21], "import": [20, 21, 22], "o": [20, 21], "platform": [20, 21], "shutil": [20, 21], "cpuinfo": [20, 21], "psutil": [20, 21], "hbutil": [20, 21], "scale": [20, 21], "size_to_bytes_str": [20, 21], "python": [20, 21, 22], "python_implement": [20, 21], "python_vers": [20, 21], "cpu": [20, 21], "brand": [20, 21], "get_cpu_info": [20, 21], "brand_raw": [20, 21], "count": [20, 21], "cpu_count": [20, 21], "freq": [20, 21], "cpu_freq": [20, 21], "mhz": [20, 21], "memori": [20, 21], "virtual_memori": [20, 21], "total": [20, 21], "precis": [20, 21], "3": [20, 21, 22], "cuda": [20, 21], "ye": [20, 21], "nvidia": [20, 21], "smi": [20, 21], "els": [20, 21], "No": [20, 21], "linux": [20, 21], "6": [20, 21], "5": [20, 21], "0": [20, 21, 22], "azur": [20, 21], "x86_64": [20, 21], "glibc2": [20, 21], "34": [20, 21], "cpython": [20, 21], "18": [20, 21], "amd": [20, 21], "epyc": [20, 21], "7763": [20, 21], "64": [20, 21], "core": [20, 21], "processor": [20, 21], "4": [20, 21], "2717": 20, "66775": 20, "15": [20, 21], "606": [20, 21], "gib": [20, 21], "pleas": [20, 21], "note": [20, 21], "deploi": [20, 21], "document": [20, 21, 22], "automat": [20, 21], "execut": [20, 21], "github": [20, 21, 22], "action": [20, 21], "therefor": [20, 21], "some": [20, 21], "data": [20, 21], "mai": [20, 21], "differ": [20, 21], "your": [20, 21, 22], "2928": 21, "245": 21, "hfutil": 22, "host": 22, "pypi": 22, "can": 22, "newest": 22, "u": 22, "git": 22, "http": 22, "com": 22, "deepgh": 22, "script": 22, "__name__": 22, "__main__": 22, "develop": 22, "maintain": 22, "like": 22, "below": 22, "mean": 22, "success": 22, "narugo1992": 22, "still": 22, "under": 22, "out": 22, "stabl": 22, "index": 22, "html": 22, "faq": 23}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [16, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "validate"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[13, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[14, 0, 0, "-", "binary"], [15, 0, 0, "-", "download"], [17, 0, 0, "-", "tqdm_"], [18, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[14, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[15, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[17, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[18, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 15], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12, 13], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "valid": 13, "is_local_file_readi": 13, "util": [14, 15, 16, 17, 18], "binari": 14, "is_binary_fil": 14, "download_fil": 15, "tqdm": 17, "walk": 18, "walk_fil": 18, "welcom": 19, "": 19, "document": 19, "overview": 19, "tutori": 19, "inform": [19, 20, 21], "api": 19, "run": [20, 21], "environ": [20, 21], "instal": 22, "quick": 23, "start": 23}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.operate.validate": [[13, "module-hfutils.operate.validate"]], "is_local_file_ready": [[13, "is-local-file-ready"]], "hfutils.utils.binary": [[14, "module-hfutils.utils.binary"]], "is_binary_file": [[14, "is-binary-file"]], "hfutils.utils.download": [[15, "module-hfutils.utils.download"]], "download_file": [[15, "download-file"]], "hfutils.utils": [[16, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[17, "module-hfutils.utils.tqdm_"]], "tqdm": [[17, "tqdm"]], "hfutils.utils.walk": [[18, "module-hfutils.utils.walk"]], "walk_files": [[18, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[19, "welcome-to-hfutils-s-documentation"]], "Overview": [[19, "overview"]], "Tutorials": [[19, null]], "Information": [[19, null]], "API Documentation": [[19, null]], "Run Environment Information": [[20, "Run-Environment-Information"], [21, "Run-Environment-Information"]], "Installation": [[22, "installation"]], "Quick Start": [[23, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.operate.validate"], [14, "module-hfutils.utils.binary"], [15, "module-hfutils.utils.download"], [16, "module-hfutils.utils"], [17, "module-hfutils.utils.tqdm_"], [18, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[13, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[13, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[14, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[14, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[15, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[15, "module-hfutils.utils.download"]], "hfutils.utils": [[16, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[17, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[17, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[18, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[18, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.1.1/.buildinfo b/v0.1.1/.buildinfo
index 700dc9701d..60274e2aac 100644
--- a/v0.1.1/.buildinfo
+++ b/v0.1.1/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: e896285dad24bd39cc3951d677ad82ac
+config: bed7ce630f780131cf2e98a5514f8350
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.1.1/.doctrees/api_doc/archive/index.doctree b/v0.1.1/.doctrees/api_doc/archive/index.doctree
index bfab3bf40a..5f666503f5 100644
Binary files a/v0.1.1/.doctrees/api_doc/archive/index.doctree and b/v0.1.1/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/config/index.doctree b/v0.1.1/.doctrees/api_doc/config/index.doctree
index 94b2923260..6d58259daa 100644
Binary files a/v0.1.1/.doctrees/api_doc/config/index.doctree and b/v0.1.1/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/config/meta.doctree b/v0.1.1/.doctrees/api_doc/config/meta.doctree
index 519e93a50d..abcc02ca85 100644
Binary files a/v0.1.1/.doctrees/api_doc/config/meta.doctree and b/v0.1.1/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/entry/base.doctree b/v0.1.1/.doctrees/api_doc/entry/base.doctree
index b9eaa92dda..cfb6556fd3 100644
Binary files a/v0.1.1/.doctrees/api_doc/entry/base.doctree and b/v0.1.1/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/entry/cli.doctree b/v0.1.1/.doctrees/api_doc/entry/cli.doctree
index 77e1c51f17..7e8d07ddef 100644
Binary files a/v0.1.1/.doctrees/api_doc/entry/cli.doctree and b/v0.1.1/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/entry/dispatch.doctree b/v0.1.1/.doctrees/api_doc/entry/dispatch.doctree
index 2ccdc675b1..7460a10437 100644
Binary files a/v0.1.1/.doctrees/api_doc/entry/dispatch.doctree and b/v0.1.1/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/entry/download.doctree b/v0.1.1/.doctrees/api_doc/entry/download.doctree
index d46f9865b8..6384e10262 100644
Binary files a/v0.1.1/.doctrees/api_doc/entry/download.doctree and b/v0.1.1/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/entry/index.doctree b/v0.1.1/.doctrees/api_doc/entry/index.doctree
index 333b73aa17..d0b6cf78e1 100644
Binary files a/v0.1.1/.doctrees/api_doc/entry/index.doctree and b/v0.1.1/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/entry/upload.doctree b/v0.1.1/.doctrees/api_doc/entry/upload.doctree
index 21d187aa6e..2e931ae570 100644
Binary files a/v0.1.1/.doctrees/api_doc/entry/upload.doctree and b/v0.1.1/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/operate/base.doctree b/v0.1.1/.doctrees/api_doc/operate/base.doctree
index a1d45afe93..4fc53d4ea2 100644
Binary files a/v0.1.1/.doctrees/api_doc/operate/base.doctree and b/v0.1.1/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/operate/download.doctree b/v0.1.1/.doctrees/api_doc/operate/download.doctree
index d911a89207..089862d7d4 100644
Binary files a/v0.1.1/.doctrees/api_doc/operate/download.doctree and b/v0.1.1/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/operate/index.doctree b/v0.1.1/.doctrees/api_doc/operate/index.doctree
index ea2e8c4524..425bf72c0a 100644
Binary files a/v0.1.1/.doctrees/api_doc/operate/index.doctree and b/v0.1.1/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/operate/upload.doctree b/v0.1.1/.doctrees/api_doc/operate/upload.doctree
index a780afc737..a580223787 100644
Binary files a/v0.1.1/.doctrees/api_doc/operate/upload.doctree and b/v0.1.1/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/operate/validate.doctree b/v0.1.1/.doctrees/api_doc/operate/validate.doctree
index 0262a71bae..d7041ecf5e 100644
Binary files a/v0.1.1/.doctrees/api_doc/operate/validate.doctree and b/v0.1.1/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/utils/binary.doctree b/v0.1.1/.doctrees/api_doc/utils/binary.doctree
index 4e0937b224..69143462a8 100644
Binary files a/v0.1.1/.doctrees/api_doc/utils/binary.doctree and b/v0.1.1/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/utils/download.doctree b/v0.1.1/.doctrees/api_doc/utils/download.doctree
index 6092eec26f..df4290006b 100644
Binary files a/v0.1.1/.doctrees/api_doc/utils/download.doctree and b/v0.1.1/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/utils/index.doctree b/v0.1.1/.doctrees/api_doc/utils/index.doctree
index 40b786c3a9..0d87f34c83 100644
Binary files a/v0.1.1/.doctrees/api_doc/utils/index.doctree and b/v0.1.1/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/utils/tqdm_.doctree b/v0.1.1/.doctrees/api_doc/utils/tqdm_.doctree
index d9b8c8219e..54760da3f1 100644
Binary files a/v0.1.1/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.1.1/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.1.1/.doctrees/api_doc/utils/walk.doctree b/v0.1.1/.doctrees/api_doc/utils/walk.doctree
index bb5d548a23..eaaee6ea69 100644
Binary files a/v0.1.1/.doctrees/api_doc/utils/walk.doctree and b/v0.1.1/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.1.1/.doctrees/environment.pickle b/v0.1.1/.doctrees/environment.pickle
index 3de0984af7..d9369beaae 100644
Binary files a/v0.1.1/.doctrees/environment.pickle and b/v0.1.1/.doctrees/environment.pickle differ
diff --git a/v0.1.1/.doctrees/index.doctree b/v0.1.1/.doctrees/index.doctree
index 5475e6bfae..c4c4be2fcf 100644
Binary files a/v0.1.1/.doctrees/index.doctree and b/v0.1.1/.doctrees/index.doctree differ
diff --git a/v0.1.1/.doctrees/information/environment.doctree b/v0.1.1/.doctrees/information/environment.doctree
index 05911ceb37..15af6f568e 100644
Binary files a/v0.1.1/.doctrees/information/environment.doctree and b/v0.1.1/.doctrees/information/environment.doctree differ
diff --git a/v0.1.1/.doctrees/information/environment.result.doctree b/v0.1.1/.doctrees/information/environment.result.doctree
index 5487f60654..4ac93e8233 100644
Binary files a/v0.1.1/.doctrees/information/environment.result.doctree and b/v0.1.1/.doctrees/information/environment.result.doctree differ
diff --git a/v0.1.1/.doctrees/nbsphinx/information/environment.ipynb b/v0.1.1/.doctrees/nbsphinx/information/environment.ipynb
index 6e19b0aad7..b59d7dc6f9 100644
--- a/v0.1.1/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.1.1/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:41:04.419281Z",
-     "iopub.status.busy": "2024-07-23T17:41:04.419077Z",
-     "iopub.status.idle": "2024-07-23T17:41:05.585400Z",
-     "shell.execute_reply": "2024-07-23T17:41:05.584659Z"
+     "iopub.execute_input": "2024-07-23T17:47:18.146837Z",
+     "iopub.status.busy": "2024-07-23T17:47:18.146240Z",
+     "iopub.status.idle": "2024-07-23T17:47:19.320886Z",
+     "shell.execute_reply": "2024-07-23T17:47:19.320129Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2740.8405 MHz\n",
+      "CPU Freq: 2892.6177500000003 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.1/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.1.1/.doctrees/nbsphinx/information/environment.result.ipynb
index 68d1bf782d..3696ebd55b 100644
--- a/v0.1.1/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.1.1/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:03:04.841635Z",
-     "iopub.status.busy": "2024-07-23T17:03:04.841442Z",
-     "iopub.status.idle": "2024-07-23T17:03:06.020401Z",
-     "shell.execute_reply": "2024-07-23T17:03:06.019627Z"
+     "iopub.execute_input": "2024-07-23T17:08:39.282982Z",
+     "iopub.status.busy": "2024-07-23T17:08:39.282761Z",
+     "iopub.status.idle": "2024-07-23T17:08:40.458287Z",
+     "shell.execute_reply": "2024-07-23T17:08:40.457510Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2918.9089999999997 MHz\n",
+      "CPU Freq: 2712.9755 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.1/.doctrees/tutorials/installation/index.doctree b/v0.1.1/.doctrees/tutorials/installation/index.doctree
index 5bf802bac0..9d3510542a 100644
Binary files a/v0.1.1/.doctrees/tutorials/installation/index.doctree and b/v0.1.1/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.1.1/.doctrees/tutorials/quick_start/index.doctree b/v0.1.1/.doctrees/tutorials/quick_start/index.doctree
index 4ac3035d9f..0af97bbf39 100644
Binary files a/v0.1.1/.doctrees/tutorials/quick_start/index.doctree and b/v0.1.1/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.1.1/_sources/information/environment.result.ipynb.txt b/v0.1.1/_sources/information/environment.result.ipynb.txt
index 68d1bf782d..3696ebd55b 100644
--- a/v0.1.1/_sources/information/environment.result.ipynb.txt
+++ b/v0.1.1/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:03:04.841635Z",
-     "iopub.status.busy": "2024-07-23T17:03:04.841442Z",
-     "iopub.status.idle": "2024-07-23T17:03:06.020401Z",
-     "shell.execute_reply": "2024-07-23T17:03:06.019627Z"
+     "iopub.execute_input": "2024-07-23T17:08:39.282982Z",
+     "iopub.status.busy": "2024-07-23T17:08:39.282761Z",
+     "iopub.status.idle": "2024-07-23T17:08:40.458287Z",
+     "shell.execute_reply": "2024-07-23T17:08:40.457510Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2918.9089999999997 MHz\n",
+      "CPU Freq: 2712.9755 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.1/information/environment.html b/v0.1.1/information/environment.html
index 946bd5a5e3..ea64cba648 100644
--- a/v0.1.1/information/environment.html
+++ b/v0.1.1/information/environment.html
@@ -125,11 +125,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2740.8405 MHz
+CPU Freq: 2892.6177500000003 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.1.1/information/environment.ipynb b/v0.1.1/information/environment.ipynb
index 6e19b0aad7..b59d7dc6f9 100644
--- a/v0.1.1/information/environment.ipynb
+++ b/v0.1.1/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:41:04.419281Z",
-     "iopub.status.busy": "2024-07-23T17:41:04.419077Z",
-     "iopub.status.idle": "2024-07-23T17:41:05.585400Z",
-     "shell.execute_reply": "2024-07-23T17:41:05.584659Z"
+     "iopub.execute_input": "2024-07-23T17:47:18.146837Z",
+     "iopub.status.busy": "2024-07-23T17:47:18.146240Z",
+     "iopub.status.idle": "2024-07-23T17:47:19.320886Z",
+     "shell.execute_reply": "2024-07-23T17:47:19.320129Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2740.8405 MHz\n",
+      "CPU Freq: 2892.6177500000003 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.1/information/environment.result.html b/v0.1.1/information/environment.result.html
index b44642f08a..4736ab93eb 100644
--- a/v0.1.1/information/environment.result.html
+++ b/v0.1.1/information/environment.result.html
@@ -127,11 +127,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2918.9089999999997 MHz
+CPU Freq: 2712.9755 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.1.1/information/environment.result.ipynb b/v0.1.1/information/environment.result.ipynb
index 68d1bf782d..3696ebd55b 100644
--- a/v0.1.1/information/environment.result.ipynb
+++ b/v0.1.1/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:03:04.841635Z",
-     "iopub.status.busy": "2024-07-23T17:03:04.841442Z",
-     "iopub.status.idle": "2024-07-23T17:03:06.020401Z",
-     "shell.execute_reply": "2024-07-23T17:03:06.019627Z"
+     "iopub.execute_input": "2024-07-23T17:08:39.282982Z",
+     "iopub.status.busy": "2024-07-23T17:08:39.282761Z",
+     "iopub.status.idle": "2024-07-23T17:08:40.458287Z",
+     "shell.execute_reply": "2024-07-23T17:08:40.457510Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2918.9089999999997 MHz\n",
+      "CPU Freq: 2712.9755 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.1/searchindex.js b/v0.1.1/searchindex.js
index eee8380dfe..f08731da4f 100644
--- a/v0.1.1/searchindex.js
+++ b/v0.1.1/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 15, 17], "you": [0, 22], "requir": [0, 22], "simpli": [0, 22], "instal": [0, 19], "us": [0, 3, 9, 10, 12, 15, 19, 22], "follow": [0, 22], "code": [0, 3, 6, 8], "pip": [0, 22], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18, 22], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18], "i": [0, 6, 8, 10, 13, 14, 19, 20, 21, 22], "we": 0, "util": [0, 19, 22], "rarfil": 0, "librari": [0, 15], "which": [0, 20, 21, 22], "doe": 0, "offer": 0, "function": [0, 3, 14, 15, 17], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 15, 17, 18], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 18], "an": [0, 10, 12, 15, 17, 18], "filenam": [0, 15], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 15, 17], "bool": [0, 5, 10, 12, 13, 14, 15, 17], "fals": [0, 10, 12, 13, 14, 15, 17], "clear": [0, 12], "specifi": [0, 12, 15], "result": 0, "true": [0, 10, 12, 13, 14, 15, 17], "suppress": [0, 10, 12, 15], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 12], "exist": [0, 10], "when": [0, 10], "return": [0, 3, 9, 13, 14, 15, 17, 18], "path": [0, 6, 8, 9, 10, 12, 13, 14, 15, 18], "password": [0, 10], "none": [0, 3, 5, 6, 8, 9, 10, 12, 13, 15], "content": [0, 17], "option": [0, 3, 5, 6, 8, 9, 10, 12, 13, 15, 17], "determin": 0, "base": [0, 7, 11, 19], "rais": 0, "valueerror": 0, "ani": [0, 5, 14], "get": [0, 9, 15], "meta": [1, 19, 22], "__title__": [1, 22], "__version__": [1, 22], "__description__": [1, 22], "__author__": [1, 22], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 14, 15, 17, 20, 21], "project": 2, "should": [2, 15, 22], "version": [2, 5, 17, 22], "short": 2, "descript": [2, 15], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 15, 20, 21, 22], "object": [3, 9, 10, 12, 15], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 18], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 15, 17], "keyword": [3, 15, 17], "argument": [3, 15, 17], "For": 3, "exampl": 3, "one": 3, "1": [3, 20, 21, 22], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 15, 17], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 22], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 15, 17, 22], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 20, 21, 22], "traceback": 3, "provid": [3, 15], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 22], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 19], "current": [5, 20, 21, 22], "metadata": 5, "arg": [5, 17], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12, 13], "assign": [6, 8, 9, 10, 12], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 19], "print_vers": 7, "download": [7, 11, 16, 19], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 19], "noremotepathassignedwithupload": 7, "33": 8, "hf_token": [9, 10, 12, 13], "hfapi": 9, "hug": [9, 10, 12, 13], "face": [9, 10, 12, 13], "api": [9, 10, 12, 13], "client": [9, 10, 12], "huggingfac": [9, 10, 12, 19, 22], "token": [9, 10, 12, 13], "variabl": [9, 10, 12], "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12, 13], "repo_typ": [9, 10, 12, 13], "liter": [9, 10, 12, 13], "dataset": [9, 10, 12, 13], "model": [9, 10, 12, 13], "space": [9, 10, 12, 13], "subdir": 9, "revis": [9, 10, 12, 13], "main": [9, 10, 12, 13, 22], "ignore_pattern": [9, 10, 12], "given": [9, 14, 15], "identifi": [9, 10, 12, 13], "repotypetyp": [9, 10, 12, 13], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12, 13], "file_in_repo": [10, 12, 13], "resume_download": 10, "save": [10, 15], "local": [10, 12, 13, 15, 20, 21], "within": [10, 12], "resum": 10, "local_directori": [10, 12], "archiv": [10, 12, 19], "dir_in_repo": 10, "max_work": 10, "int": [10, 15], "8": [10, 20, 21, 22], "all": [10, 18], "progress": [10, 12, 15, 17], "bar": [10, 12, 15, 17], "max": 10, "worker": 10, "default": [10, 13], "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "valid": [11, 19], "is_local_file_readi": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "its": 12, "append": 12, "timestamp": 12, "present": 12, "check": [13, 14, 15, 22], "readi": 13, "compar": 13, "hub": 13, "match": 13, "otherwis": [13, 15], "read": 14, "first": 14, "1024": 14, "byte": [14, 15], "contain": 14, "non": 14, "text": 14, "charact": 14, "url": 15, "expected_s": 15, "desc": 15, "session": 15, "request": 15, "tqdm": [15, 16, 19], "It": [15, 22], "also": [15, 22], "perform": [15, 20, 21], "ensur": 15, "ha": [15, 20, 21], "expect": 15, "size": [15, 20, 21], "where": 15, "addit": [15, 17], "pass": [15, 17], "binari": [16, 19], "is_binary_fil": 16, "download_fil": 16, "walk": [16, 19], "walk_fil": 16, "tqdm_": 17, "enhanc": 17, "silenc": 17, "modifi": 17, "behavior": 17, "allow": 17, "posit": 17, "std": 17, "recurs": 18, "through": [18, 22], "yield": 18, "rel": 18, "root": 18, "start": [18, 19], "modul": 19, "quick": 19, "run": 19, "environ": 19, "register_archive_typ": 19, "archive_pack": 19, "archive_unpack": 19, "get_archive_typ": 19, "get_archive_extnam": 19, "config": [19, 22], "entri": 19, "oper": 19, "here": [20, 21], "import": [20, 21, 22], "o": [20, 21], "platform": [20, 21], "shutil": [20, 21], "cpuinfo": [20, 21], "psutil": [20, 21], "hbutil": [20, 21], "scale": [20, 21], "size_to_bytes_str": [20, 21], "python": [20, 21, 22], "python_implement": [20, 21], "python_vers": [20, 21], "cpu": [20, 21], "brand": [20, 21], "get_cpu_info": [20, 21], "brand_raw": [20, 21], "count": [20, 21], "cpu_count": [20, 21], "freq": [20, 21], "cpu_freq": [20, 21], "mhz": [20, 21], "memori": [20, 21], "virtual_memori": [20, 21], "total": [20, 21], "precis": [20, 21], "3": [20, 21, 22], "cuda": [20, 21], "ye": [20, 21], "nvidia": [20, 21], "smi": [20, 21], "els": [20, 21], "No": [20, 21], "linux": [20, 21], "6": [20, 21], "5": [20, 21], "0": [20, 21, 22], "1023": [20, 21], "azur": [20, 21], "x86_64": [20, 21], "glibc2": [20, 21], "34": [20, 21], "cpython": [20, 21], "18": [20, 21], "amd": [20, 21], "epyc": [20, 21], "7763": [20, 21], "64": [20, 21], "core": [20, 21], "processor": [20, 21], "4": [20, 21], "2740": 20, "8405": 20, "15": [20, 21], "606": [20, 21], "gib": [20, 21], "pleas": [20, 21], "note": [20, 21], "deploi": [20, 21], "document": [20, 21, 22], "automat": [20, 21], "execut": [20, 21], "github": [20, 21, 22], "action": [20, 21], "therefor": [20, 21], "some": [20, 21], "data": [20, 21], "mai": [20, 21], "differ": [20, 21], "your": [20, 21, 22], "2918": 21, "9089999999997": 21, "hfutil": 22, "host": 22, "pypi": 22, "can": 22, "newest": 22, "u": 22, "git": 22, "http": 22, "com": 22, "deepgh": 22, "script": 22, "__name__": 22, "__main__": 22, "develop": 22, "maintain": 22, "like": 22, "below": 22, "mean": 22, "success": 22, "narugo1992": 22, "still": 22, "under": 22, "out": 22, "stabl": 22, "index": 22, "html": 22, "faq": 23}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [16, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "validate"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[13, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[14, 0, 0, "-", "binary"], [15, 0, 0, "-", "download"], [17, 0, 0, "-", "tqdm_"], [18, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[14, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[15, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[17, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[18, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 15], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12, 13], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "valid": 13, "is_local_file_readi": 13, "util": [14, 15, 16, 17, 18], "binari": 14, "is_binary_fil": 14, "download_fil": 15, "tqdm": 17, "walk": 18, "walk_fil": 18, "welcom": 19, "": 19, "document": 19, "overview": 19, "tutori": 19, "inform": [19, 20, 21], "api": 19, "run": [20, 21], "environ": [20, 21], "instal": 22, "quick": 23, "start": 23}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.operate.validate": [[13, "module-hfutils.operate.validate"]], "is_local_file_ready": [[13, "is-local-file-ready"]], "hfutils.utils.binary": [[14, "module-hfutils.utils.binary"]], "is_binary_file": [[14, "is-binary-file"]], "hfutils.utils.download": [[15, "module-hfutils.utils.download"]], "download_file": [[15, "download-file"]], "hfutils.utils": [[16, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[17, "module-hfutils.utils.tqdm_"]], "tqdm": [[17, "tqdm"]], "hfutils.utils.walk": [[18, "module-hfutils.utils.walk"]], "walk_files": [[18, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[19, "welcome-to-hfutils-s-documentation"]], "Overview": [[19, "overview"]], "Tutorials": [[19, null]], "Information": [[19, null]], "API Documentation": [[19, null]], "Run Environment Information": [[20, "Run-Environment-Information"], [21, "Run-Environment-Information"]], "Installation": [[22, "installation"]], "Quick Start": [[23, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.operate.validate"], [14, "module-hfutils.utils.binary"], [15, "module-hfutils.utils.download"], [16, "module-hfutils.utils"], [17, "module-hfutils.utils.tqdm_"], [18, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[13, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[13, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[14, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[14, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[15, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[15, "module-hfutils.utils.download"]], "hfutils.utils": [[16, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[17, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[17, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[18, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[18, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 15, 17], "you": [0, 22], "requir": [0, 22], "simpli": [0, 22], "instal": [0, 19], "us": [0, 3, 9, 10, 12, 15, 19, 22], "follow": [0, 22], "code": [0, 3, 6, 8], "pip": [0, 22], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18, 22], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18], "i": [0, 6, 8, 10, 13, 14, 19, 20, 21, 22], "we": 0, "util": [0, 19, 22], "rarfil": 0, "librari": [0, 15], "which": [0, 20, 21, 22], "doe": 0, "offer": 0, "function": [0, 3, 14, 15, 17], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 15, 17, 18], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 18], "an": [0, 10, 12, 15, 17, 18], "filenam": [0, 15], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 15, 17], "bool": [0, 5, 10, 12, 13, 14, 15, 17], "fals": [0, 10, 12, 13, 14, 15, 17], "clear": [0, 12], "specifi": [0, 12, 15], "result": 0, "true": [0, 10, 12, 13, 14, 15, 17], "suppress": [0, 10, 12, 15], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 12], "exist": [0, 10], "when": [0, 10], "return": [0, 3, 9, 13, 14, 15, 17, 18], "path": [0, 6, 8, 9, 10, 12, 13, 14, 15, 18], "password": [0, 10], "none": [0, 3, 5, 6, 8, 9, 10, 12, 13, 15], "content": [0, 17], "option": [0, 3, 5, 6, 8, 9, 10, 12, 13, 15, 17], "determin": 0, "base": [0, 7, 11, 19], "rais": 0, "valueerror": 0, "ani": [0, 5, 14], "get": [0, 9, 15], "meta": [1, 19, 22], "__title__": [1, 22], "__version__": [1, 22], "__description__": [1, 22], "__author__": [1, 22], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 14, 15, 17, 20, 21], "project": 2, "should": [2, 15, 22], "version": [2, 5, 17, 22], "short": 2, "descript": [2, 15], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 15, 20, 21, 22], "object": [3, 9, 10, 12, 15], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 18], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 15, 17], "keyword": [3, 15, 17], "argument": [3, 15, 17], "For": 3, "exampl": 3, "one": 3, "1": [3, 20, 21, 22], "two": 3, "2": 3, "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 15, 17], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 22], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 15, 17, 22], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 20, 21, 22], "traceback": 3, "provid": [3, 15], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 22], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 19], "current": [5, 20, 21, 22], "metadata": 5, "arg": [5, 17], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12, 13], "assign": [6, 8, 9, 10, 12], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 19], "print_vers": 7, "download": [7, 11, 16, 19], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 19], "noremotepathassignedwithupload": 7, "33": 8, "hf_token": [9, 10, 12, 13], "hfapi": 9, "hug": [9, 10, 12, 13], "face": [9, 10, 12, 13], "api": [9, 10, 12, 13], "client": [9, 10, 12], "huggingfac": [9, 10, 12, 19, 22], "token": [9, 10, 12, 13], "variabl": [9, 10, 12], "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12, 13], "repo_typ": [9, 10, 12, 13], "liter": [9, 10, 12, 13], "dataset": [9, 10, 12, 13], "model": [9, 10, 12, 13], "space": [9, 10, 12, 13], "subdir": 9, "revis": [9, 10, 12, 13], "main": [9, 10, 12, 13, 22], "ignore_pattern": [9, 10, 12], "given": [9, 14, 15], "identifi": [9, 10, 12, 13], "repotypetyp": [9, 10, 12, 13], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12, 13], "file_in_repo": [10, 12, 13], "resume_download": 10, "save": [10, 15], "local": [10, 12, 13, 15, 20, 21], "within": [10, 12], "resum": 10, "local_directori": [10, 12], "archiv": [10, 12, 19], "dir_in_repo": 10, "max_work": 10, "int": [10, 15], "8": [10, 20, 21, 22], "all": [10, 18], "progress": [10, 12, 15, 17], "bar": [10, 12, 15, 17], "max": 10, "worker": 10, "default": [10, 13], "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "valid": [11, 19], "is_local_file_readi": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "its": 12, "append": 12, "timestamp": 12, "present": 12, "check": [13, 14, 15, 22], "readi": 13, "compar": 13, "hub": 13, "match": 13, "otherwis": [13, 15], "read": 14, "first": 14, "1024": [14, 20, 21], "byte": [14, 15], "contain": 14, "non": 14, "text": 14, "charact": 14, "url": 15, "expected_s": 15, "desc": 15, "session": 15, "request": 15, "tqdm": [15, 16, 19], "It": [15, 22], "also": [15, 22], "perform": [15, 20, 21], "ensur": 15, "ha": [15, 20, 21], "expect": 15, "size": [15, 20, 21], "where": 15, "addit": [15, 17], "pass": [15, 17], "binari": [16, 19], "is_binary_fil": 16, "download_fil": 16, "walk": [16, 19], "walk_fil": 16, "tqdm_": 17, "enhanc": 17, "silenc": 17, "modifi": 17, "behavior": 17, "allow": 17, "posit": 17, "std": 17, "recurs": 18, "through": [18, 22], "yield": 18, "rel": 18, "root": 18, "start": [18, 19], "modul": 19, "quick": 19, "run": 19, "environ": 19, "register_archive_typ": 19, "archive_pack": 19, "archive_unpack": 19, "get_archive_typ": 19, "get_archive_extnam": 19, "config": [19, 22], "entri": 19, "oper": 19, "here": [20, 21], "import": [20, 21, 22], "o": [20, 21], "platform": [20, 21], "shutil": [20, 21], "cpuinfo": [20, 21], "psutil": [20, 21], "hbutil": [20, 21], "scale": [20, 21], "size_to_bytes_str": [20, 21], "python": [20, 21, 22], "python_implement": [20, 21], "python_vers": [20, 21], "cpu": [20, 21], "brand": [20, 21], "get_cpu_info": [20, 21], "brand_raw": [20, 21], "count": [20, 21], "cpu_count": [20, 21], "freq": [20, 21], "cpu_freq": [20, 21], "mhz": [20, 21], "memori": [20, 21], "virtual_memori": [20, 21], "total": [20, 21], "precis": [20, 21], "3": [20, 21, 22], "cuda": [20, 21], "ye": [20, 21], "nvidia": [20, 21], "smi": [20, 21], "els": [20, 21], "No": [20, 21], "linux": [20, 21], "6": [20, 21], "5": [20, 21], "0": [20, 21, 22], "azur": [20, 21], "x86_64": [20, 21], "glibc2": [20, 21], "34": [20, 21], "cpython": [20, 21], "18": [20, 21], "amd": [20, 21], "epyc": [20, 21], "7763": [20, 21], "64": [20, 21], "core": [20, 21], "processor": [20, 21], "4": [20, 21], "2892": 20, "6177500000003": 20, "15": [20, 21], "606": [20, 21], "gib": [20, 21], "pleas": [20, 21], "note": [20, 21], "deploi": [20, 21], "document": [20, 21, 22], "automat": [20, 21], "execut": [20, 21], "github": [20, 21, 22], "action": [20, 21], "therefor": [20, 21], "some": [20, 21], "data": [20, 21], "mai": [20, 21], "differ": [20, 21], "your": [20, 21, 22], "2712": 21, "9755": 21, "hfutil": 22, "host": 22, "pypi": 22, "can": 22, "newest": 22, "u": 22, "git": 22, "http": 22, "com": 22, "deepgh": 22, "script": 22, "__name__": 22, "__main__": 22, "develop": 22, "maintain": 22, "like": 22, "below": 22, "mean": 22, "success": 22, "narugo1992": 22, "still": 22, "under": 22, "out": 22, "stabl": 22, "index": 22, "html": 22, "faq": 23}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [16, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "validate"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[13, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[14, 0, 0, "-", "binary"], [15, 0, 0, "-", "download"], [17, 0, 0, "-", "tqdm_"], [18, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[14, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[15, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[17, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[18, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 15], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12, 13], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "valid": 13, "is_local_file_readi": 13, "util": [14, 15, 16, 17, 18], "binari": 14, "is_binary_fil": 14, "download_fil": 15, "tqdm": 17, "walk": 18, "walk_fil": 18, "welcom": 19, "": 19, "document": 19, "overview": 19, "tutori": 19, "inform": [19, 20, 21], "api": 19, "run": [20, 21], "environ": [20, 21], "instal": 22, "quick": 23, "start": 23}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.operate.validate": [[13, "module-hfutils.operate.validate"]], "is_local_file_ready": [[13, "is-local-file-ready"]], "hfutils.utils.binary": [[14, "module-hfutils.utils.binary"]], "is_binary_file": [[14, "is-binary-file"]], "hfutils.utils.download": [[15, "module-hfutils.utils.download"]], "download_file": [[15, "download-file"]], "hfutils.utils": [[16, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[17, "module-hfutils.utils.tqdm_"]], "tqdm": [[17, "tqdm"]], "hfutils.utils.walk": [[18, "module-hfutils.utils.walk"]], "walk_files": [[18, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[19, "welcome-to-hfutils-s-documentation"]], "Overview": [[19, "overview"]], "Tutorials": [[19, null]], "Information": [[19, null]], "API Documentation": [[19, null]], "Run Environment Information": [[20, "Run-Environment-Information"], [21, "Run-Environment-Information"]], "Installation": [[22, "installation"]], "Quick Start": [[23, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.operate.validate"], [14, "module-hfutils.utils.binary"], [15, "module-hfutils.utils.download"], [16, "module-hfutils.utils"], [17, "module-hfutils.utils.tqdm_"], [18, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[13, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[13, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[14, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[14, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[15, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[15, "module-hfutils.utils.download"]], "hfutils.utils": [[16, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[17, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[17, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[18, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[18, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.1.2/.buildinfo b/v0.1.2/.buildinfo
index a3c0ff721c..7177e53c18 100644
--- a/v0.1.2/.buildinfo
+++ b/v0.1.2/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 12468d0292f6af1a508d6574b7d97105
+config: c307b55805173751ad179ce0373af0d1
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.1.2/.doctrees/api_doc/archive/index.doctree b/v0.1.2/.doctrees/api_doc/archive/index.doctree
index b95c0236d3..6cf8f795ca 100644
Binary files a/v0.1.2/.doctrees/api_doc/archive/index.doctree and b/v0.1.2/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/config/index.doctree b/v0.1.2/.doctrees/api_doc/config/index.doctree
index b67ff5a37e..4722d088ac 100644
Binary files a/v0.1.2/.doctrees/api_doc/config/index.doctree and b/v0.1.2/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/config/meta.doctree b/v0.1.2/.doctrees/api_doc/config/meta.doctree
index 1085cf54a2..2924aa47ca 100644
Binary files a/v0.1.2/.doctrees/api_doc/config/meta.doctree and b/v0.1.2/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/entry/base.doctree b/v0.1.2/.doctrees/api_doc/entry/base.doctree
index a234a0c1c6..104b3388a5 100644
Binary files a/v0.1.2/.doctrees/api_doc/entry/base.doctree and b/v0.1.2/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/entry/cli.doctree b/v0.1.2/.doctrees/api_doc/entry/cli.doctree
index 04a58d88b4..efcf41cc68 100644
Binary files a/v0.1.2/.doctrees/api_doc/entry/cli.doctree and b/v0.1.2/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/entry/dispatch.doctree b/v0.1.2/.doctrees/api_doc/entry/dispatch.doctree
index c589a5d182..3d783eed56 100644
Binary files a/v0.1.2/.doctrees/api_doc/entry/dispatch.doctree and b/v0.1.2/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/entry/download.doctree b/v0.1.2/.doctrees/api_doc/entry/download.doctree
index 88df36ae09..1b63248327 100644
Binary files a/v0.1.2/.doctrees/api_doc/entry/download.doctree and b/v0.1.2/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/entry/index.doctree b/v0.1.2/.doctrees/api_doc/entry/index.doctree
index e947b5f426..fc4cfc5109 100644
Binary files a/v0.1.2/.doctrees/api_doc/entry/index.doctree and b/v0.1.2/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/entry/upload.doctree b/v0.1.2/.doctrees/api_doc/entry/upload.doctree
index 8032f4d53e..ee4fe54e45 100644
Binary files a/v0.1.2/.doctrees/api_doc/entry/upload.doctree and b/v0.1.2/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/operate/base.doctree b/v0.1.2/.doctrees/api_doc/operate/base.doctree
index 61de3bc8a9..f04c0f4241 100644
Binary files a/v0.1.2/.doctrees/api_doc/operate/base.doctree and b/v0.1.2/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/operate/download.doctree b/v0.1.2/.doctrees/api_doc/operate/download.doctree
index f442e82767..763f1bb268 100644
Binary files a/v0.1.2/.doctrees/api_doc/operate/download.doctree and b/v0.1.2/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/operate/index.doctree b/v0.1.2/.doctrees/api_doc/operate/index.doctree
index e4deaecd65..df417977a7 100644
Binary files a/v0.1.2/.doctrees/api_doc/operate/index.doctree and b/v0.1.2/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/operate/upload.doctree b/v0.1.2/.doctrees/api_doc/operate/upload.doctree
index c351c4591a..fa22df7d9d 100644
Binary files a/v0.1.2/.doctrees/api_doc/operate/upload.doctree and b/v0.1.2/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/operate/validate.doctree b/v0.1.2/.doctrees/api_doc/operate/validate.doctree
index 429f9f8d41..0e09121769 100644
Binary files a/v0.1.2/.doctrees/api_doc/operate/validate.doctree and b/v0.1.2/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/utils/binary.doctree b/v0.1.2/.doctrees/api_doc/utils/binary.doctree
index ff7ca56daf..745bb146b2 100644
Binary files a/v0.1.2/.doctrees/api_doc/utils/binary.doctree and b/v0.1.2/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/utils/download.doctree b/v0.1.2/.doctrees/api_doc/utils/download.doctree
index a6733f3eed..3394eefb40 100644
Binary files a/v0.1.2/.doctrees/api_doc/utils/download.doctree and b/v0.1.2/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/utils/index.doctree b/v0.1.2/.doctrees/api_doc/utils/index.doctree
index f484085849..530de0ce62 100644
Binary files a/v0.1.2/.doctrees/api_doc/utils/index.doctree and b/v0.1.2/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/utils/tqdm_.doctree b/v0.1.2/.doctrees/api_doc/utils/tqdm_.doctree
index b29a4ff44a..f9c5a03138 100644
Binary files a/v0.1.2/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.1.2/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.1.2/.doctrees/api_doc/utils/walk.doctree b/v0.1.2/.doctrees/api_doc/utils/walk.doctree
index 1cb50a863c..98183fbda4 100644
Binary files a/v0.1.2/.doctrees/api_doc/utils/walk.doctree and b/v0.1.2/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.1.2/.doctrees/environment.pickle b/v0.1.2/.doctrees/environment.pickle
index 91dd13daa6..59048e52b8 100644
Binary files a/v0.1.2/.doctrees/environment.pickle and b/v0.1.2/.doctrees/environment.pickle differ
diff --git a/v0.1.2/.doctrees/index.doctree b/v0.1.2/.doctrees/index.doctree
index 8b17fb345c..c4f84cba1f 100644
Binary files a/v0.1.2/.doctrees/index.doctree and b/v0.1.2/.doctrees/index.doctree differ
diff --git a/v0.1.2/.doctrees/information/environment.doctree b/v0.1.2/.doctrees/information/environment.doctree
index 3b86d3f912..202d780e44 100644
Binary files a/v0.1.2/.doctrees/information/environment.doctree and b/v0.1.2/.doctrees/information/environment.doctree differ
diff --git a/v0.1.2/.doctrees/information/environment.result.doctree b/v0.1.2/.doctrees/information/environment.result.doctree
index abd5ccdcf0..481d2e0187 100644
Binary files a/v0.1.2/.doctrees/information/environment.result.doctree and b/v0.1.2/.doctrees/information/environment.result.doctree differ
diff --git a/v0.1.2/.doctrees/nbsphinx/information/environment.ipynb b/v0.1.2/.doctrees/nbsphinx/information/environment.ipynb
index 44e0d37ffd..a4f5bb1030 100644
--- a/v0.1.2/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.1.2/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:43:15.994550Z",
-     "iopub.status.busy": "2024-07-23T17:43:15.994351Z",
-     "iopub.status.idle": "2024-07-23T17:43:17.162602Z",
-     "shell.execute_reply": "2024-07-23T17:43:17.161826Z"
+     "iopub.execute_input": "2024-07-23T17:49:33.998642Z",
+     "iopub.status.busy": "2024-07-23T17:49:33.998432Z",
+     "iopub.status.idle": "2024-07-23T17:49:35.166433Z",
+     "shell.execute_reply": "2024-07-23T17:49:35.165556Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 3068.2265 MHz\n",
+      "CPU Freq: 2912.80425 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.2/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.1.2/.doctrees/nbsphinx/information/environment.result.ipynb
index 26d9c16c3e..0fadc5a9e9 100644
--- a/v0.1.2/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.1.2/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:04:11.704584Z",
-     "iopub.status.busy": "2024-07-23T17:04:11.704389Z",
-     "iopub.status.idle": "2024-07-23T17:04:12.876101Z",
-     "shell.execute_reply": "2024-07-23T17:04:12.875367Z"
+     "iopub.execute_input": "2024-07-23T17:09:47.600242Z",
+     "iopub.status.busy": "2024-07-23T17:09:47.599680Z",
+     "iopub.status.idle": "2024-07-23T17:09:48.777657Z",
+     "shell.execute_reply": "2024-07-23T17:09:48.776895Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2919.77475 MHz\n",
+      "CPU Freq: 2912.1099999999997 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.2/.doctrees/tutorials/installation/index.doctree b/v0.1.2/.doctrees/tutorials/installation/index.doctree
index ecf7aadcfd..6be20d71ff 100644
Binary files a/v0.1.2/.doctrees/tutorials/installation/index.doctree and b/v0.1.2/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.1.2/.doctrees/tutorials/quick_start/index.doctree b/v0.1.2/.doctrees/tutorials/quick_start/index.doctree
index 2cfd5b6911..31b1bcc52c 100644
Binary files a/v0.1.2/.doctrees/tutorials/quick_start/index.doctree and b/v0.1.2/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.1.2/_sources/information/environment.result.ipynb.txt b/v0.1.2/_sources/information/environment.result.ipynb.txt
index 26d9c16c3e..0fadc5a9e9 100644
--- a/v0.1.2/_sources/information/environment.result.ipynb.txt
+++ b/v0.1.2/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:04:11.704584Z",
-     "iopub.status.busy": "2024-07-23T17:04:11.704389Z",
-     "iopub.status.idle": "2024-07-23T17:04:12.876101Z",
-     "shell.execute_reply": "2024-07-23T17:04:12.875367Z"
+     "iopub.execute_input": "2024-07-23T17:09:47.600242Z",
+     "iopub.status.busy": "2024-07-23T17:09:47.599680Z",
+     "iopub.status.idle": "2024-07-23T17:09:48.777657Z",
+     "shell.execute_reply": "2024-07-23T17:09:48.776895Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2919.77475 MHz\n",
+      "CPU Freq: 2912.1099999999997 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.2/information/environment.html b/v0.1.2/information/environment.html
index e55e80503b..f3f51c9fed 100644
--- a/v0.1.2/information/environment.html
+++ b/v0.1.2/information/environment.html
@@ -125,11 +125,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 3068.2265 MHz
+CPU Freq: 2912.80425 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.1.2/information/environment.ipynb b/v0.1.2/information/environment.ipynb
index 44e0d37ffd..a4f5bb1030 100644
--- a/v0.1.2/information/environment.ipynb
+++ b/v0.1.2/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:43:15.994550Z",
-     "iopub.status.busy": "2024-07-23T17:43:15.994351Z",
-     "iopub.status.idle": "2024-07-23T17:43:17.162602Z",
-     "shell.execute_reply": "2024-07-23T17:43:17.161826Z"
+     "iopub.execute_input": "2024-07-23T17:49:33.998642Z",
+     "iopub.status.busy": "2024-07-23T17:49:33.998432Z",
+     "iopub.status.idle": "2024-07-23T17:49:35.166433Z",
+     "shell.execute_reply": "2024-07-23T17:49:35.165556Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 3068.2265 MHz\n",
+      "CPU Freq: 2912.80425 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.2/information/environment.result.html b/v0.1.2/information/environment.result.html
index 8b85b73b5c..575fdd084c 100644
--- a/v0.1.2/information/environment.result.html
+++ b/v0.1.2/information/environment.result.html
@@ -127,11 +127,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2919.77475 MHz
+CPU Freq: 2912.1099999999997 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.1.2/information/environment.result.ipynb b/v0.1.2/information/environment.result.ipynb
index 26d9c16c3e..0fadc5a9e9 100644
--- a/v0.1.2/information/environment.result.ipynb
+++ b/v0.1.2/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:04:11.704584Z",
-     "iopub.status.busy": "2024-07-23T17:04:11.704389Z",
-     "iopub.status.idle": "2024-07-23T17:04:12.876101Z",
-     "shell.execute_reply": "2024-07-23T17:04:12.875367Z"
+     "iopub.execute_input": "2024-07-23T17:09:47.600242Z",
+     "iopub.status.busy": "2024-07-23T17:09:47.599680Z",
+     "iopub.status.idle": "2024-07-23T17:09:48.777657Z",
+     "shell.execute_reply": "2024-07-23T17:09:48.776895Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2919.77475 MHz\n",
+      "CPU Freq: 2912.1099999999997 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.1.2/searchindex.js b/v0.1.2/searchindex.js
index 881b333cee..4a6a1852da 100644
--- a/v0.1.2/searchindex.js
+++ b/v0.1.2/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 15, 17], "you": [0, 22], "requir": [0, 22], "simpli": [0, 22], "instal": [0, 19], "us": [0, 3, 9, 10, 12, 15, 19, 22], "follow": [0, 22], "code": [0, 3, 6, 8], "pip": [0, 22], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18, 22], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18], "i": [0, 6, 8, 10, 13, 14, 19, 20, 21, 22], "we": 0, "util": [0, 19, 22], "rarfil": 0, "librari": [0, 15], "which": [0, 20, 21, 22], "doe": 0, "offer": 0, "function": [0, 3, 14, 15, 17], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 15, 17, 18], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 18], "an": [0, 10, 12, 15, 17, 18], "filenam": [0, 15], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 15, 17], "bool": [0, 5, 10, 12, 13, 14, 15, 17], "fals": [0, 10, 12, 13, 14, 15, 17], "clear": [0, 12], "specifi": [0, 12, 15], "result": 0, "true": [0, 10, 12, 13, 14, 15, 17], "suppress": [0, 10, 12, 15], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 12], "exist": [0, 10], "when": [0, 10], "return": [0, 3, 9, 13, 14, 15, 17, 18], "path": [0, 6, 8, 9, 10, 12, 13, 14, 15, 18], "password": [0, 10], "none": [0, 3, 5, 6, 8, 9, 10, 12, 13, 15], "content": [0, 17], "option": [0, 3, 5, 6, 8, 9, 10, 12, 13, 15, 17], "determin": 0, "base": [0, 7, 11, 19], "rais": 0, "valueerror": 0, "ani": [0, 5, 14], "get": [0, 9, 15], "meta": [1, 19, 22], "__title__": [1, 22], "__version__": [1, 22], "__description__": [1, 22], "__author__": [1, 22], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 14, 15, 17, 20, 21], "project": 2, "should": [2, 15, 22], "version": [2, 5, 17, 22], "short": 2, "descript": [2, 15], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 15, 20, 21, 22], "object": [3, 9, 10, 12, 15], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 18], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 15, 17], "keyword": [3, 15, 17], "argument": [3, 15, 17], "For": 3, "exampl": 3, "one": 3, "1": [3, 20, 21, 22], "two": 3, "2": [3, 22], "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 15, 17], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 22], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 15, 17, 22], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 20, 21, 22], "traceback": 3, "provid": [3, 15], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 22], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 19], "current": [5, 20, 21, 22], "metadata": 5, "arg": [5, 17], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12, 13], "assign": [6, 8, 9, 10, 12], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 19], "print_vers": 7, "download": [7, 11, 16, 19], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 19], "noremotepathassignedwithupload": 7, "33": 8, "hf_token": [9, 10, 12, 13], "hfapi": 9, "hug": [9, 10, 12, 13], "face": [9, 10, 12, 13], "api": [9, 10, 12, 13], "client": [9, 10, 12], "huggingfac": [9, 10, 12, 19, 22], "token": [9, 10, 12, 13], "variabl": [9, 10, 12], "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12, 13], "repo_typ": [9, 10, 12, 13], "liter": [9, 10, 12, 13], "dataset": [9, 10, 12, 13], "model": [9, 10, 12, 13], "space": [9, 10, 12, 13], "subdir": 9, "revis": [9, 10, 12, 13], "main": [9, 10, 12, 13, 22], "ignore_pattern": [9, 10, 12], "given": [9, 14, 15], "identifi": [9, 10, 12, 13], "repotypetyp": [9, 10, 12, 13], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12, 13], "file_in_repo": [10, 12, 13], "resume_download": 10, "save": [10, 15], "local": [10, 12, 13, 15, 20, 21], "within": [10, 12], "resum": 10, "local_directori": [10, 12], "archiv": [10, 12, 19], "dir_in_repo": 10, "max_work": 10, "int": [10, 15], "8": [10, 20, 21, 22], "max_retri": 10, "5": [10, 20, 21], "all": [10, 18], "progress": [10, 12, 15, 17], "bar": [10, 12, 15, 17], "max": 10, "worker": 10, "default": [10, 13], "retri": 10, "time": 10, "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "valid": [11, 19], "is_local_file_readi": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "its": 12, "append": 12, "timestamp": 12, "present": 12, "check": [13, 14, 15, 22], "readi": 13, "compar": 13, "hub": 13, "match": 13, "otherwis": [13, 15], "read": 14, "first": 14, "1024": 14, "byte": [14, 15], "contain": 14, "non": 14, "text": 14, "charact": 14, "url": 15, "expected_s": 15, "desc": 15, "session": 15, "request": 15, "tqdm": [15, 16, 19], "It": [15, 22], "also": [15, 22], "perform": [15, 20, 21], "ensur": 15, "ha": [15, 20, 21], "expect": 15, "size": [15, 20, 21], "where": 15, "addit": [15, 17], "pass": [15, 17], "binari": [16, 19], "is_binary_fil": 16, "download_fil": 16, "walk": [16, 19], "walk_fil": 16, "tqdm_": 17, "enhanc": 17, "silenc": 17, "modifi": 17, "behavior": 17, "allow": 17, "posit": 17, "std": 17, "recurs": 18, "through": [18, 22], "yield": 18, "rel": 18, "root": 18, "start": [18, 19], "modul": 19, "quick": 19, "run": 19, "environ": 19, "register_archive_typ": 19, "archive_pack": 19, "archive_unpack": 19, "get_archive_typ": 19, "get_archive_extnam": 19, "config": [19, 22], "entri": 19, "oper": 19, "here": [20, 21], "import": [20, 21, 22], "o": [20, 21], "platform": [20, 21], "shutil": [20, 21], "cpuinfo": [20, 21], "psutil": [20, 21], "hbutil": [20, 21], "scale": [20, 21], "size_to_bytes_str": [20, 21], "python": [20, 21, 22], "python_implement": [20, 21], "python_vers": [20, 21], "cpu": [20, 21], "brand": [20, 21], "get_cpu_info": [20, 21], "brand_raw": [20, 21], "count": [20, 21], "cpu_count": [20, 21], "freq": [20, 21], "cpu_freq": [20, 21], "mhz": [20, 21], "memori": [20, 21], "virtual_memori": [20, 21], "total": [20, 21], "precis": [20, 21], "3": [20, 21, 22], "cuda": [20, 21], "ye": [20, 21], "nvidia": [20, 21], "smi": [20, 21], "els": [20, 21], "No": [20, 21], "linux": [20, 21], "6": [20, 21], "0": [20, 21, 22], "1023": [20, 21], "azur": [20, 21], "x86_64": [20, 21], "glibc2": [20, 21], "34": [20, 21], "cpython": [20, 21], "18": [20, 21], "amd": [20, 21], "epyc": [20, 21], "7763": [20, 21], "64": [20, 21], "core": [20, 21], "processor": [20, 21], "4": [20, 21], "3068": 20, "2265": 20, "15": [20, 21], "606": [20, 21], "gib": [20, 21], "pleas": [20, 21], "note": [20, 21], "deploi": [20, 21], "document": [20, 21, 22], "automat": [20, 21], "execut": [20, 21], "github": [20, 21, 22], "action": [20, 21], "therefor": [20, 21], "some": [20, 21], "data": [20, 21], "mai": [20, 21], "differ": [20, 21], "your": [20, 21, 22], "2919": 21, "77475": 21, "hfutil": 22, "host": 22, "pypi": 22, "can": 22, "newest": 22, "u": 22, "git": 22, "http": 22, "com": 22, "deepgh": 22, "script": 22, "__name__": 22, "__main__": 22, "develop": 22, "maintain": 22, "like": 22, "below": 22, "mean": 22, "success": 22, "narugo1992": 22, "still": 22, "under": 22, "out": 22, "stabl": 22, "index": 22, "html": 22, "faq": 23}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [16, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "validate"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[13, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[14, 0, 0, "-", "binary"], [15, 0, 0, "-", "download"], [17, 0, 0, "-", "tqdm_"], [18, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[14, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[15, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[17, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[18, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 15], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12, 13], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "valid": 13, "is_local_file_readi": 13, "util": [14, 15, 16, 17, 18], "binari": 14, "is_binary_fil": 14, "download_fil": 15, "tqdm": 17, "walk": 18, "walk_fil": 18, "welcom": 19, "": 19, "document": 19, "overview": 19, "tutori": 19, "inform": [19, 20, 21], "api": 19, "run": [20, 21], "environ": [20, 21], "instal": 22, "quick": 23, "start": 23}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.operate.validate": [[13, "module-hfutils.operate.validate"]], "is_local_file_ready": [[13, "is-local-file-ready"]], "hfutils.utils.binary": [[14, "module-hfutils.utils.binary"]], "is_binary_file": [[14, "is-binary-file"]], "hfutils.utils.download": [[15, "module-hfutils.utils.download"]], "download_file": [[15, "download-file"]], "hfutils.utils": [[16, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[17, "module-hfutils.utils.tqdm_"]], "tqdm": [[17, "tqdm"]], "hfutils.utils.walk": [[18, "module-hfutils.utils.walk"]], "walk_files": [[18, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[19, "welcome-to-hfutils-s-documentation"]], "Overview": [[19, "overview"]], "Tutorials": [[19, null]], "Information": [[19, null]], "API Documentation": [[19, null]], "Run Environment Information": [[20, "Run-Environment-Information"], [21, "Run-Environment-Information"]], "Installation": [[22, "installation"]], "Quick Start": [[23, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.operate.validate"], [14, "module-hfutils.utils.binary"], [15, "module-hfutils.utils.download"], [16, "module-hfutils.utils"], [17, "module-hfutils.utils.tqdm_"], [18, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[13, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[13, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[14, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[14, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[15, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[15, "module-hfutils.utils.download"]], "hfutils.utils": [[16, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[17, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[17, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[18, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[18, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/upload", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/upload.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.upload", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": 0, "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 10, 12, 15, 17], "you": [0, 22], "requir": [0, 22], "simpli": [0, 22], "instal": [0, 19], "us": [0, 3, 9, 10, 12, 15, 19, 22], "follow": [0, 22], "code": [0, 3, 6, 8], "pip": [0, 22], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18, 22], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18], "i": [0, 6, 8, 10, 13, 14, 19, 20, 21, 22], "we": 0, "util": [0, 19, 22], "rarfil": 0, "librari": [0, 15], "which": [0, 20, 21, 22], "doe": 0, "offer": 0, "function": [0, 3, 14, 15, 17], "creat": 0, "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 18], "ext": 0, "list": [0, 3, 9, 10, 12], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18], "regist": 0, "custom": [0, 3, 6, 8], "type": [0, 3, 9, 10, 12, 13, 14, 15, 17, 18], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18], "A": [0, 9], "take": 0, "directori": [0, 10, 12, 18], "an": [0, 10, 12, 15, 17, 18], "filenam": [0, 15], "input": 0, "extract": [0, 10], "type_nam": 0, "archive_fil": 0, "silent": [0, 10, 12, 15, 17], "bool": [0, 5, 10, 12, 13, 14, 15, 17], "fals": [0, 10, 12, 13, 14, 15, 17], "clear": [0, 12], "specifi": [0, 12, 15], "result": 0, "true": [0, 10, 12, 13, 14, 15, 17], "suppress": [0, 10, 12, 15], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 12], "exist": [0, 10], "when": [0, 10], "return": [0, 3, 9, 13, 14, 15, 17, 18], "path": [0, 6, 8, 9, 10, 12, 13, 14, 15, 18], "password": [0, 10], "none": [0, 3, 5, 6, 8, 9, 10, 12, 13, 15], "content": [0, 17], "option": [0, 3, 5, 6, 8, 9, 10, 12, 13, 15, 17], "determin": 0, "base": [0, 7, 11, 19], "rais": 0, "valueerror": 0, "ani": [0, 5, 14], "get": [0, 9, 15], "meta": [1, 19, 22], "__title__": [1, 22], "__version__": [1, 22], "__description__": [1, 22], "__author__": [1, 22], "__author_email__": 1, "inform": [2, 3, 5], "packag": 2, "titl": 2, "thi": [2, 3, 6, 8, 14, 15, 17, 20, 21], "project": 2, "should": [2, 15, 22], "version": [2, 5, 17, 22], "short": 2, "descript": [2, 15], "includ": [2, 3], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": 3, "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 9, 10, 15, 20, 21, 22], "object": [3, 9, 10, 12, 15], "": [3, 5], "kei": 3, "valu": [3, 5], "pair": 3, "iter": [3, 18], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 15, 17], "keyword": [3, 15, 17], "argument": [3, 15, 17], "For": 3, "exampl": 3, "one": 3, "1": [3, 20, 21, 22], "two": 3, "2": [3, 22], "class": [3, 6, 8], "messag": [3, 6, 8, 12], "except": [3, 6, 8], "displai": [3, 6, 8, 15, 17], "yellow": 3, "color": 3, "error": [3, 6, 8], "exit_cod": [3, 6, 8], "exit": [3, 6, 8], "show": [3, 6, 8], "io": [3, 6, 8, 22], "write": [3, 6, 8], "output": [3, 6, 8, 10, 12, 15, 17, 22], "red": [3, 6, 8], "err": 3, "baseexcept": 3, "print": [3, 5, 20, 21, 22], "traceback": 3, "provid": [3, 15], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 22], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 19], "current": [5, 20, 21, 22], "metadata": 5, "arg": [5, 17], "indic": [6, 8], "remot": [6, 8], "repositori": [6, 8, 9, 10, 12, 13], "assign": [6, 8, 9, 10, 12], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 19], "print_vers": 7, "download": [7, 11, 16, 19], "noremotepathassignedwithdownload": 7, "upload": [7, 11, 19], "noremotepathassignedwithupload": 7, "33": 8, "hf_token": [9, 10, 12, 13], "hfapi": 9, "hug": [9, 10, 12, 13], "face": [9, 10, 12, 13], "api": [9, 10, 12, 13], "client": [9, 10, 12], "huggingfac": [9, 10, 12, 19, 22], "token": [9, 10, 12, 13], "variabl": [9, 10, 12], "hffilesystem": 9, "system": 9, "repo_id": [9, 10, 12, 13], "repo_typ": [9, 10, 12, 13], "liter": [9, 10, 12, 13], "dataset": [9, 10, 12, 13], "model": [9, 10, 12, 13], "space": [9, 10, 12, 13], "subdir": 9, "revis": [9, 10, 12, 13], "main": [9, 10, 12, 13, 22], "ignore_pattern": [9, 10, 12], "given": [9, 14, 15], "identifi": [9, 10, 12, 13], "repotypetyp": [9, 10, 12, 13], "subdirectori": 9, "e": [9, 10, 12], "g": [9, 10, 12], "branch": [9, 10, 12], "tag": [9, 10, 12], "commit": [9, 10, 12], "hash": [9, 10, 12], "pattern": [9, 10, 12], "ignor": [9, 10, 12], "local_fil": [10, 12, 13], "file_in_repo": [10, 12, 13], "resume_download": 10, "save": [10, 15], "local": [10, 12, 13, 15, 20, 21], "within": [10, 12], "resum": 10, "local_directori": [10, 12], "archiv": [10, 12, 19], "dir_in_repo": 10, "max_work": 10, "int": [10, 15], "8": [10, 20, 21, 22], "max_retri": 10, "5": [10, 20, 21], "all": [10, 18], "progress": [10, 12, 15, 17], "bar": [10, 12, 15, 17], "max": 10, "worker": 10, "default": [10, 13], "retri": 10, "time": 10, "get_hf_client": 11, "get_hf_f": 11, "list_files_in_repositori": 11, "download_file_to_fil": 11, "download_archive_as_directori": 11, "download_directory_as_directori": 11, "upload_file_to_fil": 11, "upload_directory_as_arch": 11, "upload_directory_as_directori": 11, "valid": [11, 19], "is_local_file_readi": 11, "archive_in_repo": 12, "path_in_repo": 12, "time_suffix": 12, "its": 12, "append": 12, "timestamp": 12, "present": 12, "check": [13, 14, 15, 22], "readi": 13, "compar": 13, "hub": 13, "match": 13, "otherwis": [13, 15], "read": 14, "first": 14, "1024": [14, 20, 21], "byte": [14, 15], "contain": 14, "non": 14, "text": 14, "charact": 14, "url": 15, "expected_s": 15, "desc": 15, "session": 15, "request": 15, "tqdm": [15, 16, 19], "It": [15, 22], "also": [15, 22], "perform": [15, 20, 21], "ensur": 15, "ha": [15, 20, 21], "expect": 15, "size": [15, 20, 21], "where": 15, "addit": [15, 17], "pass": [15, 17], "binari": [16, 19], "is_binary_fil": 16, "download_fil": 16, "walk": [16, 19], "walk_fil": 16, "tqdm_": 17, "enhanc": 17, "silenc": 17, "modifi": 17, "behavior": 17, "allow": 17, "posit": 17, "std": 17, "recurs": 18, "through": [18, 22], "yield": 18, "rel": 18, "root": 18, "start": [18, 19], "modul": 19, "quick": 19, "run": 19, "environ": 19, "register_archive_typ": 19, "archive_pack": 19, "archive_unpack": 19, "get_archive_typ": 19, "get_archive_extnam": 19, "config": [19, 22], "entri": 19, "oper": 19, "here": [20, 21], "import": [20, 21, 22], "o": [20, 21], "platform": [20, 21], "shutil": [20, 21], "cpuinfo": [20, 21], "psutil": [20, 21], "hbutil": [20, 21], "scale": [20, 21], "size_to_bytes_str": [20, 21], "python": [20, 21, 22], "python_implement": [20, 21], "python_vers": [20, 21], "cpu": [20, 21], "brand": [20, 21], "get_cpu_info": [20, 21], "brand_raw": [20, 21], "count": [20, 21], "cpu_count": [20, 21], "freq": [20, 21], "cpu_freq": [20, 21], "mhz": [20, 21], "memori": [20, 21], "virtual_memori": [20, 21], "total": [20, 21], "precis": [20, 21], "3": [20, 21, 22], "cuda": [20, 21], "ye": [20, 21], "nvidia": [20, 21], "smi": [20, 21], "els": [20, 21], "No": [20, 21], "linux": [20, 21], "6": [20, 21], "0": [20, 21, 22], "azur": [20, 21], "x86_64": [20, 21], "glibc2": [20, 21], "34": [20, 21], "cpython": [20, 21], "18": [20, 21], "amd": [20, 21], "epyc": [20, 21], "7763": [20, 21], "64": [20, 21], "core": [20, 21], "processor": [20, 21], "4": [20, 21], "2912": [20, 21], "80425": 20, "15": [20, 21], "606": [20, 21], "gib": [20, 21], "pleas": [20, 21], "note": [20, 21], "deploi": [20, 21], "document": [20, 21, 22], "automat": [20, 21], "execut": [20, 21], "github": [20, 21, 22], "action": [20, 21], "therefor": [20, 21], "some": [20, 21], "data": [20, 21], "mai": [20, 21], "differ": [20, 21], "your": [20, 21, 22], "1099999999997": 21, "hfutil": 22, "host": 22, "pypi": 22, "can": 22, "newest": 22, "u": 22, "git": 22, "http": 22, "com": 22, "deepgh": 22, "script": 22, "__name__": 22, "__main__": 22, "develop": 22, "maintain": 22, "like": 22, "below": 22, "mean": 22, "success": 22, "narugo1992": 22, "still": 22, "under": 22, "out": 22, "stabl": 22, "index": 22, "html": 22, "faq": 23}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "operate"], [16, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.upload": [[8, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.operate": [[9, 0, 0, "-", "base"], [10, 0, 0, "-", "download"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "validate"]], "hfutils.operate.base": [[9, 1, 1, "", "get_hf_client"], [9, 1, 1, "", "get_hf_fs"], [9, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[10, 1, 1, "", "download_archive_as_directory"], [10, 1, 1, "", "download_directory_as_directory"], [10, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[12, 1, 1, "", "upload_directory_as_archive"], [12, 1, 1, "", "upload_directory_as_directory"], [12, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[13, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[14, 0, 0, "-", "binary"], [15, 0, 0, "-", "download"], [17, 0, 0, "-", "tqdm_"], [18, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[14, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[15, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[17, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[18, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8], "base": [3, 9], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 10, 15], "noremotepathassignedwithdownload": 6, "upload": [8, 12], "noremotepathassignedwithupload": 8, "oper": [9, 10, 11, 12, 13], "get_hf_client": 9, "get_hf_f": 9, "list_files_in_repositori": 9, "download_file_to_fil": 10, "download_archive_as_directori": 10, "download_directory_as_directori": 10, "upload_file_to_fil": 12, "upload_directory_as_arch": 12, "upload_directory_as_directori": 12, "valid": 13, "is_local_file_readi": 13, "util": [14, 15, 16, 17, 18], "binari": 14, "is_binary_fil": 14, "download_fil": 15, "tqdm": 17, "walk": 18, "walk_fil": 18, "welcom": 19, "": 19, "document": 19, "overview": 19, "tutori": 19, "inform": [19, 20, 21], "api": 19, "run": [20, 21], "environ": [20, 21], "instal": 22, "quick": 23, "start": 23}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[8, "noremotepathassignedwithupload"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "get_hf_client": [[9, "get-hf-client"]], "get_hf_fs": [[9, "get-hf-fs"]], "list_files_in_repository": [[9, "list-files-in-repository"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "download_file_to_file": [[10, "download-file-to-file"]], "download_archive_as_directory": [[10, "download-archive-as-directory"]], "download_directory_as_directory": [[10, "download-directory-as-directory"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_file_to_file": [[12, "upload-file-to-file"]], "upload_directory_as_archive": [[12, "upload-directory-as-archive"]], "upload_directory_as_directory": [[12, "upload-directory-as-directory"]], "hfutils.operate.validate": [[13, "module-hfutils.operate.validate"]], "is_local_file_ready": [[13, "is-local-file-ready"]], "hfutils.utils.binary": [[14, "module-hfutils.utils.binary"]], "is_binary_file": [[14, "is-binary-file"]], "hfutils.utils.download": [[15, "module-hfutils.utils.download"]], "download_file": [[15, "download-file"]], "hfutils.utils": [[16, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[17, "module-hfutils.utils.tqdm_"]], "tqdm": [[17, "tqdm"]], "hfutils.utils.walk": [[18, "module-hfutils.utils.walk"]], "walk_files": [[18, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[19, "welcome-to-hfutils-s-documentation"]], "Overview": [[19, "overview"]], "Tutorials": [[19, null]], "Information": [[19, null]], "API Documentation": [[19, null]], "Run Environment Information": [[20, "Run-Environment-Information"], [21, "Run-Environment-Information"]], "Installation": [[22, "installation"]], "Quick Start": [[23, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.upload"], [9, "module-hfutils.operate.base"], [10, "module-hfutils.operate.download"], [11, "module-hfutils.operate"], [12, "module-hfutils.operate.upload"], [13, "module-hfutils.operate.validate"], [14, "module-hfutils.utils.binary"], [15, "module-hfutils.utils.download"], [16, "module-hfutils.utils"], [17, "module-hfutils.utils.tqdm_"], [18, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[8, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[8, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "get_hf_client() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[9, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[9, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[10, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[10, "module-hfutils.operate.download"]], "hfutils.operate": [[11, "module-hfutils.operate"]], "hfutils.operate.upload": [[12, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[12, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[13, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[13, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[14, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[14, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[15, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[15, "module-hfutils.utils.download"]], "hfutils.utils": [[16, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[17, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[17, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[18, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[18, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.2.0/.buildinfo b/v0.2.0/.buildinfo
index 32087d4a8c..43b8212a1e 100644
--- a/v0.2.0/.buildinfo
+++ b/v0.2.0/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 0e20da4da889519adb3663d092c9c1e1
+config: 7e2b435d4ca5fe7696c0685ef6102626
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.2.0/.doctrees/api_doc/archive/index.doctree b/v0.2.0/.doctrees/api_doc/archive/index.doctree
index 3d166fd02c..ff591e83d4 100644
Binary files a/v0.2.0/.doctrees/api_doc/archive/index.doctree and b/v0.2.0/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/config/index.doctree b/v0.2.0/.doctrees/api_doc/config/index.doctree
index d927482220..05405d18f5 100644
Binary files a/v0.2.0/.doctrees/api_doc/config/index.doctree and b/v0.2.0/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/config/meta.doctree b/v0.2.0/.doctrees/api_doc/config/meta.doctree
index 84d0f2e603..8b6e5f3929 100644
Binary files a/v0.2.0/.doctrees/api_doc/config/meta.doctree and b/v0.2.0/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/entry/base.doctree b/v0.2.0/.doctrees/api_doc/entry/base.doctree
index 558e413d50..95ee8541ca 100644
Binary files a/v0.2.0/.doctrees/api_doc/entry/base.doctree and b/v0.2.0/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/entry/cli.doctree b/v0.2.0/.doctrees/api_doc/entry/cli.doctree
index 11794b301e..bc11259b73 100644
Binary files a/v0.2.0/.doctrees/api_doc/entry/cli.doctree and b/v0.2.0/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/entry/dispatch.doctree b/v0.2.0/.doctrees/api_doc/entry/dispatch.doctree
index db15fc2dad..f7f3904fc3 100644
Binary files a/v0.2.0/.doctrees/api_doc/entry/dispatch.doctree and b/v0.2.0/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/entry/download.doctree b/v0.2.0/.doctrees/api_doc/entry/download.doctree
index 0d6b1f75ae..2b735c56fd 100644
Binary files a/v0.2.0/.doctrees/api_doc/entry/download.doctree and b/v0.2.0/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/entry/index.doctree b/v0.2.0/.doctrees/api_doc/entry/index.doctree
index 0e0f88026a..dee36713ce 100644
Binary files a/v0.2.0/.doctrees/api_doc/entry/index.doctree and b/v0.2.0/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/entry/ls.doctree b/v0.2.0/.doctrees/api_doc/entry/ls.doctree
index c23efdd502..68c83067cc 100644
Binary files a/v0.2.0/.doctrees/api_doc/entry/ls.doctree and b/v0.2.0/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/entry/upload.doctree b/v0.2.0/.doctrees/api_doc/entry/upload.doctree
index 7884d9e509..a023e9d7f5 100644
Binary files a/v0.2.0/.doctrees/api_doc/entry/upload.doctree and b/v0.2.0/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/index/fetch.doctree b/v0.2.0/.doctrees/api_doc/index/fetch.doctree
index 5cafb7aab8..068e919c32 100644
Binary files a/v0.2.0/.doctrees/api_doc/index/fetch.doctree and b/v0.2.0/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/index/index.doctree b/v0.2.0/.doctrees/api_doc/index/index.doctree
index 1096f729d5..e6a4458714 100644
Binary files a/v0.2.0/.doctrees/api_doc/index/index.doctree and b/v0.2.0/.doctrees/api_doc/index/index.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/index/make.doctree b/v0.2.0/.doctrees/api_doc/index/make.doctree
index 4baca49cfe..7bfc3cfde5 100644
Binary files a/v0.2.0/.doctrees/api_doc/index/make.doctree and b/v0.2.0/.doctrees/api_doc/index/make.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/operate/base.doctree b/v0.2.0/.doctrees/api_doc/operate/base.doctree
index 07f495019f..6fe52c8b3a 100644
Binary files a/v0.2.0/.doctrees/api_doc/operate/base.doctree and b/v0.2.0/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/operate/download.doctree b/v0.2.0/.doctrees/api_doc/operate/download.doctree
index 85cc4adbb4..e91bf35d55 100644
Binary files a/v0.2.0/.doctrees/api_doc/operate/download.doctree and b/v0.2.0/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/operate/index.doctree b/v0.2.0/.doctrees/api_doc/operate/index.doctree
index 0c8ebda5e7..74af3c0b14 100644
Binary files a/v0.2.0/.doctrees/api_doc/operate/index.doctree and b/v0.2.0/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/operate/upload.doctree b/v0.2.0/.doctrees/api_doc/operate/upload.doctree
index e153ae2d2c..da3339bbda 100644
Binary files a/v0.2.0/.doctrees/api_doc/operate/upload.doctree and b/v0.2.0/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/operate/validate.doctree b/v0.2.0/.doctrees/api_doc/operate/validate.doctree
index 7427c12960..af005ab3da 100644
Binary files a/v0.2.0/.doctrees/api_doc/operate/validate.doctree and b/v0.2.0/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/utils/binary.doctree b/v0.2.0/.doctrees/api_doc/utils/binary.doctree
index 81fbcb09ad..ca4319511c 100644
Binary files a/v0.2.0/.doctrees/api_doc/utils/binary.doctree and b/v0.2.0/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/utils/download.doctree b/v0.2.0/.doctrees/api_doc/utils/download.doctree
index dec4027960..507eabc1b4 100644
Binary files a/v0.2.0/.doctrees/api_doc/utils/download.doctree and b/v0.2.0/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/utils/index.doctree b/v0.2.0/.doctrees/api_doc/utils/index.doctree
index 42c20ba3c0..9ff98ddbca 100644
Binary files a/v0.2.0/.doctrees/api_doc/utils/index.doctree and b/v0.2.0/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/utils/tqdm_.doctree b/v0.2.0/.doctrees/api_doc/utils/tqdm_.doctree
index 42afb72072..db34fc3263 100644
Binary files a/v0.2.0/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.2.0/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.2.0/.doctrees/api_doc/utils/walk.doctree b/v0.2.0/.doctrees/api_doc/utils/walk.doctree
index 3c1f45223c..13c6668453 100644
Binary files a/v0.2.0/.doctrees/api_doc/utils/walk.doctree and b/v0.2.0/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.2.0/.doctrees/environment.pickle b/v0.2.0/.doctrees/environment.pickle
index 0f574a1aa2..f3ac5e9a5f 100644
Binary files a/v0.2.0/.doctrees/environment.pickle and b/v0.2.0/.doctrees/environment.pickle differ
diff --git a/v0.2.0/.doctrees/index.doctree b/v0.2.0/.doctrees/index.doctree
index d730579a01..49bb569b0b 100644
Binary files a/v0.2.0/.doctrees/index.doctree and b/v0.2.0/.doctrees/index.doctree differ
diff --git a/v0.2.0/.doctrees/information/environment.doctree b/v0.2.0/.doctrees/information/environment.doctree
index fcefa47462..0de19e4999 100644
Binary files a/v0.2.0/.doctrees/information/environment.doctree and b/v0.2.0/.doctrees/information/environment.doctree differ
diff --git a/v0.2.0/.doctrees/information/environment.result.doctree b/v0.2.0/.doctrees/information/environment.result.doctree
index caeb12a6fa..d39936eb7d 100644
Binary files a/v0.2.0/.doctrees/information/environment.result.doctree and b/v0.2.0/.doctrees/information/environment.result.doctree differ
diff --git a/v0.2.0/.doctrees/nbsphinx/information/environment.ipynb b/v0.2.0/.doctrees/nbsphinx/information/environment.ipynb
index e5d68b4ad7..9b775bb2f1 100644
--- a/v0.2.0/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.2.0/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:45:28.585744Z",
-     "iopub.status.busy": "2024-07-23T17:45:28.585193Z",
-     "iopub.status.idle": "2024-07-23T17:45:29.752747Z",
-     "shell.execute_reply": "2024-07-23T17:45:29.751998Z"
+     "iopub.execute_input": "2024-07-23T17:51:51.681537Z",
+     "iopub.status.busy": "2024-07-23T17:51:51.681328Z",
+     "iopub.status.idle": "2024-07-23T17:51:52.854737Z",
+     "shell.execute_reply": "2024-07-23T17:51:52.853945Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 3166.3995 MHz\n",
+      "CPU Freq: 2714.21625 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.0/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.2.0/.doctrees/nbsphinx/information/environment.result.ipynb
index b1f2fafadc..eff42086b3 100644
--- a/v0.2.0/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.2.0/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:05:18.769939Z",
-     "iopub.status.busy": "2024-07-23T17:05:18.769367Z",
-     "iopub.status.idle": "2024-07-23T17:05:19.943829Z",
-     "shell.execute_reply": "2024-07-23T17:05:19.943100Z"
+     "iopub.execute_input": "2024-07-23T17:10:56.145305Z",
+     "iopub.status.busy": "2024-07-23T17:10:56.145092Z",
+     "iopub.status.idle": "2024-07-23T17:10:57.323842Z",
+     "shell.execute_reply": "2024-07-23T17:10:57.323057Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2941.9392499999994 MHz\n",
+      "CPU Freq: 3035.12475 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.0/.doctrees/tutorials/installation/index.doctree b/v0.2.0/.doctrees/tutorials/installation/index.doctree
index 5188cd82a2..a5105509a0 100644
Binary files a/v0.2.0/.doctrees/tutorials/installation/index.doctree and b/v0.2.0/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.2.0/.doctrees/tutorials/quick_start/index.doctree b/v0.2.0/.doctrees/tutorials/quick_start/index.doctree
index abeb51a5f0..e05b2f04a2 100644
Binary files a/v0.2.0/.doctrees/tutorials/quick_start/index.doctree and b/v0.2.0/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.2.0/_sources/information/environment.result.ipynb.txt b/v0.2.0/_sources/information/environment.result.ipynb.txt
index b1f2fafadc..eff42086b3 100644
--- a/v0.2.0/_sources/information/environment.result.ipynb.txt
+++ b/v0.2.0/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:05:18.769939Z",
-     "iopub.status.busy": "2024-07-23T17:05:18.769367Z",
-     "iopub.status.idle": "2024-07-23T17:05:19.943829Z",
-     "shell.execute_reply": "2024-07-23T17:05:19.943100Z"
+     "iopub.execute_input": "2024-07-23T17:10:56.145305Z",
+     "iopub.status.busy": "2024-07-23T17:10:56.145092Z",
+     "iopub.status.idle": "2024-07-23T17:10:57.323842Z",
+     "shell.execute_reply": "2024-07-23T17:10:57.323057Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2941.9392499999994 MHz\n",
+      "CPU Freq: 3035.12475 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.0/information/environment.html b/v0.2.0/information/environment.html
index 3622ff6a8e..6818645f4b 100644
--- a/v0.2.0/information/environment.html
+++ b/v0.2.0/information/environment.html
@@ -126,11 +126,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 3166.3995 MHz
+CPU Freq: 2714.21625 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.0/information/environment.ipynb b/v0.2.0/information/environment.ipynb
index e5d68b4ad7..9b775bb2f1 100644
--- a/v0.2.0/information/environment.ipynb
+++ b/v0.2.0/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:45:28.585744Z",
-     "iopub.status.busy": "2024-07-23T17:45:28.585193Z",
-     "iopub.status.idle": "2024-07-23T17:45:29.752747Z",
-     "shell.execute_reply": "2024-07-23T17:45:29.751998Z"
+     "iopub.execute_input": "2024-07-23T17:51:51.681537Z",
+     "iopub.status.busy": "2024-07-23T17:51:51.681328Z",
+     "iopub.status.idle": "2024-07-23T17:51:52.854737Z",
+     "shell.execute_reply": "2024-07-23T17:51:52.853945Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 3166.3995 MHz\n",
+      "CPU Freq: 2714.21625 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.0/information/environment.result.html b/v0.2.0/information/environment.result.html
index 8ff2651c64..be6e723c6f 100644
--- a/v0.2.0/information/environment.result.html
+++ b/v0.2.0/information/environment.result.html
@@ -128,11 +128,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2941.9392499999994 MHz
+CPU Freq: 3035.12475 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.0/information/environment.result.ipynb b/v0.2.0/information/environment.result.ipynb
index b1f2fafadc..eff42086b3 100644
--- a/v0.2.0/information/environment.result.ipynb
+++ b/v0.2.0/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:05:18.769939Z",
-     "iopub.status.busy": "2024-07-23T17:05:18.769367Z",
-     "iopub.status.idle": "2024-07-23T17:05:19.943829Z",
-     "shell.execute_reply": "2024-07-23T17:05:19.943100Z"
+     "iopub.execute_input": "2024-07-23T17:10:56.145305Z",
+     "iopub.status.busy": "2024-07-23T17:10:56.145092Z",
+     "iopub.status.idle": "2024-07-23T17:10:57.323842Z",
+     "shell.execute_reply": "2024-07-23T17:10:57.323057Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2941.9392499999994 MHz\n",
+      "CPU Freq: 3035.12475 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.0/searchindex.js b/v0.2.0/searchindex.js
index 270ea7d79e..b0851d5357 100644
--- a/v0.2.0/searchindex.js
+++ b/v0.2.0/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/upload", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/upload.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.upload", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 10, 12], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 14, 16, 19, 21], "you": [0, 26], "requir": [0, 26], "simpli": [0, 26], "instal": [0, 23], "us": [0, 3, 10, 13, 14, 16, 19, 23, 26], "follow": [0, 8, 26], "code": [0, 3, 6, 9], "pip": [0, 26], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 16, 17, 18, 19, 22, 26], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 16, 17, 18, 19, 22], "i": [0, 6, 9, 10, 14, 17, 18, 23, 24, 25, 26], "we": 0, "util": [0, 23, 26], "rarfil": 0, "librari": [0, 19], "which": [0, 24, 25, 26], "doe": [0, 10], "offer": 0, "function": [0, 3, 18, 19, 21], "creat": [0, 12], "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 16, 17, 18, 19, 22], "ext": 0, "list": [0, 3, 8, 10, 13, 14, 16], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17, 18, 19, 21, 22], "regist": 0, "custom": [0, 3, 6, 9], "type": [0, 3, 8, 10, 12, 13, 14, 16, 17, 18, 19, 21, 22], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17, 18, 19, 21, 22], "A": [0, 13], "take": 0, "directori": [0, 8, 12, 14, 16, 22], "an": [0, 10, 12, 14, 16, 19, 21, 22], "filenam": [0, 12, 19], "input": 0, "extract": [0, 14], "type_nam": 0, "archive_fil": 0, "silent": [0, 12, 14, 16, 19, 21], "bool": [0, 5, 10, 12, 14, 16, 17, 18, 19, 21], "fals": [0, 10, 12, 14, 16, 17, 18, 19, 21], "clear": [0, 16], "specifi": [0, 16, 19], "result": 0, "true": [0, 10, 12, 14, 16, 17, 18, 19, 21], "suppress": [0, 12, 14, 16, 19], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 16], "exist": [0, 10, 14], "when": [0, 10, 14], "return": [0, 3, 10, 12, 13, 17, 18, 19, 21, 22], "path": [0, 6, 9, 10, 12, 13, 14, 16, 17, 18, 19, 22], "password": [0, 14], "none": [0, 3, 5, 6, 9, 10, 12, 13, 14, 16, 17, 19], "content": [0, 21], "option": [0, 3, 5, 6, 9, 10, 12, 13, 14, 16, 17, 19, 21], "determin": 0, "base": [0, 7, 8, 15, 23], "rais": [0, 10], "valueerror": 0, "ani": [0, 5, 18], "get": [0, 10, 12, 13, 19], "meta": [1, 23, 26], "__title__": [1, 26], "__version__": [1, 26], "__description__": [1, 26], "__author__": [1, 26], "__author_email__": 1, "inform": [2, 3, 5, 12], "packag": 2, "titl": 2, "thi": [2, 3, 6, 9, 18, 19, 21, 24, 25], "project": 2, "should": [2, 19, 26], "version": [2, 5, 21, 26], "short": 2, "descript": [2, 19], "includ": [2, 3, 12], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 10, 12], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 10, 12, 13, 14, 19, 24, 25, 26], "object": [3, 8, 13, 14, 16, 19], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 22], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 19, 21], "keyword": [3, 19, 21], "argument": [3, 19, 21], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 12, 24, 25], "two": 3, "2": [3, 8, 26], "class": [3, 6, 8, 9, 10], "messag": [3, 6, 9, 12, 16], "except": [3, 6, 9, 10], "displai": [3, 6, 9, 19, 21], "yellow": 3, "color": 3, "error": [3, 6, 9], "exit_cod": [3, 6, 9], "exit": [3, 6, 9], "show": [3, 6, 9], "io": [3, 6, 9, 26], "write": [3, 6, 9], "output": [3, 6, 9, 14, 16, 19, 21, 26], "red": [3, 6, 9], "err": 3, "baseexcept": 3, "print": [3, 5, 24, 25, 26], "traceback": 3, "provid": [3, 19], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 26], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 23], "current": [5, 24, 25, 26], "metadata": 5, "arg": [5, 21], "indic": [6, 9], "remot": [6, 9], "repositori": [6, 9, 10, 12, 13, 14, 16, 17], "assign": [6, 9, 13, 14, 16], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 23], "print_vers": 7, "download": [7, 10, 15, 20, 23], "noremotepathassignedwithdownload": 7, "l": [7, 23], "listitemtyp": 7, "listitem": 7, "upload": [7, 12, 15, 23], "noremotepathassignedwithupload": 7, "enum": 8, "repres": 8, "differ": [8, 24, 25], "item": 8, "valid": [8, 15, 23], "ar": 8, "folder": 8, "imag": 8, "3": [8, 24, 25, 26], "archiv": [8, 10, 12, 14, 16, 23], "4": [8, 24, 25], "model": [8, 10, 12, 13, 14, 16, 17], "5": [8, 14, 24, 25], "data": [8, 24, 25], "6": [8, 24, 25], "repofold": 8, "repofil": 8, "base_dir": 8, "union": [8, 10], "33": 9, "standalon": 10, "incomplet": 10, "hash": [10, 12, 13, 14, 16], "match": [10, 17], "repo_id": [10, 12, 13, 14, 16, 17], "archive_in_repo": [10, 12, 16], "repo_typ": [10, 12, 13, 14, 16, 17], "liter": [10, 12, 13, 14, 16, 17], "dataset": [10, 12, 13, 14, 16, 17], "space": [10, 12, 13, 14, 16, 17], "revis": [10, 12, 13, 14, 16, 17], "main": [10, 12, 13, 14, 16, 17, 26], "idx_repo_id": [10, 12], "idx_file_in_repo": 10, "idx_repo_typ": [10, 12], "idx_revis": [10, 12], "hf_token": [10, 12, 13, 14, 16, 17], "insid": 10, "hug": [10, 12, 13, 14, 16, 17], "face": [10, 12, 13, 14, 16, 17], "identifi": [10, 12, 13, 14, 16, 17], "repotypetyp": [10, 12, 13, 14, 16, 17], "access": [10, 12], "token": [10, 12, 13, 14, 16, 17], "file_in_arch": 10, "local_fil": [10, 14, 16, 17], "proxi": 10, "user_ag": 10, "header": 10, "endpoint": 10, "save": [10, 12, 14, 19], "local": [10, 12, 14, 16, 17, 19, 24, 25], "http": [10, 26], "request": [10, 19], "user": 10, "agent": 10, "addit": [10, 19, 21], "api": [10, 13, 14, 16, 17], "check": [10, 17, 18, 19, 26], "otherwis": [10, 17, 19], "fetch": [11, 23], "archivestandalonefileincompletedownload": 11, "archivestandalonefilehashnotmatch": 11, "hf_tar_list_fil": 11, "hf_tar_file_download": 11, "hf_tar_get_index": 11, "hf_tar_file_exist": 11, "make": [11, 23], "tar_create_index": 11, "hf_tar_create_index": 11, "tar_get_index_info": 11, "hf_tar_create_from_directori": 11, "src_tar_fil": 12, "dst_index_fil": 12, "chunk_for_hash": 12, "int": [12, 14, 19], "1048576": 12, "with_hash": 12, "default": [12, 14, 17], "chunk": 12, "size": [12, 19, 24, 25], "20": 12, "mb": 12, "whether": 12, "progress": [12, 14, 16, 19, 21], "bar": [12, 14, 16, 19, 21], "log": 12, "idx_filenam": 12, "local_directori": [12, 14, 16], "hfapi": 13, "client": [13, 14, 16], "huggingfac": [13, 14, 16, 23, 26], "variabl": [13, 14, 16], "hffilesystem": 13, "system": 13, "subdir": 13, "ignore_pattern": [13, 14, 16], "given": [13, 18, 19], "subdirectori": 13, "e": [13, 14, 16], "g": [13, 14, 16], "branch": [13, 14, 16], "tag": [13, 14, 16], "commit": [13, 14, 16], "pattern": [13, 14, 16], "ignor": [13, 14, 16], "file_in_repo": [14, 16, 17], "resume_download": 14, "within": [14, 16], "resum": 14, "dir_in_repo": 14, "max_work": 14, "8": [14, 24, 25, 26], "max_retri": 14, "all": [14, 22], "max": 14, "worker": 14, "retri": 14, "time": 14, "get_hf_client": 15, "get_hf_f": 15, "list_files_in_repositori": 15, "download_file_to_fil": 15, "download_archive_as_directori": 15, "download_directory_as_directori": 15, "upload_file_to_fil": 15, "upload_directory_as_arch": 15, "upload_directory_as_directori": 15, "is_local_file_readi": 15, "path_in_repo": 16, "time_suffix": 16, "its": 16, "append": 16, "timestamp": 16, "present": 16, "readi": 17, "compar": 17, "hub": 17, "read": 18, "first": 18, "1024": 18, "byte": [18, 19], "contain": 18, "non": 18, "text": 18, "charact": 18, "url": 19, "expected_s": 19, "desc": 19, "session": 19, "tqdm": [19, 20, 23], "It": [19, 26], "also": [19, 26], "perform": [19, 24, 25], "ensur": 19, "ha": [19, 24, 25], "expect": 19, "where": 19, "pass": [19, 21], "binari": [20, 23], "is_binary_fil": 20, "download_fil": 20, "walk": [20, 23], "walk_fil": 20, "tqdm_": 21, "enhanc": 21, "silenc": 21, "modifi": 21, "behavior": 21, "allow": 21, "posit": 21, "std": 21, "recurs": 22, "through": [22, 26], "yield": 22, "rel": 22, "root": 22, "start": [22, 23], "modul": 23, "quick": 23, "run": 23, "environ": 23, "register_archive_typ": 23, "archive_pack": 23, "archive_unpack": 23, "get_archive_typ": 23, "get_archive_extnam": 23, "config": [23, 26], "entri": 23, "index": [23, 26], "oper": 23, "here": [24, 25], "import": [24, 25, 26], "o": [24, 25], "platform": [24, 25], "shutil": [24, 25], "cpuinfo": [24, 25], "psutil": [24, 25], "hbutil": [24, 25], "scale": [24, 25], "size_to_bytes_str": [24, 25], "python": [24, 25, 26], "python_implement": [24, 25], "python_vers": [24, 25], "cpu": [24, 25], "brand": [24, 25], "get_cpu_info": [24, 25], "brand_raw": [24, 25], "count": [24, 25], "cpu_count": [24, 25], "freq": [24, 25], "cpu_freq": [24, 25], "mhz": [24, 25], "memori": [24, 25], "virtual_memori": [24, 25], "total": [24, 25], "precis": [24, 25], "cuda": [24, 25], "ye": [24, 25], "nvidia": [24, 25], "smi": [24, 25], "els": [24, 25], "No": [24, 25], "linux": [24, 25], "0": [24, 25, 26], "1023": [24, 25], "azur": [24, 25], "x86_64": [24, 25], "glibc2": [24, 25], "34": [24, 25], "cpython": [24, 25], "18": [24, 25], "amd": [24, 25], "epyc": [24, 25], "7763": [24, 25], "64": [24, 25], "core": [24, 25], "processor": [24, 25], "3166": 24, "3995": 24, "15": [24, 25], "606": [24, 25], "gib": [24, 25], "pleas": [24, 25], "note": [24, 25], "deploi": [24, 25], "document": [24, 25, 26], "automat": [24, 25], "execut": [24, 25], "github": [24, 25, 26], "action": [24, 25], "therefor": [24, 25], "some": [24, 25], "mai": [24, 25], "your": [24, 25, 26], "2941": 25, "9392499999994": 25, "hfutil": 26, "host": 26, "pypi": 26, "can": 26, "newest": 26, "u": 26, "git": 26, "com": 26, "deepgh": 26, "script": 26, "__name__": 26, "__main__": 26, "develop": 26, "maintain": 26, "like": 26, "below": 26, "mean": 26, "success": 26, "narugo1992": 26, "still": 26, "under": 26, "out": 26, "stabl": 26, "html": 26, "faq": 27}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "index"], [15, 0, 0, "-", "operate"], [20, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.upload": [[9, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.index": [[10, 0, 0, "-", "fetch"], [12, 0, 0, "-", "make"]], "hfutils.index.fetch": [[10, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [10, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [10, 1, 1, "", "hf_tar_file_download"], [10, 1, 1, "", "hf_tar_file_exists"], [10, 1, 1, "", "hf_tar_get_index"], [10, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[12, 1, 1, "", "hf_tar_create_from_directory"], [12, 1, 1, "", "hf_tar_create_index"], [12, 1, 1, "", "tar_create_index"], [12, 1, 1, "", "tar_get_index_info"]], "hfutils.operate": [[13, 0, 0, "-", "base"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "upload"], [17, 0, 0, "-", "validate"]], "hfutils.operate.base": [[13, 1, 1, "", "get_hf_client"], [13, 1, 1, "", "get_hf_fs"], [13, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[14, 1, 1, "", "download_archive_as_directory"], [14, 1, 1, "", "download_directory_as_directory"], [14, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[16, 1, 1, "", "upload_directory_as_archive"], [16, 1, 1, "", "upload_directory_as_directory"], [16, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[17, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[18, 0, 0, "-", "binary"], [19, 0, 0, "-", "download"], [21, 0, 0, "-", "tqdm_"], [22, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[18, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[19, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[21, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[22, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9], "base": [3, 13], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 14, 19], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "upload": [9, 16], "noremotepathassignedwithupload": 9, "index": [10, 11, 12], "fetch": 10, "archivestandalonefileincompletedownload": 10, "archivestandalonefilehashnotmatch": 10, "hf_tar_list_fil": 10, "hf_tar_file_download": 10, "hf_tar_get_index": 10, "hf_tar_file_exist": 10, "make": 12, "tar_create_index": 12, "hf_tar_create_index": 12, "tar_get_index_info": 12, "hf_tar_create_from_directori": 12, "oper": [13, 14, 15, 16, 17], "get_hf_client": 13, "get_hf_f": 13, "list_files_in_repositori": 13, "download_file_to_fil": 14, "download_archive_as_directori": 14, "download_directory_as_directori": 14, "upload_file_to_fil": 16, "upload_directory_as_arch": 16, "upload_directory_as_directori": 16, "valid": 17, "is_local_file_readi": 17, "util": [18, 19, 20, 21, 22], "binari": 18, "is_binary_fil": 18, "download_fil": 19, "tqdm": 21, "walk": 22, "walk_fil": 22, "welcom": 23, "": 23, "document": 23, "overview": 23, "tutori": 23, "inform": [23, 24, 25], "api": 23, "run": [24, 25], "environ": [24, 25], "instal": 26, "quick": 27, "start": 27}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[9, "noremotepathassignedwithupload"]], "hfutils.index.fetch": [[10, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[10, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[10, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[10, "hf-tar-list-files"]], "hf_tar_file_download": [[10, "hf-tar-file-download"]], "hf_tar_get_index": [[10, "hf-tar-get-index"]], "hf_tar_file_exists": [[10, "hf-tar-file-exists"]], "hfutils.index": [[11, "module-hfutils.index"]], "hfutils.index.make": [[12, "module-hfutils.index.make"]], "tar_create_index": [[12, "tar-create-index"]], "hf_tar_create_index": [[12, "hf-tar-create-index"]], "tar_get_index_info": [[12, "tar-get-index-info"]], "hf_tar_create_from_directory": [[12, "hf-tar-create-from-directory"]], "hfutils.operate.base": [[13, "module-hfutils.operate.base"]], "get_hf_client": [[13, "get-hf-client"]], "get_hf_fs": [[13, "get-hf-fs"]], "list_files_in_repository": [[13, "list-files-in-repository"]], "hfutils.operate.download": [[14, "module-hfutils.operate.download"]], "download_file_to_file": [[14, "download-file-to-file"]], "download_archive_as_directory": [[14, "download-archive-as-directory"]], "download_directory_as_directory": [[14, "download-directory-as-directory"]], "hfutils.operate": [[15, "module-hfutils.operate"]], "hfutils.operate.upload": [[16, "module-hfutils.operate.upload"]], "upload_file_to_file": [[16, "upload-file-to-file"]], "upload_directory_as_archive": [[16, "upload-directory-as-archive"]], "upload_directory_as_directory": [[16, "upload-directory-as-directory"]], "hfutils.operate.validate": [[17, "module-hfutils.operate.validate"]], "is_local_file_ready": [[17, "is-local-file-ready"]], "hfutils.utils.binary": [[18, "module-hfutils.utils.binary"]], "is_binary_file": [[18, "is-binary-file"]], "hfutils.utils.download": [[19, "module-hfutils.utils.download"]], "download_file": [[19, "download-file"]], "hfutils.utils": [[20, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[21, "module-hfutils.utils.tqdm_"]], "tqdm": [[21, "tqdm"]], "hfutils.utils.walk": [[22, "module-hfutils.utils.walk"]], "walk_files": [[22, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[23, "welcome-to-hfutils-s-documentation"]], "Overview": [[23, "overview"]], "Tutorials": [[23, null]], "Information": [[23, null]], "API Documentation": [[23, null]], "Run Environment Information": [[24, "Run-Environment-Information"], [25, "Run-Environment-Information"]], "Installation": [[26, "installation"]], "Quick Start": [[27, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.upload"], [10, "module-hfutils.index.fetch"], [11, "module-hfutils.index"], [12, "module-hfutils.index.make"], [13, "module-hfutils.operate.base"], [14, "module-hfutils.operate.download"], [15, "module-hfutils.operate"], [16, "module-hfutils.operate.upload"], [17, "module-hfutils.operate.validate"], [18, "module-hfutils.utils.binary"], [19, "module-hfutils.utils.download"], [20, "module-hfutils.utils"], [21, "module-hfutils.utils.tqdm_"], [22, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[10, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[10, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[10, "module-hfutils.index.fetch"]], "hfutils.index": [[11, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[12, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[12, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[12, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[12, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[12, "hfutils.index.make.tar_get_index_info"]], "get_hf_client() (in module hfutils.operate.base)": [[13, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[13, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[13, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[13, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[14, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[14, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[14, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[14, "module-hfutils.operate.download"]], "hfutils.operate": [[15, "module-hfutils.operate"]], "hfutils.operate.upload": [[16, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[16, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[16, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[16, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[17, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[17, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[18, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[18, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[19, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[19, "module-hfutils.utils.download"]], "hfutils.utils": [[20, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[21, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[21, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[22, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[22, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/upload", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/upload.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.upload", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 10, 12], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 14, 16, 19, 21], "you": [0, 26], "requir": [0, 26], "simpli": [0, 26], "instal": [0, 23], "us": [0, 3, 10, 13, 14, 16, 19, 23, 26], "follow": [0, 8, 26], "code": [0, 3, 6, 9], "pip": [0, 26], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 16, 17, 18, 19, 22, 26], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 16, 17, 18, 19, 22], "i": [0, 6, 9, 10, 14, 17, 18, 23, 24, 25, 26], "we": 0, "util": [0, 23, 26], "rarfil": 0, "librari": [0, 19], "which": [0, 24, 25, 26], "doe": [0, 10], "offer": 0, "function": [0, 3, 18, 19, 21], "creat": [0, 12], "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 16, 17, 18, 19, 22], "ext": 0, "list": [0, 3, 8, 10, 13, 14, 16], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17, 18, 19, 21, 22], "regist": 0, "custom": [0, 3, 6, 9], "type": [0, 3, 8, 10, 12, 13, 14, 16, 17, 18, 19, 21, 22], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 16, 17, 18, 19, 21, 22], "A": [0, 13], "take": 0, "directori": [0, 8, 12, 14, 16, 22], "an": [0, 10, 12, 14, 16, 19, 21, 22], "filenam": [0, 12, 19], "input": 0, "extract": [0, 14], "type_nam": 0, "archive_fil": 0, "silent": [0, 12, 14, 16, 19, 21], "bool": [0, 5, 10, 12, 14, 16, 17, 18, 19, 21], "fals": [0, 10, 12, 14, 16, 17, 18, 19, 21], "clear": [0, 16], "specifi": [0, 16, 19], "result": 0, "true": [0, 10, 12, 14, 16, 17, 18, 19, 21], "suppress": [0, 12, 14, 16, 19], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 16], "exist": [0, 10, 14], "when": [0, 10, 14], "return": [0, 3, 10, 12, 13, 17, 18, 19, 21, 22], "path": [0, 6, 9, 10, 12, 13, 14, 16, 17, 18, 19, 22], "password": [0, 14], "none": [0, 3, 5, 6, 9, 10, 12, 13, 14, 16, 17, 19], "content": [0, 21], "option": [0, 3, 5, 6, 9, 10, 12, 13, 14, 16, 17, 19, 21], "determin": 0, "base": [0, 7, 8, 15, 23], "rais": [0, 10], "valueerror": 0, "ani": [0, 5, 18], "get": [0, 10, 12, 13, 19], "meta": [1, 23, 26], "__title__": [1, 26], "__version__": [1, 26], "__description__": [1, 26], "__author__": [1, 26], "__author_email__": 1, "inform": [2, 3, 5, 12], "packag": 2, "titl": 2, "thi": [2, 3, 6, 9, 18, 19, 21, 24, 25], "project": 2, "should": [2, 19, 26], "version": [2, 5, 21, 26], "short": 2, "descript": [2, 19], "includ": [2, 3, 12], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 10, 12], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 10, 12, 13, 14, 19, 24, 25, 26], "object": [3, 8, 13, 14, 16, 19], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 22], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 19, 21], "keyword": [3, 19, 21], "argument": [3, 19, 21], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 12, 24, 25], "two": 3, "2": [3, 8, 26], "class": [3, 6, 8, 9, 10], "messag": [3, 6, 9, 12, 16], "except": [3, 6, 9, 10], "displai": [3, 6, 9, 19, 21], "yellow": 3, "color": 3, "error": [3, 6, 9], "exit_cod": [3, 6, 9], "exit": [3, 6, 9], "show": [3, 6, 9], "io": [3, 6, 9, 26], "write": [3, 6, 9], "output": [3, 6, 9, 14, 16, 19, 21, 26], "red": [3, 6, 9], "err": 3, "baseexcept": 3, "print": [3, 5, 24, 25, 26], "traceback": 3, "provid": [3, 19], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 26], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 23], "current": [5, 24, 25, 26], "metadata": 5, "arg": [5, 21], "indic": [6, 9], "remot": [6, 9], "repositori": [6, 9, 10, 12, 13, 14, 16, 17], "assign": [6, 9, 13, 14, 16], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 23], "print_vers": 7, "download": [7, 10, 15, 20, 23], "noremotepathassignedwithdownload": 7, "l": [7, 23], "listitemtyp": 7, "listitem": 7, "upload": [7, 12, 15, 23], "noremotepathassignedwithupload": 7, "enum": 8, "repres": 8, "differ": [8, 24, 25], "item": 8, "valid": [8, 15, 23], "ar": 8, "folder": 8, "imag": 8, "3": [8, 24, 25, 26], "archiv": [8, 10, 12, 14, 16, 23], "4": [8, 24, 25], "model": [8, 10, 12, 13, 14, 16, 17], "5": [8, 14, 24, 25], "data": [8, 24, 25], "6": [8, 24, 25], "repofold": 8, "repofil": 8, "base_dir": 8, "union": [8, 10], "33": 9, "standalon": 10, "incomplet": 10, "hash": [10, 12, 13, 14, 16], "match": [10, 17], "repo_id": [10, 12, 13, 14, 16, 17], "archive_in_repo": [10, 12, 16], "repo_typ": [10, 12, 13, 14, 16, 17], "liter": [10, 12, 13, 14, 16, 17], "dataset": [10, 12, 13, 14, 16, 17], "space": [10, 12, 13, 14, 16, 17], "revis": [10, 12, 13, 14, 16, 17], "main": [10, 12, 13, 14, 16, 17, 26], "idx_repo_id": [10, 12], "idx_file_in_repo": 10, "idx_repo_typ": [10, 12], "idx_revis": [10, 12], "hf_token": [10, 12, 13, 14, 16, 17], "insid": 10, "hug": [10, 12, 13, 14, 16, 17], "face": [10, 12, 13, 14, 16, 17], "identifi": [10, 12, 13, 14, 16, 17], "repotypetyp": [10, 12, 13, 14, 16, 17], "access": [10, 12], "token": [10, 12, 13, 14, 16, 17], "file_in_arch": 10, "local_fil": [10, 14, 16, 17], "proxi": 10, "user_ag": 10, "header": 10, "endpoint": 10, "save": [10, 12, 14, 19], "local": [10, 12, 14, 16, 17, 19, 24, 25], "http": [10, 26], "request": [10, 19], "user": 10, "agent": 10, "addit": [10, 19, 21], "api": [10, 13, 14, 16, 17], "check": [10, 17, 18, 19, 26], "otherwis": [10, 17, 19], "fetch": [11, 23], "archivestandalonefileincompletedownload": 11, "archivestandalonefilehashnotmatch": 11, "hf_tar_list_fil": 11, "hf_tar_file_download": 11, "hf_tar_get_index": 11, "hf_tar_file_exist": 11, "make": [11, 23], "tar_create_index": 11, "hf_tar_create_index": 11, "tar_get_index_info": 11, "hf_tar_create_from_directori": 11, "src_tar_fil": 12, "dst_index_fil": 12, "chunk_for_hash": 12, "int": [12, 14, 19], "1048576": 12, "with_hash": 12, "default": [12, 14, 17], "chunk": 12, "size": [12, 19, 24, 25], "20": 12, "mb": 12, "whether": 12, "progress": [12, 14, 16, 19, 21], "bar": [12, 14, 16, 19, 21], "log": 12, "idx_filenam": 12, "local_directori": [12, 14, 16], "hfapi": 13, "client": [13, 14, 16], "huggingfac": [13, 14, 16, 23, 26], "variabl": [13, 14, 16], "hffilesystem": 13, "system": 13, "subdir": 13, "ignore_pattern": [13, 14, 16], "given": [13, 18, 19], "subdirectori": 13, "e": [13, 14, 16], "g": [13, 14, 16], "branch": [13, 14, 16], "tag": [13, 14, 16], "commit": [13, 14, 16], "pattern": [13, 14, 16], "ignor": [13, 14, 16], "file_in_repo": [14, 16, 17], "resume_download": 14, "within": [14, 16], "resum": 14, "dir_in_repo": 14, "max_work": 14, "8": [14, 24, 25, 26], "max_retri": 14, "all": [14, 22], "max": 14, "worker": 14, "retri": 14, "time": 14, "get_hf_client": 15, "get_hf_f": 15, "list_files_in_repositori": 15, "download_file_to_fil": 15, "download_archive_as_directori": 15, "download_directory_as_directori": 15, "upload_file_to_fil": 15, "upload_directory_as_arch": 15, "upload_directory_as_directori": 15, "is_local_file_readi": 15, "path_in_repo": 16, "time_suffix": 16, "its": 16, "append": 16, "timestamp": 16, "present": 16, "readi": 17, "compar": 17, "hub": 17, "read": 18, "first": 18, "1024": [18, 24, 25], "byte": [18, 19], "contain": 18, "non": 18, "text": 18, "charact": 18, "url": 19, "expected_s": 19, "desc": 19, "session": 19, "tqdm": [19, 20, 23], "It": [19, 26], "also": [19, 26], "perform": [19, 24, 25], "ensur": 19, "ha": [19, 24, 25], "expect": 19, "where": 19, "pass": [19, 21], "binari": [20, 23], "is_binary_fil": 20, "download_fil": 20, "walk": [20, 23], "walk_fil": 20, "tqdm_": 21, "enhanc": 21, "silenc": 21, "modifi": 21, "behavior": 21, "allow": 21, "posit": 21, "std": 21, "recurs": 22, "through": [22, 26], "yield": 22, "rel": 22, "root": 22, "start": [22, 23], "modul": 23, "quick": 23, "run": 23, "environ": 23, "register_archive_typ": 23, "archive_pack": 23, "archive_unpack": 23, "get_archive_typ": 23, "get_archive_extnam": 23, "config": [23, 26], "entri": 23, "index": [23, 26], "oper": 23, "here": [24, 25], "import": [24, 25, 26], "o": [24, 25], "platform": [24, 25], "shutil": [24, 25], "cpuinfo": [24, 25], "psutil": [24, 25], "hbutil": [24, 25], "scale": [24, 25], "size_to_bytes_str": [24, 25], "python": [24, 25, 26], "python_implement": [24, 25], "python_vers": [24, 25], "cpu": [24, 25], "brand": [24, 25], "get_cpu_info": [24, 25], "brand_raw": [24, 25], "count": [24, 25], "cpu_count": [24, 25], "freq": [24, 25], "cpu_freq": [24, 25], "mhz": [24, 25], "memori": [24, 25], "virtual_memori": [24, 25], "total": [24, 25], "precis": [24, 25], "cuda": [24, 25], "ye": [24, 25], "nvidia": [24, 25], "smi": [24, 25], "els": [24, 25], "No": [24, 25], "linux": [24, 25], "0": [24, 25, 26], "azur": [24, 25], "x86_64": [24, 25], "glibc2": [24, 25], "34": [24, 25], "cpython": [24, 25], "18": [24, 25], "amd": [24, 25], "epyc": [24, 25], "7763": [24, 25], "64": [24, 25], "core": [24, 25], "processor": [24, 25], "2714": 24, "21625": 24, "15": [24, 25], "606": [24, 25], "gib": [24, 25], "pleas": [24, 25], "note": [24, 25], "deploi": [24, 25], "document": [24, 25, 26], "automat": [24, 25], "execut": [24, 25], "github": [24, 25, 26], "action": [24, 25], "therefor": [24, 25], "some": [24, 25], "mai": [24, 25], "your": [24, 25, 26], "3035": 25, "12475": 25, "hfutil": 26, "host": 26, "pypi": 26, "can": 26, "newest": 26, "u": 26, "git": 26, "com": 26, "deepgh": 26, "script": 26, "__name__": 26, "__main__": 26, "develop": 26, "maintain": 26, "like": 26, "below": 26, "mean": 26, "success": 26, "narugo1992": 26, "still": 26, "under": 26, "out": 26, "stabl": 26, "html": 26, "faq": 27}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "index"], [15, 0, 0, "-", "operate"], [20, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.upload": [[9, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.index": [[10, 0, 0, "-", "fetch"], [12, 0, 0, "-", "make"]], "hfutils.index.fetch": [[10, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [10, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [10, 1, 1, "", "hf_tar_file_download"], [10, 1, 1, "", "hf_tar_file_exists"], [10, 1, 1, "", "hf_tar_get_index"], [10, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[12, 1, 1, "", "hf_tar_create_from_directory"], [12, 1, 1, "", "hf_tar_create_index"], [12, 1, 1, "", "tar_create_index"], [12, 1, 1, "", "tar_get_index_info"]], "hfutils.operate": [[13, 0, 0, "-", "base"], [14, 0, 0, "-", "download"], [16, 0, 0, "-", "upload"], [17, 0, 0, "-", "validate"]], "hfutils.operate.base": [[13, 1, 1, "", "get_hf_client"], [13, 1, 1, "", "get_hf_fs"], [13, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[14, 1, 1, "", "download_archive_as_directory"], [14, 1, 1, "", "download_directory_as_directory"], [14, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[16, 1, 1, "", "upload_directory_as_archive"], [16, 1, 1, "", "upload_directory_as_directory"], [16, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[17, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[18, 0, 0, "-", "binary"], [19, 0, 0, "-", "download"], [21, 0, 0, "-", "tqdm_"], [22, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[18, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[19, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[21, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[22, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9], "base": [3, 13], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 14, 19], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "upload": [9, 16], "noremotepathassignedwithupload": 9, "index": [10, 11, 12], "fetch": 10, "archivestandalonefileincompletedownload": 10, "archivestandalonefilehashnotmatch": 10, "hf_tar_list_fil": 10, "hf_tar_file_download": 10, "hf_tar_get_index": 10, "hf_tar_file_exist": 10, "make": 12, "tar_create_index": 12, "hf_tar_create_index": 12, "tar_get_index_info": 12, "hf_tar_create_from_directori": 12, "oper": [13, 14, 15, 16, 17], "get_hf_client": 13, "get_hf_f": 13, "list_files_in_repositori": 13, "download_file_to_fil": 14, "download_archive_as_directori": 14, "download_directory_as_directori": 14, "upload_file_to_fil": 16, "upload_directory_as_arch": 16, "upload_directory_as_directori": 16, "valid": 17, "is_local_file_readi": 17, "util": [18, 19, 20, 21, 22], "binari": 18, "is_binary_fil": 18, "download_fil": 19, "tqdm": 21, "walk": 22, "walk_fil": 22, "welcom": 23, "": 23, "document": 23, "overview": 23, "tutori": 23, "inform": [23, 24, 25], "api": 23, "run": [24, 25], "environ": [24, 25], "instal": 26, "quick": 27, "start": 27}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[9, "noremotepathassignedwithupload"]], "hfutils.index.fetch": [[10, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[10, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[10, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[10, "hf-tar-list-files"]], "hf_tar_file_download": [[10, "hf-tar-file-download"]], "hf_tar_get_index": [[10, "hf-tar-get-index"]], "hf_tar_file_exists": [[10, "hf-tar-file-exists"]], "hfutils.index": [[11, "module-hfutils.index"]], "hfutils.index.make": [[12, "module-hfutils.index.make"]], "tar_create_index": [[12, "tar-create-index"]], "hf_tar_create_index": [[12, "hf-tar-create-index"]], "tar_get_index_info": [[12, "tar-get-index-info"]], "hf_tar_create_from_directory": [[12, "hf-tar-create-from-directory"]], "hfutils.operate.base": [[13, "module-hfutils.operate.base"]], "get_hf_client": [[13, "get-hf-client"]], "get_hf_fs": [[13, "get-hf-fs"]], "list_files_in_repository": [[13, "list-files-in-repository"]], "hfutils.operate.download": [[14, "module-hfutils.operate.download"]], "download_file_to_file": [[14, "download-file-to-file"]], "download_archive_as_directory": [[14, "download-archive-as-directory"]], "download_directory_as_directory": [[14, "download-directory-as-directory"]], "hfutils.operate": [[15, "module-hfutils.operate"]], "hfutils.operate.upload": [[16, "module-hfutils.operate.upload"]], "upload_file_to_file": [[16, "upload-file-to-file"]], "upload_directory_as_archive": [[16, "upload-directory-as-archive"]], "upload_directory_as_directory": [[16, "upload-directory-as-directory"]], "hfutils.operate.validate": [[17, "module-hfutils.operate.validate"]], "is_local_file_ready": [[17, "is-local-file-ready"]], "hfutils.utils.binary": [[18, "module-hfutils.utils.binary"]], "is_binary_file": [[18, "is-binary-file"]], "hfutils.utils.download": [[19, "module-hfutils.utils.download"]], "download_file": [[19, "download-file"]], "hfutils.utils": [[20, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[21, "module-hfutils.utils.tqdm_"]], "tqdm": [[21, "tqdm"]], "hfutils.utils.walk": [[22, "module-hfutils.utils.walk"]], "walk_files": [[22, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[23, "welcome-to-hfutils-s-documentation"]], "Overview": [[23, "overview"]], "Tutorials": [[23, null]], "Information": [[23, null]], "API Documentation": [[23, null]], "Run Environment Information": [[24, "Run-Environment-Information"], [25, "Run-Environment-Information"]], "Installation": [[26, "installation"]], "Quick Start": [[27, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.upload"], [10, "module-hfutils.index.fetch"], [11, "module-hfutils.index"], [12, "module-hfutils.index.make"], [13, "module-hfutils.operate.base"], [14, "module-hfutils.operate.download"], [15, "module-hfutils.operate"], [16, "module-hfutils.operate.upload"], [17, "module-hfutils.operate.validate"], [18, "module-hfutils.utils.binary"], [19, "module-hfutils.utils.download"], [20, "module-hfutils.utils"], [21, "module-hfutils.utils.tqdm_"], [22, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[10, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[10, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[10, "module-hfutils.index.fetch"]], "hfutils.index": [[11, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[12, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[12, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[12, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[12, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[12, "hfutils.index.make.tar_get_index_info"]], "get_hf_client() (in module hfutils.operate.base)": [[13, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[13, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[13, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[13, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[14, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[14, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[14, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[14, "module-hfutils.operate.download"]], "hfutils.operate": [[15, "module-hfutils.operate"]], "hfutils.operate.upload": [[16, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[16, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[16, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[16, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[17, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[17, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[18, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[18, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[19, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[19, "module-hfutils.utils.download"]], "hfutils.utils": [[20, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[21, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[21, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[22, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[22, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.2.1/.buildinfo b/v0.2.1/.buildinfo
index 370bd50812..6eb71305fb 100644
--- a/v0.2.1/.buildinfo
+++ b/v0.2.1/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: cb045370ba026a6c297bd078448a4300
+config: 29fd6f2a92fd7fc387179add16dbaec4
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.2.1/.doctrees/api_doc/archive/index.doctree b/v0.2.1/.doctrees/api_doc/archive/index.doctree
index cb67dd0e86..4b608fe9ad 100644
Binary files a/v0.2.1/.doctrees/api_doc/archive/index.doctree and b/v0.2.1/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/config/index.doctree b/v0.2.1/.doctrees/api_doc/config/index.doctree
index b2b693f4af..2a95ab90ad 100644
Binary files a/v0.2.1/.doctrees/api_doc/config/index.doctree and b/v0.2.1/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/config/meta.doctree b/v0.2.1/.doctrees/api_doc/config/meta.doctree
index 7265964c6f..9068d4921b 100644
Binary files a/v0.2.1/.doctrees/api_doc/config/meta.doctree and b/v0.2.1/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/entry/base.doctree b/v0.2.1/.doctrees/api_doc/entry/base.doctree
index a16ec81015..11610f2573 100644
Binary files a/v0.2.1/.doctrees/api_doc/entry/base.doctree and b/v0.2.1/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/entry/cli.doctree b/v0.2.1/.doctrees/api_doc/entry/cli.doctree
index 786532ce02..f41ec0bbbe 100644
Binary files a/v0.2.1/.doctrees/api_doc/entry/cli.doctree and b/v0.2.1/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/entry/dispatch.doctree b/v0.2.1/.doctrees/api_doc/entry/dispatch.doctree
index e979f646be..058dc28a6d 100644
Binary files a/v0.2.1/.doctrees/api_doc/entry/dispatch.doctree and b/v0.2.1/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/entry/download.doctree b/v0.2.1/.doctrees/api_doc/entry/download.doctree
index aaad22b91b..6c6e707781 100644
Binary files a/v0.2.1/.doctrees/api_doc/entry/download.doctree and b/v0.2.1/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/entry/index.doctree b/v0.2.1/.doctrees/api_doc/entry/index.doctree
index 2e0a09a92e..a3b865fcc4 100644
Binary files a/v0.2.1/.doctrees/api_doc/entry/index.doctree and b/v0.2.1/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/entry/ls.doctree b/v0.2.1/.doctrees/api_doc/entry/ls.doctree
index 9658115bc1..a48c949697 100644
Binary files a/v0.2.1/.doctrees/api_doc/entry/ls.doctree and b/v0.2.1/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/entry/upload.doctree b/v0.2.1/.doctrees/api_doc/entry/upload.doctree
index 2a601214c2..f4885737bc 100644
Binary files a/v0.2.1/.doctrees/api_doc/entry/upload.doctree and b/v0.2.1/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/index/fetch.doctree b/v0.2.1/.doctrees/api_doc/index/fetch.doctree
index 5b0e42f9b6..eab4e304b5 100644
Binary files a/v0.2.1/.doctrees/api_doc/index/fetch.doctree and b/v0.2.1/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/index/index.doctree b/v0.2.1/.doctrees/api_doc/index/index.doctree
index c0c81246a5..4ab7a15daf 100644
Binary files a/v0.2.1/.doctrees/api_doc/index/index.doctree and b/v0.2.1/.doctrees/api_doc/index/index.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/index/make.doctree b/v0.2.1/.doctrees/api_doc/index/make.doctree
index 1b898fb577..d116e5bf2e 100644
Binary files a/v0.2.1/.doctrees/api_doc/index/make.doctree and b/v0.2.1/.doctrees/api_doc/index/make.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/index/validate.doctree b/v0.2.1/.doctrees/api_doc/index/validate.doctree
index 9d35a3e98e..38f7f2d64f 100644
Binary files a/v0.2.1/.doctrees/api_doc/index/validate.doctree and b/v0.2.1/.doctrees/api_doc/index/validate.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/operate/base.doctree b/v0.2.1/.doctrees/api_doc/operate/base.doctree
index e5f657e06a..daf26549b9 100644
Binary files a/v0.2.1/.doctrees/api_doc/operate/base.doctree and b/v0.2.1/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/operate/download.doctree b/v0.2.1/.doctrees/api_doc/operate/download.doctree
index 55dde4abcd..3aa53fb798 100644
Binary files a/v0.2.1/.doctrees/api_doc/operate/download.doctree and b/v0.2.1/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/operate/index.doctree b/v0.2.1/.doctrees/api_doc/operate/index.doctree
index 02abadd6a6..ef8d08fae8 100644
Binary files a/v0.2.1/.doctrees/api_doc/operate/index.doctree and b/v0.2.1/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/operate/upload.doctree b/v0.2.1/.doctrees/api_doc/operate/upload.doctree
index bac426cc15..7dd010805a 100644
Binary files a/v0.2.1/.doctrees/api_doc/operate/upload.doctree and b/v0.2.1/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/operate/validate.doctree b/v0.2.1/.doctrees/api_doc/operate/validate.doctree
index e44507c2ec..e6939545ba 100644
Binary files a/v0.2.1/.doctrees/api_doc/operate/validate.doctree and b/v0.2.1/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/utils/binary.doctree b/v0.2.1/.doctrees/api_doc/utils/binary.doctree
index a2481c4db6..a092fc5402 100644
Binary files a/v0.2.1/.doctrees/api_doc/utils/binary.doctree and b/v0.2.1/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/utils/download.doctree b/v0.2.1/.doctrees/api_doc/utils/download.doctree
index 1702c2729f..53c851cdac 100644
Binary files a/v0.2.1/.doctrees/api_doc/utils/download.doctree and b/v0.2.1/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/utils/index.doctree b/v0.2.1/.doctrees/api_doc/utils/index.doctree
index 182849e376..9057691aae 100644
Binary files a/v0.2.1/.doctrees/api_doc/utils/index.doctree and b/v0.2.1/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/utils/tqdm_.doctree b/v0.2.1/.doctrees/api_doc/utils/tqdm_.doctree
index 35fb54a62a..18e884b022 100644
Binary files a/v0.2.1/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.2.1/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.2.1/.doctrees/api_doc/utils/walk.doctree b/v0.2.1/.doctrees/api_doc/utils/walk.doctree
index 9b272634db..9a68abab8d 100644
Binary files a/v0.2.1/.doctrees/api_doc/utils/walk.doctree and b/v0.2.1/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.2.1/.doctrees/environment.pickle b/v0.2.1/.doctrees/environment.pickle
index bb78417d17..809f58626f 100644
Binary files a/v0.2.1/.doctrees/environment.pickle and b/v0.2.1/.doctrees/environment.pickle differ
diff --git a/v0.2.1/.doctrees/index.doctree b/v0.2.1/.doctrees/index.doctree
index 090039b26a..f9c75a147a 100644
Binary files a/v0.2.1/.doctrees/index.doctree and b/v0.2.1/.doctrees/index.doctree differ
diff --git a/v0.2.1/.doctrees/information/environment.doctree b/v0.2.1/.doctrees/information/environment.doctree
index afb3e9e221..89525e4db3 100644
Binary files a/v0.2.1/.doctrees/information/environment.doctree and b/v0.2.1/.doctrees/information/environment.doctree differ
diff --git a/v0.2.1/.doctrees/information/environment.result.doctree b/v0.2.1/.doctrees/information/environment.result.doctree
index 324067ee20..9e7b988f7a 100644
Binary files a/v0.2.1/.doctrees/information/environment.result.doctree and b/v0.2.1/.doctrees/information/environment.result.doctree differ
diff --git a/v0.2.1/.doctrees/nbsphinx/information/environment.ipynb b/v0.2.1/.doctrees/nbsphinx/information/environment.ipynb
index 28cf9a347a..e1907a800f 100644
--- a/v0.2.1/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.2.1/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:47:40.938293Z",
-     "iopub.status.busy": "2024-07-23T17:47:40.938086Z",
-     "iopub.status.idle": "2024-07-23T17:47:42.106742Z",
-     "shell.execute_reply": "2024-07-23T17:47:42.105990Z"
+     "iopub.execute_input": "2024-07-23T17:54:10.610896Z",
+     "iopub.status.busy": "2024-07-23T17:54:10.610690Z",
+     "iopub.status.idle": "2024-07-23T17:54:11.781324Z",
+     "shell.execute_reply": "2024-07-23T17:54:11.780544Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2888.6879999999996 MHz\n",
+      "CPU Freq: 2925.518 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.1/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.2.1/.doctrees/nbsphinx/information/environment.result.ipynb
index f6f0aecbbd..137f113fd6 100644
--- a/v0.2.1/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.2.1/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:06:25.929741Z",
-     "iopub.status.busy": "2024-07-23T17:06:25.929257Z",
-     "iopub.status.idle": "2024-07-23T17:06:27.102335Z",
-     "shell.execute_reply": "2024-07-23T17:06:27.101553Z"
+     "iopub.execute_input": "2024-07-23T17:12:05.607391Z",
+     "iopub.status.busy": "2024-07-23T17:12:05.607184Z",
+     "iopub.status.idle": "2024-07-23T17:12:06.784912Z",
+     "shell.execute_reply": "2024-07-23T17:12:06.784160Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2719.2242499999998 MHz\n",
+      "CPU Freq: 3045.374 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.1/.doctrees/tutorials/installation/index.doctree b/v0.2.1/.doctrees/tutorials/installation/index.doctree
index c0af9ebc5f..e64dcf617e 100644
Binary files a/v0.2.1/.doctrees/tutorials/installation/index.doctree and b/v0.2.1/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.2.1/.doctrees/tutorials/quick_start/index.doctree b/v0.2.1/.doctrees/tutorials/quick_start/index.doctree
index db48eff082..4a5995b61f 100644
Binary files a/v0.2.1/.doctrees/tutorials/quick_start/index.doctree and b/v0.2.1/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.2.1/_sources/information/environment.result.ipynb.txt b/v0.2.1/_sources/information/environment.result.ipynb.txt
index f6f0aecbbd..137f113fd6 100644
--- a/v0.2.1/_sources/information/environment.result.ipynb.txt
+++ b/v0.2.1/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:06:25.929741Z",
-     "iopub.status.busy": "2024-07-23T17:06:25.929257Z",
-     "iopub.status.idle": "2024-07-23T17:06:27.102335Z",
-     "shell.execute_reply": "2024-07-23T17:06:27.101553Z"
+     "iopub.execute_input": "2024-07-23T17:12:05.607391Z",
+     "iopub.status.busy": "2024-07-23T17:12:05.607184Z",
+     "iopub.status.idle": "2024-07-23T17:12:06.784912Z",
+     "shell.execute_reply": "2024-07-23T17:12:06.784160Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2719.2242499999998 MHz\n",
+      "CPU Freq: 3045.374 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.1/information/environment.html b/v0.2.1/information/environment.html
index 256fd35dc3..8862710eaa 100644
--- a/v0.2.1/information/environment.html
+++ b/v0.2.1/information/environment.html
@@ -126,11 +126,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2888.6879999999996 MHz
+CPU Freq: 2925.518 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.1/information/environment.ipynb b/v0.2.1/information/environment.ipynb
index 28cf9a347a..e1907a800f 100644
--- a/v0.2.1/information/environment.ipynb
+++ b/v0.2.1/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:47:40.938293Z",
-     "iopub.status.busy": "2024-07-23T17:47:40.938086Z",
-     "iopub.status.idle": "2024-07-23T17:47:42.106742Z",
-     "shell.execute_reply": "2024-07-23T17:47:42.105990Z"
+     "iopub.execute_input": "2024-07-23T17:54:10.610896Z",
+     "iopub.status.busy": "2024-07-23T17:54:10.610690Z",
+     "iopub.status.idle": "2024-07-23T17:54:11.781324Z",
+     "shell.execute_reply": "2024-07-23T17:54:11.780544Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2888.6879999999996 MHz\n",
+      "CPU Freq: 2925.518 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.1/information/environment.result.html b/v0.2.1/information/environment.result.html
index d653c5ecf6..0168e069aa 100644
--- a/v0.2.1/information/environment.result.html
+++ b/v0.2.1/information/environment.result.html
@@ -128,11 +128,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2719.2242499999998 MHz
+CPU Freq: 3045.374 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.1/information/environment.result.ipynb b/v0.2.1/information/environment.result.ipynb
index f6f0aecbbd..137f113fd6 100644
--- a/v0.2.1/information/environment.result.ipynb
+++ b/v0.2.1/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:06:25.929741Z",
-     "iopub.status.busy": "2024-07-23T17:06:25.929257Z",
-     "iopub.status.idle": "2024-07-23T17:06:27.102335Z",
-     "shell.execute_reply": "2024-07-23T17:06:27.101553Z"
+     "iopub.execute_input": "2024-07-23T17:12:05.607391Z",
+     "iopub.status.busy": "2024-07-23T17:12:05.607184Z",
+     "iopub.status.idle": "2024-07-23T17:12:06.784912Z",
+     "shell.execute_reply": "2024-07-23T17:12:06.784160Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2719.2242499999998 MHz\n",
+      "CPU Freq: 3045.374 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.1/searchindex.js b/v0.2.1/searchindex.js
index 8ba35ba767..5c5bf9b614 100644
--- a/v0.2.1/searchindex.js
+++ b/v0.2.1/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/upload", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/upload.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.upload", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 10, 12, 13], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 13, 15, 17, 20, 22], "you": [0, 27], "requir": [0, 27], "simpli": [0, 27], "instal": [0, 24], "us": [0, 3, 10, 14, 15, 17, 20, 24, 27], "follow": [0, 8, 27], "code": [0, 3, 6, 9], "pip": [0, 27], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23, 27], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23], "i": [0, 6, 9, 10, 12, 13, 15, 18, 19, 24, 25, 26, 27], "we": 0, "util": [0, 24, 27], "rarfil": 0, "librari": [0, 20], "which": [0, 25, 26, 27], "doe": [0, 10], "offer": 0, "function": [0, 3, 13, 19, 20, 22], "creat": [0, 12], "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23], "ext": 0, "list": [0, 3, 8, 10, 14, 15, 17], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 22, 23], "regist": 0, "custom": [0, 3, 6, 9], "type": [0, 3, 8, 10, 12, 13, 14, 15, 17, 18, 19, 20, 22, 23], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 22, 23], "A": [0, 14], "take": 0, "directori": [0, 8, 12, 13, 15, 17, 23], "an": [0, 10, 12, 15, 17, 20, 22, 23], "filenam": [0, 20], "input": 0, "extract": [0, 15], "type_nam": 0, "archive_fil": 0, "silent": [0, 12, 15, 17, 20, 22], "bool": [0, 5, 10, 12, 13, 15, 17, 18, 19, 20, 22], "fals": [0, 10, 12, 13, 15, 17, 18, 19, 20, 22], "clear": [0, 17], "specifi": [0, 13, 17, 20], "result": 0, "true": [0, 10, 12, 13, 15, 17, 18, 19, 20, 22], "suppress": [0, 12, 15, 17, 20], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 17], "exist": [0, 10, 15], "when": [0, 10, 12, 15], "return": [0, 3, 10, 12, 13, 14, 18, 19, 20, 22, 23], "path": [0, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23], "password": [0, 15], "none": [0, 3, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 20], "content": [0, 22], "option": [0, 3, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 20, 22], "determin": 0, "base": [0, 7, 8, 16, 24], "rais": [0, 10, 13], "valueerror": 0, "ani": [0, 5, 19], "get": [0, 10, 12, 14, 20], "meta": [1, 24, 27], "__title__": [1, 27], "__version__": [1, 27], "__description__": [1, 27], "__author__": [1, 27], "__author_email__": 1, "inform": [2, 3, 5, 12], "packag": 2, "titl": 2, "thi": [2, 3, 6, 9, 13, 19, 20, 22, 25, 26], "project": 2, "should": [2, 20, 27], "version": [2, 5, 22, 27], "short": 2, "descript": [2, 20], "includ": [2, 3, 12], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 10, 12], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 10, 12, 13, 14, 15, 20, 25, 26, 27], "object": [3, 8, 14, 15, 17, 20], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 23], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 20, 22], "keyword": [3, 20, 22], "argument": [3, 20, 22], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 12, 13, 25, 26, 27], "two": 3, "2": [3, 8, 27], "class": [3, 6, 8, 9, 10], "messag": [3, 6, 9, 12, 17], "except": [3, 6, 9, 10], "displai": [3, 6, 9, 20, 22], "yellow": 3, "color": 3, "error": [3, 6, 9], "exit_cod": [3, 6, 9], "exit": [3, 6, 9], "show": [3, 6, 9], "io": [3, 6, 9, 27], "write": [3, 6, 9], "output": [3, 6, 9, 15, 17, 20, 22, 27], "red": [3, 6, 9], "err": 3, "baseexcept": 3, "print": [3, 5, 25, 26, 27], "traceback": 3, "provid": [3, 20], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 27], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 24], "current": [5, 25, 26, 27], "metadata": 5, "arg": [5, 22], "indic": [6, 9], "remot": [6, 9], "repositori": [6, 9, 10, 12, 13, 14, 15, 17, 18], "assign": [6, 9, 14, 15, 17], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 24], "print_vers": 7, "download": [7, 10, 16, 21, 24], "noremotepathassignedwithdownload": 7, "l": [7, 24], "listitemtyp": 7, "listitem": 7, "upload": [7, 12, 16, 24], "noremotepathassignedwithupload": 7, "enum": 8, "repres": 8, "differ": [8, 25, 26], "item": [8, 13], "valid": [8, 11, 16, 24], "ar": 8, "folder": 8, "imag": 8, "3": [8, 25, 26, 27], "archiv": [8, 10, 12, 13, 15, 17, 24], "4": [8, 25, 26], "model": [8, 10, 12, 13, 14, 15, 17, 18], "5": [8, 15, 25, 26], "data": [8, 25, 26], "6": [8, 25, 26], "repofold": 8, "repofil": [8, 13], "base_dir": 8, "union": [8, 10], "33": 9, "standalon": 10, "incomplet": 10, "hash": [10, 12, 13, 14, 15, 17], "match": [10, 13, 18], "repo_id": [10, 12, 13, 14, 15, 17, 18], "archive_in_repo": [10, 12, 13, 17], "repo_typ": [10, 12, 13, 14, 15, 17, 18], "liter": [10, 12, 13, 14, 15, 17, 18], "dataset": [10, 12, 13, 14, 15, 17, 18], "space": [10, 12, 13, 14, 15, 17, 18], "revis": [10, 12, 13, 14, 15, 17, 18], "main": [10, 12, 13, 14, 15, 17, 18, 27], "idx_repo_id": [10, 12, 13], "idx_file_in_repo": [10, 12, 13], "idx_repo_typ": [10, 12, 13], "idx_revis": [10, 12, 13], "hf_token": [10, 12, 13, 14, 15, 17, 18], "insid": 10, "hug": [10, 12, 13, 14, 15, 17, 18], "face": [10, 12, 13, 14, 15, 17, 18], "identifi": [10, 12, 14, 15, 17, 18], "repotypetyp": [10, 12, 13, 14, 15, 17, 18], "access": [10, 12], "token": [10, 12, 13, 14, 15, 17, 18], "file_in_arch": 10, "local_fil": [10, 15, 17, 18], "proxi": 10, "user_ag": 10, "header": 10, "endpoint": 10, "save": [10, 12, 15, 20], "local": [10, 12, 15, 17, 18, 20, 25, 26], "http": [10, 27], "request": [10, 20], "user": 10, "agent": 10, "addit": [10, 20, 22], "api": [10, 14, 15, 17, 18], "check": [10, 13, 18, 19, 20, 27], "otherwis": [10, 13, 18, 20], "fetch": [11, 24], "archivestandalonefileincompletedownload": 11, "archivestandalonefilehashnotmatch": 11, "hf_tar_list_fil": 11, "hf_tar_file_download": 11, "hf_tar_get_index": 11, "hf_tar_file_exist": 11, "make": [11, 24], "tar_create_index": 11, "hf_tar_create_index": 11, "tar_get_index_info": 11, "hf_tar_create_from_directori": 11, "hf_tar_item_valid": 11, "hf_tar_valid": 11, "src_tar_fil": 12, "dst_index_fil": 12, "chunk_for_hash": 12, "int": [12, 13, 15, 20], "1048576": 12, "with_hash": 12, "default": [12, 13, 15, 18], "chunk": 12, "size": [12, 13, 20, 25, 26], "20": 12, "mb": 12, "whether": 12, "progress": [12, 15, 17, 20, 22], "bar": [12, 15, 17, 20, 22], "log": 12, "skip_when_sync": 12, "skip": 12, "sync": 12, "readi": [12, 18], "local_directori": [12, 15, 17], "file_item": 13, "hash_": 13, "hash_lf": 13, "expect": [13, 20], "sha": 13, "256": 13, "store": 13, "lf": 13, "id": 13, "where": [13, 20], "authent": 13, "entrynotfounderror": 13, "entri": [13, 24], "found": 13, "isadirectoryerror": 13, "hfapi": 14, "client": [14, 15, 17], "huggingfac": [14, 15, 17, 24, 27], "variabl": [14, 15, 17], "hffilesystem": 14, "system": 14, "subdir": 14, "ignore_pattern": [14, 15, 17], "given": [14, 19, 20], "subdirectori": 14, "e": [14, 15, 17], "g": [14, 15, 17], "branch": [14, 15, 17], "tag": [14, 15, 17], "commit": [14, 15, 17], "pattern": [14, 15, 17], "ignor": [14, 15, 17], "file_in_repo": [15, 17, 18], "resume_download": 15, "within": [15, 17], "resum": 15, "dir_in_repo": 15, "max_work": 15, "8": [15, 25, 26, 27], "max_retri": 15, "all": [15, 23], "max": 15, "worker": 15, "retri": 15, "time": 15, "get_hf_client": 16, "get_hf_f": 16, "list_files_in_repositori": 16, "download_file_to_fil": 16, "download_archive_as_directori": 16, "download_directory_as_directori": 16, "upload_file_to_fil": 16, "upload_directory_as_arch": 16, "upload_directory_as_directori": 16, "is_local_file_readi": 16, "path_in_repo": 17, "time_suffix": 17, "its": 17, "append": 17, "timestamp": 17, "present": 17, "compar": 18, "hub": 18, "read": 19, "first": 19, "1024": 19, "byte": [19, 20], "contain": 19, "non": 19, "text": 19, "charact": 19, "url": 20, "expected_s": 20, "desc": 20, "session": 20, "tqdm": [20, 21, 24], "It": [20, 27], "also": [20, 27], "perform": [20, 25, 26], "ensur": 20, "ha": [20, 25, 26], "pass": [20, 22], "binari": [21, 24], "is_binary_fil": 21, "download_fil": 21, "walk": [21, 24], "walk_fil": 21, "tqdm_": 22, "enhanc": 22, "silenc": 22, "modifi": 22, "behavior": 22, "allow": 22, "posit": 22, "std": 22, "recurs": 23, "through": [23, 27], "yield": 23, "rel": 23, "root": 23, "start": [23, 24], "modul": 24, "quick": 24, "run": 24, "environ": 24, "register_archive_typ": 24, "archive_pack": 24, "archive_unpack": 24, "get_archive_typ": 24, "get_archive_extnam": 24, "config": [24, 27], "index": [24, 27], "oper": 24, "here": [25, 26], "import": [25, 26, 27], "o": [25, 26], "platform": [25, 26], "shutil": [25, 26], "cpuinfo": [25, 26], "psutil": [25, 26], "hbutil": [25, 26], "scale": [25, 26], "size_to_bytes_str": [25, 26], "python": [25, 26, 27], "python_implement": [25, 26], "python_vers": [25, 26], "cpu": [25, 26], "brand": [25, 26], "get_cpu_info": [25, 26], "brand_raw": [25, 26], "count": [25, 26], "cpu_count": [25, 26], "freq": [25, 26], "cpu_freq": [25, 26], "mhz": [25, 26], "memori": [25, 26], "virtual_memori": [25, 26], "total": [25, 26], "precis": [25, 26], "cuda": [25, 26], "ye": [25, 26], "nvidia": [25, 26], "smi": [25, 26], "els": [25, 26], "No": [25, 26], "linux": [25, 26], "0": [25, 26, 27], "1023": [25, 26], "azur": [25, 26], "x86_64": [25, 26], "glibc2": [25, 26], "34": [25, 26], "cpython": [25, 26], "18": [25, 26], "amd": [25, 26], "epyc": [25, 26], "7763": [25, 26], "64": [25, 26], "core": [25, 26], "processor": [25, 26], "2888": 25, "6879999999996": 25, "15": [25, 26], "606": [25, 26], "gib": [25, 26], "pleas": [25, 26], "note": [25, 26], "deploi": [25, 26], "document": [25, 26, 27], "automat": [25, 26], "execut": [25, 26], "github": [25, 26, 27], "action": [25, 26], "therefor": [25, 26], "some": [25, 26], "mai": [25, 26], "your": [25, 26, 27], "2719": 26, "2242499999998": 26, "hfutil": 27, "host": 27, "pypi": 27, "can": 27, "newest": 27, "u": 27, "git": 27, "com": 27, "deepgh": 27, "script": 27, "__name__": 27, "__main__": 27, "develop": 27, "maintain": 27, "like": 27, "below": 27, "mean": 27, "success": 27, "narugo1992": 27, "still": 27, "under": 27, "out": 27, "stabl": 27, "html": 27, "faq": 28}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "index"], [16, 0, 0, "-", "operate"], [21, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.upload": [[9, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.index": [[10, 0, 0, "-", "fetch"], [12, 0, 0, "-", "make"], [13, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[10, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [10, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [10, 1, 1, "", "hf_tar_file_download"], [10, 1, 1, "", "hf_tar_file_exists"], [10, 1, 1, "", "hf_tar_get_index"], [10, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[12, 1, 1, "", "hf_tar_create_from_directory"], [12, 1, 1, "", "hf_tar_create_index"], [12, 1, 1, "", "tar_create_index"], [12, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[13, 1, 1, "", "hf_tar_item_validate"], [13, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[14, 0, 0, "-", "base"], [15, 0, 0, "-", "download"], [17, 0, 0, "-", "upload"], [18, 0, 0, "-", "validate"]], "hfutils.operate.base": [[14, 1, 1, "", "get_hf_client"], [14, 1, 1, "", "get_hf_fs"], [14, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[15, 1, 1, "", "download_archive_as_directory"], [15, 1, 1, "", "download_directory_as_directory"], [15, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[17, 1, 1, "", "upload_directory_as_archive"], [17, 1, 1, "", "upload_directory_as_directory"], [17, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[18, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[19, 0, 0, "-", "binary"], [20, 0, 0, "-", "download"], [22, 0, 0, "-", "tqdm_"], [23, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[19, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[20, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[22, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[23, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9], "base": [3, 14], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 15, 20], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "upload": [9, 17], "noremotepathassignedwithupload": 9, "index": [10, 11, 12, 13], "fetch": 10, "archivestandalonefileincompletedownload": 10, "archivestandalonefilehashnotmatch": 10, "hf_tar_list_fil": 10, "hf_tar_file_download": 10, "hf_tar_get_index": 10, "hf_tar_file_exist": 10, "make": 12, "tar_create_index": 12, "hf_tar_create_index": 12, "tar_get_index_info": 12, "hf_tar_create_from_directori": 12, "valid": [13, 18], "hf_tar_item_valid": 13, "hf_tar_valid": 13, "oper": [14, 15, 16, 17, 18], "get_hf_client": 14, "get_hf_f": 14, "list_files_in_repositori": 14, "download_file_to_fil": 15, "download_archive_as_directori": 15, "download_directory_as_directori": 15, "upload_file_to_fil": 17, "upload_directory_as_arch": 17, "upload_directory_as_directori": 17, "is_local_file_readi": 18, "util": [19, 20, 21, 22, 23], "binari": 19, "is_binary_fil": 19, "download_fil": 20, "tqdm": 22, "walk": 23, "walk_fil": 23, "welcom": 24, "": 24, "document": 24, "overview": 24, "tutori": 24, "inform": [24, 25, 26], "api": 24, "run": [25, 26], "environ": [25, 26], "instal": 27, "quick": 28, "start": 28}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[9, "noremotepathassignedwithupload"]], "hfutils.index.fetch": [[10, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[10, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[10, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[10, "hf-tar-list-files"]], "hf_tar_file_download": [[10, "hf-tar-file-download"]], "hf_tar_get_index": [[10, "hf-tar-get-index"]], "hf_tar_file_exists": [[10, "hf-tar-file-exists"]], "hfutils.index": [[11, "module-hfutils.index"]], "hfutils.index.make": [[12, "module-hfutils.index.make"]], "tar_create_index": [[12, "tar-create-index"]], "hf_tar_create_index": [[12, "hf-tar-create-index"]], "tar_get_index_info": [[12, "tar-get-index-info"]], "hf_tar_create_from_directory": [[12, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[13, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[13, "hf-tar-item-validate"]], "hf_tar_validate": [[13, "hf-tar-validate"]], "hfutils.operate.base": [[14, "module-hfutils.operate.base"]], "get_hf_client": [[14, "get-hf-client"]], "get_hf_fs": [[14, "get-hf-fs"]], "list_files_in_repository": [[14, "list-files-in-repository"]], "hfutils.operate.download": [[15, "module-hfutils.operate.download"]], "download_file_to_file": [[15, "download-file-to-file"]], "download_archive_as_directory": [[15, "download-archive-as-directory"]], "download_directory_as_directory": [[15, "download-directory-as-directory"]], "hfutils.operate": [[16, "module-hfutils.operate"]], "hfutils.operate.upload": [[17, "module-hfutils.operate.upload"]], "upload_file_to_file": [[17, "upload-file-to-file"]], "upload_directory_as_archive": [[17, "upload-directory-as-archive"]], "upload_directory_as_directory": [[17, "upload-directory-as-directory"]], "hfutils.operate.validate": [[18, "module-hfutils.operate.validate"]], "is_local_file_ready": [[18, "is-local-file-ready"]], "hfutils.utils.binary": [[19, "module-hfutils.utils.binary"]], "is_binary_file": [[19, "is-binary-file"]], "hfutils.utils.download": [[20, "module-hfutils.utils.download"]], "download_file": [[20, "download-file"]], "hfutils.utils": [[21, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[22, "module-hfutils.utils.tqdm_"]], "tqdm": [[22, "tqdm"]], "hfutils.utils.walk": [[23, "module-hfutils.utils.walk"]], "walk_files": [[23, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[24, "welcome-to-hfutils-s-documentation"]], "Overview": [[24, "overview"]], "Tutorials": [[24, null]], "Information": [[24, null]], "API Documentation": [[24, null]], "Run Environment Information": [[25, "Run-Environment-Information"], [26, "Run-Environment-Information"]], "Installation": [[27, "installation"]], "Quick Start": [[28, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.upload"], [10, "module-hfutils.index.fetch"], [11, "module-hfutils.index"], [12, "module-hfutils.index.make"], [13, "module-hfutils.index.validate"], [14, "module-hfutils.operate.base"], [15, "module-hfutils.operate.download"], [16, "module-hfutils.operate"], [17, "module-hfutils.operate.upload"], [18, "module-hfutils.operate.validate"], [19, "module-hfutils.utils.binary"], [20, "module-hfutils.utils.download"], [21, "module-hfutils.utils"], [22, "module-hfutils.utils.tqdm_"], [23, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[10, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[10, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[10, "module-hfutils.index.fetch"]], "hfutils.index": [[11, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[12, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[12, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[12, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[12, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[12, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[13, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[13, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[13, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[14, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[14, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[14, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[14, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[15, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[15, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[15, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[15, "module-hfutils.operate.download"]], "hfutils.operate": [[16, "module-hfutils.operate"]], "hfutils.operate.upload": [[17, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[17, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[17, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[17, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[18, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[18, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[19, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[19, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[20, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[20, "module-hfutils.utils.download"]], "hfutils.utils": [[21, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[22, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[22, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[23, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[23, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/upload", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/upload.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.upload", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 10, 12, 13], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 13, 15, 17, 20, 22], "you": [0, 27], "requir": [0, 27], "simpli": [0, 27], "instal": [0, 24], "us": [0, 3, 10, 14, 15, 17, 20, 24, 27], "follow": [0, 8, 27], "code": [0, 3, 6, 9], "pip": [0, 27], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23, 27], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23], "i": [0, 6, 9, 10, 12, 13, 15, 18, 19, 24, 25, 26, 27], "we": 0, "util": [0, 24, 27], "rarfil": 0, "librari": [0, 20], "which": [0, 25, 26, 27], "doe": [0, 10], "offer": 0, "function": [0, 3, 13, 19, 20, 22], "creat": [0, 12], "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23], "ext": 0, "list": [0, 3, 8, 10, 14, 15, 17], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 22, 23], "regist": 0, "custom": [0, 3, 6, 9], "type": [0, 3, 8, 10, 12, 13, 14, 15, 17, 18, 19, 20, 22, 23], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 22, 23], "A": [0, 14], "take": 0, "directori": [0, 8, 12, 13, 15, 17, 23], "an": [0, 10, 12, 15, 17, 20, 22, 23], "filenam": [0, 20], "input": 0, "extract": [0, 15], "type_nam": 0, "archive_fil": 0, "silent": [0, 12, 15, 17, 20, 22], "bool": [0, 5, 10, 12, 13, 15, 17, 18, 19, 20, 22], "fals": [0, 10, 12, 13, 15, 17, 18, 19, 20, 22], "clear": [0, 17], "specifi": [0, 13, 17, 20], "result": 0, "true": [0, 10, 12, 13, 15, 17, 18, 19, 20, 22], "suppress": [0, 12, 15, 17, 20], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 17], "exist": [0, 10, 15], "when": [0, 10, 12, 15], "return": [0, 3, 10, 12, 13, 14, 18, 19, 20, 22, 23], "path": [0, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23], "password": [0, 15], "none": [0, 3, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 20], "content": [0, 22], "option": [0, 3, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 20, 22], "determin": 0, "base": [0, 7, 8, 16, 24], "rais": [0, 10, 13], "valueerror": 0, "ani": [0, 5, 19], "get": [0, 10, 12, 14, 20], "meta": [1, 24, 27], "__title__": [1, 27], "__version__": [1, 27], "__description__": [1, 27], "__author__": [1, 27], "__author_email__": 1, "inform": [2, 3, 5, 12], "packag": 2, "titl": 2, "thi": [2, 3, 6, 9, 13, 19, 20, 22, 25, 26], "project": 2, "should": [2, 20, 27], "version": [2, 5, 22, 27], "short": 2, "descript": [2, 20], "includ": [2, 3, 12], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 10, 12], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 10, 12, 13, 14, 15, 20, 25, 26, 27], "object": [3, 8, 14, 15, 17, 20], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 23], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 20, 22], "keyword": [3, 20, 22], "argument": [3, 20, 22], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 12, 13, 25, 26, 27], "two": 3, "2": [3, 8, 27], "class": [3, 6, 8, 9, 10], "messag": [3, 6, 9, 12, 17], "except": [3, 6, 9, 10], "displai": [3, 6, 9, 20, 22], "yellow": 3, "color": 3, "error": [3, 6, 9], "exit_cod": [3, 6, 9], "exit": [3, 6, 9], "show": [3, 6, 9], "io": [3, 6, 9, 27], "write": [3, 6, 9], "output": [3, 6, 9, 15, 17, 20, 22, 27], "red": [3, 6, 9], "err": 3, "baseexcept": 3, "print": [3, 5, 25, 26, 27], "traceback": 3, "provid": [3, 20], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 27], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 24], "current": [5, 25, 26, 27], "metadata": 5, "arg": [5, 22], "indic": [6, 9], "remot": [6, 9], "repositori": [6, 9, 10, 12, 13, 14, 15, 17, 18], "assign": [6, 9, 14, 15, 17], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 24], "print_vers": 7, "download": [7, 10, 16, 21, 24], "noremotepathassignedwithdownload": 7, "l": [7, 24], "listitemtyp": 7, "listitem": 7, "upload": [7, 12, 16, 24], "noremotepathassignedwithupload": 7, "enum": 8, "repres": 8, "differ": [8, 25, 26], "item": [8, 13], "valid": [8, 11, 16, 24], "ar": 8, "folder": 8, "imag": 8, "3": [8, 25, 26, 27], "archiv": [8, 10, 12, 13, 15, 17, 24], "4": [8, 25, 26], "model": [8, 10, 12, 13, 14, 15, 17, 18], "5": [8, 15, 25, 26], "data": [8, 25, 26], "6": [8, 25, 26], "repofold": 8, "repofil": [8, 13], "base_dir": 8, "union": [8, 10], "33": 9, "standalon": 10, "incomplet": 10, "hash": [10, 12, 13, 14, 15, 17], "match": [10, 13, 18], "repo_id": [10, 12, 13, 14, 15, 17, 18], "archive_in_repo": [10, 12, 13, 17], "repo_typ": [10, 12, 13, 14, 15, 17, 18], "liter": [10, 12, 13, 14, 15, 17, 18], "dataset": [10, 12, 13, 14, 15, 17, 18], "space": [10, 12, 13, 14, 15, 17, 18], "revis": [10, 12, 13, 14, 15, 17, 18], "main": [10, 12, 13, 14, 15, 17, 18, 27], "idx_repo_id": [10, 12, 13], "idx_file_in_repo": [10, 12, 13], "idx_repo_typ": [10, 12, 13], "idx_revis": [10, 12, 13], "hf_token": [10, 12, 13, 14, 15, 17, 18], "insid": 10, "hug": [10, 12, 13, 14, 15, 17, 18], "face": [10, 12, 13, 14, 15, 17, 18], "identifi": [10, 12, 14, 15, 17, 18], "repotypetyp": [10, 12, 13, 14, 15, 17, 18], "access": [10, 12], "token": [10, 12, 13, 14, 15, 17, 18], "file_in_arch": 10, "local_fil": [10, 15, 17, 18], "proxi": 10, "user_ag": 10, "header": 10, "endpoint": 10, "save": [10, 12, 15, 20], "local": [10, 12, 15, 17, 18, 20, 25, 26], "http": [10, 27], "request": [10, 20], "user": 10, "agent": 10, "addit": [10, 20, 22], "api": [10, 14, 15, 17, 18], "check": [10, 13, 18, 19, 20, 27], "otherwis": [10, 13, 18, 20], "fetch": [11, 24], "archivestandalonefileincompletedownload": 11, "archivestandalonefilehashnotmatch": 11, "hf_tar_list_fil": 11, "hf_tar_file_download": 11, "hf_tar_get_index": 11, "hf_tar_file_exist": 11, "make": [11, 24], "tar_create_index": 11, "hf_tar_create_index": 11, "tar_get_index_info": 11, "hf_tar_create_from_directori": 11, "hf_tar_item_valid": 11, "hf_tar_valid": 11, "src_tar_fil": 12, "dst_index_fil": 12, "chunk_for_hash": 12, "int": [12, 13, 15, 20], "1048576": 12, "with_hash": 12, "default": [12, 13, 15, 18], "chunk": 12, "size": [12, 13, 20, 25, 26], "20": 12, "mb": 12, "whether": 12, "progress": [12, 15, 17, 20, 22], "bar": [12, 15, 17, 20, 22], "log": 12, "skip_when_sync": 12, "skip": 12, "sync": 12, "readi": [12, 18], "local_directori": [12, 15, 17], "file_item": 13, "hash_": 13, "hash_lf": 13, "expect": [13, 20], "sha": 13, "256": 13, "store": 13, "lf": 13, "id": 13, "where": [13, 20], "authent": 13, "entrynotfounderror": 13, "entri": [13, 24], "found": 13, "isadirectoryerror": 13, "hfapi": 14, "client": [14, 15, 17], "huggingfac": [14, 15, 17, 24, 27], "variabl": [14, 15, 17], "hffilesystem": 14, "system": 14, "subdir": 14, "ignore_pattern": [14, 15, 17], "given": [14, 19, 20], "subdirectori": 14, "e": [14, 15, 17], "g": [14, 15, 17], "branch": [14, 15, 17], "tag": [14, 15, 17], "commit": [14, 15, 17], "pattern": [14, 15, 17], "ignor": [14, 15, 17], "file_in_repo": [15, 17, 18], "resume_download": 15, "within": [15, 17], "resum": 15, "dir_in_repo": 15, "max_work": 15, "8": [15, 25, 26, 27], "max_retri": 15, "all": [15, 23], "max": 15, "worker": 15, "retri": 15, "time": 15, "get_hf_client": 16, "get_hf_f": 16, "list_files_in_repositori": 16, "download_file_to_fil": 16, "download_archive_as_directori": 16, "download_directory_as_directori": 16, "upload_file_to_fil": 16, "upload_directory_as_arch": 16, "upload_directory_as_directori": 16, "is_local_file_readi": 16, "path_in_repo": 17, "time_suffix": 17, "its": 17, "append": 17, "timestamp": 17, "present": 17, "compar": 18, "hub": 18, "read": 19, "first": 19, "1024": [19, 25, 26], "byte": [19, 20], "contain": 19, "non": 19, "text": 19, "charact": 19, "url": 20, "expected_s": 20, "desc": 20, "session": 20, "tqdm": [20, 21, 24], "It": [20, 27], "also": [20, 27], "perform": [20, 25, 26], "ensur": 20, "ha": [20, 25, 26], "pass": [20, 22], "binari": [21, 24], "is_binary_fil": 21, "download_fil": 21, "walk": [21, 24], "walk_fil": 21, "tqdm_": 22, "enhanc": 22, "silenc": 22, "modifi": 22, "behavior": 22, "allow": 22, "posit": 22, "std": 22, "recurs": 23, "through": [23, 27], "yield": 23, "rel": 23, "root": 23, "start": [23, 24], "modul": 24, "quick": 24, "run": 24, "environ": 24, "register_archive_typ": 24, "archive_pack": 24, "archive_unpack": 24, "get_archive_typ": 24, "get_archive_extnam": 24, "config": [24, 27], "index": [24, 27], "oper": 24, "here": [25, 26], "import": [25, 26, 27], "o": [25, 26], "platform": [25, 26], "shutil": [25, 26], "cpuinfo": [25, 26], "psutil": [25, 26], "hbutil": [25, 26], "scale": [25, 26], "size_to_bytes_str": [25, 26], "python": [25, 26, 27], "python_implement": [25, 26], "python_vers": [25, 26], "cpu": [25, 26], "brand": [25, 26], "get_cpu_info": [25, 26], "brand_raw": [25, 26], "count": [25, 26], "cpu_count": [25, 26], "freq": [25, 26], "cpu_freq": [25, 26], "mhz": [25, 26], "memori": [25, 26], "virtual_memori": [25, 26], "total": [25, 26], "precis": [25, 26], "cuda": [25, 26], "ye": [25, 26], "nvidia": [25, 26], "smi": [25, 26], "els": [25, 26], "No": [25, 26], "linux": [25, 26], "0": [25, 26, 27], "azur": [25, 26], "x86_64": [25, 26], "glibc2": [25, 26], "34": [25, 26], "cpython": [25, 26], "18": [25, 26], "amd": [25, 26], "epyc": [25, 26], "7763": [25, 26], "64": [25, 26], "core": [25, 26], "processor": [25, 26], "2925": 25, "518": 25, "15": [25, 26], "606": [25, 26], "gib": [25, 26], "pleas": [25, 26], "note": [25, 26], "deploi": [25, 26], "document": [25, 26, 27], "automat": [25, 26], "execut": [25, 26], "github": [25, 26, 27], "action": [25, 26], "therefor": [25, 26], "some": [25, 26], "mai": [25, 26], "your": [25, 26, 27], "3045": 26, "374": 26, "hfutil": 27, "host": 27, "pypi": 27, "can": 27, "newest": 27, "u": 27, "git": 27, "com": 27, "deepgh": 27, "script": 27, "__name__": 27, "__main__": 27, "develop": 27, "maintain": 27, "like": 27, "below": 27, "mean": 27, "success": 27, "narugo1992": 27, "still": 27, "under": 27, "out": 27, "stabl": 27, "html": 27, "faq": 28}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "index"], [16, 0, 0, "-", "operate"], [21, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.upload": [[9, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.index": [[10, 0, 0, "-", "fetch"], [12, 0, 0, "-", "make"], [13, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[10, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [10, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [10, 1, 1, "", "hf_tar_file_download"], [10, 1, 1, "", "hf_tar_file_exists"], [10, 1, 1, "", "hf_tar_get_index"], [10, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[12, 1, 1, "", "hf_tar_create_from_directory"], [12, 1, 1, "", "hf_tar_create_index"], [12, 1, 1, "", "tar_create_index"], [12, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[13, 1, 1, "", "hf_tar_item_validate"], [13, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[14, 0, 0, "-", "base"], [15, 0, 0, "-", "download"], [17, 0, 0, "-", "upload"], [18, 0, 0, "-", "validate"]], "hfutils.operate.base": [[14, 1, 1, "", "get_hf_client"], [14, 1, 1, "", "get_hf_fs"], [14, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[15, 1, 1, "", "download_archive_as_directory"], [15, 1, 1, "", "download_directory_as_directory"], [15, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[17, 1, 1, "", "upload_directory_as_archive"], [17, 1, 1, "", "upload_directory_as_directory"], [17, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[18, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[19, 0, 0, "-", "binary"], [20, 0, 0, "-", "download"], [22, 0, 0, "-", "tqdm_"], [23, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[19, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[20, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[22, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[23, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9], "base": [3, 14], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 15, 20], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "upload": [9, 17], "noremotepathassignedwithupload": 9, "index": [10, 11, 12, 13], "fetch": 10, "archivestandalonefileincompletedownload": 10, "archivestandalonefilehashnotmatch": 10, "hf_tar_list_fil": 10, "hf_tar_file_download": 10, "hf_tar_get_index": 10, "hf_tar_file_exist": 10, "make": 12, "tar_create_index": 12, "hf_tar_create_index": 12, "tar_get_index_info": 12, "hf_tar_create_from_directori": 12, "valid": [13, 18], "hf_tar_item_valid": 13, "hf_tar_valid": 13, "oper": [14, 15, 16, 17, 18], "get_hf_client": 14, "get_hf_f": 14, "list_files_in_repositori": 14, "download_file_to_fil": 15, "download_archive_as_directori": 15, "download_directory_as_directori": 15, "upload_file_to_fil": 17, "upload_directory_as_arch": 17, "upload_directory_as_directori": 17, "is_local_file_readi": 18, "util": [19, 20, 21, 22, 23], "binari": 19, "is_binary_fil": 19, "download_fil": 20, "tqdm": 22, "walk": 23, "walk_fil": 23, "welcom": 24, "": 24, "document": 24, "overview": 24, "tutori": 24, "inform": [24, 25, 26], "api": 24, "run": [25, 26], "environ": [25, 26], "instal": 27, "quick": 28, "start": 28}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[9, "noremotepathassignedwithupload"]], "hfutils.index.fetch": [[10, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[10, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[10, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[10, "hf-tar-list-files"]], "hf_tar_file_download": [[10, "hf-tar-file-download"]], "hf_tar_get_index": [[10, "hf-tar-get-index"]], "hf_tar_file_exists": [[10, "hf-tar-file-exists"]], "hfutils.index": [[11, "module-hfutils.index"]], "hfutils.index.make": [[12, "module-hfutils.index.make"]], "tar_create_index": [[12, "tar-create-index"]], "hf_tar_create_index": [[12, "hf-tar-create-index"]], "tar_get_index_info": [[12, "tar-get-index-info"]], "hf_tar_create_from_directory": [[12, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[13, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[13, "hf-tar-item-validate"]], "hf_tar_validate": [[13, "hf-tar-validate"]], "hfutils.operate.base": [[14, "module-hfutils.operate.base"]], "get_hf_client": [[14, "get-hf-client"]], "get_hf_fs": [[14, "get-hf-fs"]], "list_files_in_repository": [[14, "list-files-in-repository"]], "hfutils.operate.download": [[15, "module-hfutils.operate.download"]], "download_file_to_file": [[15, "download-file-to-file"]], "download_archive_as_directory": [[15, "download-archive-as-directory"]], "download_directory_as_directory": [[15, "download-directory-as-directory"]], "hfutils.operate": [[16, "module-hfutils.operate"]], "hfutils.operate.upload": [[17, "module-hfutils.operate.upload"]], "upload_file_to_file": [[17, "upload-file-to-file"]], "upload_directory_as_archive": [[17, "upload-directory-as-archive"]], "upload_directory_as_directory": [[17, "upload-directory-as-directory"]], "hfutils.operate.validate": [[18, "module-hfutils.operate.validate"]], "is_local_file_ready": [[18, "is-local-file-ready"]], "hfutils.utils.binary": [[19, "module-hfutils.utils.binary"]], "is_binary_file": [[19, "is-binary-file"]], "hfutils.utils.download": [[20, "module-hfutils.utils.download"]], "download_file": [[20, "download-file"]], "hfutils.utils": [[21, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[22, "module-hfutils.utils.tqdm_"]], "tqdm": [[22, "tqdm"]], "hfutils.utils.walk": [[23, "module-hfutils.utils.walk"]], "walk_files": [[23, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[24, "welcome-to-hfutils-s-documentation"]], "Overview": [[24, "overview"]], "Tutorials": [[24, null]], "Information": [[24, null]], "API Documentation": [[24, null]], "Run Environment Information": [[25, "Run-Environment-Information"], [26, "Run-Environment-Information"]], "Installation": [[27, "installation"]], "Quick Start": [[28, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.upload"], [10, "module-hfutils.index.fetch"], [11, "module-hfutils.index"], [12, "module-hfutils.index.make"], [13, "module-hfutils.index.validate"], [14, "module-hfutils.operate.base"], [15, "module-hfutils.operate.download"], [16, "module-hfutils.operate"], [17, "module-hfutils.operate.upload"], [18, "module-hfutils.operate.validate"], [19, "module-hfutils.utils.binary"], [20, "module-hfutils.utils.download"], [21, "module-hfutils.utils"], [22, "module-hfutils.utils.tqdm_"], [23, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[10, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[10, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[10, "module-hfutils.index.fetch"]], "hfutils.index": [[11, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[12, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[12, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[12, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[12, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[12, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[13, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[13, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[13, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[14, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[14, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[14, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[14, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[15, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[15, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[15, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[15, "module-hfutils.operate.download"]], "hfutils.operate": [[16, "module-hfutils.operate"]], "hfutils.operate.upload": [[17, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[17, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[17, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[17, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[18, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[18, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[19, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[19, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[20, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[20, "module-hfutils.utils.download"]], "hfutils.utils": [[21, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[22, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[22, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[23, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[23, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.2.10/.buildinfo b/v0.2.10/.buildinfo
index 6e24485b19..66599feee9 100644
--- a/v0.2.10/.buildinfo
+++ b/v0.2.10/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: edd02bf7d7dd14c49e4c53a1cf4c6b66
+config: 32d919eb09c36ea9f92d74a2c1e085b9
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.2.10/.doctrees/api_doc/archive/index.doctree b/v0.2.10/.doctrees/api_doc/archive/index.doctree
index 00cf81807c..0ca971c0d8 100644
Binary files a/v0.2.10/.doctrees/api_doc/archive/index.doctree and b/v0.2.10/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/cache/delete.doctree b/v0.2.10/.doctrees/api_doc/cache/delete.doctree
index a25058d715..331678454f 100644
Binary files a/v0.2.10/.doctrees/api_doc/cache/delete.doctree and b/v0.2.10/.doctrees/api_doc/cache/delete.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/cache/index.doctree b/v0.2.10/.doctrees/api_doc/cache/index.doctree
index 63c8be7004..965ec04501 100644
Binary files a/v0.2.10/.doctrees/api_doc/cache/index.doctree and b/v0.2.10/.doctrees/api_doc/cache/index.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/config/index.doctree b/v0.2.10/.doctrees/api_doc/config/index.doctree
index bd5f3156b7..b292b6b76d 100644
Binary files a/v0.2.10/.doctrees/api_doc/config/index.doctree and b/v0.2.10/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/config/meta.doctree b/v0.2.10/.doctrees/api_doc/config/meta.doctree
index f4062c7d43..2388be775a 100644
Binary files a/v0.2.10/.doctrees/api_doc/config/meta.doctree and b/v0.2.10/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/entry/base.doctree b/v0.2.10/.doctrees/api_doc/entry/base.doctree
index f8347c3fb9..5440ad6f78 100644
Binary files a/v0.2.10/.doctrees/api_doc/entry/base.doctree and b/v0.2.10/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/entry/cli.doctree b/v0.2.10/.doctrees/api_doc/entry/cli.doctree
index eb1cd59170..e58917369f 100644
Binary files a/v0.2.10/.doctrees/api_doc/entry/cli.doctree and b/v0.2.10/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/entry/dispatch.doctree b/v0.2.10/.doctrees/api_doc/entry/dispatch.doctree
index 476b25404a..c0e3cbce15 100644
Binary files a/v0.2.10/.doctrees/api_doc/entry/dispatch.doctree and b/v0.2.10/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/entry/download.doctree b/v0.2.10/.doctrees/api_doc/entry/download.doctree
index 084307b883..deae9072f3 100644
Binary files a/v0.2.10/.doctrees/api_doc/entry/download.doctree and b/v0.2.10/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/entry/index.doctree b/v0.2.10/.doctrees/api_doc/entry/index.doctree
index c77c600149..5ecaab8e3b 100644
Binary files a/v0.2.10/.doctrees/api_doc/entry/index.doctree and b/v0.2.10/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/entry/ls.doctree b/v0.2.10/.doctrees/api_doc/entry/ls.doctree
index ce08ff3b85..eee857e6fa 100644
Binary files a/v0.2.10/.doctrees/api_doc/entry/ls.doctree and b/v0.2.10/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/entry/ls_repo.doctree b/v0.2.10/.doctrees/api_doc/entry/ls_repo.doctree
index d8bbaa6f1d..7ca249ad69 100644
Binary files a/v0.2.10/.doctrees/api_doc/entry/ls_repo.doctree and b/v0.2.10/.doctrees/api_doc/entry/ls_repo.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/entry/upload.doctree b/v0.2.10/.doctrees/api_doc/entry/upload.doctree
index fe66e91068..67367dbd8b 100644
Binary files a/v0.2.10/.doctrees/api_doc/entry/upload.doctree and b/v0.2.10/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/entry/whoami.doctree b/v0.2.10/.doctrees/api_doc/entry/whoami.doctree
index 7ba8749c85..b4dfd0ecf5 100644
Binary files a/v0.2.10/.doctrees/api_doc/entry/whoami.doctree and b/v0.2.10/.doctrees/api_doc/entry/whoami.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/index/fetch.doctree b/v0.2.10/.doctrees/api_doc/index/fetch.doctree
index 011da12769..49cafbcf2b 100644
Binary files a/v0.2.10/.doctrees/api_doc/index/fetch.doctree and b/v0.2.10/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/index/index.doctree b/v0.2.10/.doctrees/api_doc/index/index.doctree
index 6c6c8f4835..7c2c72ddc8 100644
Binary files a/v0.2.10/.doctrees/api_doc/index/index.doctree and b/v0.2.10/.doctrees/api_doc/index/index.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/index/make.doctree b/v0.2.10/.doctrees/api_doc/index/make.doctree
index aed9f78d0a..db093ff00d 100644
Binary files a/v0.2.10/.doctrees/api_doc/index/make.doctree and b/v0.2.10/.doctrees/api_doc/index/make.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/index/validate.doctree b/v0.2.10/.doctrees/api_doc/index/validate.doctree
index a1539f01a0..843488861f 100644
Binary files a/v0.2.10/.doctrees/api_doc/index/validate.doctree and b/v0.2.10/.doctrees/api_doc/index/validate.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/operate/base.doctree b/v0.2.10/.doctrees/api_doc/operate/base.doctree
index d2be386bb7..bcee29dbb8 100644
Binary files a/v0.2.10/.doctrees/api_doc/operate/base.doctree and b/v0.2.10/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/operate/download.doctree b/v0.2.10/.doctrees/api_doc/operate/download.doctree
index dfe46372bd..dbeebfc397 100644
Binary files a/v0.2.10/.doctrees/api_doc/operate/download.doctree and b/v0.2.10/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/operate/index.doctree b/v0.2.10/.doctrees/api_doc/operate/index.doctree
index 1df94e98da..2b2093b4d4 100644
Binary files a/v0.2.10/.doctrees/api_doc/operate/index.doctree and b/v0.2.10/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/operate/upload.doctree b/v0.2.10/.doctrees/api_doc/operate/upload.doctree
index a0b2b4f2b6..cf857ac092 100644
Binary files a/v0.2.10/.doctrees/api_doc/operate/upload.doctree and b/v0.2.10/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/operate/validate.doctree b/v0.2.10/.doctrees/api_doc/operate/validate.doctree
index 3da048c062..a1e6071132 100644
Binary files a/v0.2.10/.doctrees/api_doc/operate/validate.doctree and b/v0.2.10/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/utils/binary.doctree b/v0.2.10/.doctrees/api_doc/utils/binary.doctree
index 6c2a051d1e..1ded411dc1 100644
Binary files a/v0.2.10/.doctrees/api_doc/utils/binary.doctree and b/v0.2.10/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/utils/download.doctree b/v0.2.10/.doctrees/api_doc/utils/download.doctree
index 15594c0544..97858ed49b 100644
Binary files a/v0.2.10/.doctrees/api_doc/utils/download.doctree and b/v0.2.10/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/utils/index.doctree b/v0.2.10/.doctrees/api_doc/utils/index.doctree
index aa141f50d2..e674a566a9 100644
Binary files a/v0.2.10/.doctrees/api_doc/utils/index.doctree and b/v0.2.10/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/utils/path.doctree b/v0.2.10/.doctrees/api_doc/utils/path.doctree
index 1a173d7c1a..3609d575bc 100644
Binary files a/v0.2.10/.doctrees/api_doc/utils/path.doctree and b/v0.2.10/.doctrees/api_doc/utils/path.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/utils/tqdm_.doctree b/v0.2.10/.doctrees/api_doc/utils/tqdm_.doctree
index 171470ce51..2a034e367c 100644
Binary files a/v0.2.10/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.2.10/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.2.10/.doctrees/api_doc/utils/walk.doctree b/v0.2.10/.doctrees/api_doc/utils/walk.doctree
index d41d0aea8a..49f46c7371 100644
Binary files a/v0.2.10/.doctrees/api_doc/utils/walk.doctree and b/v0.2.10/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.2.10/.doctrees/environment.pickle b/v0.2.10/.doctrees/environment.pickle
index f3feecbe0e..acdb12ae06 100644
Binary files a/v0.2.10/.doctrees/environment.pickle and b/v0.2.10/.doctrees/environment.pickle differ
diff --git a/v0.2.10/.doctrees/index.doctree b/v0.2.10/.doctrees/index.doctree
index 675cc84cde..4419a39f4b 100644
Binary files a/v0.2.10/.doctrees/index.doctree and b/v0.2.10/.doctrees/index.doctree differ
diff --git a/v0.2.10/.doctrees/information/environment.doctree b/v0.2.10/.doctrees/information/environment.doctree
index 53e4437982..c76045de94 100644
Binary files a/v0.2.10/.doctrees/information/environment.doctree and b/v0.2.10/.doctrees/information/environment.doctree differ
diff --git a/v0.2.10/.doctrees/information/environment.result.doctree b/v0.2.10/.doctrees/information/environment.result.doctree
index 03fd0cbb06..e96ef4be64 100644
Binary files a/v0.2.10/.doctrees/information/environment.result.doctree and b/v0.2.10/.doctrees/information/environment.result.doctree differ
diff --git a/v0.2.10/.doctrees/nbsphinx/information/environment.ipynb b/v0.2.10/.doctrees/nbsphinx/information/environment.ipynb
index e402676023..c245f457f5 100644
--- a/v0.2.10/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.2.10/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:49:53.811848Z",
-     "iopub.status.busy": "2024-07-23T17:49:53.811642Z",
-     "iopub.status.idle": "2024-07-23T17:49:54.979643Z",
-     "shell.execute_reply": "2024-07-23T17:49:54.978913Z"
+     "iopub.execute_input": "2024-07-23T17:56:26.372636Z",
+     "iopub.status.busy": "2024-07-23T17:56:26.372423Z",
+     "iopub.status.idle": "2024-07-23T17:56:27.543337Z",
+     "shell.execute_reply": "2024-07-23T17:56:27.542572Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2918.364 MHz\n",
+      "CPU Freq: 2930.58075 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.10/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.2.10/.doctrees/nbsphinx/information/environment.result.ipynb
index 0e64f28050..ef5c007c60 100644
--- a/v0.2.10/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.2.10/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:07:33.442438Z",
-     "iopub.status.busy": "2024-07-23T17:07:33.441912Z",
-     "iopub.status.idle": "2024-07-23T17:07:34.613499Z",
-     "shell.execute_reply": "2024-07-23T17:07:34.612723Z"
+     "iopub.execute_input": "2024-07-23T17:13:15.226569Z",
+     "iopub.status.busy": "2024-07-23T17:13:15.226334Z",
+     "iopub.status.idle": "2024-07-23T17:13:16.403912Z",
+     "shell.execute_reply": "2024-07-23T17:13:16.403108Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2740.08075 MHz\n",
+      "CPU Freq: 2922.5455 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.10/.doctrees/tutorials/installation/index.doctree b/v0.2.10/.doctrees/tutorials/installation/index.doctree
index 5dad169cab..c17c3f82ba 100644
Binary files a/v0.2.10/.doctrees/tutorials/installation/index.doctree and b/v0.2.10/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.2.10/.doctrees/tutorials/quick_start/index.doctree b/v0.2.10/.doctrees/tutorials/quick_start/index.doctree
index b52a2d1b94..34d1c7718a 100644
Binary files a/v0.2.10/.doctrees/tutorials/quick_start/index.doctree and b/v0.2.10/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.2.10/_sources/information/environment.result.ipynb.txt b/v0.2.10/_sources/information/environment.result.ipynb.txt
index 0e64f28050..ef5c007c60 100644
--- a/v0.2.10/_sources/information/environment.result.ipynb.txt
+++ b/v0.2.10/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:07:33.442438Z",
-     "iopub.status.busy": "2024-07-23T17:07:33.441912Z",
-     "iopub.status.idle": "2024-07-23T17:07:34.613499Z",
-     "shell.execute_reply": "2024-07-23T17:07:34.612723Z"
+     "iopub.execute_input": "2024-07-23T17:13:15.226569Z",
+     "iopub.status.busy": "2024-07-23T17:13:15.226334Z",
+     "iopub.status.idle": "2024-07-23T17:13:16.403912Z",
+     "shell.execute_reply": "2024-07-23T17:13:16.403108Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2740.08075 MHz\n",
+      "CPU Freq: 2922.5455 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.10/information/environment.html b/v0.2.10/information/environment.html
index 0578e4a2a4..4d477b673b 100644
--- a/v0.2.10/information/environment.html
+++ b/v0.2.10/information/environment.html
@@ -127,11 +127,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2918.364 MHz
+CPU Freq: 2930.58075 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.10/information/environment.ipynb b/v0.2.10/information/environment.ipynb
index e402676023..c245f457f5 100644
--- a/v0.2.10/information/environment.ipynb
+++ b/v0.2.10/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:49:53.811848Z",
-     "iopub.status.busy": "2024-07-23T17:49:53.811642Z",
-     "iopub.status.idle": "2024-07-23T17:49:54.979643Z",
-     "shell.execute_reply": "2024-07-23T17:49:54.978913Z"
+     "iopub.execute_input": "2024-07-23T17:56:26.372636Z",
+     "iopub.status.busy": "2024-07-23T17:56:26.372423Z",
+     "iopub.status.idle": "2024-07-23T17:56:27.543337Z",
+     "shell.execute_reply": "2024-07-23T17:56:27.542572Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2918.364 MHz\n",
+      "CPU Freq: 2930.58075 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.10/information/environment.result.html b/v0.2.10/information/environment.result.html
index 1793e1cb4b..c965db07fe 100644
--- a/v0.2.10/information/environment.result.html
+++ b/v0.2.10/information/environment.result.html
@@ -129,11 +129,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2740.08075 MHz
+CPU Freq: 2922.5455 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.10/information/environment.result.ipynb b/v0.2.10/information/environment.result.ipynb
index 0e64f28050..ef5c007c60 100644
--- a/v0.2.10/information/environment.result.ipynb
+++ b/v0.2.10/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:07:33.442438Z",
-     "iopub.status.busy": "2024-07-23T17:07:33.441912Z",
-     "iopub.status.idle": "2024-07-23T17:07:34.613499Z",
-     "shell.execute_reply": "2024-07-23T17:07:34.612723Z"
+     "iopub.execute_input": "2024-07-23T17:13:15.226569Z",
+     "iopub.status.busy": "2024-07-23T17:13:15.226334Z",
+     "iopub.status.idle": "2024-07-23T17:13:16.403912Z",
+     "shell.execute_reply": "2024-07-23T17:13:16.403108Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2740.08075 MHz\n",
+      "CPU Freq: 2922.5455 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.10/searchindex.js b/v0.2.10/searchindex.js
index dbd6c54f78..bb1cc11a45 100644
--- a/v0.2.10/searchindex.js
+++ b/v0.2.10/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/cache/delete", "api_doc/cache/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/cache/delete.rst", "api_doc/cache/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.cache.delete", "hfutils.cache", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2, 4], "pack": 0, "unpack": 0, "manag": [0, 2], "support": 0, "format": 0, "extens": 0, "name": [0, 5], "7z": 0, "bztar": 0, "tar": [0, 14, 16, 17], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 1, 5, 17, 19, 21, 24, 26, 27], "you": [0, 14, 32], "requir": [0, 32], "simpli": [0, 32], "instal": [0, 29], "us": [0, 1, 5, 14, 16, 17, 18, 19, 21, 24, 29, 32], "follow": [0, 10, 32], "code": [0, 5, 8, 12], "pip": [0, 32], "The": [0, 1, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28, 32], "creation": 0, "file": [0, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 28], "i": [0, 1, 8, 11, 12, 14, 16, 17, 19, 22, 23, 26, 29, 30, 31, 32], "we": 0, "util": [0, 29, 32], "rarfil": 0, "librari": [0, 24], "which": [0, 14, 30, 31, 32], "doe": [0, 14], "offer": 0, "function": [0, 5, 14, 16, 17, 23, 24, 27], "creat": [0, 16], "str": [0, 1, 5, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28], "ext": 0, "list": [0, 5, 10, 14, 18, 19, 21], "fn_pack": 0, "callabl": [0, 5], "fn_unpack": 0, "sourc": [0, 1, 5, 7, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "regist": 0, "custom": [0, 5, 8, 12], "type": [0, 1, 5, 10, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "associ": 0, "paramet": [0, 1, 5, 7, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "A": [0, 18], "take": 0, "directori": [0, 1, 10, 16, 17, 19, 21, 28], "an": [0, 14, 16, 17, 19, 21, 24, 27, 28], "filenam": [0, 24, 26], "input": 0, "extract": [0, 19], "type_nam": 0, "archive_fil": 0, "silent": [0, 16, 19, 21, 24, 27], "bool": [0, 7, 14, 16, 17, 19, 21, 22, 23, 24, 27], "fals": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "clear": [0, 21], "specifi": [0, 1, 17, 21, 24], "result": 0, "true": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "suppress": [0, 16, 19, 21, 24], "warn": [0, 5], "dure": 0, "process": 0, "remov": [0, 21], "exist": [0, 14, 19], "when": [0, 11, 14, 16, 19], "return": [0, 5, 14, 16, 17, 18, 22, 23, 24, 26, 27, 28], "path": [0, 8, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 25, 28, 29], "password": [0, 19], "none": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26], "content": [0, 27], "option": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26, 27], "determin": 0, "base": [0, 9, 10, 17, 20, 29], "rais": [0, 11, 14, 17, 26], "valueerror": [0, 26], "ani": [0, 1, 7, 23, 26], "get": [0, 14, 16, 18, 24, 26], "repo_id": [1, 14, 16, 17, 18, 19, 21, 22, 26], "repo_typ": [1, 14, 16, 17, 18, 19, 21, 22, 26], "cache_dir": 1, "all": [1, 14, 19, 28], "detach": 1, "revis": [1, 14, 16, 17, 18, 19, 21, 22, 26], "from": [1, 5, 14, 16, 17, 18, 19, 24, 30, 31, 32], "match": [1, 14, 17, 22], "repositori": [1, 8, 12, 14, 16, 17, 18, 19, 21, 22, 26], "id": [1, 17, 26], "where": [1, 17, 24], "store": [1, 17], "default": [1, 16, 17, 19, 22, 26], "huggingfac": [2, 17, 18, 19, 21, 26, 29, 32], "local": [2, 11, 14, 16, 19, 21, 22, 24, 30, 31], "can": [2, 14, 17, 32], "quickli": 2, "make": [2, 15, 17, 29], "disk": 2, "space": [2, 14, 16, 17, 18, 19, 21, 22, 26], "under": [2, 32], "control": 2, "delet": [2, 29], "delete_detached_cach": 2, "delete_cach": 2, "meta": [3, 14, 29, 32], "__title__": [3, 32], "__version__": [3, 32], "__description__": [3, 32], "__author__": [3, 32], "__author_email__": 3, "inform": [4, 5, 7, 14, 16, 17], "packag": 4, "titl": 4, "thi": [4, 5, 8, 12, 14, 16, 17, 23, 24, 26, 27, 30, 31], "project": 4, "should": [4, 24, 32], "version": [4, 7, 27, 32], "short": 4, "descript": [4, 24], "includ": [4, 5, 14, 16], "setup": 4, "py": 4, "author": 4, "email": 4, "help_option_nam": 5, "h": 5, "help": 5, "dict": [5, 14, 16], "new": 5, "empti": 5, "dictionari": [5, 14], "map": 5, "initi": 5, "object": [5, 10, 14, 18, 19, 21, 24], "": [5, 7, 14], "kei": [5, 14], "valu": [5, 7, 10, 16], "pair": 5, "iter": [5, 28], "via": 5, "d": 5, "k": 5, "v": 5, "kwarg": [5, 7, 24, 27], "keyword": [5, 24, 27], "argument": [5, 14, 24, 27], "For": 5, "exampl": [5, 14], "one": 5, "1": [5, 10, 16, 17, 30, 31], "two": 5, "2": [5, 10, 32], "class": [5, 8, 10, 11, 12, 14, 26], "messag": [5, 8, 11, 12, 16, 21], "except": [5, 8, 11, 12, 14], "displai": [5, 8, 12, 24, 27], "yellow": 5, "color": 5, "error": [5, 8, 12], "exit_cod": [5, 8, 12], "exit": [5, 8, 12], "show": [5, 8, 12], "io": [5, 8, 12, 32], "write": [5, 8, 12], "output": [5, 8, 12, 19, 21, 24, 27, 32], "red": [5, 8, 12], "err": 5, "baseexcept": 5, "print": [5, 7, 30, 31, 32], "traceback": 5, "provid": [5, 24], "built": 5, "msg": 5, "handl": 5, "keyboard": 5, "interrupt": 5, "__init__": 5, "7": 5, "decor": 5, "wrap": 5, "click": [5, 7], "command": [5, 32], "catch": 5, "consist": 5, "group": 6, "hfutilcli": [6, 9], "ctx": 7, "context": 7, "param": 7, "cli": [7, 9, 29], "current": [7, 30, 31, 32], "metadata": 7, "arg": [7, 27], "indic": [8, 12], "remot": [8, 12], "assign": [8, 12, 14, 18, 19, 21], "17": 8, "context_set": 9, "clickwarningexcept": 9, "clickerrorexcept": 9, "print_except": 9, "keyboardinterrupt": 9, "command_wrap": 9, "dispatch": [9, 29], "print_vers": 9, "download": [9, 14, 17, 20, 25, 29], "noremotepathassignedwithdownload": 9, "l": [9, 29], "listitemtyp": 9, "listitem": 9, "ls_repo": [9, 29], "nolocalauthent": 9, "upload": [9, 16, 20, 29], "noremotepathassignedwithupload": 9, "whoami": [9, 29], "enum": 10, "repres": [10, 14], "differ": [10, 14, 30, 31], "item": [10, 17], "valid": [10, 15, 20, 29], "ar": [10, 14], "folder": 10, "imag": [10, 14], "3": [10, 30, 31, 32], "archiv": [10, 14, 16, 17, 19, 21, 29], "4": [10, 30, 31], "model": [10, 14, 16, 17, 18, 19, 21, 22, 26], "5": [10, 19, 30, 31], "data": [10, 14, 30, 31], "6": [10, 30, 31], "repofold": 10, "repofil": [10, 17], "base_dir": 10, "union": [10, 14], "authent": [11, 17], "token": [11, 14, 16, 17, 18, 19, 21, 22], "33": 12, "standalon": 14, "incomplet": 14, "hash": [14, 16, 17, 18, 19, 21], "archive_in_repo": [14, 16, 17, 21], "liter": [14, 16, 17, 18, 19, 21, 22, 26], "dataset": [14, 16, 17, 18, 19, 21, 22, 26], "main": [14, 16, 17, 18, 19, 21, 22, 32], "idx_repo_id": [14, 16, 17], "idx_file_in_repo": [14, 16, 17], "idx_repo_typ": [14, 16, 17], "idx_revis": [14, 16, 17], "hf_token": [14, 16, 17, 18, 19, 21, 22], "hug": [14, 16, 17, 18, 19, 21, 22], "face": [14, 16, 17, 18, 19, 21, 22], "identifi": [14, 16, 18, 19, 21, 22], "repotypetyp": [14, 16, 17, 18, 19, 21, 22, 26], "access": [14, 16], "import": [14, 30, 31, 32], "idx": 14, "deepgh": [14, 32], "danbooru_newest": 14, "0000": 14, "dict_kei": 14, "files": 14, "hash_lf": [14, 17], "7507000": 14, "jpg": 14, "7506000": 14, "7505000": 14, "besid": 14, "also": [14, 24, 32], "explicitli": 14, "nyanko7": 14, "danbooru2023": 14, "danbooru2023_index": 14, "origin": 14, "1000": 14, "png": 14, "10000": 14, "100000": 14, "insid": 14, "file_in_arch": 14, "check": [14, 17, 22, 23, 24, 32], "otherwis": [14, 17, 22, 24], "17506000": 14, "10000000001000": 14, "int": [14, 16, 17, 19, 24], "size": [14, 16, 17, 24, 30, 31], "integ": 14, "filenotfounderror": 14, "435671": 14, "11966": 14, "detail": 14, "offset": 14, "sha256": 14, "265728": 14, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 14, "1024": [14, 23], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 14, "local_fil": [14, 19, 21, 22], "proxi": 14, "user_ag": 14, "header": 14, "endpoint": 14, "save": [14, 16, 19, 24], "http": [14, 32], "request": [14, 24], "user": 14, "agent": 14, "addit": [14, 24, 27], "api": [14, 17, 18, 19, 21, 22], "test_exampl": 14, "destin": 14, "given": [14, 18, 23, 24, 26], "fetch": [15, 29], "archivestandalonefileincompletedownload": 15, "archivestandalonefilehashnotmatch": 15, "hf_tar_get_index": 15, "hf_tar_list_fil": 15, "hf_tar_file_exist": 15, "hf_tar_file_s": 15, "hf_tar_file_info": 15, "hf_tar_file_download": 15, "tar_create_index": 15, "hf_tar_create_index": [15, 17], "tar_get_index_info": 15, "hf_tar_create_from_directori": 15, "hf_tar_item_valid": 15, "hf_tar_valid": 15, "src_tar_fil": 16, "dst_index_fil": 16, "chunk_for_hash": 16, "1048576": 16, "with_hash": 16, "chunk": 16, "20": 16, "mb": 16, "whether": 16, "progress": [16, 19, 21, 24, 27], "bar": [16, 19, 21, 24, 27], "log": 16, "skip_when_sync": 16, "skip": 16, "sync": 16, "readi": [16, 22], "directli": 16, "json": [16, 17], "local_directori": [16, 19, 21], "file_item": 17, "hash_": 17, "expect": [17, 24], "sha": 17, "256": 17, "lf": 17, "entrynotfounderror": 17, "entri": [17, 29], "found": 17, "isadirectoryerror": 17, "mean": [17, 32], "expir": 17, "need": 17, "re": 17, "gener": 17, "so": 17, "togeth": 17, "gracefulli": 17, "refresh": 17, "hfapi": 18, "client": [18, 19, 21], "variabl": [18, 19, 21], "hffilesystem": 18, "system": 18, "subdir": 18, "ignore_pattern": [18, 19, 21], "subdirectori": 18, "e": [18, 19, 21], "g": [18, 19, 21], "branch": [18, 19, 21], "tag": [18, 19, 21], "commit": [18, 19, 21], "pattern": [18, 19, 21], "ignor": [18, 19, 21], "file_in_repo": [19, 21, 22], "resume_download": 19, "within": [19, 21], "resum": 19, "dir_in_repo": 19, "max_work": 19, "8": [19, 30, 31, 32], "max_retri": 19, "max": 19, "worker": 19, "retri": 19, "time": 19, "get_hf_client": 20, "get_hf_f": 20, "list_files_in_repositori": 20, "download_file_to_fil": 20, "download_archive_as_directori": 20, "download_directory_as_directori": 20, "upload_file_to_fil": 20, "upload_directory_as_arch": 20, "upload_directory_as_directori": 20, "is_local_file_readi": 20, "path_in_repo": 21, "time_suffix": 21, "its": 21, "append": 21, "timestamp": 21, "present": 21, "compar": 22, "hub": 22, "read": 23, "first": 23, "byte": [23, 24], "contain": 23, "non": 23, "text": 23, "charact": 23, "url": 24, "expected_s": 24, "desc": 24, "session": 24, "tqdm": [24, 25, 29], "It": [24, 32], "perform": [24, 30, 31], "ensur": 24, "ha": [24, 30, 31], "pass": [24, 27], "binari": [25, 29], "is_binary_fil": 25, "download_fil": 25, "hf_normpath": 25, "hf_fs_path": 25, "parse_hf_fs_path": 25, "hffilesystempath": 25, "walk": [25, 29], "walk_fil": 25, "normal": 26, "filesystem": 26, "pars": 26, "invalid": 26, "tqdm_": 27, "enhanc": 27, "silenc": 27, "modifi": 27, "behavior": 27, "allow": 27, "posit": 27, "std": 27, "recurs": 28, "through": [28, 32], "yield": 28, "rel": 28, "root": 28, "start": [28, 29], "modul": 29, "quick": 29, "run": 29, "environ": 29, "register_archive_typ": 29, "archive_pack": 29, "archive_unpack": 29, "get_archive_typ": 29, "get_archive_extnam": 29, "cach": 29, "config": [29, 32], "index": [29, 32], "oper": 29, "here": [30, 31], "o": [30, 31], "platform": [30, 31], "shutil": [30, 31], "cpuinfo": [30, 31], "psutil": [30, 31], "hbutil": [30, 31], "scale": [30, 31], "size_to_bytes_str": [30, 31], "python": [30, 31, 32], "python_implement": [30, 31], "python_vers": [30, 31], "cpu": [30, 31], "brand": [30, 31], "get_cpu_info": [30, 31], "brand_raw": [30, 31], "count": [30, 31], "cpu_count": [30, 31], "freq": [30, 31], "cpu_freq": [30, 31], "mhz": [30, 31], "memori": [30, 31], "virtual_memori": [30, 31], "total": [30, 31], "precis": [30, 31], "cuda": [30, 31], "ye": [30, 31], "nvidia": [30, 31], "smi": [30, 31], "els": [30, 31], "No": [30, 31], "linux": [30, 31], "0": [30, 31, 32], "1023": [30, 31], "azur": [30, 31], "x86_64": [30, 31], "glibc2": [30, 31], "34": [30, 31], "cpython": [30, 31], "18": [30, 31], "amd": [30, 31], "epyc": [30, 31], "7763": [30, 31], "64": [30, 31], "core": [30, 31], "processor": [30, 31], "2918": 30, "364": 30, "15": [30, 31], "606": [30, 31], "gib": [30, 31], "pleas": [30, 31], "note": [30, 31], "deploi": [30, 31], "document": [30, 31, 32], "automat": [30, 31], "execut": [30, 31], "github": [30, 31, 32], "action": [30, 31], "therefor": [30, 31], "some": [30, 31], "mai": [30, 31], "your": [30, 31, 32], "2740": 31, "08075": 31, "hfutil": 32, "host": 32, "pypi": 32, "newest": 32, "u": 32, "git": 32, "com": 32, "script": 32, "__name__": 32, "__main__": 32, "develop": 32, "maintain": 32, "like": 32, "below": 32, "success": 32, "10": 32, "narugo1992": 32, "still": 32, "out": 32, "stabl": 32, "html": 32, "faq": 33}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [2, 0, 0, "-", "cache"], [3, 0, 0, "-", "config"], [9, 0, 0, "-", "entry"], [15, 0, 0, "-", "index"], [20, 0, 0, "-", "operate"], [25, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.cache": [[1, 0, 0, "-", "delete"]], "hfutils.cache.delete": [[1, 1, 1, "", "delete_cache"], [1, 1, 1, "", "delete_detached_cache"]], "hfutils.config": [[4, 0, 0, "-", "meta"]], "hfutils.config.meta": [[4, 2, 1, "", "__AUTHOR_EMAIL__"], [4, 2, 1, "", "__AUTHOR__"], [4, 2, 1, "", "__DESCRIPTION__"], [4, 2, 1, "", "__TITLE__"], [4, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[5, 0, 0, "-", "base"], [6, 0, 0, "-", "cli"], [7, 0, 0, "-", "dispatch"], [8, 0, 0, "-", "download"], [10, 0, 0, "-", "ls"], [11, 0, 0, "-", "ls_repo"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[5, 2, 1, "", "CONTEXT_SETTINGS"], [5, 3, 1, "", "ClickErrorException"], [5, 3, 1, "", "ClickWarningException"], [5, 3, 1, "", "KeyboardInterrupted"], [5, 1, 1, "", "command_wrap"], [5, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[5, 5, 1, "", "__init__"], [5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.cli": [[6, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[7, 1, 1, "", "hfutilcli"], [7, 1, 1, "", "print_version"]], "hfutils.entry.download": [[8, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.entry.ls": [[10, 3, 1, "", "ListItem"], [10, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[10, 4, 1, "", "ARCHIVE"], [10, 4, 1, "", "DATA"], [10, 4, 1, "", "FILE"], [10, 4, 1, "", "FOLDER"], [10, 4, 1, "", "IMAGE"], [10, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[11, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[12, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[12, 4, 1, "", "exit_code"], [12, 5, 1, "", "show"]], "hfutils.index": [[14, 0, 0, "-", "fetch"], [16, 0, 0, "-", "make"], [17, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[14, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [14, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [14, 1, 1, "", "hf_tar_file_download"], [14, 1, 1, "", "hf_tar_file_exists"], [14, 1, 1, "", "hf_tar_file_info"], [14, 1, 1, "", "hf_tar_file_size"], [14, 1, 1, "", "hf_tar_get_index"], [14, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[16, 1, 1, "", "hf_tar_create_from_directory"], [16, 1, 1, "", "hf_tar_create_index"], [16, 1, 1, "", "tar_create_index"], [16, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[17, 1, 1, "", "hf_tar_item_validate"], [17, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[18, 0, 0, "-", "base"], [19, 0, 0, "-", "download"], [21, 0, 0, "-", "upload"], [22, 0, 0, "-", "validate"]], "hfutils.operate.base": [[18, 1, 1, "", "get_hf_client"], [18, 1, 1, "", "get_hf_fs"], [18, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[19, 1, 1, "", "download_archive_as_directory"], [19, 1, 1, "", "download_directory_as_directory"], [19, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[21, 1, 1, "", "upload_directory_as_archive"], [21, 1, 1, "", "upload_directory_as_directory"], [21, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[22, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[23, 0, 0, "-", "binary"], [24, 0, 0, "-", "download"], [26, 0, 0, "-", "path"], [27, 0, 0, "-", "tqdm_"], [28, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[23, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[24, 1, 1, "", "download_file"]], "hfutils.utils.path": [[26, 3, 1, "", "HfFileSystemPath"], [26, 1, 1, "", "hf_fs_path"], [26, 1, 1, "", "hf_normpath"], [26, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[28, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "cach": [1, 2], "delet": 1, "delete_detached_cach": 1, "delete_cach": 1, "config": [3, 4], "meta": 4, "__title__": 4, "__version__": 4, "__description__": 4, "__author__": 4, "__author_email__": 4, "entri": [5, 6, 7, 8, 9, 10, 11, 12, 13], "base": [5, 18], "context_set": 5, "clickwarningexcept": 5, "clickerrorexcept": 5, "print_except": 5, "keyboardinterrupt": 5, "command_wrap": 5, "cli": 6, "dispatch": 7, "print_vers": 7, "hfutilcli": 7, "download": [8, 19, 24], "noremotepathassignedwithdownload": 8, "l": 10, "listitemtyp": 10, "listitem": 10, "ls_repo": 11, "nolocalauthent": 11, "upload": [12, 21], "noremotepathassignedwithupload": 12, "whoami": 13, "index": [14, 15, 16, 17], "fetch": 14, "archivestandalonefileincompletedownload": 14, "archivestandalonefilehashnotmatch": 14, "hf_tar_get_index": 14, "hf_tar_list_fil": 14, "hf_tar_file_exist": 14, "hf_tar_file_s": 14, "hf_tar_file_info": 14, "hf_tar_file_download": 14, "make": 16, "tar_create_index": 16, "hf_tar_create_index": 16, "tar_get_index_info": 16, "hf_tar_create_from_directori": 16, "valid": [17, 22], "hf_tar_item_valid": 17, "hf_tar_valid": 17, "oper": [18, 19, 20, 21, 22], "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 19, "download_archive_as_directori": 19, "download_directory_as_directori": 19, "upload_file_to_fil": 21, "upload_directory_as_arch": 21, "upload_directory_as_directori": 21, "is_local_file_readi": 22, "util": [23, 24, 25, 26, 27, 28], "binari": 23, "is_binary_fil": 23, "download_fil": 24, "path": 26, "hf_normpath": 26, "hf_fs_path": 26, "parse_hf_fs_path": 26, "hffilesystempath": 26, "tqdm": 27, "walk": 28, "walk_fil": 28, "welcom": 29, "": 29, "document": 29, "overview": 29, "tutori": 29, "inform": [29, 30, 31], "api": 29, "run": [30, 31], "environ": [30, 31], "instal": 32, "quick": 33, "start": 33}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "delete_detached_cache": [[1, "delete-detached-cache"]], "delete_cache": [[1, "delete-cache"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "__TITLE__": [[4, "title"]], "__VERSION__": [[4, "version"]], "__DESCRIPTION__": [[4, "description"]], "__AUTHOR__": [[4, "author"]], "__AUTHOR_EMAIL__": [[4, "author-email"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[5, "context-settings"]], "ClickWarningException": [[5, "clickwarningexception"]], "ClickErrorException": [[5, "clickerrorexception"]], "print_exception": [[5, "print-exception"]], "KeyboardInterrupted": [[5, "keyboardinterrupted"]], "command_wrap": [[5, "command-wrap"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "cli": [[6, "cli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version": [[7, "print-version"]], "hfutilcli": [[7, "hfutilcli"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[8, "noremotepathassignedwithdownload"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "ListItemType": [[10, "listitemtype"]], "ListItem": [[10, "listitem"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[11, "nolocalauthentication"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[12, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[14, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[14, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[14, "hf-tar-get-index"]], "hf_tar_list_files": [[14, "hf-tar-list-files"]], "hf_tar_file_exists": [[14, "hf-tar-file-exists"]], "hf_tar_file_size": [[14, "hf-tar-file-size"]], "hf_tar_file_info": [[14, "hf-tar-file-info"]], "hf_tar_file_download": [[14, "hf-tar-file-download"]], "hfutils.index": [[15, "module-hfutils.index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index": [[16, "tar-create-index"]], "hf_tar_create_index": [[16, "hf-tar-create-index"]], "tar_get_index_info": [[16, "tar-get-index-info"]], "hf_tar_create_from_directory": [[16, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[17, "hf-tar-item-validate"]], "hf_tar_validate": [[17, "hf-tar-validate"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "get_hf_client": [[18, "get-hf-client"]], "get_hf_fs": [[18, "get-hf-fs"]], "list_files_in_repository": [[18, "list-files-in-repository"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "download_file_to_file": [[19, "download-file-to-file"]], "download_archive_as_directory": [[19, "download-archive-as-directory"]], "download_directory_as_directory": [[19, "download-directory-as-directory"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_file_to_file": [[21, "upload-file-to-file"]], "upload_directory_as_archive": [[21, "upload-directory-as-archive"]], "upload_directory_as_directory": [[21, "upload-directory-as-directory"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready": [[22, "is-local-file-ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file": [[23, "is-binary-file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "download_file": [[24, "download-file"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "hf_normpath": [[26, "hf-normpath"]], "hf_fs_path": [[26, "hf-fs-path"]], "parse_hf_fs_path": [[26, "parse-hf-fs-path"]], "HfFileSystemPath": [[26, "hffilesystempath"]], "hfutils.utils.tqdm": [[27, "module-hfutils.utils.tqdm_"]], "tqdm": [[27, "tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files": [[28, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[29, "welcome-to-hfutils-s-documentation"]], "Overview": [[29, "overview"]], "Tutorials": [[29, null]], "Information": [[29, null]], "API Documentation": [[29, null]], "Run Environment Information": [[30, "Run-Environment-Information"], [31, "Run-Environment-Information"]], "Installation": [[32, "installation"]], "Quick Start": [[33, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.cache.delete"], [2, "module-hfutils.cache"], [3, "module-hfutils.config"], [4, "module-hfutils.config.meta"], [5, "module-hfutils.entry.base"], [6, "module-hfutils.entry.cli"], [7, "module-hfutils.entry.dispatch"], [8, "module-hfutils.entry.download"], [9, "module-hfutils.entry"], [10, "module-hfutils.entry.ls"], [11, "module-hfutils.entry.ls_repo"], [12, "module-hfutils.entry.upload"], [13, "module-hfutils.entry.whoami"], [14, "module-hfutils.index.fetch"], [15, "module-hfutils.index"], [16, "module-hfutils.index.make"], [17, "module-hfutils.index.validate"], [18, "module-hfutils.operate.base"], [19, "module-hfutils.operate.download"], [20, "module-hfutils.operate"], [21, "module-hfutils.operate.upload"], [22, "module-hfutils.operate.validate"], [23, "module-hfutils.utils.binary"], [24, "module-hfutils.utils.download"], [25, "module-hfutils.utils"], [26, "module-hfutils.utils.path"], [27, "module-hfutils.utils.tqdm_"], [28, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "delete_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_cache"]], "delete_detached_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_detached_cache"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[5, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[5, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[5, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[5, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[5, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[5, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[5, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[6, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[10, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[11, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "hfutils.index": [[15, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[22, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[23, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[24, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[26, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[27, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[28, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/cache/delete", "api_doc/cache/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/cache/delete.rst", "api_doc/cache/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.cache.delete", "hfutils.cache", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2, 4], "pack": 0, "unpack": 0, "manag": [0, 2], "support": 0, "format": 0, "extens": 0, "name": [0, 5], "7z": 0, "bztar": 0, "tar": [0, 14, 16, 17], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 1, 5, 17, 19, 21, 24, 26, 27], "you": [0, 14, 32], "requir": [0, 32], "simpli": [0, 32], "instal": [0, 29], "us": [0, 1, 5, 14, 16, 17, 18, 19, 21, 24, 29, 32], "follow": [0, 10, 32], "code": [0, 5, 8, 12], "pip": [0, 32], "The": [0, 1, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28, 32], "creation": 0, "file": [0, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 28], "i": [0, 1, 8, 11, 12, 14, 16, 17, 19, 22, 23, 26, 29, 30, 31, 32], "we": 0, "util": [0, 29, 32], "rarfil": 0, "librari": [0, 24], "which": [0, 14, 30, 31, 32], "doe": [0, 14], "offer": 0, "function": [0, 5, 14, 16, 17, 23, 24, 27], "creat": [0, 16], "str": [0, 1, 5, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28], "ext": 0, "list": [0, 5, 10, 14, 18, 19, 21], "fn_pack": 0, "callabl": [0, 5], "fn_unpack": 0, "sourc": [0, 1, 5, 7, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "regist": 0, "custom": [0, 5, 8, 12], "type": [0, 1, 5, 10, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "associ": 0, "paramet": [0, 1, 5, 7, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "A": [0, 18], "take": 0, "directori": [0, 1, 10, 16, 17, 19, 21, 28], "an": [0, 14, 16, 17, 19, 21, 24, 27, 28], "filenam": [0, 24, 26], "input": 0, "extract": [0, 19], "type_nam": 0, "archive_fil": 0, "silent": [0, 16, 19, 21, 24, 27], "bool": [0, 7, 14, 16, 17, 19, 21, 22, 23, 24, 27], "fals": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "clear": [0, 21], "specifi": [0, 1, 17, 21, 24], "result": 0, "true": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "suppress": [0, 16, 19, 21, 24], "warn": [0, 5], "dure": 0, "process": 0, "remov": [0, 21], "exist": [0, 14, 19], "when": [0, 11, 14, 16, 19], "return": [0, 5, 14, 16, 17, 18, 22, 23, 24, 26, 27, 28], "path": [0, 8, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 25, 28, 29], "password": [0, 19], "none": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26], "content": [0, 27], "option": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26, 27], "determin": 0, "base": [0, 9, 10, 17, 20, 29], "rais": [0, 11, 14, 17, 26], "valueerror": [0, 26], "ani": [0, 1, 7, 23, 26], "get": [0, 14, 16, 18, 24, 26], "repo_id": [1, 14, 16, 17, 18, 19, 21, 22, 26], "repo_typ": [1, 14, 16, 17, 18, 19, 21, 22, 26], "cache_dir": 1, "all": [1, 14, 19, 28], "detach": 1, "revis": [1, 14, 16, 17, 18, 19, 21, 22, 26], "from": [1, 5, 14, 16, 17, 18, 19, 24, 30, 31, 32], "match": [1, 14, 17, 22], "repositori": [1, 8, 12, 14, 16, 17, 18, 19, 21, 22, 26], "id": [1, 17, 26], "where": [1, 17, 24], "store": [1, 17], "default": [1, 16, 17, 19, 22, 26], "huggingfac": [2, 17, 18, 19, 21, 26, 29, 32], "local": [2, 11, 14, 16, 19, 21, 22, 24, 30, 31], "can": [2, 14, 17, 32], "quickli": 2, "make": [2, 15, 17, 29], "disk": 2, "space": [2, 14, 16, 17, 18, 19, 21, 22, 26], "under": [2, 32], "control": 2, "delet": [2, 29], "delete_detached_cach": 2, "delete_cach": 2, "meta": [3, 14, 29, 32], "__title__": [3, 32], "__version__": [3, 32], "__description__": [3, 32], "__author__": [3, 32], "__author_email__": 3, "inform": [4, 5, 7, 14, 16, 17], "packag": 4, "titl": 4, "thi": [4, 5, 8, 12, 14, 16, 17, 23, 24, 26, 27, 30, 31], "project": 4, "should": [4, 24, 32], "version": [4, 7, 27, 32], "short": 4, "descript": [4, 24], "includ": [4, 5, 14, 16], "setup": 4, "py": 4, "author": 4, "email": 4, "help_option_nam": 5, "h": 5, "help": 5, "dict": [5, 14, 16], "new": 5, "empti": 5, "dictionari": [5, 14], "map": 5, "initi": 5, "object": [5, 10, 14, 18, 19, 21, 24], "": [5, 7, 14], "kei": [5, 14], "valu": [5, 7, 10, 16], "pair": 5, "iter": [5, 28], "via": 5, "d": 5, "k": 5, "v": 5, "kwarg": [5, 7, 24, 27], "keyword": [5, 24, 27], "argument": [5, 14, 24, 27], "For": 5, "exampl": [5, 14], "one": 5, "1": [5, 10, 16, 17, 30, 31], "two": 5, "2": [5, 10, 32], "class": [5, 8, 10, 11, 12, 14, 26], "messag": [5, 8, 11, 12, 16, 21], "except": [5, 8, 11, 12, 14], "displai": [5, 8, 12, 24, 27], "yellow": 5, "color": 5, "error": [5, 8, 12], "exit_cod": [5, 8, 12], "exit": [5, 8, 12], "show": [5, 8, 12], "io": [5, 8, 12, 32], "write": [5, 8, 12], "output": [5, 8, 12, 19, 21, 24, 27, 32], "red": [5, 8, 12], "err": 5, "baseexcept": 5, "print": [5, 7, 30, 31, 32], "traceback": 5, "provid": [5, 24], "built": 5, "msg": 5, "handl": 5, "keyboard": 5, "interrupt": 5, "__init__": 5, "7": 5, "decor": 5, "wrap": 5, "click": [5, 7], "command": [5, 32], "catch": 5, "consist": 5, "group": 6, "hfutilcli": [6, 9], "ctx": 7, "context": 7, "param": 7, "cli": [7, 9, 29], "current": [7, 30, 31, 32], "metadata": 7, "arg": [7, 27], "indic": [8, 12], "remot": [8, 12], "assign": [8, 12, 14, 18, 19, 21], "17": 8, "context_set": 9, "clickwarningexcept": 9, "clickerrorexcept": 9, "print_except": 9, "keyboardinterrupt": 9, "command_wrap": 9, "dispatch": [9, 29], "print_vers": 9, "download": [9, 14, 17, 20, 25, 29], "noremotepathassignedwithdownload": 9, "l": [9, 29], "listitemtyp": 9, "listitem": 9, "ls_repo": [9, 29], "nolocalauthent": 9, "upload": [9, 16, 20, 29], "noremotepathassignedwithupload": 9, "whoami": [9, 29], "enum": 10, "repres": [10, 14], "differ": [10, 14, 30, 31], "item": [10, 17], "valid": [10, 15, 20, 29], "ar": [10, 14], "folder": 10, "imag": [10, 14], "3": [10, 30, 31, 32], "archiv": [10, 14, 16, 17, 19, 21, 29], "4": [10, 30, 31], "model": [10, 14, 16, 17, 18, 19, 21, 22, 26], "5": [10, 19, 30, 31], "data": [10, 14, 30, 31], "6": [10, 30, 31], "repofold": 10, "repofil": [10, 17], "base_dir": 10, "union": [10, 14], "authent": [11, 17], "token": [11, 14, 16, 17, 18, 19, 21, 22], "33": 12, "standalon": 14, "incomplet": 14, "hash": [14, 16, 17, 18, 19, 21], "archive_in_repo": [14, 16, 17, 21], "liter": [14, 16, 17, 18, 19, 21, 22, 26], "dataset": [14, 16, 17, 18, 19, 21, 22, 26], "main": [14, 16, 17, 18, 19, 21, 22, 32], "idx_repo_id": [14, 16, 17], "idx_file_in_repo": [14, 16, 17], "idx_repo_typ": [14, 16, 17], "idx_revis": [14, 16, 17], "hf_token": [14, 16, 17, 18, 19, 21, 22], "hug": [14, 16, 17, 18, 19, 21, 22], "face": [14, 16, 17, 18, 19, 21, 22], "identifi": [14, 16, 18, 19, 21, 22], "repotypetyp": [14, 16, 17, 18, 19, 21, 22, 26], "access": [14, 16], "import": [14, 30, 31, 32], "idx": 14, "deepgh": [14, 32], "danbooru_newest": 14, "0000": 14, "dict_kei": 14, "files": 14, "hash_lf": [14, 17], "7507000": 14, "jpg": 14, "7506000": 14, "7505000": 14, "besid": 14, "also": [14, 24, 32], "explicitli": 14, "nyanko7": 14, "danbooru2023": 14, "danbooru2023_index": 14, "origin": 14, "1000": 14, "png": 14, "10000": 14, "100000": 14, "insid": 14, "file_in_arch": 14, "check": [14, 17, 22, 23, 24, 32], "otherwis": [14, 17, 22, 24], "17506000": 14, "10000000001000": 14, "int": [14, 16, 17, 19, 24], "size": [14, 16, 17, 24, 30, 31], "integ": 14, "filenotfounderror": 14, "435671": 14, "11966": 14, "detail": 14, "offset": 14, "sha256": 14, "265728": 14, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 14, "1024": [14, 23, 30, 31], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 14, "local_fil": [14, 19, 21, 22], "proxi": 14, "user_ag": 14, "header": 14, "endpoint": 14, "save": [14, 16, 19, 24], "http": [14, 32], "request": [14, 24], "user": 14, "agent": 14, "addit": [14, 24, 27], "api": [14, 17, 18, 19, 21, 22], "test_exampl": 14, "destin": 14, "given": [14, 18, 23, 24, 26], "fetch": [15, 29], "archivestandalonefileincompletedownload": 15, "archivestandalonefilehashnotmatch": 15, "hf_tar_get_index": 15, "hf_tar_list_fil": 15, "hf_tar_file_exist": 15, "hf_tar_file_s": 15, "hf_tar_file_info": 15, "hf_tar_file_download": 15, "tar_create_index": 15, "hf_tar_create_index": [15, 17], "tar_get_index_info": 15, "hf_tar_create_from_directori": 15, "hf_tar_item_valid": 15, "hf_tar_valid": 15, "src_tar_fil": 16, "dst_index_fil": 16, "chunk_for_hash": 16, "1048576": 16, "with_hash": 16, "chunk": 16, "20": 16, "mb": 16, "whether": 16, "progress": [16, 19, 21, 24, 27], "bar": [16, 19, 21, 24, 27], "log": 16, "skip_when_sync": 16, "skip": 16, "sync": 16, "readi": [16, 22], "directli": 16, "json": [16, 17], "local_directori": [16, 19, 21], "file_item": 17, "hash_": 17, "expect": [17, 24], "sha": 17, "256": 17, "lf": 17, "entrynotfounderror": 17, "entri": [17, 29], "found": 17, "isadirectoryerror": 17, "mean": [17, 32], "expir": 17, "need": 17, "re": 17, "gener": 17, "so": 17, "togeth": 17, "gracefulli": 17, "refresh": 17, "hfapi": 18, "client": [18, 19, 21], "variabl": [18, 19, 21], "hffilesystem": 18, "system": 18, "subdir": 18, "ignore_pattern": [18, 19, 21], "subdirectori": 18, "e": [18, 19, 21], "g": [18, 19, 21], "branch": [18, 19, 21], "tag": [18, 19, 21], "commit": [18, 19, 21], "pattern": [18, 19, 21], "ignor": [18, 19, 21], "file_in_repo": [19, 21, 22], "resume_download": 19, "within": [19, 21], "resum": 19, "dir_in_repo": 19, "max_work": 19, "8": [19, 30, 31, 32], "max_retri": 19, "max": 19, "worker": 19, "retri": 19, "time": 19, "get_hf_client": 20, "get_hf_f": 20, "list_files_in_repositori": 20, "download_file_to_fil": 20, "download_archive_as_directori": 20, "download_directory_as_directori": 20, "upload_file_to_fil": 20, "upload_directory_as_arch": 20, "upload_directory_as_directori": 20, "is_local_file_readi": 20, "path_in_repo": 21, "time_suffix": 21, "its": 21, "append": 21, "timestamp": 21, "present": 21, "compar": 22, "hub": 22, "read": 23, "first": 23, "byte": [23, 24], "contain": 23, "non": 23, "text": 23, "charact": 23, "url": 24, "expected_s": 24, "desc": 24, "session": 24, "tqdm": [24, 25, 29], "It": [24, 32], "perform": [24, 30, 31], "ensur": 24, "ha": [24, 30, 31], "pass": [24, 27], "binari": [25, 29], "is_binary_fil": 25, "download_fil": 25, "hf_normpath": 25, "hf_fs_path": 25, "parse_hf_fs_path": 25, "hffilesystempath": 25, "walk": [25, 29], "walk_fil": 25, "normal": 26, "filesystem": 26, "pars": 26, "invalid": 26, "tqdm_": 27, "enhanc": 27, "silenc": 27, "modifi": 27, "behavior": 27, "allow": 27, "posit": 27, "std": 27, "recurs": 28, "through": [28, 32], "yield": 28, "rel": 28, "root": 28, "start": [28, 29], "modul": 29, "quick": 29, "run": 29, "environ": 29, "register_archive_typ": 29, "archive_pack": 29, "archive_unpack": 29, "get_archive_typ": 29, "get_archive_extnam": 29, "cach": 29, "config": [29, 32], "index": [29, 32], "oper": 29, "here": [30, 31], "o": [30, 31], "platform": [30, 31], "shutil": [30, 31], "cpuinfo": [30, 31], "psutil": [30, 31], "hbutil": [30, 31], "scale": [30, 31], "size_to_bytes_str": [30, 31], "python": [30, 31, 32], "python_implement": [30, 31], "python_vers": [30, 31], "cpu": [30, 31], "brand": [30, 31], "get_cpu_info": [30, 31], "brand_raw": [30, 31], "count": [30, 31], "cpu_count": [30, 31], "freq": [30, 31], "cpu_freq": [30, 31], "mhz": [30, 31], "memori": [30, 31], "virtual_memori": [30, 31], "total": [30, 31], "precis": [30, 31], "cuda": [30, 31], "ye": [30, 31], "nvidia": [30, 31], "smi": [30, 31], "els": [30, 31], "No": [30, 31], "linux": [30, 31], "0": [30, 31, 32], "azur": [30, 31], "x86_64": [30, 31], "glibc2": [30, 31], "34": [30, 31], "cpython": [30, 31], "18": [30, 31], "amd": [30, 31], "epyc": [30, 31], "7763": [30, 31], "64": [30, 31], "core": [30, 31], "processor": [30, 31], "2930": 30, "58075": 30, "15": [30, 31], "606": [30, 31], "gib": [30, 31], "pleas": [30, 31], "note": [30, 31], "deploi": [30, 31], "document": [30, 31, 32], "automat": [30, 31], "execut": [30, 31], "github": [30, 31, 32], "action": [30, 31], "therefor": [30, 31], "some": [30, 31], "mai": [30, 31], "your": [30, 31, 32], "2922": 31, "5455": 31, "hfutil": 32, "host": 32, "pypi": 32, "newest": 32, "u": 32, "git": 32, "com": 32, "script": 32, "__name__": 32, "__main__": 32, "develop": 32, "maintain": 32, "like": 32, "below": 32, "success": 32, "10": 32, "narugo1992": 32, "still": 32, "out": 32, "stabl": 32, "html": 32, "faq": 33}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [2, 0, 0, "-", "cache"], [3, 0, 0, "-", "config"], [9, 0, 0, "-", "entry"], [15, 0, 0, "-", "index"], [20, 0, 0, "-", "operate"], [25, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.cache": [[1, 0, 0, "-", "delete"]], "hfutils.cache.delete": [[1, 1, 1, "", "delete_cache"], [1, 1, 1, "", "delete_detached_cache"]], "hfutils.config": [[4, 0, 0, "-", "meta"]], "hfutils.config.meta": [[4, 2, 1, "", "__AUTHOR_EMAIL__"], [4, 2, 1, "", "__AUTHOR__"], [4, 2, 1, "", "__DESCRIPTION__"], [4, 2, 1, "", "__TITLE__"], [4, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[5, 0, 0, "-", "base"], [6, 0, 0, "-", "cli"], [7, 0, 0, "-", "dispatch"], [8, 0, 0, "-", "download"], [10, 0, 0, "-", "ls"], [11, 0, 0, "-", "ls_repo"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[5, 2, 1, "", "CONTEXT_SETTINGS"], [5, 3, 1, "", "ClickErrorException"], [5, 3, 1, "", "ClickWarningException"], [5, 3, 1, "", "KeyboardInterrupted"], [5, 1, 1, "", "command_wrap"], [5, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[5, 5, 1, "", "__init__"], [5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.cli": [[6, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[7, 1, 1, "", "hfutilcli"], [7, 1, 1, "", "print_version"]], "hfutils.entry.download": [[8, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.entry.ls": [[10, 3, 1, "", "ListItem"], [10, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[10, 4, 1, "", "ARCHIVE"], [10, 4, 1, "", "DATA"], [10, 4, 1, "", "FILE"], [10, 4, 1, "", "FOLDER"], [10, 4, 1, "", "IMAGE"], [10, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[11, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[12, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[12, 4, 1, "", "exit_code"], [12, 5, 1, "", "show"]], "hfutils.index": [[14, 0, 0, "-", "fetch"], [16, 0, 0, "-", "make"], [17, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[14, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [14, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [14, 1, 1, "", "hf_tar_file_download"], [14, 1, 1, "", "hf_tar_file_exists"], [14, 1, 1, "", "hf_tar_file_info"], [14, 1, 1, "", "hf_tar_file_size"], [14, 1, 1, "", "hf_tar_get_index"], [14, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[16, 1, 1, "", "hf_tar_create_from_directory"], [16, 1, 1, "", "hf_tar_create_index"], [16, 1, 1, "", "tar_create_index"], [16, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[17, 1, 1, "", "hf_tar_item_validate"], [17, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[18, 0, 0, "-", "base"], [19, 0, 0, "-", "download"], [21, 0, 0, "-", "upload"], [22, 0, 0, "-", "validate"]], "hfutils.operate.base": [[18, 1, 1, "", "get_hf_client"], [18, 1, 1, "", "get_hf_fs"], [18, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[19, 1, 1, "", "download_archive_as_directory"], [19, 1, 1, "", "download_directory_as_directory"], [19, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[21, 1, 1, "", "upload_directory_as_archive"], [21, 1, 1, "", "upload_directory_as_directory"], [21, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[22, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[23, 0, 0, "-", "binary"], [24, 0, 0, "-", "download"], [26, 0, 0, "-", "path"], [27, 0, 0, "-", "tqdm_"], [28, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[23, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[24, 1, 1, "", "download_file"]], "hfutils.utils.path": [[26, 3, 1, "", "HfFileSystemPath"], [26, 1, 1, "", "hf_fs_path"], [26, 1, 1, "", "hf_normpath"], [26, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[28, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "cach": [1, 2], "delet": 1, "delete_detached_cach": 1, "delete_cach": 1, "config": [3, 4], "meta": 4, "__title__": 4, "__version__": 4, "__description__": 4, "__author__": 4, "__author_email__": 4, "entri": [5, 6, 7, 8, 9, 10, 11, 12, 13], "base": [5, 18], "context_set": 5, "clickwarningexcept": 5, "clickerrorexcept": 5, "print_except": 5, "keyboardinterrupt": 5, "command_wrap": 5, "cli": 6, "dispatch": 7, "print_vers": 7, "hfutilcli": 7, "download": [8, 19, 24], "noremotepathassignedwithdownload": 8, "l": 10, "listitemtyp": 10, "listitem": 10, "ls_repo": 11, "nolocalauthent": 11, "upload": [12, 21], "noremotepathassignedwithupload": 12, "whoami": 13, "index": [14, 15, 16, 17], "fetch": 14, "archivestandalonefileincompletedownload": 14, "archivestandalonefilehashnotmatch": 14, "hf_tar_get_index": 14, "hf_tar_list_fil": 14, "hf_tar_file_exist": 14, "hf_tar_file_s": 14, "hf_tar_file_info": 14, "hf_tar_file_download": 14, "make": 16, "tar_create_index": 16, "hf_tar_create_index": 16, "tar_get_index_info": 16, "hf_tar_create_from_directori": 16, "valid": [17, 22], "hf_tar_item_valid": 17, "hf_tar_valid": 17, "oper": [18, 19, 20, 21, 22], "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 19, "download_archive_as_directori": 19, "download_directory_as_directori": 19, "upload_file_to_fil": 21, "upload_directory_as_arch": 21, "upload_directory_as_directori": 21, "is_local_file_readi": 22, "util": [23, 24, 25, 26, 27, 28], "binari": 23, "is_binary_fil": 23, "download_fil": 24, "path": 26, "hf_normpath": 26, "hf_fs_path": 26, "parse_hf_fs_path": 26, "hffilesystempath": 26, "tqdm": 27, "walk": 28, "walk_fil": 28, "welcom": 29, "": 29, "document": 29, "overview": 29, "tutori": 29, "inform": [29, 30, 31], "api": 29, "run": [30, 31], "environ": [30, 31], "instal": 32, "quick": 33, "start": 33}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "delete_detached_cache": [[1, "delete-detached-cache"]], "delete_cache": [[1, "delete-cache"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "__TITLE__": [[4, "title"]], "__VERSION__": [[4, "version"]], "__DESCRIPTION__": [[4, "description"]], "__AUTHOR__": [[4, "author"]], "__AUTHOR_EMAIL__": [[4, "author-email"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[5, "context-settings"]], "ClickWarningException": [[5, "clickwarningexception"]], "ClickErrorException": [[5, "clickerrorexception"]], "print_exception": [[5, "print-exception"]], "KeyboardInterrupted": [[5, "keyboardinterrupted"]], "command_wrap": [[5, "command-wrap"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "cli": [[6, "cli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version": [[7, "print-version"]], "hfutilcli": [[7, "hfutilcli"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[8, "noremotepathassignedwithdownload"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "ListItemType": [[10, "listitemtype"]], "ListItem": [[10, "listitem"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[11, "nolocalauthentication"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[12, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[14, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[14, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[14, "hf-tar-get-index"]], "hf_tar_list_files": [[14, "hf-tar-list-files"]], "hf_tar_file_exists": [[14, "hf-tar-file-exists"]], "hf_tar_file_size": [[14, "hf-tar-file-size"]], "hf_tar_file_info": [[14, "hf-tar-file-info"]], "hf_tar_file_download": [[14, "hf-tar-file-download"]], "hfutils.index": [[15, "module-hfutils.index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index": [[16, "tar-create-index"]], "hf_tar_create_index": [[16, "hf-tar-create-index"]], "tar_get_index_info": [[16, "tar-get-index-info"]], "hf_tar_create_from_directory": [[16, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[17, "hf-tar-item-validate"]], "hf_tar_validate": [[17, "hf-tar-validate"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "get_hf_client": [[18, "get-hf-client"]], "get_hf_fs": [[18, "get-hf-fs"]], "list_files_in_repository": [[18, "list-files-in-repository"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "download_file_to_file": [[19, "download-file-to-file"]], "download_archive_as_directory": [[19, "download-archive-as-directory"]], "download_directory_as_directory": [[19, "download-directory-as-directory"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_file_to_file": [[21, "upload-file-to-file"]], "upload_directory_as_archive": [[21, "upload-directory-as-archive"]], "upload_directory_as_directory": [[21, "upload-directory-as-directory"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready": [[22, "is-local-file-ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file": [[23, "is-binary-file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "download_file": [[24, "download-file"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "hf_normpath": [[26, "hf-normpath"]], "hf_fs_path": [[26, "hf-fs-path"]], "parse_hf_fs_path": [[26, "parse-hf-fs-path"]], "HfFileSystemPath": [[26, "hffilesystempath"]], "hfutils.utils.tqdm": [[27, "module-hfutils.utils.tqdm_"]], "tqdm": [[27, "tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files": [[28, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[29, "welcome-to-hfutils-s-documentation"]], "Overview": [[29, "overview"]], "Tutorials": [[29, null]], "Information": [[29, null]], "API Documentation": [[29, null]], "Run Environment Information": [[30, "Run-Environment-Information"], [31, "Run-Environment-Information"]], "Installation": [[32, "installation"]], "Quick Start": [[33, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.cache.delete"], [2, "module-hfutils.cache"], [3, "module-hfutils.config"], [4, "module-hfutils.config.meta"], [5, "module-hfutils.entry.base"], [6, "module-hfutils.entry.cli"], [7, "module-hfutils.entry.dispatch"], [8, "module-hfutils.entry.download"], [9, "module-hfutils.entry"], [10, "module-hfutils.entry.ls"], [11, "module-hfutils.entry.ls_repo"], [12, "module-hfutils.entry.upload"], [13, "module-hfutils.entry.whoami"], [14, "module-hfutils.index.fetch"], [15, "module-hfutils.index"], [16, "module-hfutils.index.make"], [17, "module-hfutils.index.validate"], [18, "module-hfutils.operate.base"], [19, "module-hfutils.operate.download"], [20, "module-hfutils.operate"], [21, "module-hfutils.operate.upload"], [22, "module-hfutils.operate.validate"], [23, "module-hfutils.utils.binary"], [24, "module-hfutils.utils.download"], [25, "module-hfutils.utils"], [26, "module-hfutils.utils.path"], [27, "module-hfutils.utils.tqdm_"], [28, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "delete_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_cache"]], "delete_detached_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_detached_cache"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[5, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[5, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[5, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[5, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[5, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[5, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[5, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[6, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[10, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[11, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "hfutils.index": [[15, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[22, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[23, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[24, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[26, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[27, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[28, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.2.11/.buildinfo b/v0.2.11/.buildinfo
index 4e657745c4..184fed0eeb 100644
--- a/v0.2.11/.buildinfo
+++ b/v0.2.11/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d148e776ce946f7c6b9316b03621fada
+config: c21e44316299a145c95854baba1033cd
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.2.11/.doctrees/api_doc/archive/index.doctree b/v0.2.11/.doctrees/api_doc/archive/index.doctree
index fe925c41db..1f2d4e5514 100644
Binary files a/v0.2.11/.doctrees/api_doc/archive/index.doctree and b/v0.2.11/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/cache/delete.doctree b/v0.2.11/.doctrees/api_doc/cache/delete.doctree
index cf70d09a9a..bfe90bd419 100644
Binary files a/v0.2.11/.doctrees/api_doc/cache/delete.doctree and b/v0.2.11/.doctrees/api_doc/cache/delete.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/cache/index.doctree b/v0.2.11/.doctrees/api_doc/cache/index.doctree
index cfe3d6b550..3516c37485 100644
Binary files a/v0.2.11/.doctrees/api_doc/cache/index.doctree and b/v0.2.11/.doctrees/api_doc/cache/index.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/config/index.doctree b/v0.2.11/.doctrees/api_doc/config/index.doctree
index 505b1fa2e1..084e9012ee 100644
Binary files a/v0.2.11/.doctrees/api_doc/config/index.doctree and b/v0.2.11/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/config/meta.doctree b/v0.2.11/.doctrees/api_doc/config/meta.doctree
index 59e3c95bd1..1abe782092 100644
Binary files a/v0.2.11/.doctrees/api_doc/config/meta.doctree and b/v0.2.11/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/entry/base.doctree b/v0.2.11/.doctrees/api_doc/entry/base.doctree
index ce6ca951e2..0d6b524c83 100644
Binary files a/v0.2.11/.doctrees/api_doc/entry/base.doctree and b/v0.2.11/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/entry/cli.doctree b/v0.2.11/.doctrees/api_doc/entry/cli.doctree
index 7926bb2812..f4ac4b68dc 100644
Binary files a/v0.2.11/.doctrees/api_doc/entry/cli.doctree and b/v0.2.11/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/entry/dispatch.doctree b/v0.2.11/.doctrees/api_doc/entry/dispatch.doctree
index db415cf7d8..1e71ed6624 100644
Binary files a/v0.2.11/.doctrees/api_doc/entry/dispatch.doctree and b/v0.2.11/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/entry/download.doctree b/v0.2.11/.doctrees/api_doc/entry/download.doctree
index 3305201635..c43de65fb4 100644
Binary files a/v0.2.11/.doctrees/api_doc/entry/download.doctree and b/v0.2.11/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/entry/index.doctree b/v0.2.11/.doctrees/api_doc/entry/index.doctree
index 512d4a7dc7..ee582b7538 100644
Binary files a/v0.2.11/.doctrees/api_doc/entry/index.doctree and b/v0.2.11/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/entry/ls.doctree b/v0.2.11/.doctrees/api_doc/entry/ls.doctree
index e91382ec76..9065523ace 100644
Binary files a/v0.2.11/.doctrees/api_doc/entry/ls.doctree and b/v0.2.11/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/entry/ls_repo.doctree b/v0.2.11/.doctrees/api_doc/entry/ls_repo.doctree
index 3a3230e2d1..e0b9f89cfe 100644
Binary files a/v0.2.11/.doctrees/api_doc/entry/ls_repo.doctree and b/v0.2.11/.doctrees/api_doc/entry/ls_repo.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/entry/upload.doctree b/v0.2.11/.doctrees/api_doc/entry/upload.doctree
index f46c30e88f..caab7ee85a 100644
Binary files a/v0.2.11/.doctrees/api_doc/entry/upload.doctree and b/v0.2.11/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/entry/whoami.doctree b/v0.2.11/.doctrees/api_doc/entry/whoami.doctree
index 58faf106e0..dcd59fa3e8 100644
Binary files a/v0.2.11/.doctrees/api_doc/entry/whoami.doctree and b/v0.2.11/.doctrees/api_doc/entry/whoami.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/index/fetch.doctree b/v0.2.11/.doctrees/api_doc/index/fetch.doctree
index 5920fea36f..71cd3c78e5 100644
Binary files a/v0.2.11/.doctrees/api_doc/index/fetch.doctree and b/v0.2.11/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/index/index.doctree b/v0.2.11/.doctrees/api_doc/index/index.doctree
index 4f464ab409..294ce902cd 100644
Binary files a/v0.2.11/.doctrees/api_doc/index/index.doctree and b/v0.2.11/.doctrees/api_doc/index/index.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/index/make.doctree b/v0.2.11/.doctrees/api_doc/index/make.doctree
index 5280b137e2..f9a587a099 100644
Binary files a/v0.2.11/.doctrees/api_doc/index/make.doctree and b/v0.2.11/.doctrees/api_doc/index/make.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/index/validate.doctree b/v0.2.11/.doctrees/api_doc/index/validate.doctree
index 25a4736bc4..8e61a68156 100644
Binary files a/v0.2.11/.doctrees/api_doc/index/validate.doctree and b/v0.2.11/.doctrees/api_doc/index/validate.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/operate/base.doctree b/v0.2.11/.doctrees/api_doc/operate/base.doctree
index 67e0a6b4f6..5eb7ec0b24 100644
Binary files a/v0.2.11/.doctrees/api_doc/operate/base.doctree and b/v0.2.11/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/operate/download.doctree b/v0.2.11/.doctrees/api_doc/operate/download.doctree
index e243616b51..7ed46ffb95 100644
Binary files a/v0.2.11/.doctrees/api_doc/operate/download.doctree and b/v0.2.11/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/operate/index.doctree b/v0.2.11/.doctrees/api_doc/operate/index.doctree
index a9ec6e70ba..cabe8f285d 100644
Binary files a/v0.2.11/.doctrees/api_doc/operate/index.doctree and b/v0.2.11/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/operate/upload.doctree b/v0.2.11/.doctrees/api_doc/operate/upload.doctree
index 07bacbb012..d2849a6c87 100644
Binary files a/v0.2.11/.doctrees/api_doc/operate/upload.doctree and b/v0.2.11/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/operate/validate.doctree b/v0.2.11/.doctrees/api_doc/operate/validate.doctree
index 66682f4b9b..49ea8af2b2 100644
Binary files a/v0.2.11/.doctrees/api_doc/operate/validate.doctree and b/v0.2.11/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/utils/binary.doctree b/v0.2.11/.doctrees/api_doc/utils/binary.doctree
index 18aedbc766..6856013e56 100644
Binary files a/v0.2.11/.doctrees/api_doc/utils/binary.doctree and b/v0.2.11/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/utils/download.doctree b/v0.2.11/.doctrees/api_doc/utils/download.doctree
index 2aca738d8c..65f39450c6 100644
Binary files a/v0.2.11/.doctrees/api_doc/utils/download.doctree and b/v0.2.11/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/utils/index.doctree b/v0.2.11/.doctrees/api_doc/utils/index.doctree
index 1ee2475385..def94bb02f 100644
Binary files a/v0.2.11/.doctrees/api_doc/utils/index.doctree and b/v0.2.11/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/utils/path.doctree b/v0.2.11/.doctrees/api_doc/utils/path.doctree
index c8a94592ed..d01b0e76e9 100644
Binary files a/v0.2.11/.doctrees/api_doc/utils/path.doctree and b/v0.2.11/.doctrees/api_doc/utils/path.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/utils/tqdm_.doctree b/v0.2.11/.doctrees/api_doc/utils/tqdm_.doctree
index 3714a7467d..658c2a00a7 100644
Binary files a/v0.2.11/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.2.11/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.2.11/.doctrees/api_doc/utils/walk.doctree b/v0.2.11/.doctrees/api_doc/utils/walk.doctree
index 668ae9072a..db1a329565 100644
Binary files a/v0.2.11/.doctrees/api_doc/utils/walk.doctree and b/v0.2.11/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.2.11/.doctrees/environment.pickle b/v0.2.11/.doctrees/environment.pickle
index 058f045b5c..b79227f967 100644
Binary files a/v0.2.11/.doctrees/environment.pickle and b/v0.2.11/.doctrees/environment.pickle differ
diff --git a/v0.2.11/.doctrees/index.doctree b/v0.2.11/.doctrees/index.doctree
index 62b7f447b8..31ab1451c8 100644
Binary files a/v0.2.11/.doctrees/index.doctree and b/v0.2.11/.doctrees/index.doctree differ
diff --git a/v0.2.11/.doctrees/information/environment.doctree b/v0.2.11/.doctrees/information/environment.doctree
index 85aac9d577..0f34a2803d 100644
Binary files a/v0.2.11/.doctrees/information/environment.doctree and b/v0.2.11/.doctrees/information/environment.doctree differ
diff --git a/v0.2.11/.doctrees/information/environment.result.doctree b/v0.2.11/.doctrees/information/environment.result.doctree
index 6f25c0332c..2ed23bf1a3 100644
Binary files a/v0.2.11/.doctrees/information/environment.result.doctree and b/v0.2.11/.doctrees/information/environment.result.doctree differ
diff --git a/v0.2.11/.doctrees/nbsphinx/information/environment.ipynb b/v0.2.11/.doctrees/nbsphinx/information/environment.ipynb
index 2d1d2a0604..87f0bb215f 100644
--- a/v0.2.11/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.2.11/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:52:07.029442Z",
-     "iopub.status.busy": "2024-07-23T17:52:07.029231Z",
-     "iopub.status.idle": "2024-07-23T17:52:08.199529Z",
-     "shell.execute_reply": "2024-07-23T17:52:08.198798Z"
+     "iopub.execute_input": "2024-07-23T17:58:43.182665Z",
+     "iopub.status.busy": "2024-07-23T17:58:43.182459Z",
+     "iopub.status.idle": "2024-07-23T17:58:44.353131Z",
+     "shell.execute_reply": "2024-07-23T17:58:44.352365Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2911.1995 MHz\n",
+      "CPU Freq: 2926.77175 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.11/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.2.11/.doctrees/nbsphinx/information/environment.result.ipynb
index 071fec88f2..3a55bbdefd 100644
--- a/v0.2.11/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.2.11/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:08:40.621003Z",
-     "iopub.status.busy": "2024-07-23T17:08:40.620611Z",
-     "iopub.status.idle": "2024-07-23T17:08:41.794343Z",
-     "shell.execute_reply": "2024-07-23T17:08:41.793589Z"
+     "iopub.execute_input": "2024-07-23T17:14:25.109118Z",
+     "iopub.status.busy": "2024-07-23T17:14:25.108908Z",
+     "iopub.status.idle": "2024-07-23T17:14:26.288084Z",
+     "shell.execute_reply": "2024-07-23T17:14:26.287333Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2943.10775 MHz\n",
+      "CPU Freq: 3168.1947499999997 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.11/.doctrees/tutorials/installation/index.doctree b/v0.2.11/.doctrees/tutorials/installation/index.doctree
index edc736ece7..5179a8d7b3 100644
Binary files a/v0.2.11/.doctrees/tutorials/installation/index.doctree and b/v0.2.11/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.2.11/.doctrees/tutorials/quick_start/index.doctree b/v0.2.11/.doctrees/tutorials/quick_start/index.doctree
index 204af1586b..c16b269c99 100644
Binary files a/v0.2.11/.doctrees/tutorials/quick_start/index.doctree and b/v0.2.11/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.2.11/_sources/information/environment.result.ipynb.txt b/v0.2.11/_sources/information/environment.result.ipynb.txt
index 071fec88f2..3a55bbdefd 100644
--- a/v0.2.11/_sources/information/environment.result.ipynb.txt
+++ b/v0.2.11/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:08:40.621003Z",
-     "iopub.status.busy": "2024-07-23T17:08:40.620611Z",
-     "iopub.status.idle": "2024-07-23T17:08:41.794343Z",
-     "shell.execute_reply": "2024-07-23T17:08:41.793589Z"
+     "iopub.execute_input": "2024-07-23T17:14:25.109118Z",
+     "iopub.status.busy": "2024-07-23T17:14:25.108908Z",
+     "iopub.status.idle": "2024-07-23T17:14:26.288084Z",
+     "shell.execute_reply": "2024-07-23T17:14:26.287333Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2943.10775 MHz\n",
+      "CPU Freq: 3168.1947499999997 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.11/information/environment.html b/v0.2.11/information/environment.html
index 9a2780b0f4..3e5ab0d67b 100644
--- a/v0.2.11/information/environment.html
+++ b/v0.2.11/information/environment.html
@@ -127,11 +127,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2911.1995 MHz
+CPU Freq: 2926.77175 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.11/information/environment.ipynb b/v0.2.11/information/environment.ipynb
index 2d1d2a0604..87f0bb215f 100644
--- a/v0.2.11/information/environment.ipynb
+++ b/v0.2.11/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:52:07.029442Z",
-     "iopub.status.busy": "2024-07-23T17:52:07.029231Z",
-     "iopub.status.idle": "2024-07-23T17:52:08.199529Z",
-     "shell.execute_reply": "2024-07-23T17:52:08.198798Z"
+     "iopub.execute_input": "2024-07-23T17:58:43.182665Z",
+     "iopub.status.busy": "2024-07-23T17:58:43.182459Z",
+     "iopub.status.idle": "2024-07-23T17:58:44.353131Z",
+     "shell.execute_reply": "2024-07-23T17:58:44.352365Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2911.1995 MHz\n",
+      "CPU Freq: 2926.77175 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.11/information/environment.result.html b/v0.2.11/information/environment.result.html
index 18f55181b7..58ace6973f 100644
--- a/v0.2.11/information/environment.result.html
+++ b/v0.2.11/information/environment.result.html
@@ -129,11 +129,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2943.10775 MHz
+CPU Freq: 3168.1947499999997 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.11/information/environment.result.ipynb b/v0.2.11/information/environment.result.ipynb
index 071fec88f2..3a55bbdefd 100644
--- a/v0.2.11/information/environment.result.ipynb
+++ b/v0.2.11/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:08:40.621003Z",
-     "iopub.status.busy": "2024-07-23T17:08:40.620611Z",
-     "iopub.status.idle": "2024-07-23T17:08:41.794343Z",
-     "shell.execute_reply": "2024-07-23T17:08:41.793589Z"
+     "iopub.execute_input": "2024-07-23T17:14:25.109118Z",
+     "iopub.status.busy": "2024-07-23T17:14:25.108908Z",
+     "iopub.status.idle": "2024-07-23T17:14:26.288084Z",
+     "shell.execute_reply": "2024-07-23T17:14:26.287333Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2943.10775 MHz\n",
+      "CPU Freq: 3168.1947499999997 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.11/searchindex.js b/v0.2.11/searchindex.js
index e49560548e..de87128334 100644
--- a/v0.2.11/searchindex.js
+++ b/v0.2.11/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/cache/delete", "api_doc/cache/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/cache/delete.rst", "api_doc/cache/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.cache.delete", "hfutils.cache", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2, 4], "pack": 0, "unpack": 0, "manag": [0, 2], "support": 0, "format": 0, "extens": 0, "name": [0, 5], "7z": 0, "bztar": 0, "tar": [0, 14, 16, 17], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 1, 5, 17, 19, 21, 24, 26, 27], "you": [0, 14, 32], "requir": [0, 32], "simpli": [0, 32], "instal": [0, 29], "us": [0, 1, 5, 14, 16, 17, 18, 19, 21, 24, 29, 32], "follow": [0, 10, 32], "code": [0, 5, 8, 12], "pip": [0, 32], "The": [0, 1, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28, 32], "creation": 0, "file": [0, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 28], "i": [0, 1, 8, 11, 12, 14, 16, 17, 19, 22, 23, 26, 29, 30, 31, 32], "we": 0, "util": [0, 29, 32], "rarfil": 0, "librari": [0, 24], "which": [0, 14, 30, 31, 32], "doe": [0, 14], "offer": 0, "function": [0, 5, 14, 16, 17, 23, 24, 27], "creat": [0, 16], "str": [0, 1, 5, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28], "ext": 0, "list": [0, 5, 10, 14, 18, 19, 21], "fn_pack": 0, "callabl": [0, 5], "fn_unpack": 0, "sourc": [0, 1, 5, 7, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "regist": 0, "custom": [0, 5, 8, 12], "type": [0, 1, 5, 10, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "associ": 0, "paramet": [0, 1, 5, 7, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "A": [0, 18], "take": 0, "directori": [0, 1, 10, 16, 17, 19, 21, 28], "an": [0, 14, 16, 17, 19, 21, 24, 27, 28], "filenam": [0, 24, 26], "input": 0, "extract": [0, 19], "type_nam": 0, "archive_fil": 0, "silent": [0, 16, 19, 21, 24, 27], "bool": [0, 7, 14, 16, 17, 19, 21, 22, 23, 24, 27], "fals": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "clear": [0, 21], "specifi": [0, 1, 17, 21, 24], "result": 0, "true": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "suppress": [0, 16, 19, 21, 24], "warn": [0, 5], "dure": 0, "process": 0, "remov": [0, 21], "exist": [0, 14, 19], "when": [0, 11, 14, 16, 19], "return": [0, 5, 14, 16, 17, 18, 22, 23, 24, 26, 27, 28], "path": [0, 8, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 25, 28, 29], "password": [0, 19], "none": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26], "content": [0, 27], "option": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26, 27], "determin": 0, "base": [0, 9, 10, 17, 20, 29], "rais": [0, 11, 14, 17, 26], "valueerror": [0, 26], "ani": [0, 1, 7, 23, 26], "get": [0, 14, 16, 18, 24, 26], "repo_id": [1, 14, 16, 17, 18, 19, 21, 22, 26], "repo_typ": [1, 14, 16, 17, 18, 19, 21, 22, 26], "cache_dir": 1, "all": [1, 14, 19, 28], "detach": 1, "revis": [1, 14, 16, 17, 18, 19, 21, 22, 26], "from": [1, 5, 14, 16, 17, 18, 19, 24, 30, 31, 32], "match": [1, 14, 17, 22], "repositori": [1, 8, 12, 14, 16, 17, 18, 19, 21, 22, 26], "id": [1, 17, 26], "where": [1, 17, 24], "store": [1, 17], "default": [1, 16, 17, 19, 22, 26], "huggingfac": [2, 17, 18, 19, 21, 26, 29, 32], "local": [2, 11, 14, 16, 19, 21, 22, 24, 30, 31], "can": [2, 14, 17, 32], "quickli": 2, "make": [2, 15, 17, 29], "disk": 2, "space": [2, 14, 16, 17, 18, 19, 21, 22, 26], "under": [2, 32], "control": 2, "delet": [2, 29], "delete_detached_cach": 2, "delete_cach": 2, "meta": [3, 14, 29, 32], "__title__": [3, 32], "__version__": [3, 32], "__description__": [3, 32], "__author__": [3, 32], "__author_email__": 3, "inform": [4, 5, 7, 14, 16, 17], "packag": 4, "titl": 4, "thi": [4, 5, 8, 12, 14, 16, 17, 23, 24, 26, 27, 30, 31], "project": 4, "should": [4, 24, 32], "version": [4, 7, 27, 32], "short": 4, "descript": [4, 24], "includ": [4, 5, 14, 16], "setup": 4, "py": 4, "author": 4, "email": 4, "help_option_nam": 5, "h": 5, "help": 5, "dict": [5, 14, 16], "new": 5, "empti": 5, "dictionari": [5, 14], "map": 5, "initi": 5, "object": [5, 10, 14, 18, 19, 21, 24], "": [5, 7, 14], "kei": [5, 14], "valu": [5, 7, 10, 16], "pair": 5, "iter": [5, 28], "via": 5, "d": 5, "k": 5, "v": 5, "kwarg": [5, 7, 24, 27], "keyword": [5, 24, 27], "argument": [5, 14, 24, 27], "For": 5, "exampl": [5, 14], "one": 5, "1": [5, 10, 16, 17, 30, 31], "two": 5, "2": [5, 10, 32], "class": [5, 8, 10, 11, 12, 14, 26], "messag": [5, 8, 11, 12, 16, 21], "except": [5, 8, 11, 12, 14], "displai": [5, 8, 12, 24, 27], "yellow": 5, "color": 5, "error": [5, 8, 12], "exit_cod": [5, 8, 12], "exit": [5, 8, 12], "show": [5, 8, 12], "io": [5, 8, 12, 32], "write": [5, 8, 12], "output": [5, 8, 12, 19, 21, 24, 27, 32], "red": [5, 8, 12], "err": 5, "baseexcept": 5, "print": [5, 7, 30, 31, 32], "traceback": 5, "provid": [5, 24], "built": 5, "msg": 5, "handl": 5, "keyboard": 5, "interrupt": 5, "__init__": 5, "7": 5, "decor": 5, "wrap": 5, "click": [5, 7], "command": [5, 32], "catch": 5, "consist": 5, "group": 6, "hfutilcli": [6, 9], "ctx": 7, "context": 7, "param": 7, "cli": [7, 9, 29], "current": [7, 30, 31, 32], "metadata": 7, "arg": [7, 27], "indic": [8, 12], "remot": [8, 12], "assign": [8, 12, 14, 18, 19, 21], "17": 8, "context_set": 9, "clickwarningexcept": 9, "clickerrorexcept": 9, "print_except": 9, "keyboardinterrupt": 9, "command_wrap": 9, "dispatch": [9, 29], "print_vers": 9, "download": [9, 14, 17, 20, 25, 29], "noremotepathassignedwithdownload": 9, "l": [9, 29], "listitemtyp": 9, "listitem": 9, "ls_repo": [9, 29], "nolocalauthent": 9, "upload": [9, 16, 20, 29], "noremotepathassignedwithupload": 9, "whoami": [9, 29], "enum": 10, "repres": [10, 14], "differ": [10, 14, 30, 31], "item": [10, 17], "valid": [10, 15, 20, 29], "ar": [10, 14], "folder": 10, "imag": [10, 14], "3": [10, 30, 31, 32], "archiv": [10, 14, 16, 17, 19, 21, 29], "4": [10, 30, 31], "model": [10, 14, 16, 17, 18, 19, 21, 22, 26], "5": [10, 19, 30, 31], "data": [10, 14, 30, 31], "6": [10, 30, 31], "repofold": 10, "repofil": [10, 17], "base_dir": 10, "union": [10, 14], "authent": [11, 17], "token": [11, 14, 16, 17, 18, 19, 21, 22], "33": 12, "standalon": 14, "incomplet": 14, "hash": [14, 16, 17, 18, 19, 21], "archive_in_repo": [14, 16, 17, 21], "liter": [14, 16, 17, 18, 19, 21, 22, 26], "dataset": [14, 16, 17, 18, 19, 21, 22, 26], "main": [14, 16, 17, 18, 19, 21, 22, 32], "idx_repo_id": [14, 16, 17], "idx_file_in_repo": [14, 16, 17], "idx_repo_typ": [14, 16, 17], "idx_revis": [14, 16, 17], "hf_token": [14, 16, 17, 18, 19, 21, 22], "hug": [14, 16, 17, 18, 19, 21, 22], "face": [14, 16, 17, 18, 19, 21, 22], "identifi": [14, 16, 18, 19, 21, 22], "repotypetyp": [14, 16, 17, 18, 19, 21, 22, 26], "access": [14, 16], "import": [14, 30, 31, 32], "idx": 14, "deepgh": [14, 32], "danbooru_newest": 14, "0000": 14, "dict_kei": 14, "files": 14, "hash_lf": [14, 17], "7507000": 14, "jpg": 14, "7506000": 14, "7505000": 14, "besid": 14, "also": [14, 24, 32], "explicitli": 14, "nyanko7": 14, "danbooru2023": 14, "danbooru2023_index": 14, "origin": 14, "1000": 14, "png": 14, "10000": 14, "100000": 14, "insid": 14, "file_in_arch": 14, "check": [14, 17, 22, 23, 24, 32], "otherwis": [14, 17, 22, 24], "17506000": 14, "10000000001000": 14, "int": [14, 16, 17, 19, 24], "size": [14, 16, 17, 24, 30, 31], "integ": 14, "filenotfounderror": 14, "435671": 14, "11966": 14, "detail": 14, "offset": 14, "sha256": 14, "265728": 14, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 14, "1024": [14, 23], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 14, "local_fil": [14, 19, 21, 22], "proxi": 14, "user_ag": 14, "header": 14, "endpoint": 14, "save": [14, 16, 19, 24], "http": [14, 32], "request": [14, 24], "user": 14, "agent": 14, "addit": [14, 24, 27], "api": [14, 17, 18, 19, 21, 22], "test_exampl": 14, "destin": 14, "given": [14, 18, 23, 24, 26], "fetch": [15, 29], "archivestandalonefileincompletedownload": 15, "archivestandalonefilehashnotmatch": 15, "hf_tar_get_index": 15, "hf_tar_list_fil": 15, "hf_tar_file_exist": 15, "hf_tar_file_s": 15, "hf_tar_file_info": 15, "hf_tar_file_download": 15, "tar_create_index": 15, "hf_tar_create_index": [15, 17], "tar_get_index_info": 15, "hf_tar_create_from_directori": 15, "hf_tar_item_valid": 15, "hf_tar_valid": 15, "src_tar_fil": 16, "dst_index_fil": 16, "chunk_for_hash": 16, "1048576": 16, "with_hash": 16, "chunk": 16, "20": 16, "mb": 16, "whether": 16, "progress": [16, 19, 21, 24, 27], "bar": [16, 19, 21, 24, 27], "log": 16, "skip_when_sync": 16, "skip": 16, "sync": 16, "readi": [16, 22], "directli": 16, "json": [16, 17], "local_directori": [16, 19, 21], "file_item": 17, "hash_": 17, "expect": [17, 24], "sha": 17, "256": 17, "lf": 17, "entrynotfounderror": 17, "entri": [17, 29], "found": 17, "isadirectoryerror": 17, "mean": [17, 32], "expir": 17, "need": 17, "re": 17, "gener": 17, "so": 17, "togeth": 17, "gracefulli": 17, "refresh": 17, "hfapi": 18, "client": [18, 19, 21], "variabl": [18, 19, 21], "hffilesystem": 18, "system": 18, "subdir": 18, "ignore_pattern": [18, 19, 21], "subdirectori": 18, "e": [18, 19, 21], "g": [18, 19, 21], "branch": [18, 19, 21], "tag": [18, 19, 21], "commit": [18, 19, 21], "pattern": [18, 19, 21], "ignor": [18, 19, 21], "file_in_repo": [19, 21, 22], "resume_download": 19, "within": [19, 21], "resum": 19, "dir_in_repo": 19, "max_work": 19, "8": [19, 30, 31, 32], "max_retri": 19, "max": 19, "worker": 19, "retri": 19, "time": 19, "get_hf_client": 20, "get_hf_f": 20, "list_files_in_repositori": 20, "download_file_to_fil": 20, "download_archive_as_directori": 20, "download_directory_as_directori": 20, "upload_file_to_fil": 20, "upload_directory_as_arch": 20, "upload_directory_as_directori": 20, "is_local_file_readi": 20, "path_in_repo": 21, "time_suffix": 21, "its": 21, "append": 21, "timestamp": 21, "present": 21, "compar": 22, "hub": 22, "read": 23, "first": 23, "byte": [23, 24], "contain": 23, "non": 23, "text": 23, "charact": 23, "url": 24, "expected_s": 24, "desc": 24, "session": 24, "tqdm": [24, 25, 29], "It": [24, 32], "perform": [24, 30, 31], "ensur": 24, "ha": [24, 30, 31], "pass": [24, 27], "binari": [25, 29], "is_binary_fil": 25, "download_fil": 25, "hf_normpath": 25, "hf_fs_path": 25, "parse_hf_fs_path": 25, "hffilesystempath": 25, "walk": [25, 29], "walk_fil": 25, "normal": 26, "filesystem": 26, "pars": 26, "invalid": 26, "tqdm_": 27, "enhanc": 27, "silenc": 27, "modifi": 27, "behavior": 27, "allow": 27, "posit": 27, "std": 27, "recurs": 28, "through": [28, 32], "yield": 28, "rel": 28, "root": 28, "start": [28, 29], "modul": 29, "quick": 29, "run": 29, "environ": 29, "register_archive_typ": 29, "archive_pack": 29, "archive_unpack": 29, "get_archive_typ": 29, "get_archive_extnam": 29, "cach": 29, "config": [29, 32], "index": [29, 32], "oper": 29, "here": [30, 31], "o": [30, 31], "platform": [30, 31], "shutil": [30, 31], "cpuinfo": [30, 31], "psutil": [30, 31], "hbutil": [30, 31], "scale": [30, 31], "size_to_bytes_str": [30, 31], "python": [30, 31, 32], "python_implement": [30, 31], "python_vers": [30, 31], "cpu": [30, 31], "brand": [30, 31], "get_cpu_info": [30, 31], "brand_raw": [30, 31], "count": [30, 31], "cpu_count": [30, 31], "freq": [30, 31], "cpu_freq": [30, 31], "mhz": [30, 31], "memori": [30, 31], "virtual_memori": [30, 31], "total": [30, 31], "precis": [30, 31], "cuda": [30, 31], "ye": [30, 31], "nvidia": [30, 31], "smi": [30, 31], "els": [30, 31], "No": [30, 31], "linux": [30, 31], "0": [30, 31, 32], "1023": [30, 31], "azur": [30, 31], "x86_64": [30, 31], "glibc2": [30, 31], "34": [30, 31], "cpython": [30, 31], "18": [30, 31], "amd": [30, 31], "epyc": [30, 31], "7763": [30, 31], "64": [30, 31], "core": [30, 31], "processor": [30, 31], "2911": 30, "1995": 30, "15": [30, 31], "606": [30, 31], "gib": [30, 31], "pleas": [30, 31], "note": [30, 31], "deploi": [30, 31], "document": [30, 31, 32], "automat": [30, 31], "execut": [30, 31], "github": [30, 31, 32], "action": [30, 31], "therefor": [30, 31], "some": [30, 31], "mai": [30, 31], "your": [30, 31, 32], "2943": 31, "10775": 31, "hfutil": 32, "host": 32, "pypi": 32, "newest": 32, "u": 32, "git": 32, "com": 32, "script": 32, "__name__": 32, "__main__": 32, "develop": 32, "maintain": 32, "like": 32, "below": 32, "success": 32, "11": 32, "narugo1992": 32, "still": 32, "out": 32, "stabl": 32, "html": 32, "faq": 33}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [2, 0, 0, "-", "cache"], [3, 0, 0, "-", "config"], [9, 0, 0, "-", "entry"], [15, 0, 0, "-", "index"], [20, 0, 0, "-", "operate"], [25, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.cache": [[1, 0, 0, "-", "delete"]], "hfutils.cache.delete": [[1, 1, 1, "", "delete_cache"], [1, 1, 1, "", "delete_detached_cache"]], "hfutils.config": [[4, 0, 0, "-", "meta"]], "hfutils.config.meta": [[4, 2, 1, "", "__AUTHOR_EMAIL__"], [4, 2, 1, "", "__AUTHOR__"], [4, 2, 1, "", "__DESCRIPTION__"], [4, 2, 1, "", "__TITLE__"], [4, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[5, 0, 0, "-", "base"], [6, 0, 0, "-", "cli"], [7, 0, 0, "-", "dispatch"], [8, 0, 0, "-", "download"], [10, 0, 0, "-", "ls"], [11, 0, 0, "-", "ls_repo"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[5, 2, 1, "", "CONTEXT_SETTINGS"], [5, 3, 1, "", "ClickErrorException"], [5, 3, 1, "", "ClickWarningException"], [5, 3, 1, "", "KeyboardInterrupted"], [5, 1, 1, "", "command_wrap"], [5, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[5, 5, 1, "", "__init__"], [5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.cli": [[6, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[7, 1, 1, "", "hfutilcli"], [7, 1, 1, "", "print_version"]], "hfutils.entry.download": [[8, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.entry.ls": [[10, 3, 1, "", "ListItem"], [10, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[10, 4, 1, "", "ARCHIVE"], [10, 4, 1, "", "DATA"], [10, 4, 1, "", "FILE"], [10, 4, 1, "", "FOLDER"], [10, 4, 1, "", "IMAGE"], [10, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[11, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[12, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[12, 4, 1, "", "exit_code"], [12, 5, 1, "", "show"]], "hfutils.index": [[14, 0, 0, "-", "fetch"], [16, 0, 0, "-", "make"], [17, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[14, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [14, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [14, 1, 1, "", "hf_tar_file_download"], [14, 1, 1, "", "hf_tar_file_exists"], [14, 1, 1, "", "hf_tar_file_info"], [14, 1, 1, "", "hf_tar_file_size"], [14, 1, 1, "", "hf_tar_get_index"], [14, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[16, 1, 1, "", "hf_tar_create_from_directory"], [16, 1, 1, "", "hf_tar_create_index"], [16, 1, 1, "", "tar_create_index"], [16, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[17, 1, 1, "", "hf_tar_item_validate"], [17, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[18, 0, 0, "-", "base"], [19, 0, 0, "-", "download"], [21, 0, 0, "-", "upload"], [22, 0, 0, "-", "validate"]], "hfutils.operate.base": [[18, 1, 1, "", "get_hf_client"], [18, 1, 1, "", "get_hf_fs"], [18, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[19, 1, 1, "", "download_archive_as_directory"], [19, 1, 1, "", "download_directory_as_directory"], [19, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[21, 1, 1, "", "upload_directory_as_archive"], [21, 1, 1, "", "upload_directory_as_directory"], [21, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[22, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[23, 0, 0, "-", "binary"], [24, 0, 0, "-", "download"], [26, 0, 0, "-", "path"], [27, 0, 0, "-", "tqdm_"], [28, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[23, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[24, 1, 1, "", "download_file"]], "hfutils.utils.path": [[26, 3, 1, "", "HfFileSystemPath"], [26, 1, 1, "", "hf_fs_path"], [26, 1, 1, "", "hf_normpath"], [26, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[28, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "cach": [1, 2], "delet": 1, "delete_detached_cach": 1, "delete_cach": 1, "config": [3, 4], "meta": 4, "__title__": 4, "__version__": 4, "__description__": 4, "__author__": 4, "__author_email__": 4, "entri": [5, 6, 7, 8, 9, 10, 11, 12, 13], "base": [5, 18], "context_set": 5, "clickwarningexcept": 5, "clickerrorexcept": 5, "print_except": 5, "keyboardinterrupt": 5, "command_wrap": 5, "cli": 6, "dispatch": 7, "print_vers": 7, "hfutilcli": 7, "download": [8, 19, 24], "noremotepathassignedwithdownload": 8, "l": 10, "listitemtyp": 10, "listitem": 10, "ls_repo": 11, "nolocalauthent": 11, "upload": [12, 21], "noremotepathassignedwithupload": 12, "whoami": 13, "index": [14, 15, 16, 17], "fetch": 14, "archivestandalonefileincompletedownload": 14, "archivestandalonefilehashnotmatch": 14, "hf_tar_get_index": 14, "hf_tar_list_fil": 14, "hf_tar_file_exist": 14, "hf_tar_file_s": 14, "hf_tar_file_info": 14, "hf_tar_file_download": 14, "make": 16, "tar_create_index": 16, "hf_tar_create_index": 16, "tar_get_index_info": 16, "hf_tar_create_from_directori": 16, "valid": [17, 22], "hf_tar_item_valid": 17, "hf_tar_valid": 17, "oper": [18, 19, 20, 21, 22], "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 19, "download_archive_as_directori": 19, "download_directory_as_directori": 19, "upload_file_to_fil": 21, "upload_directory_as_arch": 21, "upload_directory_as_directori": 21, "is_local_file_readi": 22, "util": [23, 24, 25, 26, 27, 28], "binari": 23, "is_binary_fil": 23, "download_fil": 24, "path": 26, "hf_normpath": 26, "hf_fs_path": 26, "parse_hf_fs_path": 26, "hffilesystempath": 26, "tqdm": 27, "walk": 28, "walk_fil": 28, "welcom": 29, "": 29, "document": 29, "overview": 29, "tutori": 29, "inform": [29, 30, 31], "api": 29, "run": [30, 31], "environ": [30, 31], "instal": 32, "quick": 33, "start": 33}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "delete_detached_cache": [[1, "delete-detached-cache"]], "delete_cache": [[1, "delete-cache"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "__TITLE__": [[4, "title"]], "__VERSION__": [[4, "version"]], "__DESCRIPTION__": [[4, "description"]], "__AUTHOR__": [[4, "author"]], "__AUTHOR_EMAIL__": [[4, "author-email"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[5, "context-settings"]], "ClickWarningException": [[5, "clickwarningexception"]], "ClickErrorException": [[5, "clickerrorexception"]], "print_exception": [[5, "print-exception"]], "KeyboardInterrupted": [[5, "keyboardinterrupted"]], "command_wrap": [[5, "command-wrap"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "cli": [[6, "cli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version": [[7, "print-version"]], "hfutilcli": [[7, "hfutilcli"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[8, "noremotepathassignedwithdownload"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "ListItemType": [[10, "listitemtype"]], "ListItem": [[10, "listitem"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[11, "nolocalauthentication"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[12, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[14, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[14, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[14, "hf-tar-get-index"]], "hf_tar_list_files": [[14, "hf-tar-list-files"]], "hf_tar_file_exists": [[14, "hf-tar-file-exists"]], "hf_tar_file_size": [[14, "hf-tar-file-size"]], "hf_tar_file_info": [[14, "hf-tar-file-info"]], "hf_tar_file_download": [[14, "hf-tar-file-download"]], "hfutils.index": [[15, "module-hfutils.index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index": [[16, "tar-create-index"]], "hf_tar_create_index": [[16, "hf-tar-create-index"]], "tar_get_index_info": [[16, "tar-get-index-info"]], "hf_tar_create_from_directory": [[16, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[17, "hf-tar-item-validate"]], "hf_tar_validate": [[17, "hf-tar-validate"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "get_hf_client": [[18, "get-hf-client"]], "get_hf_fs": [[18, "get-hf-fs"]], "list_files_in_repository": [[18, "list-files-in-repository"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "download_file_to_file": [[19, "download-file-to-file"]], "download_archive_as_directory": [[19, "download-archive-as-directory"]], "download_directory_as_directory": [[19, "download-directory-as-directory"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_file_to_file": [[21, "upload-file-to-file"]], "upload_directory_as_archive": [[21, "upload-directory-as-archive"]], "upload_directory_as_directory": [[21, "upload-directory-as-directory"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready": [[22, "is-local-file-ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file": [[23, "is-binary-file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "download_file": [[24, "download-file"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "hf_normpath": [[26, "hf-normpath"]], "hf_fs_path": [[26, "hf-fs-path"]], "parse_hf_fs_path": [[26, "parse-hf-fs-path"]], "HfFileSystemPath": [[26, "hffilesystempath"]], "hfutils.utils.tqdm": [[27, "module-hfutils.utils.tqdm_"]], "tqdm": [[27, "tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files": [[28, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[29, "welcome-to-hfutils-s-documentation"]], "Overview": [[29, "overview"]], "Tutorials": [[29, null]], "Information": [[29, null]], "API Documentation": [[29, null]], "Run Environment Information": [[30, "Run-Environment-Information"], [31, "Run-Environment-Information"]], "Installation": [[32, "installation"]], "Quick Start": [[33, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.cache.delete"], [2, "module-hfutils.cache"], [3, "module-hfutils.config"], [4, "module-hfutils.config.meta"], [5, "module-hfutils.entry.base"], [6, "module-hfutils.entry.cli"], [7, "module-hfutils.entry.dispatch"], [8, "module-hfutils.entry.download"], [9, "module-hfutils.entry"], [10, "module-hfutils.entry.ls"], [11, "module-hfutils.entry.ls_repo"], [12, "module-hfutils.entry.upload"], [13, "module-hfutils.entry.whoami"], [14, "module-hfutils.index.fetch"], [15, "module-hfutils.index"], [16, "module-hfutils.index.make"], [17, "module-hfutils.index.validate"], [18, "module-hfutils.operate.base"], [19, "module-hfutils.operate.download"], [20, "module-hfutils.operate"], [21, "module-hfutils.operate.upload"], [22, "module-hfutils.operate.validate"], [23, "module-hfutils.utils.binary"], [24, "module-hfutils.utils.download"], [25, "module-hfutils.utils"], [26, "module-hfutils.utils.path"], [27, "module-hfutils.utils.tqdm_"], [28, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "delete_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_cache"]], "delete_detached_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_detached_cache"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[5, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[5, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[5, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[5, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[5, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[5, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[5, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[6, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[10, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[11, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "hfutils.index": [[15, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[22, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[23, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[24, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[26, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[27, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[28, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/cache/delete", "api_doc/cache/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/cache/delete.rst", "api_doc/cache/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.cache.delete", "hfutils.cache", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2, 4], "pack": 0, "unpack": 0, "manag": [0, 2], "support": 0, "format": 0, "extens": 0, "name": [0, 5], "7z": 0, "bztar": 0, "tar": [0, 14, 16, 17], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 1, 5, 17, 19, 21, 24, 26, 27], "you": [0, 14, 32], "requir": [0, 32], "simpli": [0, 32], "instal": [0, 29], "us": [0, 1, 5, 14, 16, 17, 18, 19, 21, 24, 29, 32], "follow": [0, 10, 32], "code": [0, 5, 8, 12], "pip": [0, 32], "The": [0, 1, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28, 32], "creation": 0, "file": [0, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 28], "i": [0, 1, 8, 11, 12, 14, 16, 17, 19, 22, 23, 26, 29, 30, 31, 32], "we": 0, "util": [0, 29, 32], "rarfil": 0, "librari": [0, 24], "which": [0, 14, 30, 31, 32], "doe": [0, 14], "offer": 0, "function": [0, 5, 14, 16, 17, 23, 24, 27], "creat": [0, 16], "str": [0, 1, 5, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28], "ext": 0, "list": [0, 5, 10, 14, 18, 19, 21], "fn_pack": 0, "callabl": [0, 5], "fn_unpack": 0, "sourc": [0, 1, 5, 7, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "regist": 0, "custom": [0, 5, 8, 12], "type": [0, 1, 5, 10, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "associ": 0, "paramet": [0, 1, 5, 7, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "A": [0, 18], "take": 0, "directori": [0, 1, 10, 16, 17, 19, 21, 28], "an": [0, 14, 16, 17, 19, 21, 24, 27, 28], "filenam": [0, 24, 26], "input": 0, "extract": [0, 19], "type_nam": 0, "archive_fil": 0, "silent": [0, 16, 19, 21, 24, 27], "bool": [0, 7, 14, 16, 17, 19, 21, 22, 23, 24, 27], "fals": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "clear": [0, 21], "specifi": [0, 1, 17, 21, 24], "result": 0, "true": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "suppress": [0, 16, 19, 21, 24], "warn": [0, 5], "dure": 0, "process": 0, "remov": [0, 21], "exist": [0, 14, 19], "when": [0, 11, 14, 16, 19], "return": [0, 5, 14, 16, 17, 18, 22, 23, 24, 26, 27, 28], "path": [0, 8, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 25, 28, 29], "password": [0, 19], "none": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26], "content": [0, 27], "option": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26, 27], "determin": 0, "base": [0, 9, 10, 17, 20, 29], "rais": [0, 11, 14, 17, 26], "valueerror": [0, 26], "ani": [0, 1, 7, 23, 26], "get": [0, 14, 16, 18, 24, 26], "repo_id": [1, 14, 16, 17, 18, 19, 21, 22, 26], "repo_typ": [1, 14, 16, 17, 18, 19, 21, 22, 26], "cache_dir": 1, "all": [1, 14, 19, 28], "detach": 1, "revis": [1, 14, 16, 17, 18, 19, 21, 22, 26], "from": [1, 5, 14, 16, 17, 18, 19, 24, 30, 31, 32], "match": [1, 14, 17, 22], "repositori": [1, 8, 12, 14, 16, 17, 18, 19, 21, 22, 26], "id": [1, 17, 26], "where": [1, 17, 24], "store": [1, 17], "default": [1, 16, 17, 19, 22, 26], "huggingfac": [2, 17, 18, 19, 21, 26, 29, 32], "local": [2, 11, 14, 16, 19, 21, 22, 24, 30, 31], "can": [2, 14, 17, 32], "quickli": 2, "make": [2, 15, 17, 29], "disk": 2, "space": [2, 14, 16, 17, 18, 19, 21, 22, 26], "under": [2, 32], "control": 2, "delet": [2, 29], "delete_detached_cach": 2, "delete_cach": 2, "meta": [3, 14, 29, 32], "__title__": [3, 32], "__version__": [3, 32], "__description__": [3, 32], "__author__": [3, 32], "__author_email__": 3, "inform": [4, 5, 7, 14, 16, 17], "packag": 4, "titl": 4, "thi": [4, 5, 8, 12, 14, 16, 17, 23, 24, 26, 27, 30, 31], "project": 4, "should": [4, 24, 32], "version": [4, 7, 27, 32], "short": 4, "descript": [4, 24], "includ": [4, 5, 14, 16], "setup": 4, "py": 4, "author": 4, "email": 4, "help_option_nam": 5, "h": 5, "help": 5, "dict": [5, 14, 16], "new": 5, "empti": 5, "dictionari": [5, 14], "map": 5, "initi": 5, "object": [5, 10, 14, 18, 19, 21, 24], "": [5, 7, 14], "kei": [5, 14], "valu": [5, 7, 10, 16], "pair": 5, "iter": [5, 28], "via": 5, "d": 5, "k": 5, "v": 5, "kwarg": [5, 7, 24, 27], "keyword": [5, 24, 27], "argument": [5, 14, 24, 27], "For": 5, "exampl": [5, 14], "one": 5, "1": [5, 10, 16, 17, 30, 31], "two": 5, "2": [5, 10, 32], "class": [5, 8, 10, 11, 12, 14, 26], "messag": [5, 8, 11, 12, 16, 21], "except": [5, 8, 11, 12, 14], "displai": [5, 8, 12, 24, 27], "yellow": 5, "color": 5, "error": [5, 8, 12], "exit_cod": [5, 8, 12], "exit": [5, 8, 12], "show": [5, 8, 12], "io": [5, 8, 12, 32], "write": [5, 8, 12], "output": [5, 8, 12, 19, 21, 24, 27, 32], "red": [5, 8, 12], "err": 5, "baseexcept": 5, "print": [5, 7, 30, 31, 32], "traceback": 5, "provid": [5, 24], "built": 5, "msg": 5, "handl": 5, "keyboard": 5, "interrupt": 5, "__init__": 5, "7": 5, "decor": 5, "wrap": 5, "click": [5, 7], "command": [5, 32], "catch": 5, "consist": 5, "group": 6, "hfutilcli": [6, 9], "ctx": 7, "context": 7, "param": 7, "cli": [7, 9, 29], "current": [7, 30, 31, 32], "metadata": 7, "arg": [7, 27], "indic": [8, 12], "remot": [8, 12], "assign": [8, 12, 14, 18, 19, 21], "17": 8, "context_set": 9, "clickwarningexcept": 9, "clickerrorexcept": 9, "print_except": 9, "keyboardinterrupt": 9, "command_wrap": 9, "dispatch": [9, 29], "print_vers": 9, "download": [9, 14, 17, 20, 25, 29], "noremotepathassignedwithdownload": 9, "l": [9, 29], "listitemtyp": 9, "listitem": 9, "ls_repo": [9, 29], "nolocalauthent": 9, "upload": [9, 16, 20, 29], "noremotepathassignedwithupload": 9, "whoami": [9, 29], "enum": 10, "repres": [10, 14], "differ": [10, 14, 30, 31], "item": [10, 17], "valid": [10, 15, 20, 29], "ar": [10, 14], "folder": 10, "imag": [10, 14], "3": [10, 30, 31, 32], "archiv": [10, 14, 16, 17, 19, 21, 29], "4": [10, 30, 31], "model": [10, 14, 16, 17, 18, 19, 21, 22, 26], "5": [10, 19, 30, 31], "data": [10, 14, 30, 31], "6": [10, 30, 31], "repofold": 10, "repofil": [10, 17], "base_dir": 10, "union": [10, 14], "authent": [11, 17], "token": [11, 14, 16, 17, 18, 19, 21, 22], "33": 12, "standalon": 14, "incomplet": 14, "hash": [14, 16, 17, 18, 19, 21], "archive_in_repo": [14, 16, 17, 21], "liter": [14, 16, 17, 18, 19, 21, 22, 26], "dataset": [14, 16, 17, 18, 19, 21, 22, 26], "main": [14, 16, 17, 18, 19, 21, 22, 32], "idx_repo_id": [14, 16, 17], "idx_file_in_repo": [14, 16, 17], "idx_repo_typ": [14, 16, 17], "idx_revis": [14, 16, 17], "hf_token": [14, 16, 17, 18, 19, 21, 22], "hug": [14, 16, 17, 18, 19, 21, 22], "face": [14, 16, 17, 18, 19, 21, 22], "identifi": [14, 16, 18, 19, 21, 22], "repotypetyp": [14, 16, 17, 18, 19, 21, 22, 26], "access": [14, 16], "import": [14, 30, 31, 32], "idx": 14, "deepgh": [14, 32], "danbooru_newest": 14, "0000": 14, "dict_kei": 14, "files": 14, "hash_lf": [14, 17], "7507000": 14, "jpg": 14, "7506000": 14, "7505000": 14, "besid": 14, "also": [14, 24, 32], "explicitli": 14, "nyanko7": 14, "danbooru2023": 14, "danbooru2023_index": 14, "origin": 14, "1000": 14, "png": 14, "10000": 14, "100000": 14, "insid": 14, "file_in_arch": 14, "check": [14, 17, 22, 23, 24, 32], "otherwis": [14, 17, 22, 24], "17506000": 14, "10000000001000": 14, "int": [14, 16, 17, 19, 24], "size": [14, 16, 17, 24, 30, 31], "integ": 14, "filenotfounderror": 14, "435671": 14, "11966": 14, "detail": 14, "offset": 14, "sha256": 14, "265728": 14, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 14, "1024": [14, 23, 30, 31], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 14, "local_fil": [14, 19, 21, 22], "proxi": 14, "user_ag": 14, "header": 14, "endpoint": 14, "save": [14, 16, 19, 24], "http": [14, 32], "request": [14, 24], "user": 14, "agent": 14, "addit": [14, 24, 27], "api": [14, 17, 18, 19, 21, 22], "test_exampl": 14, "destin": 14, "given": [14, 18, 23, 24, 26], "fetch": [15, 29], "archivestandalonefileincompletedownload": 15, "archivestandalonefilehashnotmatch": 15, "hf_tar_get_index": 15, "hf_tar_list_fil": 15, "hf_tar_file_exist": 15, "hf_tar_file_s": 15, "hf_tar_file_info": 15, "hf_tar_file_download": 15, "tar_create_index": 15, "hf_tar_create_index": [15, 17], "tar_get_index_info": 15, "hf_tar_create_from_directori": 15, "hf_tar_item_valid": 15, "hf_tar_valid": 15, "src_tar_fil": 16, "dst_index_fil": 16, "chunk_for_hash": 16, "1048576": 16, "with_hash": 16, "chunk": 16, "20": 16, "mb": 16, "whether": 16, "progress": [16, 19, 21, 24, 27], "bar": [16, 19, 21, 24, 27], "log": 16, "skip_when_sync": 16, "skip": 16, "sync": 16, "readi": [16, 22], "directli": 16, "json": [16, 17], "local_directori": [16, 19, 21], "file_item": 17, "hash_": 17, "expect": [17, 24], "sha": 17, "256": 17, "lf": 17, "entrynotfounderror": 17, "entri": [17, 29], "found": 17, "isadirectoryerror": 17, "mean": [17, 32], "expir": 17, "need": 17, "re": 17, "gener": 17, "so": 17, "togeth": 17, "gracefulli": 17, "refresh": 17, "hfapi": 18, "client": [18, 19, 21], "variabl": [18, 19, 21], "hffilesystem": 18, "system": 18, "subdir": 18, "ignore_pattern": [18, 19, 21], "subdirectori": 18, "e": [18, 19, 21], "g": [18, 19, 21], "branch": [18, 19, 21], "tag": [18, 19, 21], "commit": [18, 19, 21], "pattern": [18, 19, 21], "ignor": [18, 19, 21], "file_in_repo": [19, 21, 22], "resume_download": 19, "within": [19, 21], "resum": 19, "dir_in_repo": 19, "max_work": 19, "8": [19, 30, 31, 32], "max_retri": 19, "max": 19, "worker": 19, "retri": 19, "time": 19, "get_hf_client": 20, "get_hf_f": 20, "list_files_in_repositori": 20, "download_file_to_fil": 20, "download_archive_as_directori": 20, "download_directory_as_directori": 20, "upload_file_to_fil": 20, "upload_directory_as_arch": 20, "upload_directory_as_directori": 20, "is_local_file_readi": 20, "path_in_repo": 21, "time_suffix": 21, "its": 21, "append": 21, "timestamp": 21, "present": 21, "compar": 22, "hub": 22, "read": 23, "first": 23, "byte": [23, 24], "contain": 23, "non": 23, "text": 23, "charact": 23, "url": 24, "expected_s": 24, "desc": 24, "session": 24, "tqdm": [24, 25, 29], "It": [24, 32], "perform": [24, 30, 31], "ensur": 24, "ha": [24, 30, 31], "pass": [24, 27], "binari": [25, 29], "is_binary_fil": 25, "download_fil": 25, "hf_normpath": 25, "hf_fs_path": 25, "parse_hf_fs_path": 25, "hffilesystempath": 25, "walk": [25, 29], "walk_fil": 25, "normal": 26, "filesystem": 26, "pars": 26, "invalid": 26, "tqdm_": 27, "enhanc": 27, "silenc": 27, "modifi": 27, "behavior": 27, "allow": 27, "posit": 27, "std": 27, "recurs": 28, "through": [28, 32], "yield": 28, "rel": 28, "root": 28, "start": [28, 29], "modul": 29, "quick": 29, "run": 29, "environ": 29, "register_archive_typ": 29, "archive_pack": 29, "archive_unpack": 29, "get_archive_typ": 29, "get_archive_extnam": 29, "cach": 29, "config": [29, 32], "index": [29, 32], "oper": 29, "here": [30, 31], "o": [30, 31], "platform": [30, 31], "shutil": [30, 31], "cpuinfo": [30, 31], "psutil": [30, 31], "hbutil": [30, 31], "scale": [30, 31], "size_to_bytes_str": [30, 31], "python": [30, 31, 32], "python_implement": [30, 31], "python_vers": [30, 31], "cpu": [30, 31], "brand": [30, 31], "get_cpu_info": [30, 31], "brand_raw": [30, 31], "count": [30, 31], "cpu_count": [30, 31], "freq": [30, 31], "cpu_freq": [30, 31], "mhz": [30, 31], "memori": [30, 31], "virtual_memori": [30, 31], "total": [30, 31], "precis": [30, 31], "cuda": [30, 31], "ye": [30, 31], "nvidia": [30, 31], "smi": [30, 31], "els": [30, 31], "No": [30, 31], "linux": [30, 31], "0": [30, 31, 32], "azur": [30, 31], "x86_64": [30, 31], "glibc2": [30, 31], "34": [30, 31], "cpython": [30, 31], "18": [30, 31], "amd": [30, 31], "epyc": [30, 31], "7763": [30, 31], "64": [30, 31], "core": [30, 31], "processor": [30, 31], "2926": 30, "77175": 30, "15": [30, 31], "606": [30, 31], "gib": [30, 31], "pleas": [30, 31], "note": [30, 31], "deploi": [30, 31], "document": [30, 31, 32], "automat": [30, 31], "execut": [30, 31], "github": [30, 31, 32], "action": [30, 31], "therefor": [30, 31], "some": [30, 31], "mai": [30, 31], "your": [30, 31, 32], "3168": 31, "1947499999997": 31, "hfutil": 32, "host": 32, "pypi": 32, "newest": 32, "u": 32, "git": 32, "com": 32, "script": 32, "__name__": 32, "__main__": 32, "develop": 32, "maintain": 32, "like": 32, "below": 32, "success": 32, "11": 32, "narugo1992": 32, "still": 32, "out": 32, "stabl": 32, "html": 32, "faq": 33}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [2, 0, 0, "-", "cache"], [3, 0, 0, "-", "config"], [9, 0, 0, "-", "entry"], [15, 0, 0, "-", "index"], [20, 0, 0, "-", "operate"], [25, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.cache": [[1, 0, 0, "-", "delete"]], "hfutils.cache.delete": [[1, 1, 1, "", "delete_cache"], [1, 1, 1, "", "delete_detached_cache"]], "hfutils.config": [[4, 0, 0, "-", "meta"]], "hfutils.config.meta": [[4, 2, 1, "", "__AUTHOR_EMAIL__"], [4, 2, 1, "", "__AUTHOR__"], [4, 2, 1, "", "__DESCRIPTION__"], [4, 2, 1, "", "__TITLE__"], [4, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[5, 0, 0, "-", "base"], [6, 0, 0, "-", "cli"], [7, 0, 0, "-", "dispatch"], [8, 0, 0, "-", "download"], [10, 0, 0, "-", "ls"], [11, 0, 0, "-", "ls_repo"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[5, 2, 1, "", "CONTEXT_SETTINGS"], [5, 3, 1, "", "ClickErrorException"], [5, 3, 1, "", "ClickWarningException"], [5, 3, 1, "", "KeyboardInterrupted"], [5, 1, 1, "", "command_wrap"], [5, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[5, 5, 1, "", "__init__"], [5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.cli": [[6, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[7, 1, 1, "", "hfutilcli"], [7, 1, 1, "", "print_version"]], "hfutils.entry.download": [[8, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.entry.ls": [[10, 3, 1, "", "ListItem"], [10, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[10, 4, 1, "", "ARCHIVE"], [10, 4, 1, "", "DATA"], [10, 4, 1, "", "FILE"], [10, 4, 1, "", "FOLDER"], [10, 4, 1, "", "IMAGE"], [10, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[11, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[12, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[12, 4, 1, "", "exit_code"], [12, 5, 1, "", "show"]], "hfutils.index": [[14, 0, 0, "-", "fetch"], [16, 0, 0, "-", "make"], [17, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[14, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [14, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [14, 1, 1, "", "hf_tar_file_download"], [14, 1, 1, "", "hf_tar_file_exists"], [14, 1, 1, "", "hf_tar_file_info"], [14, 1, 1, "", "hf_tar_file_size"], [14, 1, 1, "", "hf_tar_get_index"], [14, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[16, 1, 1, "", "hf_tar_create_from_directory"], [16, 1, 1, "", "hf_tar_create_index"], [16, 1, 1, "", "tar_create_index"], [16, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[17, 1, 1, "", "hf_tar_item_validate"], [17, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[18, 0, 0, "-", "base"], [19, 0, 0, "-", "download"], [21, 0, 0, "-", "upload"], [22, 0, 0, "-", "validate"]], "hfutils.operate.base": [[18, 1, 1, "", "get_hf_client"], [18, 1, 1, "", "get_hf_fs"], [18, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[19, 1, 1, "", "download_archive_as_directory"], [19, 1, 1, "", "download_directory_as_directory"], [19, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[21, 1, 1, "", "upload_directory_as_archive"], [21, 1, 1, "", "upload_directory_as_directory"], [21, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[22, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[23, 0, 0, "-", "binary"], [24, 0, 0, "-", "download"], [26, 0, 0, "-", "path"], [27, 0, 0, "-", "tqdm_"], [28, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[23, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[24, 1, 1, "", "download_file"]], "hfutils.utils.path": [[26, 3, 1, "", "HfFileSystemPath"], [26, 1, 1, "", "hf_fs_path"], [26, 1, 1, "", "hf_normpath"], [26, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[28, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "cach": [1, 2], "delet": 1, "delete_detached_cach": 1, "delete_cach": 1, "config": [3, 4], "meta": 4, "__title__": 4, "__version__": 4, "__description__": 4, "__author__": 4, "__author_email__": 4, "entri": [5, 6, 7, 8, 9, 10, 11, 12, 13], "base": [5, 18], "context_set": 5, "clickwarningexcept": 5, "clickerrorexcept": 5, "print_except": 5, "keyboardinterrupt": 5, "command_wrap": 5, "cli": 6, "dispatch": 7, "print_vers": 7, "hfutilcli": 7, "download": [8, 19, 24], "noremotepathassignedwithdownload": 8, "l": 10, "listitemtyp": 10, "listitem": 10, "ls_repo": 11, "nolocalauthent": 11, "upload": [12, 21], "noremotepathassignedwithupload": 12, "whoami": 13, "index": [14, 15, 16, 17], "fetch": 14, "archivestandalonefileincompletedownload": 14, "archivestandalonefilehashnotmatch": 14, "hf_tar_get_index": 14, "hf_tar_list_fil": 14, "hf_tar_file_exist": 14, "hf_tar_file_s": 14, "hf_tar_file_info": 14, "hf_tar_file_download": 14, "make": 16, "tar_create_index": 16, "hf_tar_create_index": 16, "tar_get_index_info": 16, "hf_tar_create_from_directori": 16, "valid": [17, 22], "hf_tar_item_valid": 17, "hf_tar_valid": 17, "oper": [18, 19, 20, 21, 22], "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 19, "download_archive_as_directori": 19, "download_directory_as_directori": 19, "upload_file_to_fil": 21, "upload_directory_as_arch": 21, "upload_directory_as_directori": 21, "is_local_file_readi": 22, "util": [23, 24, 25, 26, 27, 28], "binari": 23, "is_binary_fil": 23, "download_fil": 24, "path": 26, "hf_normpath": 26, "hf_fs_path": 26, "parse_hf_fs_path": 26, "hffilesystempath": 26, "tqdm": 27, "walk": 28, "walk_fil": 28, "welcom": 29, "": 29, "document": 29, "overview": 29, "tutori": 29, "inform": [29, 30, 31], "api": 29, "run": [30, 31], "environ": [30, 31], "instal": 32, "quick": 33, "start": 33}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "delete_detached_cache": [[1, "delete-detached-cache"]], "delete_cache": [[1, "delete-cache"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "__TITLE__": [[4, "title"]], "__VERSION__": [[4, "version"]], "__DESCRIPTION__": [[4, "description"]], "__AUTHOR__": [[4, "author"]], "__AUTHOR_EMAIL__": [[4, "author-email"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[5, "context-settings"]], "ClickWarningException": [[5, "clickwarningexception"]], "ClickErrorException": [[5, "clickerrorexception"]], "print_exception": [[5, "print-exception"]], "KeyboardInterrupted": [[5, "keyboardinterrupted"]], "command_wrap": [[5, "command-wrap"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "cli": [[6, "cli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version": [[7, "print-version"]], "hfutilcli": [[7, "hfutilcli"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[8, "noremotepathassignedwithdownload"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "ListItemType": [[10, "listitemtype"]], "ListItem": [[10, "listitem"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[11, "nolocalauthentication"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[12, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[14, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[14, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[14, "hf-tar-get-index"]], "hf_tar_list_files": [[14, "hf-tar-list-files"]], "hf_tar_file_exists": [[14, "hf-tar-file-exists"]], "hf_tar_file_size": [[14, "hf-tar-file-size"]], "hf_tar_file_info": [[14, "hf-tar-file-info"]], "hf_tar_file_download": [[14, "hf-tar-file-download"]], "hfutils.index": [[15, "module-hfutils.index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index": [[16, "tar-create-index"]], "hf_tar_create_index": [[16, "hf-tar-create-index"]], "tar_get_index_info": [[16, "tar-get-index-info"]], "hf_tar_create_from_directory": [[16, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[17, "hf-tar-item-validate"]], "hf_tar_validate": [[17, "hf-tar-validate"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "get_hf_client": [[18, "get-hf-client"]], "get_hf_fs": [[18, "get-hf-fs"]], "list_files_in_repository": [[18, "list-files-in-repository"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "download_file_to_file": [[19, "download-file-to-file"]], "download_archive_as_directory": [[19, "download-archive-as-directory"]], "download_directory_as_directory": [[19, "download-directory-as-directory"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_file_to_file": [[21, "upload-file-to-file"]], "upload_directory_as_archive": [[21, "upload-directory-as-archive"]], "upload_directory_as_directory": [[21, "upload-directory-as-directory"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready": [[22, "is-local-file-ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file": [[23, "is-binary-file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "download_file": [[24, "download-file"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "hf_normpath": [[26, "hf-normpath"]], "hf_fs_path": [[26, "hf-fs-path"]], "parse_hf_fs_path": [[26, "parse-hf-fs-path"]], "HfFileSystemPath": [[26, "hffilesystempath"]], "hfutils.utils.tqdm": [[27, "module-hfutils.utils.tqdm_"]], "tqdm": [[27, "tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files": [[28, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[29, "welcome-to-hfutils-s-documentation"]], "Overview": [[29, "overview"]], "Tutorials": [[29, null]], "Information": [[29, null]], "API Documentation": [[29, null]], "Run Environment Information": [[30, "Run-Environment-Information"], [31, "Run-Environment-Information"]], "Installation": [[32, "installation"]], "Quick Start": [[33, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.cache.delete"], [2, "module-hfutils.cache"], [3, "module-hfutils.config"], [4, "module-hfutils.config.meta"], [5, "module-hfutils.entry.base"], [6, "module-hfutils.entry.cli"], [7, "module-hfutils.entry.dispatch"], [8, "module-hfutils.entry.download"], [9, "module-hfutils.entry"], [10, "module-hfutils.entry.ls"], [11, "module-hfutils.entry.ls_repo"], [12, "module-hfutils.entry.upload"], [13, "module-hfutils.entry.whoami"], [14, "module-hfutils.index.fetch"], [15, "module-hfutils.index"], [16, "module-hfutils.index.make"], [17, "module-hfutils.index.validate"], [18, "module-hfutils.operate.base"], [19, "module-hfutils.operate.download"], [20, "module-hfutils.operate"], [21, "module-hfutils.operate.upload"], [22, "module-hfutils.operate.validate"], [23, "module-hfutils.utils.binary"], [24, "module-hfutils.utils.download"], [25, "module-hfutils.utils"], [26, "module-hfutils.utils.path"], [27, "module-hfutils.utils.tqdm_"], [28, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "delete_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_cache"]], "delete_detached_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_detached_cache"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[5, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[5, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[5, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[5, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[5, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[5, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[5, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[6, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[10, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[11, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "hfutils.index": [[15, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[22, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[23, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[24, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[26, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[27, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[28, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.2.2/.buildinfo b/v0.2.2/.buildinfo
index 05d9d39ff6..bbcd271f1f 100644
--- a/v0.2.2/.buildinfo
+++ b/v0.2.2/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 533330d87ab4950cd6e87ff8ea75cea4
+config: f843870647d3c525c5a3047aa7c1f4f9
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.2.2/.doctrees/api_doc/archive/index.doctree b/v0.2.2/.doctrees/api_doc/archive/index.doctree
index 80cc7cfaf4..d1b939b6fb 100644
Binary files a/v0.2.2/.doctrees/api_doc/archive/index.doctree and b/v0.2.2/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/config/index.doctree b/v0.2.2/.doctrees/api_doc/config/index.doctree
index 26f35646ad..d2b68ea8c1 100644
Binary files a/v0.2.2/.doctrees/api_doc/config/index.doctree and b/v0.2.2/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/config/meta.doctree b/v0.2.2/.doctrees/api_doc/config/meta.doctree
index 7c04a8a04a..a74c0c2401 100644
Binary files a/v0.2.2/.doctrees/api_doc/config/meta.doctree and b/v0.2.2/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/entry/base.doctree b/v0.2.2/.doctrees/api_doc/entry/base.doctree
index fdab4fb5b0..13f5a335cd 100644
Binary files a/v0.2.2/.doctrees/api_doc/entry/base.doctree and b/v0.2.2/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/entry/cli.doctree b/v0.2.2/.doctrees/api_doc/entry/cli.doctree
index 32d9010dd9..f3167b4f6d 100644
Binary files a/v0.2.2/.doctrees/api_doc/entry/cli.doctree and b/v0.2.2/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/entry/dispatch.doctree b/v0.2.2/.doctrees/api_doc/entry/dispatch.doctree
index 39ca65923c..e0f6b0ab8a 100644
Binary files a/v0.2.2/.doctrees/api_doc/entry/dispatch.doctree and b/v0.2.2/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/entry/download.doctree b/v0.2.2/.doctrees/api_doc/entry/download.doctree
index fbbcf380b4..86778d0252 100644
Binary files a/v0.2.2/.doctrees/api_doc/entry/download.doctree and b/v0.2.2/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/entry/index.doctree b/v0.2.2/.doctrees/api_doc/entry/index.doctree
index cf1a57f48f..7bbc5663ba 100644
Binary files a/v0.2.2/.doctrees/api_doc/entry/index.doctree and b/v0.2.2/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/entry/ls.doctree b/v0.2.2/.doctrees/api_doc/entry/ls.doctree
index 20b8cf3ec6..3b9eb621f0 100644
Binary files a/v0.2.2/.doctrees/api_doc/entry/ls.doctree and b/v0.2.2/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/entry/upload.doctree b/v0.2.2/.doctrees/api_doc/entry/upload.doctree
index 2591fa63eb..5ceab49aef 100644
Binary files a/v0.2.2/.doctrees/api_doc/entry/upload.doctree and b/v0.2.2/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/index/fetch.doctree b/v0.2.2/.doctrees/api_doc/index/fetch.doctree
index fc6c2ba144..69200d2ccd 100644
Binary files a/v0.2.2/.doctrees/api_doc/index/fetch.doctree and b/v0.2.2/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/index/index.doctree b/v0.2.2/.doctrees/api_doc/index/index.doctree
index 061bc28fd9..c70a72f958 100644
Binary files a/v0.2.2/.doctrees/api_doc/index/index.doctree and b/v0.2.2/.doctrees/api_doc/index/index.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/index/make.doctree b/v0.2.2/.doctrees/api_doc/index/make.doctree
index 8f15986670..490d7ab1ba 100644
Binary files a/v0.2.2/.doctrees/api_doc/index/make.doctree and b/v0.2.2/.doctrees/api_doc/index/make.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/index/validate.doctree b/v0.2.2/.doctrees/api_doc/index/validate.doctree
index cf00923bd3..b2e6a540dc 100644
Binary files a/v0.2.2/.doctrees/api_doc/index/validate.doctree and b/v0.2.2/.doctrees/api_doc/index/validate.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/operate/base.doctree b/v0.2.2/.doctrees/api_doc/operate/base.doctree
index 5c5fb323b7..956b77e306 100644
Binary files a/v0.2.2/.doctrees/api_doc/operate/base.doctree and b/v0.2.2/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/operate/download.doctree b/v0.2.2/.doctrees/api_doc/operate/download.doctree
index aa77781046..d2ee40042a 100644
Binary files a/v0.2.2/.doctrees/api_doc/operate/download.doctree and b/v0.2.2/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/operate/index.doctree b/v0.2.2/.doctrees/api_doc/operate/index.doctree
index 84383e1a3b..d2d3b34b6d 100644
Binary files a/v0.2.2/.doctrees/api_doc/operate/index.doctree and b/v0.2.2/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/operate/upload.doctree b/v0.2.2/.doctrees/api_doc/operate/upload.doctree
index d0ab993f40..d2aab3b889 100644
Binary files a/v0.2.2/.doctrees/api_doc/operate/upload.doctree and b/v0.2.2/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/operate/validate.doctree b/v0.2.2/.doctrees/api_doc/operate/validate.doctree
index 1503fad223..b3fa98d150 100644
Binary files a/v0.2.2/.doctrees/api_doc/operate/validate.doctree and b/v0.2.2/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/utils/binary.doctree b/v0.2.2/.doctrees/api_doc/utils/binary.doctree
index 19cbfd4271..66bc781b58 100644
Binary files a/v0.2.2/.doctrees/api_doc/utils/binary.doctree and b/v0.2.2/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/utils/download.doctree b/v0.2.2/.doctrees/api_doc/utils/download.doctree
index 501ac7d573..cfd2455e32 100644
Binary files a/v0.2.2/.doctrees/api_doc/utils/download.doctree and b/v0.2.2/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/utils/index.doctree b/v0.2.2/.doctrees/api_doc/utils/index.doctree
index d977210fea..d24a22e01a 100644
Binary files a/v0.2.2/.doctrees/api_doc/utils/index.doctree and b/v0.2.2/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/utils/tqdm_.doctree b/v0.2.2/.doctrees/api_doc/utils/tqdm_.doctree
index 23a7228057..9ea7e25c4a 100644
Binary files a/v0.2.2/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.2.2/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.2.2/.doctrees/api_doc/utils/walk.doctree b/v0.2.2/.doctrees/api_doc/utils/walk.doctree
index fe1aad2b4b..2d4822502f 100644
Binary files a/v0.2.2/.doctrees/api_doc/utils/walk.doctree and b/v0.2.2/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.2.2/.doctrees/environment.pickle b/v0.2.2/.doctrees/environment.pickle
index 796852ac1c..d933c0b03d 100644
Binary files a/v0.2.2/.doctrees/environment.pickle and b/v0.2.2/.doctrees/environment.pickle differ
diff --git a/v0.2.2/.doctrees/index.doctree b/v0.2.2/.doctrees/index.doctree
index 88d1ef99dc..dff9fd88fb 100644
Binary files a/v0.2.2/.doctrees/index.doctree and b/v0.2.2/.doctrees/index.doctree differ
diff --git a/v0.2.2/.doctrees/information/environment.doctree b/v0.2.2/.doctrees/information/environment.doctree
index 4512c7bae5..5882bcd76d 100644
Binary files a/v0.2.2/.doctrees/information/environment.doctree and b/v0.2.2/.doctrees/information/environment.doctree differ
diff --git a/v0.2.2/.doctrees/information/environment.result.doctree b/v0.2.2/.doctrees/information/environment.result.doctree
index 2964cbfbc4..13b4d9f01c 100644
Binary files a/v0.2.2/.doctrees/information/environment.result.doctree and b/v0.2.2/.doctrees/information/environment.result.doctree differ
diff --git a/v0.2.2/.doctrees/nbsphinx/information/environment.ipynb b/v0.2.2/.doctrees/nbsphinx/information/environment.ipynb
index 79b7776d62..81c898f490 100644
--- a/v0.2.2/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.2.2/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:54:21.346674Z",
-     "iopub.status.busy": "2024-07-23T17:54:21.346473Z",
-     "iopub.status.idle": "2024-07-23T17:54:22.515671Z",
-     "shell.execute_reply": "2024-07-23T17:54:22.514928Z"
+     "iopub.execute_input": "2024-07-23T18:00:59.689066Z",
+     "iopub.status.busy": "2024-07-23T18:00:59.688565Z",
+     "iopub.status.idle": "2024-07-23T18:01:00.859343Z",
+     "shell.execute_reply": "2024-07-23T18:01:00.858620Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2935.276 MHz\n",
+      "CPU Freq: 2917.4575 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.2/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.2.2/.doctrees/nbsphinx/information/environment.result.ipynb
index ba77591283..bf0f8aa625 100644
--- a/v0.2.2/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.2.2/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:09:47.969406Z",
-     "iopub.status.busy": "2024-07-23T17:09:47.969001Z",
-     "iopub.status.idle": "2024-07-23T17:09:49.139684Z",
-     "shell.execute_reply": "2024-07-23T17:09:49.139008Z"
+     "iopub.execute_input": "2024-07-23T17:15:35.427134Z",
+     "iopub.status.busy": "2024-07-23T17:15:35.426573Z",
+     "iopub.status.idle": "2024-07-23T17:15:36.604665Z",
+     "shell.execute_reply": "2024-07-23T17:15:36.603924Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 3064.49575 MHz\n",
+      "CPU Freq: 2932.00075 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.2/.doctrees/tutorials/installation/index.doctree b/v0.2.2/.doctrees/tutorials/installation/index.doctree
index a90f37b481..af7f725c36 100644
Binary files a/v0.2.2/.doctrees/tutorials/installation/index.doctree and b/v0.2.2/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.2.2/.doctrees/tutorials/quick_start/index.doctree b/v0.2.2/.doctrees/tutorials/quick_start/index.doctree
index 1af96db0dd..929540fa95 100644
Binary files a/v0.2.2/.doctrees/tutorials/quick_start/index.doctree and b/v0.2.2/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.2.2/_sources/information/environment.result.ipynb.txt b/v0.2.2/_sources/information/environment.result.ipynb.txt
index ba77591283..bf0f8aa625 100644
--- a/v0.2.2/_sources/information/environment.result.ipynb.txt
+++ b/v0.2.2/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:09:47.969406Z",
-     "iopub.status.busy": "2024-07-23T17:09:47.969001Z",
-     "iopub.status.idle": "2024-07-23T17:09:49.139684Z",
-     "shell.execute_reply": "2024-07-23T17:09:49.139008Z"
+     "iopub.execute_input": "2024-07-23T17:15:35.427134Z",
+     "iopub.status.busy": "2024-07-23T17:15:35.426573Z",
+     "iopub.status.idle": "2024-07-23T17:15:36.604665Z",
+     "shell.execute_reply": "2024-07-23T17:15:36.603924Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 3064.49575 MHz\n",
+      "CPU Freq: 2932.00075 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.2/information/environment.html b/v0.2.2/information/environment.html
index 2dee40350c..32ff49f765 100644
--- a/v0.2.2/information/environment.html
+++ b/v0.2.2/information/environment.html
@@ -126,11 +126,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2935.276 MHz
+CPU Freq: 2917.4575 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.2/information/environment.ipynb b/v0.2.2/information/environment.ipynb
index 79b7776d62..81c898f490 100644
--- a/v0.2.2/information/environment.ipynb
+++ b/v0.2.2/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:54:21.346674Z",
-     "iopub.status.busy": "2024-07-23T17:54:21.346473Z",
-     "iopub.status.idle": "2024-07-23T17:54:22.515671Z",
-     "shell.execute_reply": "2024-07-23T17:54:22.514928Z"
+     "iopub.execute_input": "2024-07-23T18:00:59.689066Z",
+     "iopub.status.busy": "2024-07-23T18:00:59.688565Z",
+     "iopub.status.idle": "2024-07-23T18:01:00.859343Z",
+     "shell.execute_reply": "2024-07-23T18:01:00.858620Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2935.276 MHz\n",
+      "CPU Freq: 2917.4575 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.2/information/environment.result.html b/v0.2.2/information/environment.result.html
index 9bb6cda4fc..4e1aa316d3 100644
--- a/v0.2.2/information/environment.result.html
+++ b/v0.2.2/information/environment.result.html
@@ -128,11 +128,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 3064.49575 MHz
+CPU Freq: 2932.00075 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.2/information/environment.result.ipynb b/v0.2.2/information/environment.result.ipynb
index ba77591283..bf0f8aa625 100644
--- a/v0.2.2/information/environment.result.ipynb
+++ b/v0.2.2/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:09:47.969406Z",
-     "iopub.status.busy": "2024-07-23T17:09:47.969001Z",
-     "iopub.status.idle": "2024-07-23T17:09:49.139684Z",
-     "shell.execute_reply": "2024-07-23T17:09:49.139008Z"
+     "iopub.execute_input": "2024-07-23T17:15:35.427134Z",
+     "iopub.status.busy": "2024-07-23T17:15:35.426573Z",
+     "iopub.status.idle": "2024-07-23T17:15:36.604665Z",
+     "shell.execute_reply": "2024-07-23T17:15:36.603924Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 3064.49575 MHz\n",
+      "CPU Freq: 2932.00075 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.2/searchindex.js b/v0.2.2/searchindex.js
index 8287f9a9ad..71617eddd3 100644
--- a/v0.2.2/searchindex.js
+++ b/v0.2.2/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/upload", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/upload.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.upload", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 10, 12, 13], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 13, 15, 17, 20, 22], "you": [0, 27], "requir": [0, 27], "simpli": [0, 27], "instal": [0, 24], "us": [0, 3, 10, 14, 15, 17, 20, 24, 27], "follow": [0, 8, 27], "code": [0, 3, 6, 9], "pip": [0, 27], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23, 27], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23], "i": [0, 6, 9, 10, 12, 13, 15, 18, 19, 24, 25, 26, 27], "we": 0, "util": [0, 24, 27], "rarfil": 0, "librari": [0, 20], "which": [0, 25, 26, 27], "doe": [0, 10], "offer": 0, "function": [0, 3, 13, 19, 20, 22], "creat": [0, 12], "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23], "ext": 0, "list": [0, 3, 8, 10, 14, 15, 17], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 22, 23], "regist": 0, "custom": [0, 3, 6, 9], "type": [0, 3, 8, 10, 12, 13, 14, 15, 17, 18, 19, 20, 22, 23], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 22, 23], "A": [0, 14], "take": 0, "directori": [0, 8, 12, 13, 15, 17, 23], "an": [0, 10, 12, 15, 17, 20, 22, 23], "filenam": [0, 20], "input": 0, "extract": [0, 15], "type_nam": 0, "archive_fil": 0, "silent": [0, 12, 15, 17, 20, 22], "bool": [0, 5, 10, 12, 13, 15, 17, 18, 19, 20, 22], "fals": [0, 10, 12, 13, 15, 17, 18, 19, 20, 22], "clear": [0, 17], "specifi": [0, 13, 17, 20], "result": 0, "true": [0, 10, 12, 13, 15, 17, 18, 19, 20, 22], "suppress": [0, 12, 15, 17, 20], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 17], "exist": [0, 10, 15], "when": [0, 10, 12, 15], "return": [0, 3, 10, 12, 13, 14, 18, 19, 20, 22, 23], "path": [0, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23], "password": [0, 15], "none": [0, 3, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 20], "content": [0, 22], "option": [0, 3, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 20, 22], "determin": 0, "base": [0, 7, 8, 16, 24], "rais": [0, 10, 13], "valueerror": 0, "ani": [0, 5, 19], "get": [0, 10, 12, 14, 20], "meta": [1, 24, 27], "__title__": [1, 27], "__version__": [1, 27], "__description__": [1, 27], "__author__": [1, 27], "__author_email__": 1, "inform": [2, 3, 5, 12], "packag": 2, "titl": 2, "thi": [2, 3, 6, 9, 13, 19, 20, 22, 25, 26], "project": 2, "should": [2, 20, 27], "version": [2, 5, 22, 27], "short": 2, "descript": [2, 20], "includ": [2, 3, 12], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 10, 12], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 10, 12, 13, 14, 15, 20, 25, 26, 27], "object": [3, 8, 14, 15, 17, 20], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 23], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 20, 22], "keyword": [3, 20, 22], "argument": [3, 20, 22], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 12, 13, 25, 26], "two": 3, "2": [3, 8, 27], "class": [3, 6, 8, 9, 10], "messag": [3, 6, 9, 12, 17], "except": [3, 6, 9, 10], "displai": [3, 6, 9, 20, 22], "yellow": 3, "color": 3, "error": [3, 6, 9], "exit_cod": [3, 6, 9], "exit": [3, 6, 9], "show": [3, 6, 9], "io": [3, 6, 9, 27], "write": [3, 6, 9], "output": [3, 6, 9, 15, 17, 20, 22, 27], "red": [3, 6, 9], "err": 3, "baseexcept": 3, "print": [3, 5, 25, 26, 27], "traceback": 3, "provid": [3, 20], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 27], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 24], "current": [5, 25, 26, 27], "metadata": 5, "arg": [5, 22], "indic": [6, 9], "remot": [6, 9], "repositori": [6, 9, 10, 12, 13, 14, 15, 17, 18], "assign": [6, 9, 14, 15, 17], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 24], "print_vers": 7, "download": [7, 10, 16, 21, 24], "noremotepathassignedwithdownload": 7, "l": [7, 24], "listitemtyp": 7, "listitem": 7, "upload": [7, 12, 16, 24], "noremotepathassignedwithupload": 7, "enum": 8, "repres": 8, "differ": [8, 25, 26], "item": [8, 13], "valid": [8, 11, 16, 24], "ar": 8, "folder": 8, "imag": 8, "3": [8, 25, 26, 27], "archiv": [8, 10, 12, 13, 15, 17, 24], "4": [8, 25, 26], "model": [8, 10, 12, 13, 14, 15, 17, 18], "5": [8, 15, 25, 26], "data": [8, 25, 26], "6": [8, 25, 26], "repofold": 8, "repofil": [8, 13], "base_dir": 8, "union": [8, 10], "33": 9, "standalon": 10, "incomplet": 10, "hash": [10, 12, 13, 14, 15, 17], "match": [10, 13, 18], "repo_id": [10, 12, 13, 14, 15, 17, 18], "archive_in_repo": [10, 12, 13, 17], "repo_typ": [10, 12, 13, 14, 15, 17, 18], "liter": [10, 12, 13, 14, 15, 17, 18], "dataset": [10, 12, 13, 14, 15, 17, 18], "space": [10, 12, 13, 14, 15, 17, 18], "revis": [10, 12, 13, 14, 15, 17, 18], "main": [10, 12, 13, 14, 15, 17, 18, 27], "idx_repo_id": [10, 12, 13], "idx_file_in_repo": [10, 12, 13], "idx_repo_typ": [10, 12, 13], "idx_revis": [10, 12, 13], "hf_token": [10, 12, 13, 14, 15, 17, 18], "insid": 10, "hug": [10, 12, 13, 14, 15, 17, 18], "face": [10, 12, 13, 14, 15, 17, 18], "identifi": [10, 12, 14, 15, 17, 18], "repotypetyp": [10, 12, 13, 14, 15, 17, 18], "access": [10, 12], "token": [10, 12, 13, 14, 15, 17, 18], "file_in_arch": 10, "local_fil": [10, 15, 17, 18], "proxi": 10, "user_ag": 10, "header": 10, "endpoint": 10, "save": [10, 12, 15, 20], "local": [10, 12, 15, 17, 18, 20, 25, 26], "http": [10, 27], "request": [10, 20], "user": 10, "agent": 10, "addit": [10, 20, 22], "api": [10, 14, 15, 17, 18], "check": [10, 13, 18, 19, 20, 27], "otherwis": [10, 13, 18, 20], "fetch": [11, 24], "archivestandalonefileincompletedownload": 11, "archivestandalonefilehashnotmatch": 11, "hf_tar_list_fil": 11, "hf_tar_file_download": 11, "hf_tar_get_index": 11, "hf_tar_file_exist": 11, "make": [11, 24], "tar_create_index": 11, "hf_tar_create_index": 11, "tar_get_index_info": 11, "hf_tar_create_from_directori": 11, "hf_tar_item_valid": 11, "hf_tar_valid": 11, "src_tar_fil": 12, "dst_index_fil": 12, "chunk_for_hash": 12, "int": [12, 13, 15, 20], "1048576": 12, "with_hash": 12, "default": [12, 13, 15, 18], "chunk": 12, "size": [12, 13, 20, 25, 26], "20": 12, "mb": 12, "whether": 12, "progress": [12, 15, 17, 20, 22], "bar": [12, 15, 17, 20, 22], "log": 12, "skip_when_sync": 12, "skip": 12, "sync": 12, "readi": [12, 18], "local_directori": [12, 15, 17], "file_item": 13, "hash_": 13, "hash_lf": 13, "expect": [13, 20], "sha": 13, "256": 13, "store": 13, "lf": 13, "id": 13, "where": [13, 20], "authent": 13, "entrynotfounderror": 13, "entri": [13, 24], "found": 13, "isadirectoryerror": 13, "hfapi": 14, "client": [14, 15, 17], "huggingfac": [14, 15, 17, 24, 27], "variabl": [14, 15, 17], "hffilesystem": 14, "system": 14, "subdir": 14, "ignore_pattern": [14, 15, 17], "given": [14, 19, 20], "subdirectori": 14, "e": [14, 15, 17], "g": [14, 15, 17], "branch": [14, 15, 17], "tag": [14, 15, 17], "commit": [14, 15, 17], "pattern": [14, 15, 17], "ignor": [14, 15, 17], "file_in_repo": [15, 17, 18], "resume_download": 15, "within": [15, 17], "resum": 15, "dir_in_repo": 15, "max_work": 15, "8": [15, 25, 26, 27], "max_retri": 15, "all": [15, 23], "max": 15, "worker": 15, "retri": 15, "time": 15, "get_hf_client": 16, "get_hf_f": 16, "list_files_in_repositori": 16, "download_file_to_fil": 16, "download_archive_as_directori": 16, "download_directory_as_directori": 16, "upload_file_to_fil": 16, "upload_directory_as_arch": 16, "upload_directory_as_directori": 16, "is_local_file_readi": 16, "path_in_repo": 17, "time_suffix": 17, "its": 17, "append": 17, "timestamp": 17, "present": 17, "compar": 18, "hub": 18, "read": 19, "first": 19, "1024": 19, "byte": [19, 20], "contain": 19, "non": 19, "text": 19, "charact": 19, "url": 20, "expected_s": 20, "desc": 20, "session": 20, "tqdm": [20, 21, 24], "It": [20, 27], "also": [20, 27], "perform": [20, 25, 26], "ensur": 20, "ha": [20, 25, 26], "pass": [20, 22], "binari": [21, 24], "is_binary_fil": 21, "download_fil": 21, "walk": [21, 24], "walk_fil": 21, "tqdm_": 22, "enhanc": 22, "silenc": 22, "modifi": 22, "behavior": 22, "allow": 22, "posit": 22, "std": 22, "recurs": 23, "through": [23, 27], "yield": 23, "rel": 23, "root": 23, "start": [23, 24], "modul": 24, "quick": 24, "run": 24, "environ": 24, "register_archive_typ": 24, "archive_pack": 24, "archive_unpack": 24, "get_archive_typ": 24, "get_archive_extnam": 24, "config": [24, 27], "index": [24, 27], "oper": 24, "here": [25, 26], "import": [25, 26, 27], "o": [25, 26], "platform": [25, 26], "shutil": [25, 26], "cpuinfo": [25, 26], "psutil": [25, 26], "hbutil": [25, 26], "scale": [25, 26], "size_to_bytes_str": [25, 26], "python": [25, 26, 27], "python_implement": [25, 26], "python_vers": [25, 26], "cpu": [25, 26], "brand": [25, 26], "get_cpu_info": [25, 26], "brand_raw": [25, 26], "count": [25, 26], "cpu_count": [25, 26], "freq": [25, 26], "cpu_freq": [25, 26], "mhz": [25, 26], "memori": [25, 26], "virtual_memori": [25, 26], "total": [25, 26], "precis": [25, 26], "cuda": [25, 26], "ye": [25, 26], "nvidia": [25, 26], "smi": [25, 26], "els": [25, 26], "No": [25, 26], "linux": [25, 26], "0": [25, 26, 27], "1023": [25, 26], "azur": [25, 26], "x86_64": [25, 26], "glibc2": [25, 26], "34": [25, 26], "cpython": [25, 26], "18": [25, 26], "amd": [25, 26], "epyc": [25, 26], "7763": [25, 26], "64": [25, 26], "core": [25, 26], "processor": [25, 26], "2935": 25, "276": 25, "15": [25, 26], "606": [25, 26], "gib": [25, 26], "pleas": [25, 26], "note": [25, 26], "deploi": [25, 26], "document": [25, 26, 27], "automat": [25, 26], "execut": [25, 26], "github": [25, 26, 27], "action": [25, 26], "therefor": [25, 26], "some": [25, 26], "mai": [25, 26], "your": [25, 26, 27], "3064": 26, "49575": 26, "hfutil": 27, "host": 27, "pypi": 27, "can": 27, "newest": 27, "u": 27, "git": 27, "com": 27, "deepgh": 27, "script": 27, "__name__": 27, "__main__": 27, "develop": 27, "maintain": 27, "like": 27, "below": 27, "mean": 27, "success": 27, "narugo1992": 27, "still": 27, "under": 27, "out": 27, "stabl": 27, "html": 27, "faq": 28}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "index"], [16, 0, 0, "-", "operate"], [21, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.upload": [[9, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.index": [[10, 0, 0, "-", "fetch"], [12, 0, 0, "-", "make"], [13, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[10, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [10, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [10, 1, 1, "", "hf_tar_file_download"], [10, 1, 1, "", "hf_tar_file_exists"], [10, 1, 1, "", "hf_tar_get_index"], [10, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[12, 1, 1, "", "hf_tar_create_from_directory"], [12, 1, 1, "", "hf_tar_create_index"], [12, 1, 1, "", "tar_create_index"], [12, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[13, 1, 1, "", "hf_tar_item_validate"], [13, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[14, 0, 0, "-", "base"], [15, 0, 0, "-", "download"], [17, 0, 0, "-", "upload"], [18, 0, 0, "-", "validate"]], "hfutils.operate.base": [[14, 1, 1, "", "get_hf_client"], [14, 1, 1, "", "get_hf_fs"], [14, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[15, 1, 1, "", "download_archive_as_directory"], [15, 1, 1, "", "download_directory_as_directory"], [15, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[17, 1, 1, "", "upload_directory_as_archive"], [17, 1, 1, "", "upload_directory_as_directory"], [17, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[18, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[19, 0, 0, "-", "binary"], [20, 0, 0, "-", "download"], [22, 0, 0, "-", "tqdm_"], [23, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[19, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[20, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[22, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[23, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9], "base": [3, 14], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 15, 20], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "upload": [9, 17], "noremotepathassignedwithupload": 9, "index": [10, 11, 12, 13], "fetch": 10, "archivestandalonefileincompletedownload": 10, "archivestandalonefilehashnotmatch": 10, "hf_tar_list_fil": 10, "hf_tar_file_download": 10, "hf_tar_get_index": 10, "hf_tar_file_exist": 10, "make": 12, "tar_create_index": 12, "hf_tar_create_index": 12, "tar_get_index_info": 12, "hf_tar_create_from_directori": 12, "valid": [13, 18], "hf_tar_item_valid": 13, "hf_tar_valid": 13, "oper": [14, 15, 16, 17, 18], "get_hf_client": 14, "get_hf_f": 14, "list_files_in_repositori": 14, "download_file_to_fil": 15, "download_archive_as_directori": 15, "download_directory_as_directori": 15, "upload_file_to_fil": 17, "upload_directory_as_arch": 17, "upload_directory_as_directori": 17, "is_local_file_readi": 18, "util": [19, 20, 21, 22, 23], "binari": 19, "is_binary_fil": 19, "download_fil": 20, "tqdm": 22, "walk": 23, "walk_fil": 23, "welcom": 24, "": 24, "document": 24, "overview": 24, "tutori": 24, "inform": [24, 25, 26], "api": 24, "run": [25, 26], "environ": [25, 26], "instal": 27, "quick": 28, "start": 28}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[9, "noremotepathassignedwithupload"]], "hfutils.index.fetch": [[10, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[10, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[10, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[10, "hf-tar-list-files"]], "hf_tar_file_download": [[10, "hf-tar-file-download"]], "hf_tar_get_index": [[10, "hf-tar-get-index"]], "hf_tar_file_exists": [[10, "hf-tar-file-exists"]], "hfutils.index": [[11, "module-hfutils.index"]], "hfutils.index.make": [[12, "module-hfutils.index.make"]], "tar_create_index": [[12, "tar-create-index"]], "hf_tar_create_index": [[12, "hf-tar-create-index"]], "tar_get_index_info": [[12, "tar-get-index-info"]], "hf_tar_create_from_directory": [[12, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[13, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[13, "hf-tar-item-validate"]], "hf_tar_validate": [[13, "hf-tar-validate"]], "hfutils.operate.base": [[14, "module-hfutils.operate.base"]], "get_hf_client": [[14, "get-hf-client"]], "get_hf_fs": [[14, "get-hf-fs"]], "list_files_in_repository": [[14, "list-files-in-repository"]], "hfutils.operate.download": [[15, "module-hfutils.operate.download"]], "download_file_to_file": [[15, "download-file-to-file"]], "download_archive_as_directory": [[15, "download-archive-as-directory"]], "download_directory_as_directory": [[15, "download-directory-as-directory"]], "hfutils.operate": [[16, "module-hfutils.operate"]], "hfutils.operate.upload": [[17, "module-hfutils.operate.upload"]], "upload_file_to_file": [[17, "upload-file-to-file"]], "upload_directory_as_archive": [[17, "upload-directory-as-archive"]], "upload_directory_as_directory": [[17, "upload-directory-as-directory"]], "hfutils.operate.validate": [[18, "module-hfutils.operate.validate"]], "is_local_file_ready": [[18, "is-local-file-ready"]], "hfutils.utils.binary": [[19, "module-hfutils.utils.binary"]], "is_binary_file": [[19, "is-binary-file"]], "hfutils.utils.download": [[20, "module-hfutils.utils.download"]], "download_file": [[20, "download-file"]], "hfutils.utils": [[21, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[22, "module-hfutils.utils.tqdm_"]], "tqdm": [[22, "tqdm"]], "hfutils.utils.walk": [[23, "module-hfutils.utils.walk"]], "walk_files": [[23, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[24, "welcome-to-hfutils-s-documentation"]], "Overview": [[24, "overview"]], "Tutorials": [[24, null]], "Information": [[24, null]], "API Documentation": [[24, null]], "Run Environment Information": [[25, "Run-Environment-Information"], [26, "Run-Environment-Information"]], "Installation": [[27, "installation"]], "Quick Start": [[28, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.upload"], [10, "module-hfutils.index.fetch"], [11, "module-hfutils.index"], [12, "module-hfutils.index.make"], [13, "module-hfutils.index.validate"], [14, "module-hfutils.operate.base"], [15, "module-hfutils.operate.download"], [16, "module-hfutils.operate"], [17, "module-hfutils.operate.upload"], [18, "module-hfutils.operate.validate"], [19, "module-hfutils.utils.binary"], [20, "module-hfutils.utils.download"], [21, "module-hfutils.utils"], [22, "module-hfutils.utils.tqdm_"], [23, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[10, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[10, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[10, "module-hfutils.index.fetch"]], "hfutils.index": [[11, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[12, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[12, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[12, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[12, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[12, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[13, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[13, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[13, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[14, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[14, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[14, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[14, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[15, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[15, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[15, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[15, "module-hfutils.operate.download"]], "hfutils.operate": [[16, "module-hfutils.operate"]], "hfutils.operate.upload": [[17, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[17, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[17, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[17, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[18, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[18, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[19, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[19, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[20, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[20, "module-hfutils.utils.download"]], "hfutils.utils": [[21, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[22, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[22, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[23, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[23, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/upload", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/upload.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.upload", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 10, 12, 13], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 13, 15, 17, 20, 22], "you": [0, 27], "requir": [0, 27], "simpli": [0, 27], "instal": [0, 24], "us": [0, 3, 10, 14, 15, 17, 20, 24, 27], "follow": [0, 8, 27], "code": [0, 3, 6, 9], "pip": [0, 27], "The": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23, 27], "creation": 0, "file": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23], "i": [0, 6, 9, 10, 12, 13, 15, 18, 19, 24, 25, 26, 27], "we": 0, "util": [0, 24, 27], "rarfil": 0, "librari": [0, 20], "which": [0, 25, 26, 27], "doe": [0, 10], "offer": 0, "function": [0, 3, 13, 19, 20, 22], "creat": [0, 12], "str": [0, 3, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23], "ext": 0, "list": [0, 3, 8, 10, 14, 15, 17], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 22, 23], "regist": 0, "custom": [0, 3, 6, 9], "type": [0, 3, 8, 10, 12, 13, 14, 15, 17, 18, 19, 20, 22, 23], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 22, 23], "A": [0, 14], "take": 0, "directori": [0, 8, 12, 13, 15, 17, 23], "an": [0, 10, 12, 15, 17, 20, 22, 23], "filenam": [0, 20], "input": 0, "extract": [0, 15], "type_nam": 0, "archive_fil": 0, "silent": [0, 12, 15, 17, 20, 22], "bool": [0, 5, 10, 12, 13, 15, 17, 18, 19, 20, 22], "fals": [0, 10, 12, 13, 15, 17, 18, 19, 20, 22], "clear": [0, 17], "specifi": [0, 13, 17, 20], "result": 0, "true": [0, 10, 12, 13, 15, 17, 18, 19, 20, 22], "suppress": [0, 12, 15, 17, 20], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 17], "exist": [0, 10, 15], "when": [0, 10, 12, 15], "return": [0, 3, 10, 12, 13, 14, 18, 19, 20, 22, 23], "path": [0, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 23], "password": [0, 15], "none": [0, 3, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 20], "content": [0, 22], "option": [0, 3, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 20, 22], "determin": 0, "base": [0, 7, 8, 16, 24], "rais": [0, 10, 13], "valueerror": 0, "ani": [0, 5, 19], "get": [0, 10, 12, 14, 20], "meta": [1, 24, 27], "__title__": [1, 27], "__version__": [1, 27], "__description__": [1, 27], "__author__": [1, 27], "__author_email__": 1, "inform": [2, 3, 5, 12], "packag": 2, "titl": 2, "thi": [2, 3, 6, 9, 13, 19, 20, 22, 25, 26], "project": 2, "should": [2, 20, 27], "version": [2, 5, 22, 27], "short": 2, "descript": [2, 20], "includ": [2, 3, 12], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 10, 12], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 10, 12, 13, 14, 15, 20, 25, 26, 27], "object": [3, 8, 14, 15, 17, 20], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 23], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 20, 22], "keyword": [3, 20, 22], "argument": [3, 20, 22], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 12, 13, 25, 26], "two": 3, "2": [3, 8, 27], "class": [3, 6, 8, 9, 10], "messag": [3, 6, 9, 12, 17], "except": [3, 6, 9, 10], "displai": [3, 6, 9, 20, 22], "yellow": 3, "color": 3, "error": [3, 6, 9], "exit_cod": [3, 6, 9], "exit": [3, 6, 9], "show": [3, 6, 9], "io": [3, 6, 9, 27], "write": [3, 6, 9], "output": [3, 6, 9, 15, 17, 20, 22, 27], "red": [3, 6, 9], "err": 3, "baseexcept": 3, "print": [3, 5, 25, 26, 27], "traceback": 3, "provid": [3, 20], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 27], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 24], "current": [5, 25, 26, 27], "metadata": 5, "arg": [5, 22], "indic": [6, 9], "remot": [6, 9], "repositori": [6, 9, 10, 12, 13, 14, 15, 17, 18], "assign": [6, 9, 14, 15, 17], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 24], "print_vers": 7, "download": [7, 10, 16, 21, 24], "noremotepathassignedwithdownload": 7, "l": [7, 24], "listitemtyp": 7, "listitem": 7, "upload": [7, 12, 16, 24], "noremotepathassignedwithupload": 7, "enum": 8, "repres": 8, "differ": [8, 25, 26], "item": [8, 13], "valid": [8, 11, 16, 24], "ar": 8, "folder": 8, "imag": 8, "3": [8, 25, 26, 27], "archiv": [8, 10, 12, 13, 15, 17, 24], "4": [8, 25, 26], "model": [8, 10, 12, 13, 14, 15, 17, 18], "5": [8, 15, 25, 26], "data": [8, 25, 26], "6": [8, 25, 26], "repofold": 8, "repofil": [8, 13], "base_dir": 8, "union": [8, 10], "33": 9, "standalon": 10, "incomplet": 10, "hash": [10, 12, 13, 14, 15, 17], "match": [10, 13, 18], "repo_id": [10, 12, 13, 14, 15, 17, 18], "archive_in_repo": [10, 12, 13, 17], "repo_typ": [10, 12, 13, 14, 15, 17, 18], "liter": [10, 12, 13, 14, 15, 17, 18], "dataset": [10, 12, 13, 14, 15, 17, 18], "space": [10, 12, 13, 14, 15, 17, 18], "revis": [10, 12, 13, 14, 15, 17, 18], "main": [10, 12, 13, 14, 15, 17, 18, 27], "idx_repo_id": [10, 12, 13], "idx_file_in_repo": [10, 12, 13], "idx_repo_typ": [10, 12, 13], "idx_revis": [10, 12, 13], "hf_token": [10, 12, 13, 14, 15, 17, 18], "insid": 10, "hug": [10, 12, 13, 14, 15, 17, 18], "face": [10, 12, 13, 14, 15, 17, 18], "identifi": [10, 12, 14, 15, 17, 18], "repotypetyp": [10, 12, 13, 14, 15, 17, 18], "access": [10, 12], "token": [10, 12, 13, 14, 15, 17, 18], "file_in_arch": 10, "local_fil": [10, 15, 17, 18], "proxi": 10, "user_ag": 10, "header": 10, "endpoint": 10, "save": [10, 12, 15, 20], "local": [10, 12, 15, 17, 18, 20, 25, 26], "http": [10, 27], "request": [10, 20], "user": 10, "agent": 10, "addit": [10, 20, 22], "api": [10, 14, 15, 17, 18], "check": [10, 13, 18, 19, 20, 27], "otherwis": [10, 13, 18, 20], "fetch": [11, 24], "archivestandalonefileincompletedownload": 11, "archivestandalonefilehashnotmatch": 11, "hf_tar_list_fil": 11, "hf_tar_file_download": 11, "hf_tar_get_index": 11, "hf_tar_file_exist": 11, "make": [11, 24], "tar_create_index": 11, "hf_tar_create_index": 11, "tar_get_index_info": 11, "hf_tar_create_from_directori": 11, "hf_tar_item_valid": 11, "hf_tar_valid": 11, "src_tar_fil": 12, "dst_index_fil": 12, "chunk_for_hash": 12, "int": [12, 13, 15, 20], "1048576": 12, "with_hash": 12, "default": [12, 13, 15, 18], "chunk": 12, "size": [12, 13, 20, 25, 26], "20": 12, "mb": 12, "whether": 12, "progress": [12, 15, 17, 20, 22], "bar": [12, 15, 17, 20, 22], "log": 12, "skip_when_sync": 12, "skip": 12, "sync": 12, "readi": [12, 18], "local_directori": [12, 15, 17], "file_item": 13, "hash_": 13, "hash_lf": 13, "expect": [13, 20], "sha": 13, "256": 13, "store": 13, "lf": 13, "id": 13, "where": [13, 20], "authent": 13, "entrynotfounderror": 13, "entri": [13, 24], "found": 13, "isadirectoryerror": 13, "hfapi": 14, "client": [14, 15, 17], "huggingfac": [14, 15, 17, 24, 27], "variabl": [14, 15, 17], "hffilesystem": 14, "system": 14, "subdir": 14, "ignore_pattern": [14, 15, 17], "given": [14, 19, 20], "subdirectori": 14, "e": [14, 15, 17], "g": [14, 15, 17], "branch": [14, 15, 17], "tag": [14, 15, 17], "commit": [14, 15, 17], "pattern": [14, 15, 17], "ignor": [14, 15, 17], "file_in_repo": [15, 17, 18], "resume_download": 15, "within": [15, 17], "resum": 15, "dir_in_repo": 15, "max_work": 15, "8": [15, 25, 26, 27], "max_retri": 15, "all": [15, 23], "max": 15, "worker": 15, "retri": 15, "time": 15, "get_hf_client": 16, "get_hf_f": 16, "list_files_in_repositori": 16, "download_file_to_fil": 16, "download_archive_as_directori": 16, "download_directory_as_directori": 16, "upload_file_to_fil": 16, "upload_directory_as_arch": 16, "upload_directory_as_directori": 16, "is_local_file_readi": 16, "path_in_repo": 17, "time_suffix": 17, "its": 17, "append": 17, "timestamp": 17, "present": 17, "compar": 18, "hub": 18, "read": 19, "first": 19, "1024": [19, 25, 26], "byte": [19, 20], "contain": 19, "non": 19, "text": 19, "charact": 19, "url": 20, "expected_s": 20, "desc": 20, "session": 20, "tqdm": [20, 21, 24], "It": [20, 27], "also": [20, 27], "perform": [20, 25, 26], "ensur": 20, "ha": [20, 25, 26], "pass": [20, 22], "binari": [21, 24], "is_binary_fil": 21, "download_fil": 21, "walk": [21, 24], "walk_fil": 21, "tqdm_": 22, "enhanc": 22, "silenc": 22, "modifi": 22, "behavior": 22, "allow": 22, "posit": 22, "std": 22, "recurs": 23, "through": [23, 27], "yield": 23, "rel": 23, "root": 23, "start": [23, 24], "modul": 24, "quick": 24, "run": 24, "environ": 24, "register_archive_typ": 24, "archive_pack": 24, "archive_unpack": 24, "get_archive_typ": 24, "get_archive_extnam": 24, "config": [24, 27], "index": [24, 27], "oper": 24, "here": [25, 26], "import": [25, 26, 27], "o": [25, 26], "platform": [25, 26], "shutil": [25, 26], "cpuinfo": [25, 26], "psutil": [25, 26], "hbutil": [25, 26], "scale": [25, 26], "size_to_bytes_str": [25, 26], "python": [25, 26, 27], "python_implement": [25, 26], "python_vers": [25, 26], "cpu": [25, 26], "brand": [25, 26], "get_cpu_info": [25, 26], "brand_raw": [25, 26], "count": [25, 26], "cpu_count": [25, 26], "freq": [25, 26], "cpu_freq": [25, 26], "mhz": [25, 26], "memori": [25, 26], "virtual_memori": [25, 26], "total": [25, 26], "precis": [25, 26], "cuda": [25, 26], "ye": [25, 26], "nvidia": [25, 26], "smi": [25, 26], "els": [25, 26], "No": [25, 26], "linux": [25, 26], "0": [25, 26, 27], "azur": [25, 26], "x86_64": [25, 26], "glibc2": [25, 26], "34": [25, 26], "cpython": [25, 26], "18": [25, 26], "amd": [25, 26], "epyc": [25, 26], "7763": [25, 26], "64": [25, 26], "core": [25, 26], "processor": [25, 26], "2917": 25, "4575": 25, "15": [25, 26], "606": [25, 26], "gib": [25, 26], "pleas": [25, 26], "note": [25, 26], "deploi": [25, 26], "document": [25, 26, 27], "automat": [25, 26], "execut": [25, 26], "github": [25, 26, 27], "action": [25, 26], "therefor": [25, 26], "some": [25, 26], "mai": [25, 26], "your": [25, 26, 27], "2932": 26, "00075": 26, "hfutil": 27, "host": 27, "pypi": 27, "can": 27, "newest": 27, "u": 27, "git": 27, "com": 27, "deepgh": 27, "script": 27, "__name__": 27, "__main__": 27, "develop": 27, "maintain": 27, "like": 27, "below": 27, "mean": 27, "success": 27, "narugo1992": 27, "still": 27, "under": 27, "out": 27, "stabl": 27, "html": 27, "faq": 28}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [11, 0, 0, "-", "index"], [16, 0, 0, "-", "operate"], [21, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "upload"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.upload": [[9, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.index": [[10, 0, 0, "-", "fetch"], [12, 0, 0, "-", "make"], [13, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[10, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [10, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [10, 1, 1, "", "hf_tar_file_download"], [10, 1, 1, "", "hf_tar_file_exists"], [10, 1, 1, "", "hf_tar_get_index"], [10, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[12, 1, 1, "", "hf_tar_create_from_directory"], [12, 1, 1, "", "hf_tar_create_index"], [12, 1, 1, "", "tar_create_index"], [12, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[13, 1, 1, "", "hf_tar_item_validate"], [13, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[14, 0, 0, "-", "base"], [15, 0, 0, "-", "download"], [17, 0, 0, "-", "upload"], [18, 0, 0, "-", "validate"]], "hfutils.operate.base": [[14, 1, 1, "", "get_hf_client"], [14, 1, 1, "", "get_hf_fs"], [14, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[15, 1, 1, "", "download_archive_as_directory"], [15, 1, 1, "", "download_directory_as_directory"], [15, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[17, 1, 1, "", "upload_directory_as_archive"], [17, 1, 1, "", "upload_directory_as_directory"], [17, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[18, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[19, 0, 0, "-", "binary"], [20, 0, 0, "-", "download"], [22, 0, 0, "-", "tqdm_"], [23, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[19, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[20, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[22, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[23, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9], "base": [3, 14], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 15, 20], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "upload": [9, 17], "noremotepathassignedwithupload": 9, "index": [10, 11, 12, 13], "fetch": 10, "archivestandalonefileincompletedownload": 10, "archivestandalonefilehashnotmatch": 10, "hf_tar_list_fil": 10, "hf_tar_file_download": 10, "hf_tar_get_index": 10, "hf_tar_file_exist": 10, "make": 12, "tar_create_index": 12, "hf_tar_create_index": 12, "tar_get_index_info": 12, "hf_tar_create_from_directori": 12, "valid": [13, 18], "hf_tar_item_valid": 13, "hf_tar_valid": 13, "oper": [14, 15, 16, 17, 18], "get_hf_client": 14, "get_hf_f": 14, "list_files_in_repositori": 14, "download_file_to_fil": 15, "download_archive_as_directori": 15, "download_directory_as_directori": 15, "upload_file_to_fil": 17, "upload_directory_as_arch": 17, "upload_directory_as_directori": 17, "is_local_file_readi": 18, "util": [19, 20, 21, 22, 23], "binari": 19, "is_binary_fil": 19, "download_fil": 20, "tqdm": 22, "walk": 23, "walk_fil": 23, "welcom": 24, "": 24, "document": 24, "overview": 24, "tutori": 24, "inform": [24, 25, 26], "api": 24, "run": [25, 26], "environ": [25, 26], "instal": 27, "quick": 28, "start": 28}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[9, "noremotepathassignedwithupload"]], "hfutils.index.fetch": [[10, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[10, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[10, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[10, "hf-tar-list-files"]], "hf_tar_file_download": [[10, "hf-tar-file-download"]], "hf_tar_get_index": [[10, "hf-tar-get-index"]], "hf_tar_file_exists": [[10, "hf-tar-file-exists"]], "hfutils.index": [[11, "module-hfutils.index"]], "hfutils.index.make": [[12, "module-hfutils.index.make"]], "tar_create_index": [[12, "tar-create-index"]], "hf_tar_create_index": [[12, "hf-tar-create-index"]], "tar_get_index_info": [[12, "tar-get-index-info"]], "hf_tar_create_from_directory": [[12, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[13, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[13, "hf-tar-item-validate"]], "hf_tar_validate": [[13, "hf-tar-validate"]], "hfutils.operate.base": [[14, "module-hfutils.operate.base"]], "get_hf_client": [[14, "get-hf-client"]], "get_hf_fs": [[14, "get-hf-fs"]], "list_files_in_repository": [[14, "list-files-in-repository"]], "hfutils.operate.download": [[15, "module-hfutils.operate.download"]], "download_file_to_file": [[15, "download-file-to-file"]], "download_archive_as_directory": [[15, "download-archive-as-directory"]], "download_directory_as_directory": [[15, "download-directory-as-directory"]], "hfutils.operate": [[16, "module-hfutils.operate"]], "hfutils.operate.upload": [[17, "module-hfutils.operate.upload"]], "upload_file_to_file": [[17, "upload-file-to-file"]], "upload_directory_as_archive": [[17, "upload-directory-as-archive"]], "upload_directory_as_directory": [[17, "upload-directory-as-directory"]], "hfutils.operate.validate": [[18, "module-hfutils.operate.validate"]], "is_local_file_ready": [[18, "is-local-file-ready"]], "hfutils.utils.binary": [[19, "module-hfutils.utils.binary"]], "is_binary_file": [[19, "is-binary-file"]], "hfutils.utils.download": [[20, "module-hfutils.utils.download"]], "download_file": [[20, "download-file"]], "hfutils.utils": [[21, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[22, "module-hfutils.utils.tqdm_"]], "tqdm": [[22, "tqdm"]], "hfutils.utils.walk": [[23, "module-hfutils.utils.walk"]], "walk_files": [[23, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[24, "welcome-to-hfutils-s-documentation"]], "Overview": [[24, "overview"]], "Tutorials": [[24, null]], "Information": [[24, null]], "API Documentation": [[24, null]], "Run Environment Information": [[25, "Run-Environment-Information"], [26, "Run-Environment-Information"]], "Installation": [[27, "installation"]], "Quick Start": [[28, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.upload"], [10, "module-hfutils.index.fetch"], [11, "module-hfutils.index"], [12, "module-hfutils.index.make"], [13, "module-hfutils.index.validate"], [14, "module-hfutils.operate.base"], [15, "module-hfutils.operate.download"], [16, "module-hfutils.operate"], [17, "module-hfutils.operate.upload"], [18, "module-hfutils.operate.validate"], [19, "module-hfutils.utils.binary"], [20, "module-hfutils.utils.download"], [21, "module-hfutils.utils"], [22, "module-hfutils.utils.tqdm_"], [23, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[10, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[10, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[10, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[10, "module-hfutils.index.fetch"]], "hfutils.index": [[11, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[12, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[12, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[12, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[12, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[12, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[13, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[13, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[13, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[14, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[14, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[14, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[14, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[15, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[15, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[15, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[15, "module-hfutils.operate.download"]], "hfutils.operate": [[16, "module-hfutils.operate"]], "hfutils.operate.upload": [[17, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[17, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[17, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[17, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[18, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[18, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[19, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[19, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[20, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[20, "module-hfutils.utils.download"]], "hfutils.utils": [[21, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[22, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[22, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[23, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[23, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.2.3/.buildinfo b/v0.2.3/.buildinfo
index bfcd7d54ab..6b80264068 100644
--- a/v0.2.3/.buildinfo
+++ b/v0.2.3/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 36f138c247ea9adc9a5d9e9e56a490d1
+config: 673b401f49930d143b0d3017197a450a
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.2.3/.doctrees/api_doc/archive/index.doctree b/v0.2.3/.doctrees/api_doc/archive/index.doctree
index c3e4cbb860..bcb42b3917 100644
Binary files a/v0.2.3/.doctrees/api_doc/archive/index.doctree and b/v0.2.3/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/config/index.doctree b/v0.2.3/.doctrees/api_doc/config/index.doctree
index d37fea3ca9..a7b9678afc 100644
Binary files a/v0.2.3/.doctrees/api_doc/config/index.doctree and b/v0.2.3/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/config/meta.doctree b/v0.2.3/.doctrees/api_doc/config/meta.doctree
index 9cef20b3ee..4baffbed91 100644
Binary files a/v0.2.3/.doctrees/api_doc/config/meta.doctree and b/v0.2.3/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/entry/base.doctree b/v0.2.3/.doctrees/api_doc/entry/base.doctree
index 4a70df6c9a..31b95d9919 100644
Binary files a/v0.2.3/.doctrees/api_doc/entry/base.doctree and b/v0.2.3/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/entry/cli.doctree b/v0.2.3/.doctrees/api_doc/entry/cli.doctree
index 1d4d596ff8..d8dcd16cbe 100644
Binary files a/v0.2.3/.doctrees/api_doc/entry/cli.doctree and b/v0.2.3/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/entry/dispatch.doctree b/v0.2.3/.doctrees/api_doc/entry/dispatch.doctree
index 261eae301e..368f9a5d9d 100644
Binary files a/v0.2.3/.doctrees/api_doc/entry/dispatch.doctree and b/v0.2.3/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/entry/download.doctree b/v0.2.3/.doctrees/api_doc/entry/download.doctree
index bfc01c3c24..0f220c49a3 100644
Binary files a/v0.2.3/.doctrees/api_doc/entry/download.doctree and b/v0.2.3/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/entry/index.doctree b/v0.2.3/.doctrees/api_doc/entry/index.doctree
index 80f2650624..696fd51ffa 100644
Binary files a/v0.2.3/.doctrees/api_doc/entry/index.doctree and b/v0.2.3/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/entry/ls.doctree b/v0.2.3/.doctrees/api_doc/entry/ls.doctree
index fb9c66abbc..ee9906f5ca 100644
Binary files a/v0.2.3/.doctrees/api_doc/entry/ls.doctree and b/v0.2.3/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/entry/upload.doctree b/v0.2.3/.doctrees/api_doc/entry/upload.doctree
index 2972c77d3c..37a8d7ece8 100644
Binary files a/v0.2.3/.doctrees/api_doc/entry/upload.doctree and b/v0.2.3/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/entry/whoami.doctree b/v0.2.3/.doctrees/api_doc/entry/whoami.doctree
index 260bfe88c5..98443bf572 100644
Binary files a/v0.2.3/.doctrees/api_doc/entry/whoami.doctree and b/v0.2.3/.doctrees/api_doc/entry/whoami.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/index/fetch.doctree b/v0.2.3/.doctrees/api_doc/index/fetch.doctree
index aac2698fd1..b9977d3582 100644
Binary files a/v0.2.3/.doctrees/api_doc/index/fetch.doctree and b/v0.2.3/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/index/index.doctree b/v0.2.3/.doctrees/api_doc/index/index.doctree
index 3900a33262..4381133e04 100644
Binary files a/v0.2.3/.doctrees/api_doc/index/index.doctree and b/v0.2.3/.doctrees/api_doc/index/index.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/index/make.doctree b/v0.2.3/.doctrees/api_doc/index/make.doctree
index 6cad0b1ba6..c014ed362b 100644
Binary files a/v0.2.3/.doctrees/api_doc/index/make.doctree and b/v0.2.3/.doctrees/api_doc/index/make.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/index/validate.doctree b/v0.2.3/.doctrees/api_doc/index/validate.doctree
index afcf622973..f0e08f4d5d 100644
Binary files a/v0.2.3/.doctrees/api_doc/index/validate.doctree and b/v0.2.3/.doctrees/api_doc/index/validate.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/operate/base.doctree b/v0.2.3/.doctrees/api_doc/operate/base.doctree
index 71322bcb36..465e39e187 100644
Binary files a/v0.2.3/.doctrees/api_doc/operate/base.doctree and b/v0.2.3/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/operate/download.doctree b/v0.2.3/.doctrees/api_doc/operate/download.doctree
index 7797e5cc9e..35904bf04d 100644
Binary files a/v0.2.3/.doctrees/api_doc/operate/download.doctree and b/v0.2.3/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/operate/index.doctree b/v0.2.3/.doctrees/api_doc/operate/index.doctree
index 79cc56c649..cbc8439564 100644
Binary files a/v0.2.3/.doctrees/api_doc/operate/index.doctree and b/v0.2.3/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/operate/upload.doctree b/v0.2.3/.doctrees/api_doc/operate/upload.doctree
index f47cc9543c..e3b06e4f53 100644
Binary files a/v0.2.3/.doctrees/api_doc/operate/upload.doctree and b/v0.2.3/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/operate/validate.doctree b/v0.2.3/.doctrees/api_doc/operate/validate.doctree
index d472749c2b..b8709f2013 100644
Binary files a/v0.2.3/.doctrees/api_doc/operate/validate.doctree and b/v0.2.3/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/utils/binary.doctree b/v0.2.3/.doctrees/api_doc/utils/binary.doctree
index 50304f2b20..ee81cef200 100644
Binary files a/v0.2.3/.doctrees/api_doc/utils/binary.doctree and b/v0.2.3/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/utils/download.doctree b/v0.2.3/.doctrees/api_doc/utils/download.doctree
index 4e37f26bc5..8f103488a5 100644
Binary files a/v0.2.3/.doctrees/api_doc/utils/download.doctree and b/v0.2.3/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/utils/index.doctree b/v0.2.3/.doctrees/api_doc/utils/index.doctree
index fdbc693f86..f6db8a4fdd 100644
Binary files a/v0.2.3/.doctrees/api_doc/utils/index.doctree and b/v0.2.3/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/utils/tqdm_.doctree b/v0.2.3/.doctrees/api_doc/utils/tqdm_.doctree
index 6db0a3f8fc..b899accd80 100644
Binary files a/v0.2.3/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.2.3/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.2.3/.doctrees/api_doc/utils/walk.doctree b/v0.2.3/.doctrees/api_doc/utils/walk.doctree
index 6e98ed6145..5312ab2b35 100644
Binary files a/v0.2.3/.doctrees/api_doc/utils/walk.doctree and b/v0.2.3/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.2.3/.doctrees/environment.pickle b/v0.2.3/.doctrees/environment.pickle
index d957b1d5a9..c7e5dc1f60 100644
Binary files a/v0.2.3/.doctrees/environment.pickle and b/v0.2.3/.doctrees/environment.pickle differ
diff --git a/v0.2.3/.doctrees/index.doctree b/v0.2.3/.doctrees/index.doctree
index 6aa1687aac..2272b3861f 100644
Binary files a/v0.2.3/.doctrees/index.doctree and b/v0.2.3/.doctrees/index.doctree differ
diff --git a/v0.2.3/.doctrees/information/environment.doctree b/v0.2.3/.doctrees/information/environment.doctree
index 4ebc393a82..aff5200ed6 100644
Binary files a/v0.2.3/.doctrees/information/environment.doctree and b/v0.2.3/.doctrees/information/environment.doctree differ
diff --git a/v0.2.3/.doctrees/information/environment.result.doctree b/v0.2.3/.doctrees/information/environment.result.doctree
index 1e9d9b752a..210feeefac 100644
Binary files a/v0.2.3/.doctrees/information/environment.result.doctree and b/v0.2.3/.doctrees/information/environment.result.doctree differ
diff --git a/v0.2.3/.doctrees/nbsphinx/information/environment.ipynb b/v0.2.3/.doctrees/nbsphinx/information/environment.ipynb
index 3a0c5550c8..32fc59a3c7 100644
--- a/v0.2.3/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.2.3/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:56:39.930040Z",
-     "iopub.status.busy": "2024-07-23T17:56:39.929553Z",
-     "iopub.status.idle": "2024-07-23T17:56:41.098545Z",
-     "shell.execute_reply": "2024-07-23T17:56:41.097773Z"
+     "iopub.execute_input": "2024-07-23T18:03:17.631038Z",
+     "iopub.status.busy": "2024-07-23T18:03:17.630824Z",
+     "iopub.status.idle": "2024-07-23T18:03:18.803424Z",
+     "shell.execute_reply": "2024-07-23T18:03:18.802543Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2843.7980000000002 MHz\n",
+      "CPU Freq: 2881.40525 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.3/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.2.3/.doctrees/nbsphinx/information/environment.result.ipynb
index 5334b3f61a..5428cdeb51 100644
--- a/v0.2.3/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.2.3/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:10:55.122788Z",
-     "iopub.status.busy": "2024-07-23T17:10:55.122581Z",
-     "iopub.status.idle": "2024-07-23T17:10:56.296537Z",
-     "shell.execute_reply": "2024-07-23T17:10:56.295815Z"
+     "iopub.execute_input": "2024-07-23T17:16:45.107823Z",
+     "iopub.status.busy": "2024-07-23T17:16:45.107134Z",
+     "iopub.status.idle": "2024-07-23T17:16:46.285340Z",
+     "shell.execute_reply": "2024-07-23T17:16:46.284484Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2710.3182500000003 MHz\n",
+      "CPU Freq: 2923.21775 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.3/.doctrees/tutorials/installation/index.doctree b/v0.2.3/.doctrees/tutorials/installation/index.doctree
index e61cae9bc5..3f5e137ac8 100644
Binary files a/v0.2.3/.doctrees/tutorials/installation/index.doctree and b/v0.2.3/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.2.3/.doctrees/tutorials/quick_start/index.doctree b/v0.2.3/.doctrees/tutorials/quick_start/index.doctree
index c500a44389..7c6472dbfb 100644
Binary files a/v0.2.3/.doctrees/tutorials/quick_start/index.doctree and b/v0.2.3/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.2.3/_sources/information/environment.result.ipynb.txt b/v0.2.3/_sources/information/environment.result.ipynb.txt
index 5334b3f61a..5428cdeb51 100644
--- a/v0.2.3/_sources/information/environment.result.ipynb.txt
+++ b/v0.2.3/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:10:55.122788Z",
-     "iopub.status.busy": "2024-07-23T17:10:55.122581Z",
-     "iopub.status.idle": "2024-07-23T17:10:56.296537Z",
-     "shell.execute_reply": "2024-07-23T17:10:56.295815Z"
+     "iopub.execute_input": "2024-07-23T17:16:45.107823Z",
+     "iopub.status.busy": "2024-07-23T17:16:45.107134Z",
+     "iopub.status.idle": "2024-07-23T17:16:46.285340Z",
+     "shell.execute_reply": "2024-07-23T17:16:46.284484Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2710.3182500000003 MHz\n",
+      "CPU Freq: 2923.21775 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.3/information/environment.html b/v0.2.3/information/environment.html
index 9e708c4bb2..aeff32b986 100644
--- a/v0.2.3/information/environment.html
+++ b/v0.2.3/information/environment.html
@@ -126,11 +126,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2843.7980000000002 MHz
+CPU Freq: 2881.40525 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.3/information/environment.ipynb b/v0.2.3/information/environment.ipynb
index 3a0c5550c8..32fc59a3c7 100644
--- a/v0.2.3/information/environment.ipynb
+++ b/v0.2.3/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:56:39.930040Z",
-     "iopub.status.busy": "2024-07-23T17:56:39.929553Z",
-     "iopub.status.idle": "2024-07-23T17:56:41.098545Z",
-     "shell.execute_reply": "2024-07-23T17:56:41.097773Z"
+     "iopub.execute_input": "2024-07-23T18:03:17.631038Z",
+     "iopub.status.busy": "2024-07-23T18:03:17.630824Z",
+     "iopub.status.idle": "2024-07-23T18:03:18.803424Z",
+     "shell.execute_reply": "2024-07-23T18:03:18.802543Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2843.7980000000002 MHz\n",
+      "CPU Freq: 2881.40525 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.3/information/environment.result.html b/v0.2.3/information/environment.result.html
index 775e1a9585..87c30a51a4 100644
--- a/v0.2.3/information/environment.result.html
+++ b/v0.2.3/information/environment.result.html
@@ -128,11 +128,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2710.3182500000003 MHz
+CPU Freq: 2923.21775 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.3/information/environment.result.ipynb b/v0.2.3/information/environment.result.ipynb
index 5334b3f61a..5428cdeb51 100644
--- a/v0.2.3/information/environment.result.ipynb
+++ b/v0.2.3/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:10:55.122788Z",
-     "iopub.status.busy": "2024-07-23T17:10:55.122581Z",
-     "iopub.status.idle": "2024-07-23T17:10:56.296537Z",
-     "shell.execute_reply": "2024-07-23T17:10:56.295815Z"
+     "iopub.execute_input": "2024-07-23T17:16:45.107823Z",
+     "iopub.status.busy": "2024-07-23T17:16:45.107134Z",
+     "iopub.status.idle": "2024-07-23T17:16:46.285340Z",
+     "shell.execute_reply": "2024-07-23T17:16:46.284484Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2710.3182500000003 MHz\n",
+      "CPU Freq: 2923.21775 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.3/searchindex.js b/v0.2.3/searchindex.js
index 07ec7d14f5..a50451c5cb 100644
--- a/v0.2.3/searchindex.js
+++ b/v0.2.3/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 11, 13, 14], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 14, 16, 18, 21, 23], "you": [0, 28], "requir": [0, 28], "simpli": [0, 28], "instal": [0, 25], "us": [0, 3, 11, 15, 16, 18, 21, 25, 28], "follow": [0, 8, 28], "code": [0, 3, 6, 9], "pip": [0, 28], "The": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24, 28], "creation": 0, "file": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24], "i": [0, 6, 9, 11, 13, 14, 16, 19, 20, 25, 26, 27, 28], "we": 0, "util": [0, 25, 28], "rarfil": 0, "librari": [0, 21], "which": [0, 26, 27, 28], "doe": [0, 11], "offer": 0, "function": [0, 3, 14, 20, 21, 23], "creat": [0, 13], "str": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24], "ext": 0, "list": [0, 3, 8, 11, 15, 16, 18], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24], "regist": 0, "custom": [0, 3, 6, 9], "type": [0, 3, 8, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24], "A": [0, 15], "take": 0, "directori": [0, 8, 13, 14, 16, 18, 24], "an": [0, 11, 13, 16, 18, 21, 23, 24], "filenam": [0, 21], "input": 0, "extract": [0, 16], "type_nam": 0, "archive_fil": 0, "silent": [0, 13, 16, 18, 21, 23], "bool": [0, 5, 11, 13, 14, 16, 18, 19, 20, 21, 23], "fals": [0, 11, 13, 14, 16, 18, 19, 20, 21, 23], "clear": [0, 18], "specifi": [0, 14, 18, 21], "result": 0, "true": [0, 11, 13, 14, 16, 18, 19, 20, 21, 23], "suppress": [0, 13, 16, 18, 21], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 18], "exist": [0, 11, 16], "when": [0, 11, 13, 16], "return": [0, 3, 11, 13, 14, 15, 19, 20, 21, 23, 24], "path": [0, 6, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24], "password": [0, 16], "none": [0, 3, 5, 6, 9, 11, 13, 14, 15, 16, 18, 19, 21], "content": [0, 23], "option": [0, 3, 5, 6, 9, 11, 13, 14, 15, 16, 18, 19, 21, 23], "determin": 0, "base": [0, 7, 8, 17, 25], "rais": [0, 11, 14], "valueerror": 0, "ani": [0, 5, 20], "get": [0, 11, 13, 15, 21], "meta": [1, 25, 28], "__title__": [1, 28], "__version__": [1, 28], "__description__": [1, 28], "__author__": [1, 28], "__author_email__": 1, "inform": [2, 3, 5, 13], "packag": 2, "titl": 2, "thi": [2, 3, 6, 9, 14, 20, 21, 23, 26, 27], "project": 2, "should": [2, 21, 28], "version": [2, 5, 23, 28], "short": 2, "descript": [2, 21], "includ": [2, 3, 13], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 11, 13], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 11, 13, 14, 15, 16, 21, 26, 27, 28], "object": [3, 8, 15, 16, 18, 21], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 24], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 21, 23], "keyword": [3, 21, 23], "argument": [3, 21, 23], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 13, 14, 26, 27], "two": 3, "2": [3, 8, 28], "class": [3, 6, 8, 9, 11], "messag": [3, 6, 9, 13, 18], "except": [3, 6, 9, 11], "displai": [3, 6, 9, 21, 23], "yellow": 3, "color": 3, "error": [3, 6, 9], "exit_cod": [3, 6, 9], "exit": [3, 6, 9], "show": [3, 6, 9], "io": [3, 6, 9, 28], "write": [3, 6, 9], "output": [3, 6, 9, 16, 18, 21, 23, 28], "red": [3, 6, 9], "err": 3, "baseexcept": 3, "print": [3, 5, 26, 27, 28], "traceback": 3, "provid": [3, 21], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 28], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 25], "current": [5, 26, 27, 28], "metadata": 5, "arg": [5, 23], "indic": [6, 9], "remot": [6, 9], "repositori": [6, 9, 11, 13, 14, 15, 16, 18, 19], "assign": [6, 9, 15, 16, 18], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 25], "print_vers": 7, "download": [7, 11, 17, 22, 25], "noremotepathassignedwithdownload": 7, "l": [7, 25], "listitemtyp": 7, "listitem": 7, "upload": [7, 13, 17, 25], "noremotepathassignedwithupload": 7, "whoami": [7, 25], "enum": 8, "repres": 8, "differ": [8, 26, 27], "item": [8, 14], "valid": [8, 12, 17, 25], "ar": 8, "folder": 8, "imag": 8, "3": [8, 26, 27, 28], "archiv": [8, 11, 13, 14, 16, 18, 25], "4": [8, 26, 27], "model": [8, 11, 13, 14, 15, 16, 18, 19], "5": [8, 16, 26, 27], "data": [8, 26, 27], "6": [8, 26, 27], "repofold": 8, "repofil": [8, 14], "base_dir": 8, "union": [8, 11], "33": 9, "standalon": 11, "incomplet": 11, "hash": [11, 13, 14, 15, 16, 18], "match": [11, 14, 19], "repo_id": [11, 13, 14, 15, 16, 18, 19], "archive_in_repo": [11, 13, 14, 18], "repo_typ": [11, 13, 14, 15, 16, 18, 19], "liter": [11, 13, 14, 15, 16, 18, 19], "dataset": [11, 13, 14, 15, 16, 18, 19], "space": [11, 13, 14, 15, 16, 18, 19], "revis": [11, 13, 14, 15, 16, 18, 19], "main": [11, 13, 14, 15, 16, 18, 19, 28], "idx_repo_id": [11, 13, 14], "idx_file_in_repo": [11, 13, 14], "idx_repo_typ": [11, 13, 14], "idx_revis": [11, 13, 14], "hf_token": [11, 13, 14, 15, 16, 18, 19], "insid": 11, "hug": [11, 13, 14, 15, 16, 18, 19], "face": [11, 13, 14, 15, 16, 18, 19], "identifi": [11, 13, 15, 16, 18, 19], "repotypetyp": [11, 13, 14, 15, 16, 18, 19], "access": [11, 13], "token": [11, 13, 14, 15, 16, 18, 19], "file_in_arch": 11, "local_fil": [11, 16, 18, 19], "proxi": 11, "user_ag": 11, "header": 11, "endpoint": 11, "save": [11, 13, 16, 21], "local": [11, 13, 16, 18, 19, 21, 26, 27], "http": [11, 28], "request": [11, 21], "user": 11, "agent": 11, "addit": [11, 21, 23], "api": [11, 15, 16, 18, 19], "check": [11, 14, 19, 20, 21, 28], "otherwis": [11, 14, 19, 21], "fetch": [12, 25], "archivestandalonefileincompletedownload": 12, "archivestandalonefilehashnotmatch": 12, "hf_tar_list_fil": 12, "hf_tar_file_download": 12, "hf_tar_get_index": 12, "hf_tar_file_exist": 12, "make": [12, 25], "tar_create_index": 12, "hf_tar_create_index": 12, "tar_get_index_info": 12, "hf_tar_create_from_directori": 12, "hf_tar_item_valid": 12, "hf_tar_valid": 12, "src_tar_fil": 13, "dst_index_fil": 13, "chunk_for_hash": 13, "int": [13, 14, 16, 21], "1048576": 13, "with_hash": 13, "default": [13, 14, 16, 19], "chunk": 13, "size": [13, 14, 21, 26, 27], "20": 13, "mb": 13, "whether": 13, "progress": [13, 16, 18, 21, 23], "bar": [13, 16, 18, 21, 23], "log": 13, "skip_when_sync": 13, "skip": 13, "sync": 13, "readi": [13, 19], "local_directori": [13, 16, 18], "file_item": 14, "hash_": 14, "hash_lf": 14, "expect": [14, 21], "sha": 14, "256": 14, "store": 14, "lf": 14, "id": 14, "where": [14, 21], "authent": 14, "entrynotfounderror": 14, "entri": [14, 25], "found": 14, "isadirectoryerror": 14, "hfapi": 15, "client": [15, 16, 18], "huggingfac": [15, 16, 18, 25, 28], "variabl": [15, 16, 18], "hffilesystem": 15, "system": 15, "subdir": 15, "ignore_pattern": [15, 16, 18], "given": [15, 20, 21], "subdirectori": 15, "e": [15, 16, 18], "g": [15, 16, 18], "branch": [15, 16, 18], "tag": [15, 16, 18], "commit": [15, 16, 18], "pattern": [15, 16, 18], "ignor": [15, 16, 18], "file_in_repo": [16, 18, 19], "resume_download": 16, "within": [16, 18], "resum": 16, "dir_in_repo": 16, "max_work": 16, "8": [16, 26, 27, 28], "max_retri": 16, "all": [16, 24], "max": 16, "worker": 16, "retri": 16, "time": 16, "get_hf_client": 17, "get_hf_f": 17, "list_files_in_repositori": 17, "download_file_to_fil": 17, "download_archive_as_directori": 17, "download_directory_as_directori": 17, "upload_file_to_fil": 17, "upload_directory_as_arch": 17, "upload_directory_as_directori": 17, "is_local_file_readi": 17, "path_in_repo": 18, "time_suffix": 18, "its": 18, "append": 18, "timestamp": 18, "present": 18, "compar": 19, "hub": 19, "read": 20, "first": 20, "1024": 20, "byte": [20, 21], "contain": 20, "non": 20, "text": 20, "charact": 20, "url": 21, "expected_s": 21, "desc": 21, "session": 21, "tqdm": [21, 22, 25], "It": [21, 28], "also": [21, 28], "perform": [21, 26, 27], "ensur": 21, "ha": [21, 26, 27], "pass": [21, 23], "binari": [22, 25], "is_binary_fil": 22, "download_fil": 22, "walk": [22, 25], "walk_fil": 22, "tqdm_": 23, "enhanc": 23, "silenc": 23, "modifi": 23, "behavior": 23, "allow": 23, "posit": 23, "std": 23, "recurs": 24, "through": [24, 28], "yield": 24, "rel": 24, "root": 24, "start": [24, 25], "modul": 25, "quick": 25, "run": 25, "environ": 25, "register_archive_typ": 25, "archive_pack": 25, "archive_unpack": 25, "get_archive_typ": 25, "get_archive_extnam": 25, "config": [25, 28], "index": [25, 28], "oper": 25, "here": [26, 27], "import": [26, 27, 28], "o": [26, 27], "platform": [26, 27], "shutil": [26, 27], "cpuinfo": [26, 27], "psutil": [26, 27], "hbutil": [26, 27], "scale": [26, 27], "size_to_bytes_str": [26, 27], "python": [26, 27, 28], "python_implement": [26, 27], "python_vers": [26, 27], "cpu": [26, 27], "brand": [26, 27], "get_cpu_info": [26, 27], "brand_raw": [26, 27], "count": [26, 27], "cpu_count": [26, 27], "freq": [26, 27], "cpu_freq": [26, 27], "mhz": [26, 27], "memori": [26, 27], "virtual_memori": [26, 27], "total": [26, 27], "precis": [26, 27], "cuda": [26, 27], "ye": [26, 27], "nvidia": [26, 27], "smi": [26, 27], "els": [26, 27], "No": [26, 27], "linux": [26, 27], "0": [26, 27, 28], "1023": [26, 27], "azur": [26, 27], "x86_64": [26, 27], "glibc2": [26, 27], "34": [26, 27], "cpython": [26, 27], "18": [26, 27], "amd": [26, 27], "epyc": [26, 27], "7763": [26, 27], "64": [26, 27], "core": [26, 27], "processor": [26, 27], "2843": 26, "7980000000002": 26, "15": [26, 27], "606": [26, 27], "gib": [26, 27], "pleas": [26, 27], "note": [26, 27], "deploi": [26, 27], "document": [26, 27, 28], "automat": [26, 27], "execut": [26, 27], "github": [26, 27, 28], "action": [26, 27], "therefor": [26, 27], "some": [26, 27], "mai": [26, 27], "your": [26, 27, 28], "2710": 27, "3182500000003": 27, "hfutil": 28, "host": 28, "pypi": 28, "can": 28, "newest": 28, "u": 28, "git": 28, "com": 28, "deepgh": 28, "script": 28, "__name__": 28, "__main__": 28, "develop": 28, "maintain": 28, "like": 28, "below": 28, "mean": 28, "success": 28, "narugo1992": 28, "still": 28, "under": 28, "out": 28, "stabl": 28, "html": 28, "faq": 29}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [12, 0, 0, "-", "index"], [17, 0, 0, "-", "operate"], [22, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "upload"], [10, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.upload": [[9, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.index": [[11, 0, 0, "-", "fetch"], [13, 0, 0, "-", "make"], [14, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[11, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [11, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [11, 1, 1, "", "hf_tar_file_download"], [11, 1, 1, "", "hf_tar_file_exists"], [11, 1, 1, "", "hf_tar_get_index"], [11, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[13, 1, 1, "", "hf_tar_create_from_directory"], [13, 1, 1, "", "hf_tar_create_index"], [13, 1, 1, "", "tar_create_index"], [13, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[14, 1, 1, "", "hf_tar_item_validate"], [14, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[15, 0, 0, "-", "base"], [16, 0, 0, "-", "download"], [18, 0, 0, "-", "upload"], [19, 0, 0, "-", "validate"]], "hfutils.operate.base": [[15, 1, 1, "", "get_hf_client"], [15, 1, 1, "", "get_hf_fs"], [15, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[16, 1, 1, "", "download_archive_as_directory"], [16, 1, 1, "", "download_directory_as_directory"], [16, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[18, 1, 1, "", "upload_directory_as_archive"], [18, 1, 1, "", "upload_directory_as_directory"], [18, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[19, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[20, 0, 0, "-", "binary"], [21, 0, 0, "-", "download"], [23, 0, 0, "-", "tqdm_"], [24, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[20, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[21, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[23, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[24, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9, 10], "base": [3, 15], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 16, 21], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "upload": [9, 18], "noremotepathassignedwithupload": 9, "whoami": 10, "index": [11, 12, 13, 14], "fetch": 11, "archivestandalonefileincompletedownload": 11, "archivestandalonefilehashnotmatch": 11, "hf_tar_list_fil": 11, "hf_tar_file_download": 11, "hf_tar_get_index": 11, "hf_tar_file_exist": 11, "make": 13, "tar_create_index": 13, "hf_tar_create_index": 13, "tar_get_index_info": 13, "hf_tar_create_from_directori": 13, "valid": [14, 19], "hf_tar_item_valid": 14, "hf_tar_valid": 14, "oper": [15, 16, 17, 18, 19], "get_hf_client": 15, "get_hf_f": 15, "list_files_in_repositori": 15, "download_file_to_fil": 16, "download_archive_as_directori": 16, "download_directory_as_directori": 16, "upload_file_to_fil": 18, "upload_directory_as_arch": 18, "upload_directory_as_directori": 18, "is_local_file_readi": 19, "util": [20, 21, 22, 23, 24], "binari": 20, "is_binary_fil": 20, "download_fil": 21, "tqdm": 23, "walk": 24, "walk_fil": 24, "welcom": 25, "": 25, "document": 25, "overview": 25, "tutori": 25, "inform": [25, 26, 27], "api": 25, "run": [26, 27], "environ": [26, 27], "instal": 28, "quick": 29, "start": 29}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[9, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[10, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[11, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[11, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[11, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[11, "hf-tar-list-files"]], "hf_tar_file_download": [[11, "hf-tar-file-download"]], "hf_tar_get_index": [[11, "hf-tar-get-index"]], "hf_tar_file_exists": [[11, "hf-tar-file-exists"]], "hfutils.index": [[12, "module-hfutils.index"]], "hfutils.index.make": [[13, "module-hfutils.index.make"]], "tar_create_index": [[13, "tar-create-index"]], "hf_tar_create_index": [[13, "hf-tar-create-index"]], "tar_get_index_info": [[13, "tar-get-index-info"]], "hf_tar_create_from_directory": [[13, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[14, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[14, "hf-tar-item-validate"]], "hf_tar_validate": [[14, "hf-tar-validate"]], "hfutils.operate.base": [[15, "module-hfutils.operate.base"]], "get_hf_client": [[15, "get-hf-client"]], "get_hf_fs": [[15, "get-hf-fs"]], "list_files_in_repository": [[15, "list-files-in-repository"]], "hfutils.operate.download": [[16, "module-hfutils.operate.download"]], "download_file_to_file": [[16, "download-file-to-file"]], "download_archive_as_directory": [[16, "download-archive-as-directory"]], "download_directory_as_directory": [[16, "download-directory-as-directory"]], "hfutils.operate": [[17, "module-hfutils.operate"]], "hfutils.operate.upload": [[18, "module-hfutils.operate.upload"]], "upload_file_to_file": [[18, "upload-file-to-file"]], "upload_directory_as_archive": [[18, "upload-directory-as-archive"]], "upload_directory_as_directory": [[18, "upload-directory-as-directory"]], "hfutils.operate.validate": [[19, "module-hfutils.operate.validate"]], "is_local_file_ready": [[19, "is-local-file-ready"]], "hfutils.utils.binary": [[20, "module-hfutils.utils.binary"]], "is_binary_file": [[20, "is-binary-file"]], "hfutils.utils.download": [[21, "module-hfutils.utils.download"]], "download_file": [[21, "download-file"]], "hfutils.utils": [[22, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[23, "module-hfutils.utils.tqdm_"]], "tqdm": [[23, "tqdm"]], "hfutils.utils.walk": [[24, "module-hfutils.utils.walk"]], "walk_files": [[24, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[25, "welcome-to-hfutils-s-documentation"]], "Overview": [[25, "overview"]], "Tutorials": [[25, null]], "Information": [[25, null]], "API Documentation": [[25, null]], "Run Environment Information": [[26, "Run-Environment-Information"], [27, "Run-Environment-Information"]], "Installation": [[28, "installation"]], "Quick Start": [[29, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.upload"], [10, "module-hfutils.entry.whoami"], [11, "module-hfutils.index.fetch"], [12, "module-hfutils.index"], [13, "module-hfutils.index.make"], [14, "module-hfutils.index.validate"], [15, "module-hfutils.operate.base"], [16, "module-hfutils.operate.download"], [17, "module-hfutils.operate"], [18, "module-hfutils.operate.upload"], [19, "module-hfutils.operate.validate"], [20, "module-hfutils.utils.binary"], [21, "module-hfutils.utils.download"], [22, "module-hfutils.utils"], [23, "module-hfutils.utils.tqdm_"], [24, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[10, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[11, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[11, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[11, "module-hfutils.index.fetch"]], "hfutils.index": [[12, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[13, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[13, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[13, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[13, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[13, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[14, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[14, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[14, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[15, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[16, "module-hfutils.operate.download"]], "hfutils.operate": [[17, "module-hfutils.operate"]], "hfutils.operate.upload": [[18, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[19, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[19, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[20, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[20, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[21, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[21, "module-hfutils.utils.download"]], "hfutils.utils": [[22, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[23, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[23, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[24, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[24, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 11, 13, 14], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 14, 16, 18, 21, 23], "you": [0, 28], "requir": [0, 28], "simpli": [0, 28], "instal": [0, 25], "us": [0, 3, 11, 15, 16, 18, 21, 25, 28], "follow": [0, 8, 28], "code": [0, 3, 6, 9], "pip": [0, 28], "The": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24, 28], "creation": 0, "file": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24], "i": [0, 6, 9, 11, 13, 14, 16, 19, 20, 25, 26, 27, 28], "we": 0, "util": [0, 25, 28], "rarfil": 0, "librari": [0, 21], "which": [0, 26, 27, 28], "doe": [0, 11], "offer": 0, "function": [0, 3, 14, 20, 21, 23], "creat": [0, 13], "str": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24], "ext": 0, "list": [0, 3, 8, 11, 15, 16, 18], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24], "regist": 0, "custom": [0, 3, 6, 9], "type": [0, 3, 8, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24], "A": [0, 15], "take": 0, "directori": [0, 8, 13, 14, 16, 18, 24], "an": [0, 11, 13, 16, 18, 21, 23, 24], "filenam": [0, 21], "input": 0, "extract": [0, 16], "type_nam": 0, "archive_fil": 0, "silent": [0, 13, 16, 18, 21, 23], "bool": [0, 5, 11, 13, 14, 16, 18, 19, 20, 21, 23], "fals": [0, 11, 13, 14, 16, 18, 19, 20, 21, 23], "clear": [0, 18], "specifi": [0, 14, 18, 21], "result": 0, "true": [0, 11, 13, 14, 16, 18, 19, 20, 21, 23], "suppress": [0, 13, 16, 18, 21], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 18], "exist": [0, 11, 16], "when": [0, 11, 13, 16], "return": [0, 3, 11, 13, 14, 15, 19, 20, 21, 23, 24], "path": [0, 6, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24], "password": [0, 16], "none": [0, 3, 5, 6, 9, 11, 13, 14, 15, 16, 18, 19, 21], "content": [0, 23], "option": [0, 3, 5, 6, 9, 11, 13, 14, 15, 16, 18, 19, 21, 23], "determin": 0, "base": [0, 7, 8, 17, 25], "rais": [0, 11, 14], "valueerror": 0, "ani": [0, 5, 20], "get": [0, 11, 13, 15, 21], "meta": [1, 25, 28], "__title__": [1, 28], "__version__": [1, 28], "__description__": [1, 28], "__author__": [1, 28], "__author_email__": 1, "inform": [2, 3, 5, 13], "packag": 2, "titl": 2, "thi": [2, 3, 6, 9, 14, 20, 21, 23, 26, 27], "project": 2, "should": [2, 21, 28], "version": [2, 5, 23, 28], "short": 2, "descript": [2, 21], "includ": [2, 3, 13], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 11, 13], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 11, 13, 14, 15, 16, 21, 26, 27, 28], "object": [3, 8, 15, 16, 18, 21], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 24], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 21, 23], "keyword": [3, 21, 23], "argument": [3, 21, 23], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 13, 14, 26, 27], "two": 3, "2": [3, 8, 28], "class": [3, 6, 8, 9, 11], "messag": [3, 6, 9, 13, 18], "except": [3, 6, 9, 11], "displai": [3, 6, 9, 21, 23], "yellow": 3, "color": 3, "error": [3, 6, 9], "exit_cod": [3, 6, 9], "exit": [3, 6, 9], "show": [3, 6, 9], "io": [3, 6, 9, 28], "write": [3, 6, 9], "output": [3, 6, 9, 16, 18, 21, 23, 28], "red": [3, 6, 9], "err": 3, "baseexcept": 3, "print": [3, 5, 26, 27, 28], "traceback": 3, "provid": [3, 21], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 28], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 25], "current": [5, 26, 27, 28], "metadata": 5, "arg": [5, 23], "indic": [6, 9], "remot": [6, 9], "repositori": [6, 9, 11, 13, 14, 15, 16, 18, 19], "assign": [6, 9, 15, 16, 18], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 25], "print_vers": 7, "download": [7, 11, 17, 22, 25], "noremotepathassignedwithdownload": 7, "l": [7, 25], "listitemtyp": 7, "listitem": 7, "upload": [7, 13, 17, 25], "noremotepathassignedwithupload": 7, "whoami": [7, 25], "enum": 8, "repres": 8, "differ": [8, 26, 27], "item": [8, 14], "valid": [8, 12, 17, 25], "ar": 8, "folder": 8, "imag": 8, "3": [8, 26, 27, 28], "archiv": [8, 11, 13, 14, 16, 18, 25], "4": [8, 26, 27], "model": [8, 11, 13, 14, 15, 16, 18, 19], "5": [8, 16, 26, 27], "data": [8, 26, 27], "6": [8, 26, 27], "repofold": 8, "repofil": [8, 14], "base_dir": 8, "union": [8, 11], "33": 9, "standalon": 11, "incomplet": 11, "hash": [11, 13, 14, 15, 16, 18], "match": [11, 14, 19], "repo_id": [11, 13, 14, 15, 16, 18, 19], "archive_in_repo": [11, 13, 14, 18], "repo_typ": [11, 13, 14, 15, 16, 18, 19], "liter": [11, 13, 14, 15, 16, 18, 19], "dataset": [11, 13, 14, 15, 16, 18, 19], "space": [11, 13, 14, 15, 16, 18, 19], "revis": [11, 13, 14, 15, 16, 18, 19], "main": [11, 13, 14, 15, 16, 18, 19, 28], "idx_repo_id": [11, 13, 14], "idx_file_in_repo": [11, 13, 14], "idx_repo_typ": [11, 13, 14], "idx_revis": [11, 13, 14], "hf_token": [11, 13, 14, 15, 16, 18, 19], "insid": 11, "hug": [11, 13, 14, 15, 16, 18, 19], "face": [11, 13, 14, 15, 16, 18, 19], "identifi": [11, 13, 15, 16, 18, 19], "repotypetyp": [11, 13, 14, 15, 16, 18, 19], "access": [11, 13], "token": [11, 13, 14, 15, 16, 18, 19], "file_in_arch": 11, "local_fil": [11, 16, 18, 19], "proxi": 11, "user_ag": 11, "header": 11, "endpoint": 11, "save": [11, 13, 16, 21], "local": [11, 13, 16, 18, 19, 21, 26, 27], "http": [11, 28], "request": [11, 21], "user": 11, "agent": 11, "addit": [11, 21, 23], "api": [11, 15, 16, 18, 19], "check": [11, 14, 19, 20, 21, 28], "otherwis": [11, 14, 19, 21], "fetch": [12, 25], "archivestandalonefileincompletedownload": 12, "archivestandalonefilehashnotmatch": 12, "hf_tar_list_fil": 12, "hf_tar_file_download": 12, "hf_tar_get_index": 12, "hf_tar_file_exist": 12, "make": [12, 25], "tar_create_index": 12, "hf_tar_create_index": 12, "tar_get_index_info": 12, "hf_tar_create_from_directori": 12, "hf_tar_item_valid": 12, "hf_tar_valid": 12, "src_tar_fil": 13, "dst_index_fil": 13, "chunk_for_hash": 13, "int": [13, 14, 16, 21], "1048576": 13, "with_hash": 13, "default": [13, 14, 16, 19], "chunk": 13, "size": [13, 14, 21, 26, 27], "20": 13, "mb": 13, "whether": 13, "progress": [13, 16, 18, 21, 23], "bar": [13, 16, 18, 21, 23], "log": 13, "skip_when_sync": 13, "skip": 13, "sync": 13, "readi": [13, 19], "local_directori": [13, 16, 18], "file_item": 14, "hash_": 14, "hash_lf": 14, "expect": [14, 21], "sha": 14, "256": 14, "store": 14, "lf": 14, "id": 14, "where": [14, 21], "authent": 14, "entrynotfounderror": 14, "entri": [14, 25], "found": 14, "isadirectoryerror": 14, "hfapi": 15, "client": [15, 16, 18], "huggingfac": [15, 16, 18, 25, 28], "variabl": [15, 16, 18], "hffilesystem": 15, "system": 15, "subdir": 15, "ignore_pattern": [15, 16, 18], "given": [15, 20, 21], "subdirectori": 15, "e": [15, 16, 18], "g": [15, 16, 18], "branch": [15, 16, 18], "tag": [15, 16, 18], "commit": [15, 16, 18], "pattern": [15, 16, 18], "ignor": [15, 16, 18], "file_in_repo": [16, 18, 19], "resume_download": 16, "within": [16, 18], "resum": 16, "dir_in_repo": 16, "max_work": 16, "8": [16, 26, 27, 28], "max_retri": 16, "all": [16, 24], "max": 16, "worker": 16, "retri": 16, "time": 16, "get_hf_client": 17, "get_hf_f": 17, "list_files_in_repositori": 17, "download_file_to_fil": 17, "download_archive_as_directori": 17, "download_directory_as_directori": 17, "upload_file_to_fil": 17, "upload_directory_as_arch": 17, "upload_directory_as_directori": 17, "is_local_file_readi": 17, "path_in_repo": 18, "time_suffix": 18, "its": 18, "append": 18, "timestamp": 18, "present": 18, "compar": 19, "hub": 19, "read": 20, "first": 20, "1024": [20, 26, 27], "byte": [20, 21], "contain": 20, "non": 20, "text": 20, "charact": 20, "url": 21, "expected_s": 21, "desc": 21, "session": 21, "tqdm": [21, 22, 25], "It": [21, 28], "also": [21, 28], "perform": [21, 26, 27], "ensur": 21, "ha": [21, 26, 27], "pass": [21, 23], "binari": [22, 25], "is_binary_fil": 22, "download_fil": 22, "walk": [22, 25], "walk_fil": 22, "tqdm_": 23, "enhanc": 23, "silenc": 23, "modifi": 23, "behavior": 23, "allow": 23, "posit": 23, "std": 23, "recurs": 24, "through": [24, 28], "yield": 24, "rel": 24, "root": 24, "start": [24, 25], "modul": 25, "quick": 25, "run": 25, "environ": 25, "register_archive_typ": 25, "archive_pack": 25, "archive_unpack": 25, "get_archive_typ": 25, "get_archive_extnam": 25, "config": [25, 28], "index": [25, 28], "oper": 25, "here": [26, 27], "import": [26, 27, 28], "o": [26, 27], "platform": [26, 27], "shutil": [26, 27], "cpuinfo": [26, 27], "psutil": [26, 27], "hbutil": [26, 27], "scale": [26, 27], "size_to_bytes_str": [26, 27], "python": [26, 27, 28], "python_implement": [26, 27], "python_vers": [26, 27], "cpu": [26, 27], "brand": [26, 27], "get_cpu_info": [26, 27], "brand_raw": [26, 27], "count": [26, 27], "cpu_count": [26, 27], "freq": [26, 27], "cpu_freq": [26, 27], "mhz": [26, 27], "memori": [26, 27], "virtual_memori": [26, 27], "total": [26, 27], "precis": [26, 27], "cuda": [26, 27], "ye": [26, 27], "nvidia": [26, 27], "smi": [26, 27], "els": [26, 27], "No": [26, 27], "linux": [26, 27], "0": [26, 27, 28], "azur": [26, 27], "x86_64": [26, 27], "glibc2": [26, 27], "34": [26, 27], "cpython": [26, 27], "18": [26, 27], "amd": [26, 27], "epyc": [26, 27], "7763": [26, 27], "64": [26, 27], "core": [26, 27], "processor": [26, 27], "2881": 26, "40525": 26, "15": [26, 27], "606": [26, 27], "gib": [26, 27], "pleas": [26, 27], "note": [26, 27], "deploi": [26, 27], "document": [26, 27, 28], "automat": [26, 27], "execut": [26, 27], "github": [26, 27, 28], "action": [26, 27], "therefor": [26, 27], "some": [26, 27], "mai": [26, 27], "your": [26, 27, 28], "2923": 27, "21775": 27, "hfutil": 28, "host": 28, "pypi": 28, "can": 28, "newest": 28, "u": 28, "git": 28, "com": 28, "deepgh": 28, "script": 28, "__name__": 28, "__main__": 28, "develop": 28, "maintain": 28, "like": 28, "below": 28, "mean": 28, "success": 28, "narugo1992": 28, "still": 28, "under": 28, "out": 28, "stabl": 28, "html": 28, "faq": 29}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [12, 0, 0, "-", "index"], [17, 0, 0, "-", "operate"], [22, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "upload"], [10, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.upload": [[9, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.index": [[11, 0, 0, "-", "fetch"], [13, 0, 0, "-", "make"], [14, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[11, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [11, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [11, 1, 1, "", "hf_tar_file_download"], [11, 1, 1, "", "hf_tar_file_exists"], [11, 1, 1, "", "hf_tar_get_index"], [11, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[13, 1, 1, "", "hf_tar_create_from_directory"], [13, 1, 1, "", "hf_tar_create_index"], [13, 1, 1, "", "tar_create_index"], [13, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[14, 1, 1, "", "hf_tar_item_validate"], [14, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[15, 0, 0, "-", "base"], [16, 0, 0, "-", "download"], [18, 0, 0, "-", "upload"], [19, 0, 0, "-", "validate"]], "hfutils.operate.base": [[15, 1, 1, "", "get_hf_client"], [15, 1, 1, "", "get_hf_fs"], [15, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[16, 1, 1, "", "download_archive_as_directory"], [16, 1, 1, "", "download_directory_as_directory"], [16, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[18, 1, 1, "", "upload_directory_as_archive"], [18, 1, 1, "", "upload_directory_as_directory"], [18, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[19, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[20, 0, 0, "-", "binary"], [21, 0, 0, "-", "download"], [23, 0, 0, "-", "tqdm_"], [24, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[20, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[21, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[23, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[24, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9, 10], "base": [3, 15], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 16, 21], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "upload": [9, 18], "noremotepathassignedwithupload": 9, "whoami": 10, "index": [11, 12, 13, 14], "fetch": 11, "archivestandalonefileincompletedownload": 11, "archivestandalonefilehashnotmatch": 11, "hf_tar_list_fil": 11, "hf_tar_file_download": 11, "hf_tar_get_index": 11, "hf_tar_file_exist": 11, "make": 13, "tar_create_index": 13, "hf_tar_create_index": 13, "tar_get_index_info": 13, "hf_tar_create_from_directori": 13, "valid": [14, 19], "hf_tar_item_valid": 14, "hf_tar_valid": 14, "oper": [15, 16, 17, 18, 19], "get_hf_client": 15, "get_hf_f": 15, "list_files_in_repositori": 15, "download_file_to_fil": 16, "download_archive_as_directori": 16, "download_directory_as_directori": 16, "upload_file_to_fil": 18, "upload_directory_as_arch": 18, "upload_directory_as_directori": 18, "is_local_file_readi": 19, "util": [20, 21, 22, 23, 24], "binari": 20, "is_binary_fil": 20, "download_fil": 21, "tqdm": 23, "walk": 24, "walk_fil": 24, "welcom": 25, "": 25, "document": 25, "overview": 25, "tutori": 25, "inform": [25, 26, 27], "api": 25, "run": [26, 27], "environ": [26, 27], "instal": 28, "quick": 29, "start": 29}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[9, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[10, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[11, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[11, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[11, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[11, "hf-tar-list-files"]], "hf_tar_file_download": [[11, "hf-tar-file-download"]], "hf_tar_get_index": [[11, "hf-tar-get-index"]], "hf_tar_file_exists": [[11, "hf-tar-file-exists"]], "hfutils.index": [[12, "module-hfutils.index"]], "hfutils.index.make": [[13, "module-hfutils.index.make"]], "tar_create_index": [[13, "tar-create-index"]], "hf_tar_create_index": [[13, "hf-tar-create-index"]], "tar_get_index_info": [[13, "tar-get-index-info"]], "hf_tar_create_from_directory": [[13, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[14, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[14, "hf-tar-item-validate"]], "hf_tar_validate": [[14, "hf-tar-validate"]], "hfutils.operate.base": [[15, "module-hfutils.operate.base"]], "get_hf_client": [[15, "get-hf-client"]], "get_hf_fs": [[15, "get-hf-fs"]], "list_files_in_repository": [[15, "list-files-in-repository"]], "hfutils.operate.download": [[16, "module-hfutils.operate.download"]], "download_file_to_file": [[16, "download-file-to-file"]], "download_archive_as_directory": [[16, "download-archive-as-directory"]], "download_directory_as_directory": [[16, "download-directory-as-directory"]], "hfutils.operate": [[17, "module-hfutils.operate"]], "hfutils.operate.upload": [[18, "module-hfutils.operate.upload"]], "upload_file_to_file": [[18, "upload-file-to-file"]], "upload_directory_as_archive": [[18, "upload-directory-as-archive"]], "upload_directory_as_directory": [[18, "upload-directory-as-directory"]], "hfutils.operate.validate": [[19, "module-hfutils.operate.validate"]], "is_local_file_ready": [[19, "is-local-file-ready"]], "hfutils.utils.binary": [[20, "module-hfutils.utils.binary"]], "is_binary_file": [[20, "is-binary-file"]], "hfutils.utils.download": [[21, "module-hfutils.utils.download"]], "download_file": [[21, "download-file"]], "hfutils.utils": [[22, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[23, "module-hfutils.utils.tqdm_"]], "tqdm": [[23, "tqdm"]], "hfutils.utils.walk": [[24, "module-hfutils.utils.walk"]], "walk_files": [[24, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[25, "welcome-to-hfutils-s-documentation"]], "Overview": [[25, "overview"]], "Tutorials": [[25, null]], "Information": [[25, null]], "API Documentation": [[25, null]], "Run Environment Information": [[26, "Run-Environment-Information"], [27, "Run-Environment-Information"]], "Installation": [[28, "installation"]], "Quick Start": [[29, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.upload"], [10, "module-hfutils.entry.whoami"], [11, "module-hfutils.index.fetch"], [12, "module-hfutils.index"], [13, "module-hfutils.index.make"], [14, "module-hfutils.index.validate"], [15, "module-hfutils.operate.base"], [16, "module-hfutils.operate.download"], [17, "module-hfutils.operate"], [18, "module-hfutils.operate.upload"], [19, "module-hfutils.operate.validate"], [20, "module-hfutils.utils.binary"], [21, "module-hfutils.utils.download"], [22, "module-hfutils.utils"], [23, "module-hfutils.utils.tqdm_"], [24, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[10, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[11, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[11, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[11, "module-hfutils.index.fetch"]], "hfutils.index": [[12, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[13, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[13, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[13, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[13, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[13, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[14, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[14, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[14, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[15, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[16, "module-hfutils.operate.download"]], "hfutils.operate": [[17, "module-hfutils.operate"]], "hfutils.operate.upload": [[18, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[19, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[19, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[20, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[20, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[21, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[21, "module-hfutils.utils.download"]], "hfutils.utils": [[22, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[23, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[23, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[24, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[24, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.2.4/.buildinfo b/v0.2.4/.buildinfo
index bfad77ad78..2d25c858d8 100644
--- a/v0.2.4/.buildinfo
+++ b/v0.2.4/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 19f7b5af0dee47d9c85643e19bb9e870
+config: 8e5fce32961ebcb96732c9fbaa8ba33f
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.2.4/.doctrees/api_doc/archive/index.doctree b/v0.2.4/.doctrees/api_doc/archive/index.doctree
index ce248244c1..c8651f95aa 100644
Binary files a/v0.2.4/.doctrees/api_doc/archive/index.doctree and b/v0.2.4/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/config/index.doctree b/v0.2.4/.doctrees/api_doc/config/index.doctree
index efaf7f1a9a..eb210d0f21 100644
Binary files a/v0.2.4/.doctrees/api_doc/config/index.doctree and b/v0.2.4/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/config/meta.doctree b/v0.2.4/.doctrees/api_doc/config/meta.doctree
index 4fce931475..4ca6ec13a6 100644
Binary files a/v0.2.4/.doctrees/api_doc/config/meta.doctree and b/v0.2.4/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/entry/base.doctree b/v0.2.4/.doctrees/api_doc/entry/base.doctree
index 1709ffabf9..f93171dfd6 100644
Binary files a/v0.2.4/.doctrees/api_doc/entry/base.doctree and b/v0.2.4/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/entry/cli.doctree b/v0.2.4/.doctrees/api_doc/entry/cli.doctree
index fa7fb7e1b5..8c52be081a 100644
Binary files a/v0.2.4/.doctrees/api_doc/entry/cli.doctree and b/v0.2.4/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/entry/dispatch.doctree b/v0.2.4/.doctrees/api_doc/entry/dispatch.doctree
index e90530b815..0a1092d9b9 100644
Binary files a/v0.2.4/.doctrees/api_doc/entry/dispatch.doctree and b/v0.2.4/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/entry/download.doctree b/v0.2.4/.doctrees/api_doc/entry/download.doctree
index 86a3b91365..01a2b4b213 100644
Binary files a/v0.2.4/.doctrees/api_doc/entry/download.doctree and b/v0.2.4/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/entry/index.doctree b/v0.2.4/.doctrees/api_doc/entry/index.doctree
index 4e5bbc4e56..b6afab07e1 100644
Binary files a/v0.2.4/.doctrees/api_doc/entry/index.doctree and b/v0.2.4/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/entry/ls.doctree b/v0.2.4/.doctrees/api_doc/entry/ls.doctree
index 11df82058e..3c5dd0c857 100644
Binary files a/v0.2.4/.doctrees/api_doc/entry/ls.doctree and b/v0.2.4/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/entry/upload.doctree b/v0.2.4/.doctrees/api_doc/entry/upload.doctree
index 38ab50763f..d88cd3d4a2 100644
Binary files a/v0.2.4/.doctrees/api_doc/entry/upload.doctree and b/v0.2.4/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/entry/whoami.doctree b/v0.2.4/.doctrees/api_doc/entry/whoami.doctree
index 17099a64fd..00d2aa9796 100644
Binary files a/v0.2.4/.doctrees/api_doc/entry/whoami.doctree and b/v0.2.4/.doctrees/api_doc/entry/whoami.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/index/fetch.doctree b/v0.2.4/.doctrees/api_doc/index/fetch.doctree
index 7643bc1811..d31c5b5c1e 100644
Binary files a/v0.2.4/.doctrees/api_doc/index/fetch.doctree and b/v0.2.4/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/index/index.doctree b/v0.2.4/.doctrees/api_doc/index/index.doctree
index 976e730983..d55981be6d 100644
Binary files a/v0.2.4/.doctrees/api_doc/index/index.doctree and b/v0.2.4/.doctrees/api_doc/index/index.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/index/make.doctree b/v0.2.4/.doctrees/api_doc/index/make.doctree
index 2f1a6e2576..40e2edc5f2 100644
Binary files a/v0.2.4/.doctrees/api_doc/index/make.doctree and b/v0.2.4/.doctrees/api_doc/index/make.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/index/validate.doctree b/v0.2.4/.doctrees/api_doc/index/validate.doctree
index 48ecbe5ef3..9fcc462464 100644
Binary files a/v0.2.4/.doctrees/api_doc/index/validate.doctree and b/v0.2.4/.doctrees/api_doc/index/validate.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/operate/base.doctree b/v0.2.4/.doctrees/api_doc/operate/base.doctree
index 5ee82b75d4..9adec3f612 100644
Binary files a/v0.2.4/.doctrees/api_doc/operate/base.doctree and b/v0.2.4/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/operate/download.doctree b/v0.2.4/.doctrees/api_doc/operate/download.doctree
index 37652592e3..e86acccd16 100644
Binary files a/v0.2.4/.doctrees/api_doc/operate/download.doctree and b/v0.2.4/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/operate/index.doctree b/v0.2.4/.doctrees/api_doc/operate/index.doctree
index 47d30cc08e..2e3fab1643 100644
Binary files a/v0.2.4/.doctrees/api_doc/operate/index.doctree and b/v0.2.4/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/operate/upload.doctree b/v0.2.4/.doctrees/api_doc/operate/upload.doctree
index dd386ade1e..549c47de1e 100644
Binary files a/v0.2.4/.doctrees/api_doc/operate/upload.doctree and b/v0.2.4/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/operate/validate.doctree b/v0.2.4/.doctrees/api_doc/operate/validate.doctree
index acd8679cc6..25bb0de669 100644
Binary files a/v0.2.4/.doctrees/api_doc/operate/validate.doctree and b/v0.2.4/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/utils/binary.doctree b/v0.2.4/.doctrees/api_doc/utils/binary.doctree
index 21551f3762..e2226bcc6f 100644
Binary files a/v0.2.4/.doctrees/api_doc/utils/binary.doctree and b/v0.2.4/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/utils/download.doctree b/v0.2.4/.doctrees/api_doc/utils/download.doctree
index f937ae247c..5a4a9cd0db 100644
Binary files a/v0.2.4/.doctrees/api_doc/utils/download.doctree and b/v0.2.4/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/utils/index.doctree b/v0.2.4/.doctrees/api_doc/utils/index.doctree
index c1037c9dc3..6fe611f5f5 100644
Binary files a/v0.2.4/.doctrees/api_doc/utils/index.doctree and b/v0.2.4/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/utils/tqdm_.doctree b/v0.2.4/.doctrees/api_doc/utils/tqdm_.doctree
index d5c432c368..6d26f8d012 100644
Binary files a/v0.2.4/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.2.4/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.2.4/.doctrees/api_doc/utils/walk.doctree b/v0.2.4/.doctrees/api_doc/utils/walk.doctree
index b820e2fcf9..15275b5f22 100644
Binary files a/v0.2.4/.doctrees/api_doc/utils/walk.doctree and b/v0.2.4/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.2.4/.doctrees/environment.pickle b/v0.2.4/.doctrees/environment.pickle
index 3a0e9eacd5..1031a06b8e 100644
Binary files a/v0.2.4/.doctrees/environment.pickle and b/v0.2.4/.doctrees/environment.pickle differ
diff --git a/v0.2.4/.doctrees/index.doctree b/v0.2.4/.doctrees/index.doctree
index c959ce5300..d2132a3973 100644
Binary files a/v0.2.4/.doctrees/index.doctree and b/v0.2.4/.doctrees/index.doctree differ
diff --git a/v0.2.4/.doctrees/information/environment.doctree b/v0.2.4/.doctrees/information/environment.doctree
index a9c1474103..28f5dbd781 100644
Binary files a/v0.2.4/.doctrees/information/environment.doctree and b/v0.2.4/.doctrees/information/environment.doctree differ
diff --git a/v0.2.4/.doctrees/information/environment.result.doctree b/v0.2.4/.doctrees/information/environment.result.doctree
index d8e39a45bf..ed131b6f8d 100644
Binary files a/v0.2.4/.doctrees/information/environment.result.doctree and b/v0.2.4/.doctrees/information/environment.result.doctree differ
diff --git a/v0.2.4/.doctrees/nbsphinx/information/environment.ipynb b/v0.2.4/.doctrees/nbsphinx/information/environment.ipynb
index eae8636576..63ccd4dcc6 100644
--- a/v0.2.4/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.2.4/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:58:54.656764Z",
-     "iopub.status.busy": "2024-07-23T17:58:54.656571Z",
-     "iopub.status.idle": "2024-07-23T17:58:55.823027Z",
-     "shell.execute_reply": "2024-07-23T17:58:55.822295Z"
+     "iopub.execute_input": "2024-07-23T18:05:35.227122Z",
+     "iopub.status.busy": "2024-07-23T18:05:35.226917Z",
+     "iopub.status.idle": "2024-07-23T18:05:36.396583Z",
+     "shell.execute_reply": "2024-07-23T18:05:36.395825Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2908.87625 MHz\n",
+      "CPU Freq: 2880.96225 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.4/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.2.4/.doctrees/nbsphinx/information/environment.result.ipynb
index 5a7fbd14e1..9c40f68b7e 100644
--- a/v0.2.4/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.2.4/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:12:02.699580Z",
-     "iopub.status.busy": "2024-07-23T17:12:02.699377Z",
-     "iopub.status.idle": "2024-07-23T17:12:03.873395Z",
-     "shell.execute_reply": "2024-07-23T17:12:03.872638Z"
+     "iopub.execute_input": "2024-07-23T17:17:54.305102Z",
+     "iopub.status.busy": "2024-07-23T17:17:54.304695Z",
+     "iopub.status.idle": "2024-07-23T17:17:55.480364Z",
+     "shell.execute_reply": "2024-07-23T17:17:55.479546Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2696.22725 MHz\n",
+      "CPU Freq: 2966.5325000000003 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.4/.doctrees/tutorials/installation/index.doctree b/v0.2.4/.doctrees/tutorials/installation/index.doctree
index ff8f4ff8e9..5ecb316a9d 100644
Binary files a/v0.2.4/.doctrees/tutorials/installation/index.doctree and b/v0.2.4/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.2.4/.doctrees/tutorials/quick_start/index.doctree b/v0.2.4/.doctrees/tutorials/quick_start/index.doctree
index 8031062e54..e3464cbfbe 100644
Binary files a/v0.2.4/.doctrees/tutorials/quick_start/index.doctree and b/v0.2.4/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.2.4/_sources/information/environment.result.ipynb.txt b/v0.2.4/_sources/information/environment.result.ipynb.txt
index 5a7fbd14e1..9c40f68b7e 100644
--- a/v0.2.4/_sources/information/environment.result.ipynb.txt
+++ b/v0.2.4/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:12:02.699580Z",
-     "iopub.status.busy": "2024-07-23T17:12:02.699377Z",
-     "iopub.status.idle": "2024-07-23T17:12:03.873395Z",
-     "shell.execute_reply": "2024-07-23T17:12:03.872638Z"
+     "iopub.execute_input": "2024-07-23T17:17:54.305102Z",
+     "iopub.status.busy": "2024-07-23T17:17:54.304695Z",
+     "iopub.status.idle": "2024-07-23T17:17:55.480364Z",
+     "shell.execute_reply": "2024-07-23T17:17:55.479546Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2696.22725 MHz\n",
+      "CPU Freq: 2966.5325000000003 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.4/information/environment.html b/v0.2.4/information/environment.html
index 757386908a..6c04f93311 100644
--- a/v0.2.4/information/environment.html
+++ b/v0.2.4/information/environment.html
@@ -126,11 +126,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2908.87625 MHz
+CPU Freq: 2880.96225 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.4/information/environment.ipynb b/v0.2.4/information/environment.ipynb
index eae8636576..63ccd4dcc6 100644
--- a/v0.2.4/information/environment.ipynb
+++ b/v0.2.4/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:58:54.656764Z",
-     "iopub.status.busy": "2024-07-23T17:58:54.656571Z",
-     "iopub.status.idle": "2024-07-23T17:58:55.823027Z",
-     "shell.execute_reply": "2024-07-23T17:58:55.822295Z"
+     "iopub.execute_input": "2024-07-23T18:05:35.227122Z",
+     "iopub.status.busy": "2024-07-23T18:05:35.226917Z",
+     "iopub.status.idle": "2024-07-23T18:05:36.396583Z",
+     "shell.execute_reply": "2024-07-23T18:05:36.395825Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2908.87625 MHz\n",
+      "CPU Freq: 2880.96225 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.4/information/environment.result.html b/v0.2.4/information/environment.result.html
index e71f6fc06b..46511f838a 100644
--- a/v0.2.4/information/environment.result.html
+++ b/v0.2.4/information/environment.result.html
@@ -128,11 +128,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2696.22725 MHz
+CPU Freq: 2966.5325000000003 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.4/information/environment.result.ipynb b/v0.2.4/information/environment.result.ipynb
index 5a7fbd14e1..9c40f68b7e 100644
--- a/v0.2.4/information/environment.result.ipynb
+++ b/v0.2.4/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:12:02.699580Z",
-     "iopub.status.busy": "2024-07-23T17:12:02.699377Z",
-     "iopub.status.idle": "2024-07-23T17:12:03.873395Z",
-     "shell.execute_reply": "2024-07-23T17:12:03.872638Z"
+     "iopub.execute_input": "2024-07-23T17:17:54.305102Z",
+     "iopub.status.busy": "2024-07-23T17:17:54.304695Z",
+     "iopub.status.idle": "2024-07-23T17:17:55.480364Z",
+     "shell.execute_reply": "2024-07-23T17:17:55.479546Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2696.22725 MHz\n",
+      "CPU Freq: 2966.5325000000003 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.4/searchindex.js b/v0.2.4/searchindex.js
index b2a1a4e22e..a31760ffa9 100644
--- a/v0.2.4/searchindex.js
+++ b/v0.2.4/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 11, 13, 14], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 14, 16, 18, 21, 23], "you": [0, 28], "requir": [0, 28], "simpli": [0, 28], "instal": [0, 25], "us": [0, 3, 11, 15, 16, 18, 21, 25, 28], "follow": [0, 8, 28], "code": [0, 3, 6, 9], "pip": [0, 28], "The": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24, 28], "creation": 0, "file": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24], "i": [0, 6, 9, 11, 13, 14, 16, 19, 20, 25, 26, 27, 28], "we": 0, "util": [0, 25, 28], "rarfil": 0, "librari": [0, 21], "which": [0, 26, 27, 28], "doe": [0, 11], "offer": 0, "function": [0, 3, 14, 20, 21, 23], "creat": [0, 13], "str": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24], "ext": 0, "list": [0, 3, 8, 11, 15, 16, 18], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24], "regist": 0, "custom": [0, 3, 6, 9], "type": [0, 3, 8, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24], "A": [0, 15], "take": 0, "directori": [0, 8, 13, 14, 16, 18, 24], "an": [0, 11, 13, 16, 18, 21, 23, 24], "filenam": [0, 21], "input": 0, "extract": [0, 16], "type_nam": 0, "archive_fil": 0, "silent": [0, 13, 16, 18, 21, 23], "bool": [0, 5, 11, 13, 14, 16, 18, 19, 20, 21, 23], "fals": [0, 11, 13, 14, 16, 18, 19, 20, 21, 23], "clear": [0, 18], "specifi": [0, 14, 18, 21], "result": 0, "true": [0, 11, 13, 14, 16, 18, 19, 20, 21, 23], "suppress": [0, 13, 16, 18, 21], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 18], "exist": [0, 11, 16], "when": [0, 11, 13, 16], "return": [0, 3, 11, 13, 14, 15, 19, 20, 21, 23, 24], "path": [0, 6, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24], "password": [0, 16], "none": [0, 3, 5, 6, 9, 11, 13, 14, 15, 16, 18, 19, 21], "content": [0, 23], "option": [0, 3, 5, 6, 9, 11, 13, 14, 15, 16, 18, 19, 21, 23], "determin": 0, "base": [0, 7, 8, 17, 25], "rais": [0, 11, 14], "valueerror": 0, "ani": [0, 5, 20], "get": [0, 11, 13, 15, 21], "meta": [1, 25, 28], "__title__": [1, 28], "__version__": [1, 28], "__description__": [1, 28], "__author__": [1, 28], "__author_email__": 1, "inform": [2, 3, 5, 13], "packag": 2, "titl": 2, "thi": [2, 3, 6, 9, 14, 20, 21, 23, 26, 27], "project": 2, "should": [2, 21, 28], "version": [2, 5, 23, 28], "short": 2, "descript": [2, 21], "includ": [2, 3, 13], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 11, 13], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 11, 13, 14, 15, 16, 21, 26, 27, 28], "object": [3, 8, 15, 16, 18, 21], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 24], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 21, 23], "keyword": [3, 21, 23], "argument": [3, 21, 23], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 13, 14, 26, 27], "two": 3, "2": [3, 8, 28], "class": [3, 6, 8, 9, 11], "messag": [3, 6, 9, 13, 18], "except": [3, 6, 9, 11], "displai": [3, 6, 9, 21, 23], "yellow": 3, "color": 3, "error": [3, 6, 9], "exit_cod": [3, 6, 9], "exit": [3, 6, 9], "show": [3, 6, 9], "io": [3, 6, 9, 28], "write": [3, 6, 9], "output": [3, 6, 9, 16, 18, 21, 23, 28], "red": [3, 6, 9], "err": 3, "baseexcept": 3, "print": [3, 5, 26, 27, 28], "traceback": 3, "provid": [3, 21], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 28], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 25], "current": [5, 26, 27, 28], "metadata": 5, "arg": [5, 23], "indic": [6, 9], "remot": [6, 9], "repositori": [6, 9, 11, 13, 14, 15, 16, 18, 19], "assign": [6, 9, 15, 16, 18], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 25], "print_vers": 7, "download": [7, 11, 17, 22, 25], "noremotepathassignedwithdownload": 7, "l": [7, 25], "listitemtyp": 7, "listitem": 7, "upload": [7, 13, 17, 25], "noremotepathassignedwithupload": 7, "whoami": [7, 25], "enum": 8, "repres": 8, "differ": [8, 26, 27], "item": [8, 14], "valid": [8, 12, 17, 25], "ar": 8, "folder": 8, "imag": 8, "3": [8, 26, 27, 28], "archiv": [8, 11, 13, 14, 16, 18, 25], "4": [8, 26, 27, 28], "model": [8, 11, 13, 14, 15, 16, 18, 19], "5": [8, 16, 26, 27], "data": [8, 26, 27], "6": [8, 26, 27], "repofold": 8, "repofil": [8, 14], "base_dir": 8, "union": [8, 11], "33": 9, "standalon": 11, "incomplet": 11, "hash": [11, 13, 14, 15, 16, 18], "match": [11, 14, 19], "repo_id": [11, 13, 14, 15, 16, 18, 19], "archive_in_repo": [11, 13, 14, 18], "repo_typ": [11, 13, 14, 15, 16, 18, 19], "liter": [11, 13, 14, 15, 16, 18, 19], "dataset": [11, 13, 14, 15, 16, 18, 19], "space": [11, 13, 14, 15, 16, 18, 19], "revis": [11, 13, 14, 15, 16, 18, 19], "main": [11, 13, 14, 15, 16, 18, 19, 28], "idx_repo_id": [11, 13, 14], "idx_file_in_repo": [11, 13, 14], "idx_repo_typ": [11, 13, 14], "idx_revis": [11, 13, 14], "hf_token": [11, 13, 14, 15, 16, 18, 19], "insid": 11, "hug": [11, 13, 14, 15, 16, 18, 19], "face": [11, 13, 14, 15, 16, 18, 19], "identifi": [11, 13, 15, 16, 18, 19], "repotypetyp": [11, 13, 14, 15, 16, 18, 19], "access": [11, 13], "token": [11, 13, 14, 15, 16, 18, 19], "file_in_arch": 11, "local_fil": [11, 16, 18, 19], "proxi": 11, "user_ag": 11, "header": 11, "endpoint": 11, "save": [11, 13, 16, 21], "local": [11, 13, 16, 18, 19, 21, 26, 27], "http": [11, 28], "request": [11, 21], "user": 11, "agent": 11, "addit": [11, 21, 23], "api": [11, 15, 16, 18, 19], "check": [11, 14, 19, 20, 21, 28], "otherwis": [11, 14, 19, 21], "fetch": [12, 25], "archivestandalonefileincompletedownload": 12, "archivestandalonefilehashnotmatch": 12, "hf_tar_list_fil": 12, "hf_tar_file_download": 12, "hf_tar_get_index": 12, "hf_tar_file_exist": 12, "make": [12, 25], "tar_create_index": 12, "hf_tar_create_index": 12, "tar_get_index_info": 12, "hf_tar_create_from_directori": 12, "hf_tar_item_valid": 12, "hf_tar_valid": 12, "src_tar_fil": 13, "dst_index_fil": 13, "chunk_for_hash": 13, "int": [13, 14, 16, 21], "1048576": 13, "with_hash": 13, "default": [13, 14, 16, 19], "chunk": 13, "size": [13, 14, 21, 26, 27], "20": 13, "mb": 13, "whether": 13, "progress": [13, 16, 18, 21, 23], "bar": [13, 16, 18, 21, 23], "log": 13, "skip_when_sync": 13, "skip": 13, "sync": 13, "readi": [13, 19], "local_directori": [13, 16, 18], "file_item": 14, "hash_": 14, "hash_lf": 14, "expect": [14, 21], "sha": 14, "256": 14, "store": 14, "lf": 14, "id": 14, "where": [14, 21], "authent": 14, "entrynotfounderror": 14, "entri": [14, 25], "found": 14, "isadirectoryerror": 14, "hfapi": 15, "client": [15, 16, 18], "huggingfac": [15, 16, 18, 25, 28], "variabl": [15, 16, 18], "hffilesystem": 15, "system": 15, "subdir": 15, "ignore_pattern": [15, 16, 18], "given": [15, 20, 21], "subdirectori": 15, "e": [15, 16, 18], "g": [15, 16, 18], "branch": [15, 16, 18], "tag": [15, 16, 18], "commit": [15, 16, 18], "pattern": [15, 16, 18], "ignor": [15, 16, 18], "file_in_repo": [16, 18, 19], "resume_download": 16, "within": [16, 18], "resum": 16, "dir_in_repo": 16, "max_work": 16, "8": [16, 26, 27, 28], "max_retri": 16, "all": [16, 24], "max": 16, "worker": 16, "retri": 16, "time": 16, "get_hf_client": 17, "get_hf_f": 17, "list_files_in_repositori": 17, "download_file_to_fil": 17, "download_archive_as_directori": 17, "download_directory_as_directori": 17, "upload_file_to_fil": 17, "upload_directory_as_arch": 17, "upload_directory_as_directori": 17, "is_local_file_readi": 17, "path_in_repo": 18, "time_suffix": 18, "its": 18, "append": 18, "timestamp": 18, "present": 18, "compar": 19, "hub": 19, "read": 20, "first": 20, "1024": 20, "byte": [20, 21], "contain": 20, "non": 20, "text": 20, "charact": 20, "url": 21, "expected_s": 21, "desc": 21, "session": 21, "tqdm": [21, 22, 25], "It": [21, 28], "also": [21, 28], "perform": [21, 26, 27], "ensur": 21, "ha": [21, 26, 27], "pass": [21, 23], "binari": [22, 25], "is_binary_fil": 22, "download_fil": 22, "walk": [22, 25], "walk_fil": 22, "tqdm_": 23, "enhanc": 23, "silenc": 23, "modifi": 23, "behavior": 23, "allow": 23, "posit": 23, "std": 23, "recurs": 24, "through": [24, 28], "yield": 24, "rel": 24, "root": 24, "start": [24, 25], "modul": 25, "quick": 25, "run": 25, "environ": 25, "register_archive_typ": 25, "archive_pack": 25, "archive_unpack": 25, "get_archive_typ": 25, "get_archive_extnam": 25, "config": [25, 28], "index": [25, 28], "oper": 25, "here": [26, 27], "import": [26, 27, 28], "o": [26, 27], "platform": [26, 27], "shutil": [26, 27], "cpuinfo": [26, 27], "psutil": [26, 27], "hbutil": [26, 27], "scale": [26, 27], "size_to_bytes_str": [26, 27], "python": [26, 27, 28], "python_implement": [26, 27], "python_vers": [26, 27], "cpu": [26, 27], "brand": [26, 27], "get_cpu_info": [26, 27], "brand_raw": [26, 27], "count": [26, 27], "cpu_count": [26, 27], "freq": [26, 27], "cpu_freq": [26, 27], "mhz": [26, 27], "memori": [26, 27], "virtual_memori": [26, 27], "total": [26, 27], "precis": [26, 27], "cuda": [26, 27], "ye": [26, 27], "nvidia": [26, 27], "smi": [26, 27], "els": [26, 27], "No": [26, 27], "linux": [26, 27], "0": [26, 27, 28], "1023": [26, 27], "azur": [26, 27], "x86_64": [26, 27], "glibc2": [26, 27], "34": [26, 27], "cpython": [26, 27], "18": [26, 27], "amd": [26, 27], "epyc": [26, 27], "7763": [26, 27], "64": [26, 27], "core": [26, 27], "processor": [26, 27], "2908": 26, "87625": 26, "15": [26, 27], "606": [26, 27], "gib": [26, 27], "pleas": [26, 27], "note": [26, 27], "deploi": [26, 27], "document": [26, 27, 28], "automat": [26, 27], "execut": [26, 27], "github": [26, 27, 28], "action": [26, 27], "therefor": [26, 27], "some": [26, 27], "mai": [26, 27], "your": [26, 27, 28], "2696": 27, "22725": 27, "hfutil": 28, "host": 28, "pypi": 28, "can": 28, "newest": 28, "u": 28, "git": 28, "com": 28, "deepgh": 28, "script": 28, "__name__": 28, "__main__": 28, "develop": 28, "maintain": 28, "like": 28, "below": 28, "mean": 28, "success": 28, "narugo1992": 28, "still": 28, "under": 28, "out": 28, "stabl": 28, "html": 28, "faq": 29}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [12, 0, 0, "-", "index"], [17, 0, 0, "-", "operate"], [22, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "upload"], [10, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.upload": [[9, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.index": [[11, 0, 0, "-", "fetch"], [13, 0, 0, "-", "make"], [14, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[11, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [11, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [11, 1, 1, "", "hf_tar_file_download"], [11, 1, 1, "", "hf_tar_file_exists"], [11, 1, 1, "", "hf_tar_get_index"], [11, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[13, 1, 1, "", "hf_tar_create_from_directory"], [13, 1, 1, "", "hf_tar_create_index"], [13, 1, 1, "", "tar_create_index"], [13, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[14, 1, 1, "", "hf_tar_item_validate"], [14, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[15, 0, 0, "-", "base"], [16, 0, 0, "-", "download"], [18, 0, 0, "-", "upload"], [19, 0, 0, "-", "validate"]], "hfutils.operate.base": [[15, 1, 1, "", "get_hf_client"], [15, 1, 1, "", "get_hf_fs"], [15, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[16, 1, 1, "", "download_archive_as_directory"], [16, 1, 1, "", "download_directory_as_directory"], [16, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[18, 1, 1, "", "upload_directory_as_archive"], [18, 1, 1, "", "upload_directory_as_directory"], [18, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[19, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[20, 0, 0, "-", "binary"], [21, 0, 0, "-", "download"], [23, 0, 0, "-", "tqdm_"], [24, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[20, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[21, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[23, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[24, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9, 10], "base": [3, 15], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 16, 21], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "upload": [9, 18], "noremotepathassignedwithupload": 9, "whoami": 10, "index": [11, 12, 13, 14], "fetch": 11, "archivestandalonefileincompletedownload": 11, "archivestandalonefilehashnotmatch": 11, "hf_tar_list_fil": 11, "hf_tar_file_download": 11, "hf_tar_get_index": 11, "hf_tar_file_exist": 11, "make": 13, "tar_create_index": 13, "hf_tar_create_index": 13, "tar_get_index_info": 13, "hf_tar_create_from_directori": 13, "valid": [14, 19], "hf_tar_item_valid": 14, "hf_tar_valid": 14, "oper": [15, 16, 17, 18, 19], "get_hf_client": 15, "get_hf_f": 15, "list_files_in_repositori": 15, "download_file_to_fil": 16, "download_archive_as_directori": 16, "download_directory_as_directori": 16, "upload_file_to_fil": 18, "upload_directory_as_arch": 18, "upload_directory_as_directori": 18, "is_local_file_readi": 19, "util": [20, 21, 22, 23, 24], "binari": 20, "is_binary_fil": 20, "download_fil": 21, "tqdm": 23, "walk": 24, "walk_fil": 24, "welcom": 25, "": 25, "document": 25, "overview": 25, "tutori": 25, "inform": [25, 26, 27], "api": 25, "run": [26, 27], "environ": [26, 27], "instal": 28, "quick": 29, "start": 29}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[9, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[10, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[11, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[11, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[11, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[11, "hf-tar-list-files"]], "hf_tar_file_download": [[11, "hf-tar-file-download"]], "hf_tar_get_index": [[11, "hf-tar-get-index"]], "hf_tar_file_exists": [[11, "hf-tar-file-exists"]], "hfutils.index": [[12, "module-hfutils.index"]], "hfutils.index.make": [[13, "module-hfutils.index.make"]], "tar_create_index": [[13, "tar-create-index"]], "hf_tar_create_index": [[13, "hf-tar-create-index"]], "tar_get_index_info": [[13, "tar-get-index-info"]], "hf_tar_create_from_directory": [[13, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[14, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[14, "hf-tar-item-validate"]], "hf_tar_validate": [[14, "hf-tar-validate"]], "hfutils.operate.base": [[15, "module-hfutils.operate.base"]], "get_hf_client": [[15, "get-hf-client"]], "get_hf_fs": [[15, "get-hf-fs"]], "list_files_in_repository": [[15, "list-files-in-repository"]], "hfutils.operate.download": [[16, "module-hfutils.operate.download"]], "download_file_to_file": [[16, "download-file-to-file"]], "download_archive_as_directory": [[16, "download-archive-as-directory"]], "download_directory_as_directory": [[16, "download-directory-as-directory"]], "hfutils.operate": [[17, "module-hfutils.operate"]], "hfutils.operate.upload": [[18, "module-hfutils.operate.upload"]], "upload_file_to_file": [[18, "upload-file-to-file"]], "upload_directory_as_archive": [[18, "upload-directory-as-archive"]], "upload_directory_as_directory": [[18, "upload-directory-as-directory"]], "hfutils.operate.validate": [[19, "module-hfutils.operate.validate"]], "is_local_file_ready": [[19, "is-local-file-ready"]], "hfutils.utils.binary": [[20, "module-hfutils.utils.binary"]], "is_binary_file": [[20, "is-binary-file"]], "hfutils.utils.download": [[21, "module-hfutils.utils.download"]], "download_file": [[21, "download-file"]], "hfutils.utils": [[22, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[23, "module-hfutils.utils.tqdm_"]], "tqdm": [[23, "tqdm"]], "hfutils.utils.walk": [[24, "module-hfutils.utils.walk"]], "walk_files": [[24, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[25, "welcome-to-hfutils-s-documentation"]], "Overview": [[25, "overview"]], "Tutorials": [[25, null]], "Information": [[25, null]], "API Documentation": [[25, null]], "Run Environment Information": [[26, "Run-Environment-Information"], [27, "Run-Environment-Information"]], "Installation": [[28, "installation"]], "Quick Start": [[29, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.upload"], [10, "module-hfutils.entry.whoami"], [11, "module-hfutils.index.fetch"], [12, "module-hfutils.index"], [13, "module-hfutils.index.make"], [14, "module-hfutils.index.validate"], [15, "module-hfutils.operate.base"], [16, "module-hfutils.operate.download"], [17, "module-hfutils.operate"], [18, "module-hfutils.operate.upload"], [19, "module-hfutils.operate.validate"], [20, "module-hfutils.utils.binary"], [21, "module-hfutils.utils.download"], [22, "module-hfutils.utils"], [23, "module-hfutils.utils.tqdm_"], [24, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[10, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[11, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[11, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[11, "module-hfutils.index.fetch"]], "hfutils.index": [[12, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[13, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[13, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[13, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[13, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[13, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[14, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[14, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[14, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[15, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[16, "module-hfutils.operate.download"]], "hfutils.operate": [[17, "module-hfutils.operate"]], "hfutils.operate.upload": [[18, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[19, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[19, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[20, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[20, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[21, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[21, "module-hfutils.utils.download"]], "hfutils.utils": [[22, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[23, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[23, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[24, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[24, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 11, 13, 14], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 14, 16, 18, 21, 23], "you": [0, 28], "requir": [0, 28], "simpli": [0, 28], "instal": [0, 25], "us": [0, 3, 11, 15, 16, 18, 21, 25, 28], "follow": [0, 8, 28], "code": [0, 3, 6, 9], "pip": [0, 28], "The": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24, 28], "creation": 0, "file": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24], "i": [0, 6, 9, 11, 13, 14, 16, 19, 20, 25, 26, 27, 28], "we": 0, "util": [0, 25, 28], "rarfil": 0, "librari": [0, 21], "which": [0, 26, 27, 28], "doe": [0, 11], "offer": 0, "function": [0, 3, 14, 20, 21, 23], "creat": [0, 13], "str": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24], "ext": 0, "list": [0, 3, 8, 11, 15, 16, 18], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24], "regist": 0, "custom": [0, 3, 6, 9], "type": [0, 3, 8, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24], "A": [0, 15], "take": 0, "directori": [0, 8, 13, 14, 16, 18, 24], "an": [0, 11, 13, 16, 18, 21, 23, 24], "filenam": [0, 21], "input": 0, "extract": [0, 16], "type_nam": 0, "archive_fil": 0, "silent": [0, 13, 16, 18, 21, 23], "bool": [0, 5, 11, 13, 14, 16, 18, 19, 20, 21, 23], "fals": [0, 11, 13, 14, 16, 18, 19, 20, 21, 23], "clear": [0, 18], "specifi": [0, 14, 18, 21], "result": 0, "true": [0, 11, 13, 14, 16, 18, 19, 20, 21, 23], "suppress": [0, 13, 16, 18, 21], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 18], "exist": [0, 11, 16], "when": [0, 11, 13, 16], "return": [0, 3, 11, 13, 14, 15, 19, 20, 21, 23, 24], "path": [0, 6, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 24], "password": [0, 16], "none": [0, 3, 5, 6, 9, 11, 13, 14, 15, 16, 18, 19, 21], "content": [0, 23], "option": [0, 3, 5, 6, 9, 11, 13, 14, 15, 16, 18, 19, 21, 23], "determin": 0, "base": [0, 7, 8, 17, 25], "rais": [0, 11, 14], "valueerror": 0, "ani": [0, 5, 20], "get": [0, 11, 13, 15, 21], "meta": [1, 25, 28], "__title__": [1, 28], "__version__": [1, 28], "__description__": [1, 28], "__author__": [1, 28], "__author_email__": 1, "inform": [2, 3, 5, 13], "packag": 2, "titl": 2, "thi": [2, 3, 6, 9, 14, 20, 21, 23, 26, 27], "project": 2, "should": [2, 21, 28], "version": [2, 5, 23, 28], "short": 2, "descript": [2, 21], "includ": [2, 3, 13], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 11, 13], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 11, 13, 14, 15, 16, 21, 26, 27, 28], "object": [3, 8, 15, 16, 18, 21], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 24], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 21, 23], "keyword": [3, 21, 23], "argument": [3, 21, 23], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 13, 14, 26, 27], "two": 3, "2": [3, 8, 28], "class": [3, 6, 8, 9, 11], "messag": [3, 6, 9, 13, 18], "except": [3, 6, 9, 11], "displai": [3, 6, 9, 21, 23], "yellow": 3, "color": 3, "error": [3, 6, 9], "exit_cod": [3, 6, 9], "exit": [3, 6, 9], "show": [3, 6, 9], "io": [3, 6, 9, 28], "write": [3, 6, 9], "output": [3, 6, 9, 16, 18, 21, 23, 28], "red": [3, 6, 9], "err": 3, "baseexcept": 3, "print": [3, 5, 26, 27, 28], "traceback": 3, "provid": [3, 21], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 28], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 25], "current": [5, 26, 27, 28], "metadata": 5, "arg": [5, 23], "indic": [6, 9], "remot": [6, 9], "repositori": [6, 9, 11, 13, 14, 15, 16, 18, 19], "assign": [6, 9, 15, 16, 18], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 25], "print_vers": 7, "download": [7, 11, 17, 22, 25], "noremotepathassignedwithdownload": 7, "l": [7, 25], "listitemtyp": 7, "listitem": 7, "upload": [7, 13, 17, 25], "noremotepathassignedwithupload": 7, "whoami": [7, 25], "enum": 8, "repres": 8, "differ": [8, 26, 27], "item": [8, 14], "valid": [8, 12, 17, 25], "ar": 8, "folder": 8, "imag": 8, "3": [8, 26, 27, 28], "archiv": [8, 11, 13, 14, 16, 18, 25], "4": [8, 26, 27, 28], "model": [8, 11, 13, 14, 15, 16, 18, 19], "5": [8, 16, 26, 27], "data": [8, 26, 27], "6": [8, 26, 27], "repofold": 8, "repofil": [8, 14], "base_dir": 8, "union": [8, 11], "33": 9, "standalon": 11, "incomplet": 11, "hash": [11, 13, 14, 15, 16, 18], "match": [11, 14, 19], "repo_id": [11, 13, 14, 15, 16, 18, 19], "archive_in_repo": [11, 13, 14, 18], "repo_typ": [11, 13, 14, 15, 16, 18, 19], "liter": [11, 13, 14, 15, 16, 18, 19], "dataset": [11, 13, 14, 15, 16, 18, 19], "space": [11, 13, 14, 15, 16, 18, 19], "revis": [11, 13, 14, 15, 16, 18, 19], "main": [11, 13, 14, 15, 16, 18, 19, 28], "idx_repo_id": [11, 13, 14], "idx_file_in_repo": [11, 13, 14], "idx_repo_typ": [11, 13, 14], "idx_revis": [11, 13, 14], "hf_token": [11, 13, 14, 15, 16, 18, 19], "insid": 11, "hug": [11, 13, 14, 15, 16, 18, 19], "face": [11, 13, 14, 15, 16, 18, 19], "identifi": [11, 13, 15, 16, 18, 19], "repotypetyp": [11, 13, 14, 15, 16, 18, 19], "access": [11, 13], "token": [11, 13, 14, 15, 16, 18, 19], "file_in_arch": 11, "local_fil": [11, 16, 18, 19], "proxi": 11, "user_ag": 11, "header": 11, "endpoint": 11, "save": [11, 13, 16, 21], "local": [11, 13, 16, 18, 19, 21, 26, 27], "http": [11, 28], "request": [11, 21], "user": 11, "agent": 11, "addit": [11, 21, 23], "api": [11, 15, 16, 18, 19], "check": [11, 14, 19, 20, 21, 28], "otherwis": [11, 14, 19, 21], "fetch": [12, 25], "archivestandalonefileincompletedownload": 12, "archivestandalonefilehashnotmatch": 12, "hf_tar_list_fil": 12, "hf_tar_file_download": 12, "hf_tar_get_index": 12, "hf_tar_file_exist": 12, "make": [12, 25], "tar_create_index": 12, "hf_tar_create_index": 12, "tar_get_index_info": 12, "hf_tar_create_from_directori": 12, "hf_tar_item_valid": 12, "hf_tar_valid": 12, "src_tar_fil": 13, "dst_index_fil": 13, "chunk_for_hash": 13, "int": [13, 14, 16, 21], "1048576": 13, "with_hash": 13, "default": [13, 14, 16, 19], "chunk": 13, "size": [13, 14, 21, 26, 27], "20": 13, "mb": 13, "whether": 13, "progress": [13, 16, 18, 21, 23], "bar": [13, 16, 18, 21, 23], "log": 13, "skip_when_sync": 13, "skip": 13, "sync": 13, "readi": [13, 19], "local_directori": [13, 16, 18], "file_item": 14, "hash_": 14, "hash_lf": 14, "expect": [14, 21], "sha": 14, "256": 14, "store": 14, "lf": 14, "id": 14, "where": [14, 21], "authent": 14, "entrynotfounderror": 14, "entri": [14, 25], "found": 14, "isadirectoryerror": 14, "hfapi": 15, "client": [15, 16, 18], "huggingfac": [15, 16, 18, 25, 28], "variabl": [15, 16, 18], "hffilesystem": 15, "system": 15, "subdir": 15, "ignore_pattern": [15, 16, 18], "given": [15, 20, 21], "subdirectori": 15, "e": [15, 16, 18], "g": [15, 16, 18], "branch": [15, 16, 18], "tag": [15, 16, 18], "commit": [15, 16, 18], "pattern": [15, 16, 18], "ignor": [15, 16, 18], "file_in_repo": [16, 18, 19], "resume_download": 16, "within": [16, 18], "resum": 16, "dir_in_repo": 16, "max_work": 16, "8": [16, 26, 27, 28], "max_retri": 16, "all": [16, 24], "max": 16, "worker": 16, "retri": 16, "time": 16, "get_hf_client": 17, "get_hf_f": 17, "list_files_in_repositori": 17, "download_file_to_fil": 17, "download_archive_as_directori": 17, "download_directory_as_directori": 17, "upload_file_to_fil": 17, "upload_directory_as_arch": 17, "upload_directory_as_directori": 17, "is_local_file_readi": 17, "path_in_repo": 18, "time_suffix": 18, "its": 18, "append": 18, "timestamp": 18, "present": 18, "compar": 19, "hub": 19, "read": 20, "first": 20, "1024": [20, 26, 27], "byte": [20, 21], "contain": 20, "non": 20, "text": 20, "charact": 20, "url": 21, "expected_s": 21, "desc": 21, "session": 21, "tqdm": [21, 22, 25], "It": [21, 28], "also": [21, 28], "perform": [21, 26, 27], "ensur": 21, "ha": [21, 26, 27], "pass": [21, 23], "binari": [22, 25], "is_binary_fil": 22, "download_fil": 22, "walk": [22, 25], "walk_fil": 22, "tqdm_": 23, "enhanc": 23, "silenc": 23, "modifi": 23, "behavior": 23, "allow": 23, "posit": 23, "std": 23, "recurs": 24, "through": [24, 28], "yield": 24, "rel": 24, "root": 24, "start": [24, 25], "modul": 25, "quick": 25, "run": 25, "environ": 25, "register_archive_typ": 25, "archive_pack": 25, "archive_unpack": 25, "get_archive_typ": 25, "get_archive_extnam": 25, "config": [25, 28], "index": [25, 28], "oper": 25, "here": [26, 27], "import": [26, 27, 28], "o": [26, 27], "platform": [26, 27], "shutil": [26, 27], "cpuinfo": [26, 27], "psutil": [26, 27], "hbutil": [26, 27], "scale": [26, 27], "size_to_bytes_str": [26, 27], "python": [26, 27, 28], "python_implement": [26, 27], "python_vers": [26, 27], "cpu": [26, 27], "brand": [26, 27], "get_cpu_info": [26, 27], "brand_raw": [26, 27], "count": [26, 27], "cpu_count": [26, 27], "freq": [26, 27], "cpu_freq": [26, 27], "mhz": [26, 27], "memori": [26, 27], "virtual_memori": [26, 27], "total": [26, 27], "precis": [26, 27], "cuda": [26, 27], "ye": [26, 27], "nvidia": [26, 27], "smi": [26, 27], "els": [26, 27], "No": [26, 27], "linux": [26, 27], "0": [26, 27, 28], "azur": [26, 27], "x86_64": [26, 27], "glibc2": [26, 27], "34": [26, 27], "cpython": [26, 27], "18": [26, 27], "amd": [26, 27], "epyc": [26, 27], "7763": [26, 27], "64": [26, 27], "core": [26, 27], "processor": [26, 27], "2880": 26, "96225": 26, "15": [26, 27], "606": [26, 27], "gib": [26, 27], "pleas": [26, 27], "note": [26, 27], "deploi": [26, 27], "document": [26, 27, 28], "automat": [26, 27], "execut": [26, 27], "github": [26, 27, 28], "action": [26, 27], "therefor": [26, 27], "some": [26, 27], "mai": [26, 27], "your": [26, 27, 28], "2966": 27, "5325000000003": 27, "hfutil": 28, "host": 28, "pypi": 28, "can": 28, "newest": 28, "u": 28, "git": 28, "com": 28, "deepgh": 28, "script": 28, "__name__": 28, "__main__": 28, "develop": 28, "maintain": 28, "like": 28, "below": 28, "mean": 28, "success": 28, "narugo1992": 28, "still": 28, "under": 28, "out": 28, "stabl": 28, "html": 28, "faq": 29}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [12, 0, 0, "-", "index"], [17, 0, 0, "-", "operate"], [22, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "upload"], [10, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.upload": [[9, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.index": [[11, 0, 0, "-", "fetch"], [13, 0, 0, "-", "make"], [14, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[11, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [11, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [11, 1, 1, "", "hf_tar_file_download"], [11, 1, 1, "", "hf_tar_file_exists"], [11, 1, 1, "", "hf_tar_get_index"], [11, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[13, 1, 1, "", "hf_tar_create_from_directory"], [13, 1, 1, "", "hf_tar_create_index"], [13, 1, 1, "", "tar_create_index"], [13, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[14, 1, 1, "", "hf_tar_item_validate"], [14, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[15, 0, 0, "-", "base"], [16, 0, 0, "-", "download"], [18, 0, 0, "-", "upload"], [19, 0, 0, "-", "validate"]], "hfutils.operate.base": [[15, 1, 1, "", "get_hf_client"], [15, 1, 1, "", "get_hf_fs"], [15, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[16, 1, 1, "", "download_archive_as_directory"], [16, 1, 1, "", "download_directory_as_directory"], [16, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[18, 1, 1, "", "upload_directory_as_archive"], [18, 1, 1, "", "upload_directory_as_directory"], [18, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[19, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[20, 0, 0, "-", "binary"], [21, 0, 0, "-", "download"], [23, 0, 0, "-", "tqdm_"], [24, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[20, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[21, 1, 1, "", "download_file"]], "hfutils.utils.tqdm_": [[23, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[24, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9, 10], "base": [3, 15], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 16, 21], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "upload": [9, 18], "noremotepathassignedwithupload": 9, "whoami": 10, "index": [11, 12, 13, 14], "fetch": 11, "archivestandalonefileincompletedownload": 11, "archivestandalonefilehashnotmatch": 11, "hf_tar_list_fil": 11, "hf_tar_file_download": 11, "hf_tar_get_index": 11, "hf_tar_file_exist": 11, "make": 13, "tar_create_index": 13, "hf_tar_create_index": 13, "tar_get_index_info": 13, "hf_tar_create_from_directori": 13, "valid": [14, 19], "hf_tar_item_valid": 14, "hf_tar_valid": 14, "oper": [15, 16, 17, 18, 19], "get_hf_client": 15, "get_hf_f": 15, "list_files_in_repositori": 15, "download_file_to_fil": 16, "download_archive_as_directori": 16, "download_directory_as_directori": 16, "upload_file_to_fil": 18, "upload_directory_as_arch": 18, "upload_directory_as_directori": 18, "is_local_file_readi": 19, "util": [20, 21, 22, 23, 24], "binari": 20, "is_binary_fil": 20, "download_fil": 21, "tqdm": 23, "walk": 24, "walk_fil": 24, "welcom": 25, "": 25, "document": 25, "overview": 25, "tutori": 25, "inform": [25, 26, 27], "api": 25, "run": [26, 27], "environ": [26, 27], "instal": 28, "quick": 29, "start": 29}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[9, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[10, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[11, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[11, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[11, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[11, "hf-tar-list-files"]], "hf_tar_file_download": [[11, "hf-tar-file-download"]], "hf_tar_get_index": [[11, "hf-tar-get-index"]], "hf_tar_file_exists": [[11, "hf-tar-file-exists"]], "hfutils.index": [[12, "module-hfutils.index"]], "hfutils.index.make": [[13, "module-hfutils.index.make"]], "tar_create_index": [[13, "tar-create-index"]], "hf_tar_create_index": [[13, "hf-tar-create-index"]], "tar_get_index_info": [[13, "tar-get-index-info"]], "hf_tar_create_from_directory": [[13, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[14, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[14, "hf-tar-item-validate"]], "hf_tar_validate": [[14, "hf-tar-validate"]], "hfutils.operate.base": [[15, "module-hfutils.operate.base"]], "get_hf_client": [[15, "get-hf-client"]], "get_hf_fs": [[15, "get-hf-fs"]], "list_files_in_repository": [[15, "list-files-in-repository"]], "hfutils.operate.download": [[16, "module-hfutils.operate.download"]], "download_file_to_file": [[16, "download-file-to-file"]], "download_archive_as_directory": [[16, "download-archive-as-directory"]], "download_directory_as_directory": [[16, "download-directory-as-directory"]], "hfutils.operate": [[17, "module-hfutils.operate"]], "hfutils.operate.upload": [[18, "module-hfutils.operate.upload"]], "upload_file_to_file": [[18, "upload-file-to-file"]], "upload_directory_as_archive": [[18, "upload-directory-as-archive"]], "upload_directory_as_directory": [[18, "upload-directory-as-directory"]], "hfutils.operate.validate": [[19, "module-hfutils.operate.validate"]], "is_local_file_ready": [[19, "is-local-file-ready"]], "hfutils.utils.binary": [[20, "module-hfutils.utils.binary"]], "is_binary_file": [[20, "is-binary-file"]], "hfutils.utils.download": [[21, "module-hfutils.utils.download"]], "download_file": [[21, "download-file"]], "hfutils.utils": [[22, "module-hfutils.utils"]], "hfutils.utils.tqdm": [[23, "module-hfutils.utils.tqdm_"]], "tqdm": [[23, "tqdm"]], "hfutils.utils.walk": [[24, "module-hfutils.utils.walk"]], "walk_files": [[24, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[25, "welcome-to-hfutils-s-documentation"]], "Overview": [[25, "overview"]], "Tutorials": [[25, null]], "Information": [[25, null]], "API Documentation": [[25, null]], "Run Environment Information": [[26, "Run-Environment-Information"], [27, "Run-Environment-Information"]], "Installation": [[28, "installation"]], "Quick Start": [[29, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.upload"], [10, "module-hfutils.entry.whoami"], [11, "module-hfutils.index.fetch"], [12, "module-hfutils.index"], [13, "module-hfutils.index.make"], [14, "module-hfutils.index.validate"], [15, "module-hfutils.operate.base"], [16, "module-hfutils.operate.download"], [17, "module-hfutils.operate"], [18, "module-hfutils.operate.upload"], [19, "module-hfutils.operate.validate"], [20, "module-hfutils.utils.binary"], [21, "module-hfutils.utils.download"], [22, "module-hfutils.utils"], [23, "module-hfutils.utils.tqdm_"], [24, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[10, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[11, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[11, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[11, "module-hfutils.index.fetch"]], "hfutils.index": [[12, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[13, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[13, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[13, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[13, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[13, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[14, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[14, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[14, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[15, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[16, "module-hfutils.operate.download"]], "hfutils.operate": [[17, "module-hfutils.operate"]], "hfutils.operate.upload": [[18, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[19, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[19, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[20, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[20, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[21, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[21, "module-hfutils.utils.download"]], "hfutils.utils": [[22, "module-hfutils.utils"]], "hfutils.utils.tqdm_": [[23, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[23, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[24, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[24, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.2.5/.buildinfo b/v0.2.5/.buildinfo
index a32fbf841f..3bded06830 100644
--- a/v0.2.5/.buildinfo
+++ b/v0.2.5/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: eaa459018d9fe4de8a0f2b2bfa50cec9
+config: 2f4c3dd29fb066924fcff814fbc60703
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.2.5/.doctrees/api_doc/archive/index.doctree b/v0.2.5/.doctrees/api_doc/archive/index.doctree
index 2bc3ee6458..5322ada5af 100644
Binary files a/v0.2.5/.doctrees/api_doc/archive/index.doctree and b/v0.2.5/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/config/index.doctree b/v0.2.5/.doctrees/api_doc/config/index.doctree
index c3992d7f16..5c5162c61e 100644
Binary files a/v0.2.5/.doctrees/api_doc/config/index.doctree and b/v0.2.5/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/config/meta.doctree b/v0.2.5/.doctrees/api_doc/config/meta.doctree
index 4736ec564c..99e2354f56 100644
Binary files a/v0.2.5/.doctrees/api_doc/config/meta.doctree and b/v0.2.5/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/entry/base.doctree b/v0.2.5/.doctrees/api_doc/entry/base.doctree
index a4018312da..b666df58af 100644
Binary files a/v0.2.5/.doctrees/api_doc/entry/base.doctree and b/v0.2.5/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/entry/cli.doctree b/v0.2.5/.doctrees/api_doc/entry/cli.doctree
index b0dfb915a6..b6c982577a 100644
Binary files a/v0.2.5/.doctrees/api_doc/entry/cli.doctree and b/v0.2.5/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/entry/dispatch.doctree b/v0.2.5/.doctrees/api_doc/entry/dispatch.doctree
index dce31ec17c..976aa94289 100644
Binary files a/v0.2.5/.doctrees/api_doc/entry/dispatch.doctree and b/v0.2.5/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/entry/download.doctree b/v0.2.5/.doctrees/api_doc/entry/download.doctree
index c8d57362ac..f83a1d437c 100644
Binary files a/v0.2.5/.doctrees/api_doc/entry/download.doctree and b/v0.2.5/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/entry/index.doctree b/v0.2.5/.doctrees/api_doc/entry/index.doctree
index 45e3cc23c7..4c25d20718 100644
Binary files a/v0.2.5/.doctrees/api_doc/entry/index.doctree and b/v0.2.5/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/entry/ls.doctree b/v0.2.5/.doctrees/api_doc/entry/ls.doctree
index ef9c444ef4..182d2895a7 100644
Binary files a/v0.2.5/.doctrees/api_doc/entry/ls.doctree and b/v0.2.5/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/entry/upload.doctree b/v0.2.5/.doctrees/api_doc/entry/upload.doctree
index 0baed8b7a4..34d851325a 100644
Binary files a/v0.2.5/.doctrees/api_doc/entry/upload.doctree and b/v0.2.5/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/entry/whoami.doctree b/v0.2.5/.doctrees/api_doc/entry/whoami.doctree
index 13d88ae3a2..041b398d1e 100644
Binary files a/v0.2.5/.doctrees/api_doc/entry/whoami.doctree and b/v0.2.5/.doctrees/api_doc/entry/whoami.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/index/fetch.doctree b/v0.2.5/.doctrees/api_doc/index/fetch.doctree
index 878451df59..09bbd2ce6f 100644
Binary files a/v0.2.5/.doctrees/api_doc/index/fetch.doctree and b/v0.2.5/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/index/index.doctree b/v0.2.5/.doctrees/api_doc/index/index.doctree
index 313e0dad87..f7cf141108 100644
Binary files a/v0.2.5/.doctrees/api_doc/index/index.doctree and b/v0.2.5/.doctrees/api_doc/index/index.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/index/make.doctree b/v0.2.5/.doctrees/api_doc/index/make.doctree
index 971b375729..0ddf2b1430 100644
Binary files a/v0.2.5/.doctrees/api_doc/index/make.doctree and b/v0.2.5/.doctrees/api_doc/index/make.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/index/validate.doctree b/v0.2.5/.doctrees/api_doc/index/validate.doctree
index 487691e46b..0ce6ca41c1 100644
Binary files a/v0.2.5/.doctrees/api_doc/index/validate.doctree and b/v0.2.5/.doctrees/api_doc/index/validate.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/operate/base.doctree b/v0.2.5/.doctrees/api_doc/operate/base.doctree
index aa24306d57..846bb5f68a 100644
Binary files a/v0.2.5/.doctrees/api_doc/operate/base.doctree and b/v0.2.5/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/operate/download.doctree b/v0.2.5/.doctrees/api_doc/operate/download.doctree
index 34329c5b92..3830dcef2e 100644
Binary files a/v0.2.5/.doctrees/api_doc/operate/download.doctree and b/v0.2.5/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/operate/index.doctree b/v0.2.5/.doctrees/api_doc/operate/index.doctree
index 957389086c..e1e0b1f25b 100644
Binary files a/v0.2.5/.doctrees/api_doc/operate/index.doctree and b/v0.2.5/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/operate/upload.doctree b/v0.2.5/.doctrees/api_doc/operate/upload.doctree
index 8a8add109b..220186aaa8 100644
Binary files a/v0.2.5/.doctrees/api_doc/operate/upload.doctree and b/v0.2.5/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/operate/validate.doctree b/v0.2.5/.doctrees/api_doc/operate/validate.doctree
index 0df8a904d9..751546dbd9 100644
Binary files a/v0.2.5/.doctrees/api_doc/operate/validate.doctree and b/v0.2.5/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/utils/binary.doctree b/v0.2.5/.doctrees/api_doc/utils/binary.doctree
index 4bc700e582..da906de1b7 100644
Binary files a/v0.2.5/.doctrees/api_doc/utils/binary.doctree and b/v0.2.5/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/utils/download.doctree b/v0.2.5/.doctrees/api_doc/utils/download.doctree
index a39f2d99dd..53c021a4d5 100644
Binary files a/v0.2.5/.doctrees/api_doc/utils/download.doctree and b/v0.2.5/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/utils/index.doctree b/v0.2.5/.doctrees/api_doc/utils/index.doctree
index 488d7fc3db..5ca175328f 100644
Binary files a/v0.2.5/.doctrees/api_doc/utils/index.doctree and b/v0.2.5/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/utils/path.doctree b/v0.2.5/.doctrees/api_doc/utils/path.doctree
index b9455cf284..c952f6e25a 100644
Binary files a/v0.2.5/.doctrees/api_doc/utils/path.doctree and b/v0.2.5/.doctrees/api_doc/utils/path.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/utils/tqdm_.doctree b/v0.2.5/.doctrees/api_doc/utils/tqdm_.doctree
index 5d08d11656..8d0c73ed28 100644
Binary files a/v0.2.5/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.2.5/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.2.5/.doctrees/api_doc/utils/walk.doctree b/v0.2.5/.doctrees/api_doc/utils/walk.doctree
index 2ba818cf93..eee3cd02f5 100644
Binary files a/v0.2.5/.doctrees/api_doc/utils/walk.doctree and b/v0.2.5/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.2.5/.doctrees/environment.pickle b/v0.2.5/.doctrees/environment.pickle
index 37b2725578..34ef07af93 100644
Binary files a/v0.2.5/.doctrees/environment.pickle and b/v0.2.5/.doctrees/environment.pickle differ
diff --git a/v0.2.5/.doctrees/index.doctree b/v0.2.5/.doctrees/index.doctree
index 16e7887b7a..67792cb1b3 100644
Binary files a/v0.2.5/.doctrees/index.doctree and b/v0.2.5/.doctrees/index.doctree differ
diff --git a/v0.2.5/.doctrees/information/environment.doctree b/v0.2.5/.doctrees/information/environment.doctree
index 565889e26a..5c03a14c74 100644
Binary files a/v0.2.5/.doctrees/information/environment.doctree and b/v0.2.5/.doctrees/information/environment.doctree differ
diff --git a/v0.2.5/.doctrees/information/environment.result.doctree b/v0.2.5/.doctrees/information/environment.result.doctree
index 4aeac86a14..0938a2f7af 100644
Binary files a/v0.2.5/.doctrees/information/environment.result.doctree and b/v0.2.5/.doctrees/information/environment.result.doctree differ
diff --git a/v0.2.5/.doctrees/nbsphinx/information/environment.ipynb b/v0.2.5/.doctrees/nbsphinx/information/environment.ipynb
index b03dc57d5b..f28efec9f2 100644
--- a/v0.2.5/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.2.5/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:01:09.757433Z",
-     "iopub.status.busy": "2024-07-23T18:01:09.756923Z",
-     "iopub.status.idle": "2024-07-23T18:01:10.931491Z",
-     "shell.execute_reply": "2024-07-23T18:01:10.930744Z"
+     "iopub.execute_input": "2024-07-23T18:07:51.367682Z",
+     "iopub.status.busy": "2024-07-23T18:07:51.367203Z",
+     "iopub.status.idle": "2024-07-23T18:07:52.537317Z",
+     "shell.execute_reply": "2024-07-23T18:07:52.536557Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2965.37825 MHz\n",
+      "CPU Freq: 2916.2 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.5/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.2.5/.doctrees/nbsphinx/information/environment.result.ipynb
index 153a5496f9..f2b3bbe4a9 100644
--- a/v0.2.5/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.2.5/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:13:09.824624Z",
-     "iopub.status.busy": "2024-07-23T17:13:09.824115Z",
-     "iopub.status.idle": "2024-07-23T17:13:10.996268Z",
-     "shell.execute_reply": "2024-07-23T17:13:10.995491Z"
+     "iopub.execute_input": "2024-07-23T17:19:02.619214Z",
+     "iopub.status.busy": "2024-07-23T17:19:02.618990Z",
+     "iopub.status.idle": "2024-07-23T17:19:03.804557Z",
+     "shell.execute_reply": "2024-07-23T17:19:03.803741Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2905.8445 MHz\n",
+      "CPU Freq: 3081.0682500000003 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.5/.doctrees/tutorials/installation/index.doctree b/v0.2.5/.doctrees/tutorials/installation/index.doctree
index 5f4662d1cc..ad45c31e06 100644
Binary files a/v0.2.5/.doctrees/tutorials/installation/index.doctree and b/v0.2.5/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.2.5/.doctrees/tutorials/quick_start/index.doctree b/v0.2.5/.doctrees/tutorials/quick_start/index.doctree
index 9b577047d8..5cf7a49878 100644
Binary files a/v0.2.5/.doctrees/tutorials/quick_start/index.doctree and b/v0.2.5/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.2.5/_sources/information/environment.result.ipynb.txt b/v0.2.5/_sources/information/environment.result.ipynb.txt
index 153a5496f9..f2b3bbe4a9 100644
--- a/v0.2.5/_sources/information/environment.result.ipynb.txt
+++ b/v0.2.5/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:13:09.824624Z",
-     "iopub.status.busy": "2024-07-23T17:13:09.824115Z",
-     "iopub.status.idle": "2024-07-23T17:13:10.996268Z",
-     "shell.execute_reply": "2024-07-23T17:13:10.995491Z"
+     "iopub.execute_input": "2024-07-23T17:19:02.619214Z",
+     "iopub.status.busy": "2024-07-23T17:19:02.618990Z",
+     "iopub.status.idle": "2024-07-23T17:19:03.804557Z",
+     "shell.execute_reply": "2024-07-23T17:19:03.803741Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2905.8445 MHz\n",
+      "CPU Freq: 3081.0682500000003 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.5/information/environment.html b/v0.2.5/information/environment.html
index e0fdc223a8..0398e6d067 100644
--- a/v0.2.5/information/environment.html
+++ b/v0.2.5/information/environment.html
@@ -126,11 +126,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2965.37825 MHz
+CPU Freq: 2916.2 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.5/information/environment.ipynb b/v0.2.5/information/environment.ipynb
index b03dc57d5b..f28efec9f2 100644
--- a/v0.2.5/information/environment.ipynb
+++ b/v0.2.5/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:01:09.757433Z",
-     "iopub.status.busy": "2024-07-23T18:01:09.756923Z",
-     "iopub.status.idle": "2024-07-23T18:01:10.931491Z",
-     "shell.execute_reply": "2024-07-23T18:01:10.930744Z"
+     "iopub.execute_input": "2024-07-23T18:07:51.367682Z",
+     "iopub.status.busy": "2024-07-23T18:07:51.367203Z",
+     "iopub.status.idle": "2024-07-23T18:07:52.537317Z",
+     "shell.execute_reply": "2024-07-23T18:07:52.536557Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2965.37825 MHz\n",
+      "CPU Freq: 2916.2 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.5/information/environment.result.html b/v0.2.5/information/environment.result.html
index a45fe550c8..aab24aeef3 100644
--- a/v0.2.5/information/environment.result.html
+++ b/v0.2.5/information/environment.result.html
@@ -128,11 +128,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2905.8445 MHz
+CPU Freq: 3081.0682500000003 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.5/information/environment.result.ipynb b/v0.2.5/information/environment.result.ipynb
index 153a5496f9..f2b3bbe4a9 100644
--- a/v0.2.5/information/environment.result.ipynb
+++ b/v0.2.5/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:13:09.824624Z",
-     "iopub.status.busy": "2024-07-23T17:13:09.824115Z",
-     "iopub.status.idle": "2024-07-23T17:13:10.996268Z",
-     "shell.execute_reply": "2024-07-23T17:13:10.995491Z"
+     "iopub.execute_input": "2024-07-23T17:19:02.619214Z",
+     "iopub.status.busy": "2024-07-23T17:19:02.618990Z",
+     "iopub.status.idle": "2024-07-23T17:19:03.804557Z",
+     "shell.execute_reply": "2024-07-23T17:19:03.803741Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2905.8445 MHz\n",
+      "CPU Freq: 3081.0682500000003 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.5/searchindex.js b/v0.2.5/searchindex.js
index c6b4344389..5317b7c006 100644
--- a/v0.2.5/searchindex.js
+++ b/v0.2.5/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 11, 13, 14], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 14, 16, 18, 21, 23, 24], "you": [0, 29], "requir": [0, 29], "simpli": [0, 29], "instal": [0, 26], "us": [0, 3, 11, 15, 16, 18, 21, 26, 29], "follow": [0, 8, 29], "code": [0, 3, 6, 9], "pip": [0, 29], "The": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 25, 29], "creation": 0, "file": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 25], "i": [0, 6, 9, 11, 13, 14, 16, 19, 20, 23, 26, 27, 28, 29], "we": 0, "util": [0, 26, 29], "rarfil": 0, "librari": [0, 21], "which": [0, 27, 28, 29], "doe": [0, 11], "offer": 0, "function": [0, 3, 14, 20, 21, 24], "creat": [0, 13], "str": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 25], "ext": 0, "list": [0, 3, 8, 11, 15, 16, 18], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24, 25], "regist": 0, "custom": [0, 3, 6, 9], "type": [0, 3, 8, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24, 25], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24, 25], "A": [0, 15], "take": 0, "directori": [0, 8, 13, 14, 16, 18, 25], "an": [0, 11, 13, 16, 18, 21, 24, 25], "filenam": [0, 21, 23], "input": 0, "extract": [0, 16], "type_nam": 0, "archive_fil": 0, "silent": [0, 13, 16, 18, 21, 24], "bool": [0, 5, 11, 13, 14, 16, 18, 19, 20, 21, 24], "fals": [0, 11, 13, 14, 16, 18, 19, 20, 21, 24], "clear": [0, 18], "specifi": [0, 14, 18, 21], "result": 0, "true": [0, 11, 13, 14, 16, 18, 19, 20, 21, 24], "suppress": [0, 13, 16, 18, 21], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 18], "exist": [0, 11, 16], "when": [0, 11, 13, 16], "return": [0, 3, 11, 13, 14, 15, 19, 20, 21, 23, 24, 25], "path": [0, 6, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 22, 25, 26], "password": [0, 16], "none": [0, 3, 5, 6, 9, 11, 13, 14, 15, 16, 18, 19, 21, 23], "content": [0, 24], "option": [0, 3, 5, 6, 9, 11, 13, 14, 15, 16, 18, 19, 21, 23, 24], "determin": 0, "base": [0, 7, 8, 17, 26], "rais": [0, 11, 14, 23], "valueerror": [0, 23], "ani": [0, 5, 20, 23], "get": [0, 11, 13, 15, 21, 23], "meta": [1, 26, 29], "__title__": [1, 29], "__version__": [1, 29], "__description__": [1, 29], "__author__": [1, 29], "__author_email__": 1, "inform": [2, 3, 5, 13], "packag": 2, "titl": 2, "thi": [2, 3, 6, 9, 14, 20, 21, 23, 24, 27, 28], "project": 2, "should": [2, 21, 29], "version": [2, 5, 24, 29], "short": 2, "descript": [2, 21], "includ": [2, 3, 13], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 11, 13], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 11, 13, 14, 15, 16, 21, 27, 28, 29], "object": [3, 8, 15, 16, 18, 21], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 25], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 21, 24], "keyword": [3, 21, 24], "argument": [3, 21, 24], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 13, 14, 27, 28], "two": 3, "2": [3, 8, 29], "class": [3, 6, 8, 9, 11, 23], "messag": [3, 6, 9, 13, 18], "except": [3, 6, 9, 11], "displai": [3, 6, 9, 21, 24], "yellow": 3, "color": 3, "error": [3, 6, 9], "exit_cod": [3, 6, 9], "exit": [3, 6, 9], "show": [3, 6, 9], "io": [3, 6, 9, 29], "write": [3, 6, 9], "output": [3, 6, 9, 16, 18, 21, 24, 29], "red": [3, 6, 9], "err": 3, "baseexcept": 3, "print": [3, 5, 27, 28, 29], "traceback": 3, "provid": [3, 21], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 29], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 26], "current": [5, 27, 28, 29], "metadata": 5, "arg": [5, 24], "indic": [6, 9], "remot": [6, 9], "repositori": [6, 9, 11, 13, 14, 15, 16, 18, 19, 23], "assign": [6, 9, 15, 16, 18], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 26], "print_vers": 7, "download": [7, 11, 17, 22, 26], "noremotepathassignedwithdownload": 7, "l": [7, 26], "listitemtyp": 7, "listitem": 7, "upload": [7, 13, 17, 26], "noremotepathassignedwithupload": 7, "whoami": [7, 26], "enum": 8, "repres": 8, "differ": [8, 27, 28], "item": [8, 14], "valid": [8, 12, 17, 26], "ar": 8, "folder": 8, "imag": 8, "3": [8, 27, 28, 29], "archiv": [8, 11, 13, 14, 16, 18, 26], "4": [8, 27, 28], "model": [8, 11, 13, 14, 15, 16, 18, 19, 23], "5": [8, 16, 27, 28, 29], "data": [8, 27, 28], "6": [8, 27, 28], "repofold": 8, "repofil": [8, 14], "base_dir": 8, "union": [8, 11], "33": 9, "standalon": 11, "incomplet": 11, "hash": [11, 13, 14, 15, 16, 18], "match": [11, 14, 19], "repo_id": [11, 13, 14, 15, 16, 18, 19, 23], "archive_in_repo": [11, 13, 14, 18], "repo_typ": [11, 13, 14, 15, 16, 18, 19, 23], "liter": [11, 13, 14, 15, 16, 18, 19, 23], "dataset": [11, 13, 14, 15, 16, 18, 19, 23], "space": [11, 13, 14, 15, 16, 18, 19, 23], "revis": [11, 13, 14, 15, 16, 18, 19, 23], "main": [11, 13, 14, 15, 16, 18, 19, 29], "idx_repo_id": [11, 13, 14], "idx_file_in_repo": [11, 13, 14], "idx_repo_typ": [11, 13, 14], "idx_revis": [11, 13, 14], "hf_token": [11, 13, 14, 15, 16, 18, 19], "insid": 11, "hug": [11, 13, 14, 15, 16, 18, 19], "face": [11, 13, 14, 15, 16, 18, 19], "identifi": [11, 13, 15, 16, 18, 19], "repotypetyp": [11, 13, 14, 15, 16, 18, 19, 23], "access": [11, 13], "token": [11, 13, 14, 15, 16, 18, 19], "file_in_arch": 11, "local_fil": [11, 16, 18, 19], "proxi": 11, "user_ag": 11, "header": 11, "endpoint": 11, "save": [11, 13, 16, 21], "local": [11, 13, 16, 18, 19, 21, 27, 28], "http": [11, 29], "request": [11, 21], "user": 11, "agent": 11, "addit": [11, 21, 24], "api": [11, 15, 16, 18, 19], "check": [11, 14, 19, 20, 21, 29], "otherwis": [11, 14, 19, 21], "fetch": [12, 26], "archivestandalonefileincompletedownload": 12, "archivestandalonefilehashnotmatch": 12, "hf_tar_list_fil": 12, "hf_tar_file_download": 12, "hf_tar_get_index": 12, "hf_tar_file_exist": 12, "make": [12, 26], "tar_create_index": 12, "hf_tar_create_index": 12, "tar_get_index_info": 12, "hf_tar_create_from_directori": 12, "hf_tar_item_valid": 12, "hf_tar_valid": 12, "src_tar_fil": 13, "dst_index_fil": 13, "chunk_for_hash": 13, "int": [13, 14, 16, 21], "1048576": 13, "with_hash": 13, "default": [13, 14, 16, 19, 23], "chunk": 13, "size": [13, 14, 21, 27, 28], "20": 13, "mb": 13, "whether": 13, "progress": [13, 16, 18, 21, 24], "bar": [13, 16, 18, 21, 24], "log": 13, "skip_when_sync": 13, "skip": 13, "sync": 13, "readi": [13, 19], "local_directori": [13, 16, 18], "file_item": 14, "hash_": 14, "hash_lf": 14, "expect": [14, 21], "sha": 14, "256": 14, "store": 14, "lf": 14, "id": [14, 23], "where": [14, 21], "authent": 14, "entrynotfounderror": 14, "entri": [14, 26], "found": 14, "isadirectoryerror": 14, "hfapi": 15, "client": [15, 16, 18], "huggingfac": [15, 16, 18, 23, 26, 29], "variabl": [15, 16, 18], "hffilesystem": 15, "system": 15, "subdir": 15, "ignore_pattern": [15, 16, 18], "given": [15, 20, 21, 23], "subdirectori": 15, "e": [15, 16, 18], "g": [15, 16, 18], "branch": [15, 16, 18], "tag": [15, 16, 18], "commit": [15, 16, 18], "pattern": [15, 16, 18], "ignor": [15, 16, 18], "file_in_repo": [16, 18, 19], "resume_download": 16, "within": [16, 18], "resum": 16, "dir_in_repo": 16, "max_work": 16, "8": [16, 27, 28, 29], "max_retri": 16, "all": [16, 25], "max": 16, "worker": 16, "retri": 16, "time": 16, "get_hf_client": 17, "get_hf_f": 17, "list_files_in_repositori": 17, "download_file_to_fil": 17, "download_archive_as_directori": 17, "download_directory_as_directori": 17, "upload_file_to_fil": 17, "upload_directory_as_arch": 17, "upload_directory_as_directori": 17, "is_local_file_readi": 17, "path_in_repo": 18, "time_suffix": 18, "its": 18, "append": 18, "timestamp": 18, "present": 18, "compar": 19, "hub": 19, "read": 20, "first": 20, "1024": 20, "byte": [20, 21], "contain": 20, "non": 20, "text": 20, "charact": 20, "url": 21, "expected_s": 21, "desc": 21, "session": 21, "tqdm": [21, 22, 26], "It": [21, 29], "also": [21, 29], "perform": [21, 27, 28], "ensur": 21, "ha": [21, 27, 28], "pass": [21, 24], "binari": [22, 26], "is_binary_fil": 22, "download_fil": 22, "hf_normpath": 22, "hf_fs_path": 22, "parse_hf_fs_path": 22, "hffilesystempath": 22, "walk": [22, 26], "walk_fil": 22, "normal": 23, "filesystem": 23, "pars": 23, "invalid": 23, "tqdm_": 24, "enhanc": 24, "silenc": 24, "modifi": 24, "behavior": 24, "allow": 24, "posit": 24, "std": 24, "recurs": 25, "through": [25, 29], "yield": 25, "rel": 25, "root": 25, "start": [25, 26], "modul": 26, "quick": 26, "run": 26, "environ": 26, "register_archive_typ": 26, "archive_pack": 26, "archive_unpack": 26, "get_archive_typ": 26, "get_archive_extnam": 26, "config": [26, 29], "index": [26, 29], "oper": 26, "here": [27, 28], "import": [27, 28, 29], "o": [27, 28], "platform": [27, 28], "shutil": [27, 28], "cpuinfo": [27, 28], "psutil": [27, 28], "hbutil": [27, 28], "scale": [27, 28], "size_to_bytes_str": [27, 28], "python": [27, 28, 29], "python_implement": [27, 28], "python_vers": [27, 28], "cpu": [27, 28], "brand": [27, 28], "get_cpu_info": [27, 28], "brand_raw": [27, 28], "count": [27, 28], "cpu_count": [27, 28], "freq": [27, 28], "cpu_freq": [27, 28], "mhz": [27, 28], "memori": [27, 28], "virtual_memori": [27, 28], "total": [27, 28], "precis": [27, 28], "cuda": [27, 28], "ye": [27, 28], "nvidia": [27, 28], "smi": [27, 28], "els": [27, 28], "No": [27, 28], "linux": [27, 28], "0": [27, 28, 29], "1023": [27, 28], "azur": [27, 28], "x86_64": [27, 28], "glibc2": [27, 28], "34": [27, 28], "cpython": [27, 28], "18": [27, 28], "amd": [27, 28], "epyc": [27, 28], "7763": [27, 28], "64": [27, 28], "core": [27, 28], "processor": [27, 28], "2965": 27, "37825": 27, "15": [27, 28], "606": [27, 28], "gib": [27, 28], "pleas": [27, 28], "note": [27, 28], "deploi": [27, 28], "document": [27, 28, 29], "automat": [27, 28], "execut": [27, 28], "github": [27, 28, 29], "action": [27, 28], "therefor": [27, 28], "some": [27, 28], "mai": [27, 28], "your": [27, 28, 29], "2905": 28, "8445": 28, "hfutil": 29, "host": 29, "pypi": 29, "can": 29, "newest": 29, "u": 29, "git": 29, "com": 29, "deepgh": 29, "script": 29, "__name__": 29, "__main__": 29, "develop": 29, "maintain": 29, "like": 29, "below": 29, "mean": 29, "success": 29, "narugo1992": 29, "still": 29, "under": 29, "out": 29, "stabl": 29, "html": 29, "faq": 30}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [12, 0, 0, "-", "index"], [17, 0, 0, "-", "operate"], [22, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "upload"], [10, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.upload": [[9, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.index": [[11, 0, 0, "-", "fetch"], [13, 0, 0, "-", "make"], [14, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[11, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [11, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [11, 1, 1, "", "hf_tar_file_download"], [11, 1, 1, "", "hf_tar_file_exists"], [11, 1, 1, "", "hf_tar_get_index"], [11, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[13, 1, 1, "", "hf_tar_create_from_directory"], [13, 1, 1, "", "hf_tar_create_index"], [13, 1, 1, "", "tar_create_index"], [13, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[14, 1, 1, "", "hf_tar_item_validate"], [14, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[15, 0, 0, "-", "base"], [16, 0, 0, "-", "download"], [18, 0, 0, "-", "upload"], [19, 0, 0, "-", "validate"]], "hfutils.operate.base": [[15, 1, 1, "", "get_hf_client"], [15, 1, 1, "", "get_hf_fs"], [15, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[16, 1, 1, "", "download_archive_as_directory"], [16, 1, 1, "", "download_directory_as_directory"], [16, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[18, 1, 1, "", "upload_directory_as_archive"], [18, 1, 1, "", "upload_directory_as_directory"], [18, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[19, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[20, 0, 0, "-", "binary"], [21, 0, 0, "-", "download"], [23, 0, 0, "-", "path"], [24, 0, 0, "-", "tqdm_"], [25, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[20, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[21, 1, 1, "", "download_file"]], "hfutils.utils.path": [[23, 3, 1, "", "HfFileSystemPath"], [23, 1, 1, "", "hf_fs_path"], [23, 1, 1, "", "hf_normpath"], [23, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[24, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[25, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9, 10], "base": [3, 15], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 16, 21], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "upload": [9, 18], "noremotepathassignedwithupload": 9, "whoami": 10, "index": [11, 12, 13, 14], "fetch": 11, "archivestandalonefileincompletedownload": 11, "archivestandalonefilehashnotmatch": 11, "hf_tar_list_fil": 11, "hf_tar_file_download": 11, "hf_tar_get_index": 11, "hf_tar_file_exist": 11, "make": 13, "tar_create_index": 13, "hf_tar_create_index": 13, "tar_get_index_info": 13, "hf_tar_create_from_directori": 13, "valid": [14, 19], "hf_tar_item_valid": 14, "hf_tar_valid": 14, "oper": [15, 16, 17, 18, 19], "get_hf_client": 15, "get_hf_f": 15, "list_files_in_repositori": 15, "download_file_to_fil": 16, "download_archive_as_directori": 16, "download_directory_as_directori": 16, "upload_file_to_fil": 18, "upload_directory_as_arch": 18, "upload_directory_as_directori": 18, "is_local_file_readi": 19, "util": [20, 21, 22, 23, 24, 25], "binari": 20, "is_binary_fil": 20, "download_fil": 21, "path": 23, "hf_normpath": 23, "hf_fs_path": 23, "parse_hf_fs_path": 23, "hffilesystempath": 23, "tqdm": 24, "walk": 25, "walk_fil": 25, "welcom": 26, "": 26, "document": 26, "overview": 26, "tutori": 26, "inform": [26, 27, 28], "api": 26, "run": [27, 28], "environ": [27, 28], "instal": 29, "quick": 30, "start": 30}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[9, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[10, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[11, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[11, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[11, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[11, "hf-tar-list-files"]], "hf_tar_file_download": [[11, "hf-tar-file-download"]], "hf_tar_get_index": [[11, "hf-tar-get-index"]], "hf_tar_file_exists": [[11, "hf-tar-file-exists"]], "hfutils.index": [[12, "module-hfutils.index"]], "hfutils.index.make": [[13, "module-hfutils.index.make"]], "tar_create_index": [[13, "tar-create-index"]], "hf_tar_create_index": [[13, "hf-tar-create-index"]], "tar_get_index_info": [[13, "tar-get-index-info"]], "hf_tar_create_from_directory": [[13, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[14, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[14, "hf-tar-item-validate"]], "hf_tar_validate": [[14, "hf-tar-validate"]], "hfutils.operate.base": [[15, "module-hfutils.operate.base"]], "get_hf_client": [[15, "get-hf-client"]], "get_hf_fs": [[15, "get-hf-fs"]], "list_files_in_repository": [[15, "list-files-in-repository"]], "hfutils.operate.download": [[16, "module-hfutils.operate.download"]], "download_file_to_file": [[16, "download-file-to-file"]], "download_archive_as_directory": [[16, "download-archive-as-directory"]], "download_directory_as_directory": [[16, "download-directory-as-directory"]], "hfutils.operate": [[17, "module-hfutils.operate"]], "hfutils.operate.upload": [[18, "module-hfutils.operate.upload"]], "upload_file_to_file": [[18, "upload-file-to-file"]], "upload_directory_as_archive": [[18, "upload-directory-as-archive"]], "upload_directory_as_directory": [[18, "upload-directory-as-directory"]], "hfutils.operate.validate": [[19, "module-hfutils.operate.validate"]], "is_local_file_ready": [[19, "is-local-file-ready"]], "hfutils.utils.binary": [[20, "module-hfutils.utils.binary"]], "is_binary_file": [[20, "is-binary-file"]], "hfutils.utils.download": [[21, "module-hfutils.utils.download"]], "download_file": [[21, "download-file"]], "hfutils.utils": [[22, "module-hfutils.utils"]], "hfutils.utils.path": [[23, "module-hfutils.utils.path"]], "hf_normpath": [[23, "hf-normpath"]], "hf_fs_path": [[23, "hf-fs-path"]], "parse_hf_fs_path": [[23, "parse-hf-fs-path"]], "HfFileSystemPath": [[23, "hffilesystempath"]], "hfutils.utils.tqdm": [[24, "module-hfutils.utils.tqdm_"]], "tqdm": [[24, "tqdm"]], "hfutils.utils.walk": [[25, "module-hfutils.utils.walk"]], "walk_files": [[25, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[26, "welcome-to-hfutils-s-documentation"]], "Overview": [[26, "overview"]], "Tutorials": [[26, null]], "Information": [[26, null]], "API Documentation": [[26, null]], "Run Environment Information": [[27, "Run-Environment-Information"], [28, "Run-Environment-Information"]], "Installation": [[29, "installation"]], "Quick Start": [[30, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.upload"], [10, "module-hfutils.entry.whoami"], [11, "module-hfutils.index.fetch"], [12, "module-hfutils.index"], [13, "module-hfutils.index.make"], [14, "module-hfutils.index.validate"], [15, "module-hfutils.operate.base"], [16, "module-hfutils.operate.download"], [17, "module-hfutils.operate"], [18, "module-hfutils.operate.upload"], [19, "module-hfutils.operate.validate"], [20, "module-hfutils.utils.binary"], [21, "module-hfutils.utils.download"], [22, "module-hfutils.utils"], [23, "module-hfutils.utils.path"], [24, "module-hfutils.utils.tqdm_"], [25, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[10, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[11, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[11, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[11, "module-hfutils.index.fetch"]], "hfutils.index": [[12, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[13, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[13, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[13, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[13, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[13, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[14, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[14, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[14, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[15, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[16, "module-hfutils.operate.download"]], "hfutils.operate": [[17, "module-hfutils.operate"]], "hfutils.operate.upload": [[18, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[19, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[19, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[20, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[20, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[21, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[21, "module-hfutils.utils.download"]], "hfutils.utils": [[22, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[23, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[23, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[23, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[23, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[23, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[24, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[24, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[25, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[25, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 11, 13, 14], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 14, 16, 18, 21, 23, 24], "you": [0, 29], "requir": [0, 29], "simpli": [0, 29], "instal": [0, 26], "us": [0, 3, 11, 15, 16, 18, 21, 26, 29], "follow": [0, 8, 29], "code": [0, 3, 6, 9], "pip": [0, 29], "The": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 25, 29], "creation": 0, "file": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 25], "i": [0, 6, 9, 11, 13, 14, 16, 19, 20, 23, 26, 27, 28, 29], "we": 0, "util": [0, 26, 29], "rarfil": 0, "librari": [0, 21], "which": [0, 27, 28, 29], "doe": [0, 11], "offer": 0, "function": [0, 3, 14, 20, 21, 24], "creat": [0, 13], "str": [0, 3, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 25], "ext": 0, "list": [0, 3, 8, 11, 15, 16, 18], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24, 25], "regist": 0, "custom": [0, 3, 6, 9], "type": [0, 3, 8, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24, 25], "associ": 0, "paramet": [0, 3, 5, 6, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24, 25], "A": [0, 15], "take": 0, "directori": [0, 8, 13, 14, 16, 18, 25], "an": [0, 11, 13, 16, 18, 21, 24, 25], "filenam": [0, 21, 23], "input": 0, "extract": [0, 16], "type_nam": 0, "archive_fil": 0, "silent": [0, 13, 16, 18, 21, 24], "bool": [0, 5, 11, 13, 14, 16, 18, 19, 20, 21, 24], "fals": [0, 11, 13, 14, 16, 18, 19, 20, 21, 24], "clear": [0, 18], "specifi": [0, 14, 18, 21], "result": 0, "true": [0, 11, 13, 14, 16, 18, 19, 20, 21, 24], "suppress": [0, 13, 16, 18, 21], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 18], "exist": [0, 11, 16], "when": [0, 11, 13, 16], "return": [0, 3, 11, 13, 14, 15, 19, 20, 21, 23, 24, 25], "path": [0, 6, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 22, 25, 26], "password": [0, 16], "none": [0, 3, 5, 6, 9, 11, 13, 14, 15, 16, 18, 19, 21, 23], "content": [0, 24], "option": [0, 3, 5, 6, 9, 11, 13, 14, 15, 16, 18, 19, 21, 23, 24], "determin": 0, "base": [0, 7, 8, 17, 26], "rais": [0, 11, 14, 23], "valueerror": [0, 23], "ani": [0, 5, 20, 23], "get": [0, 11, 13, 15, 21, 23], "meta": [1, 26, 29], "__title__": [1, 29], "__version__": [1, 29], "__description__": [1, 29], "__author__": [1, 29], "__author_email__": 1, "inform": [2, 3, 5, 13], "packag": 2, "titl": 2, "thi": [2, 3, 6, 9, 14, 20, 21, 23, 24, 27, 28], "project": 2, "should": [2, 21, 29], "version": [2, 5, 24, 29], "short": 2, "descript": [2, 21], "includ": [2, 3, 13], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 11, 13], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 11, 13, 14, 15, 16, 21, 27, 28, 29], "object": [3, 8, 15, 16, 18, 21], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 25], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 21, 24], "keyword": [3, 21, 24], "argument": [3, 21, 24], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 13, 14, 27, 28], "two": 3, "2": [3, 8, 27, 29], "class": [3, 6, 8, 9, 11, 23], "messag": [3, 6, 9, 13, 18], "except": [3, 6, 9, 11], "displai": [3, 6, 9, 21, 24], "yellow": 3, "color": 3, "error": [3, 6, 9], "exit_cod": [3, 6, 9], "exit": [3, 6, 9], "show": [3, 6, 9], "io": [3, 6, 9, 29], "write": [3, 6, 9], "output": [3, 6, 9, 16, 18, 21, 24, 29], "red": [3, 6, 9], "err": 3, "baseexcept": 3, "print": [3, 5, 27, 28, 29], "traceback": 3, "provid": [3, 21], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 29], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 26], "current": [5, 27, 28, 29], "metadata": 5, "arg": [5, 24], "indic": [6, 9], "remot": [6, 9], "repositori": [6, 9, 11, 13, 14, 15, 16, 18, 19, 23], "assign": [6, 9, 15, 16, 18], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 26], "print_vers": 7, "download": [7, 11, 17, 22, 26], "noremotepathassignedwithdownload": 7, "l": [7, 26], "listitemtyp": 7, "listitem": 7, "upload": [7, 13, 17, 26], "noremotepathassignedwithupload": 7, "whoami": [7, 26], "enum": 8, "repres": 8, "differ": [8, 27, 28], "item": [8, 14], "valid": [8, 12, 17, 26], "ar": 8, "folder": 8, "imag": 8, "3": [8, 27, 28, 29], "archiv": [8, 11, 13, 14, 16, 18, 26], "4": [8, 27, 28], "model": [8, 11, 13, 14, 15, 16, 18, 19, 23], "5": [8, 16, 27, 28, 29], "data": [8, 27, 28], "6": [8, 27, 28], "repofold": 8, "repofil": [8, 14], "base_dir": 8, "union": [8, 11], "33": 9, "standalon": 11, "incomplet": 11, "hash": [11, 13, 14, 15, 16, 18], "match": [11, 14, 19], "repo_id": [11, 13, 14, 15, 16, 18, 19, 23], "archive_in_repo": [11, 13, 14, 18], "repo_typ": [11, 13, 14, 15, 16, 18, 19, 23], "liter": [11, 13, 14, 15, 16, 18, 19, 23], "dataset": [11, 13, 14, 15, 16, 18, 19, 23], "space": [11, 13, 14, 15, 16, 18, 19, 23], "revis": [11, 13, 14, 15, 16, 18, 19, 23], "main": [11, 13, 14, 15, 16, 18, 19, 29], "idx_repo_id": [11, 13, 14], "idx_file_in_repo": [11, 13, 14], "idx_repo_typ": [11, 13, 14], "idx_revis": [11, 13, 14], "hf_token": [11, 13, 14, 15, 16, 18, 19], "insid": 11, "hug": [11, 13, 14, 15, 16, 18, 19], "face": [11, 13, 14, 15, 16, 18, 19], "identifi": [11, 13, 15, 16, 18, 19], "repotypetyp": [11, 13, 14, 15, 16, 18, 19, 23], "access": [11, 13], "token": [11, 13, 14, 15, 16, 18, 19], "file_in_arch": 11, "local_fil": [11, 16, 18, 19], "proxi": 11, "user_ag": 11, "header": 11, "endpoint": 11, "save": [11, 13, 16, 21], "local": [11, 13, 16, 18, 19, 21, 27, 28], "http": [11, 29], "request": [11, 21], "user": 11, "agent": 11, "addit": [11, 21, 24], "api": [11, 15, 16, 18, 19], "check": [11, 14, 19, 20, 21, 29], "otherwis": [11, 14, 19, 21], "fetch": [12, 26], "archivestandalonefileincompletedownload": 12, "archivestandalonefilehashnotmatch": 12, "hf_tar_list_fil": 12, "hf_tar_file_download": 12, "hf_tar_get_index": 12, "hf_tar_file_exist": 12, "make": [12, 26], "tar_create_index": 12, "hf_tar_create_index": 12, "tar_get_index_info": 12, "hf_tar_create_from_directori": 12, "hf_tar_item_valid": 12, "hf_tar_valid": 12, "src_tar_fil": 13, "dst_index_fil": 13, "chunk_for_hash": 13, "int": [13, 14, 16, 21], "1048576": 13, "with_hash": 13, "default": [13, 14, 16, 19, 23], "chunk": 13, "size": [13, 14, 21, 27, 28], "20": 13, "mb": 13, "whether": 13, "progress": [13, 16, 18, 21, 24], "bar": [13, 16, 18, 21, 24], "log": 13, "skip_when_sync": 13, "skip": 13, "sync": 13, "readi": [13, 19], "local_directori": [13, 16, 18], "file_item": 14, "hash_": 14, "hash_lf": 14, "expect": [14, 21], "sha": 14, "256": 14, "store": 14, "lf": 14, "id": [14, 23], "where": [14, 21], "authent": 14, "entrynotfounderror": 14, "entri": [14, 26], "found": 14, "isadirectoryerror": 14, "hfapi": 15, "client": [15, 16, 18], "huggingfac": [15, 16, 18, 23, 26, 29], "variabl": [15, 16, 18], "hffilesystem": 15, "system": 15, "subdir": 15, "ignore_pattern": [15, 16, 18], "given": [15, 20, 21, 23], "subdirectori": 15, "e": [15, 16, 18], "g": [15, 16, 18], "branch": [15, 16, 18], "tag": [15, 16, 18], "commit": [15, 16, 18], "pattern": [15, 16, 18], "ignor": [15, 16, 18], "file_in_repo": [16, 18, 19], "resume_download": 16, "within": [16, 18], "resum": 16, "dir_in_repo": 16, "max_work": 16, "8": [16, 27, 28, 29], "max_retri": 16, "all": [16, 25], "max": 16, "worker": 16, "retri": 16, "time": 16, "get_hf_client": 17, "get_hf_f": 17, "list_files_in_repositori": 17, "download_file_to_fil": 17, "download_archive_as_directori": 17, "download_directory_as_directori": 17, "upload_file_to_fil": 17, "upload_directory_as_arch": 17, "upload_directory_as_directori": 17, "is_local_file_readi": 17, "path_in_repo": 18, "time_suffix": 18, "its": 18, "append": 18, "timestamp": 18, "present": 18, "compar": 19, "hub": 19, "read": 20, "first": 20, "1024": [20, 27, 28], "byte": [20, 21], "contain": 20, "non": 20, "text": 20, "charact": 20, "url": 21, "expected_s": 21, "desc": 21, "session": 21, "tqdm": [21, 22, 26], "It": [21, 29], "also": [21, 29], "perform": [21, 27, 28], "ensur": 21, "ha": [21, 27, 28], "pass": [21, 24], "binari": [22, 26], "is_binary_fil": 22, "download_fil": 22, "hf_normpath": 22, "hf_fs_path": 22, "parse_hf_fs_path": 22, "hffilesystempath": 22, "walk": [22, 26], "walk_fil": 22, "normal": 23, "filesystem": 23, "pars": 23, "invalid": 23, "tqdm_": 24, "enhanc": 24, "silenc": 24, "modifi": 24, "behavior": 24, "allow": 24, "posit": 24, "std": 24, "recurs": 25, "through": [25, 29], "yield": 25, "rel": 25, "root": 25, "start": [25, 26], "modul": 26, "quick": 26, "run": 26, "environ": 26, "register_archive_typ": 26, "archive_pack": 26, "archive_unpack": 26, "get_archive_typ": 26, "get_archive_extnam": 26, "config": [26, 29], "index": [26, 29], "oper": 26, "here": [27, 28], "import": [27, 28, 29], "o": [27, 28], "platform": [27, 28], "shutil": [27, 28], "cpuinfo": [27, 28], "psutil": [27, 28], "hbutil": [27, 28], "scale": [27, 28], "size_to_bytes_str": [27, 28], "python": [27, 28, 29], "python_implement": [27, 28], "python_vers": [27, 28], "cpu": [27, 28], "brand": [27, 28], "get_cpu_info": [27, 28], "brand_raw": [27, 28], "count": [27, 28], "cpu_count": [27, 28], "freq": [27, 28], "cpu_freq": [27, 28], "mhz": [27, 28], "memori": [27, 28], "virtual_memori": [27, 28], "total": [27, 28], "precis": [27, 28], "cuda": [27, 28], "ye": [27, 28], "nvidia": [27, 28], "smi": [27, 28], "els": [27, 28], "No": [27, 28], "linux": [27, 28], "0": [27, 28, 29], "azur": [27, 28], "x86_64": [27, 28], "glibc2": [27, 28], "34": [27, 28], "cpython": [27, 28], "18": [27, 28], "amd": [27, 28], "epyc": [27, 28], "7763": [27, 28], "64": [27, 28], "core": [27, 28], "processor": [27, 28], "2916": 27, "15": [27, 28], "606": [27, 28], "gib": [27, 28], "pleas": [27, 28], "note": [27, 28], "deploi": [27, 28], "document": [27, 28, 29], "automat": [27, 28], "execut": [27, 28], "github": [27, 28, 29], "action": [27, 28], "therefor": [27, 28], "some": [27, 28], "mai": [27, 28], "your": [27, 28, 29], "3081": 28, "0682500000003": 28, "hfutil": 29, "host": 29, "pypi": 29, "can": 29, "newest": 29, "u": 29, "git": 29, "com": 29, "deepgh": 29, "script": 29, "__name__": 29, "__main__": 29, "develop": 29, "maintain": 29, "like": 29, "below": 29, "mean": 29, "success": 29, "narugo1992": 29, "still": 29, "under": 29, "out": 29, "stabl": 29, "html": 29, "faq": 30}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [12, 0, 0, "-", "index"], [17, 0, 0, "-", "operate"], [22, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "upload"], [10, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.upload": [[9, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.index": [[11, 0, 0, "-", "fetch"], [13, 0, 0, "-", "make"], [14, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[11, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [11, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [11, 1, 1, "", "hf_tar_file_download"], [11, 1, 1, "", "hf_tar_file_exists"], [11, 1, 1, "", "hf_tar_get_index"], [11, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[13, 1, 1, "", "hf_tar_create_from_directory"], [13, 1, 1, "", "hf_tar_create_index"], [13, 1, 1, "", "tar_create_index"], [13, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[14, 1, 1, "", "hf_tar_item_validate"], [14, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[15, 0, 0, "-", "base"], [16, 0, 0, "-", "download"], [18, 0, 0, "-", "upload"], [19, 0, 0, "-", "validate"]], "hfutils.operate.base": [[15, 1, 1, "", "get_hf_client"], [15, 1, 1, "", "get_hf_fs"], [15, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[16, 1, 1, "", "download_archive_as_directory"], [16, 1, 1, "", "download_directory_as_directory"], [16, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[18, 1, 1, "", "upload_directory_as_archive"], [18, 1, 1, "", "upload_directory_as_directory"], [18, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[19, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[20, 0, 0, "-", "binary"], [21, 0, 0, "-", "download"], [23, 0, 0, "-", "path"], [24, 0, 0, "-", "tqdm_"], [25, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[20, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[21, 1, 1, "", "download_file"]], "hfutils.utils.path": [[23, 3, 1, "", "HfFileSystemPath"], [23, 1, 1, "", "hf_fs_path"], [23, 1, 1, "", "hf_normpath"], [23, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[24, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[25, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9, 10], "base": [3, 15], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 16, 21], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "upload": [9, 18], "noremotepathassignedwithupload": 9, "whoami": 10, "index": [11, 12, 13, 14], "fetch": 11, "archivestandalonefileincompletedownload": 11, "archivestandalonefilehashnotmatch": 11, "hf_tar_list_fil": 11, "hf_tar_file_download": 11, "hf_tar_get_index": 11, "hf_tar_file_exist": 11, "make": 13, "tar_create_index": 13, "hf_tar_create_index": 13, "tar_get_index_info": 13, "hf_tar_create_from_directori": 13, "valid": [14, 19], "hf_tar_item_valid": 14, "hf_tar_valid": 14, "oper": [15, 16, 17, 18, 19], "get_hf_client": 15, "get_hf_f": 15, "list_files_in_repositori": 15, "download_file_to_fil": 16, "download_archive_as_directori": 16, "download_directory_as_directori": 16, "upload_file_to_fil": 18, "upload_directory_as_arch": 18, "upload_directory_as_directori": 18, "is_local_file_readi": 19, "util": [20, 21, 22, 23, 24, 25], "binari": 20, "is_binary_fil": 20, "download_fil": 21, "path": 23, "hf_normpath": 23, "hf_fs_path": 23, "parse_hf_fs_path": 23, "hffilesystempath": 23, "tqdm": 24, "walk": 25, "walk_fil": 25, "welcom": 26, "": 26, "document": 26, "overview": 26, "tutori": 26, "inform": [26, 27, 28], "api": 26, "run": [27, 28], "environ": [27, 28], "instal": 29, "quick": 30, "start": 30}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[9, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[10, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[11, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[11, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[11, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[11, "hf-tar-list-files"]], "hf_tar_file_download": [[11, "hf-tar-file-download"]], "hf_tar_get_index": [[11, "hf-tar-get-index"]], "hf_tar_file_exists": [[11, "hf-tar-file-exists"]], "hfutils.index": [[12, "module-hfutils.index"]], "hfutils.index.make": [[13, "module-hfutils.index.make"]], "tar_create_index": [[13, "tar-create-index"]], "hf_tar_create_index": [[13, "hf-tar-create-index"]], "tar_get_index_info": [[13, "tar-get-index-info"]], "hf_tar_create_from_directory": [[13, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[14, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[14, "hf-tar-item-validate"]], "hf_tar_validate": [[14, "hf-tar-validate"]], "hfutils.operate.base": [[15, "module-hfutils.operate.base"]], "get_hf_client": [[15, "get-hf-client"]], "get_hf_fs": [[15, "get-hf-fs"]], "list_files_in_repository": [[15, "list-files-in-repository"]], "hfutils.operate.download": [[16, "module-hfutils.operate.download"]], "download_file_to_file": [[16, "download-file-to-file"]], "download_archive_as_directory": [[16, "download-archive-as-directory"]], "download_directory_as_directory": [[16, "download-directory-as-directory"]], "hfutils.operate": [[17, "module-hfutils.operate"]], "hfutils.operate.upload": [[18, "module-hfutils.operate.upload"]], "upload_file_to_file": [[18, "upload-file-to-file"]], "upload_directory_as_archive": [[18, "upload-directory-as-archive"]], "upload_directory_as_directory": [[18, "upload-directory-as-directory"]], "hfutils.operate.validate": [[19, "module-hfutils.operate.validate"]], "is_local_file_ready": [[19, "is-local-file-ready"]], "hfutils.utils.binary": [[20, "module-hfutils.utils.binary"]], "is_binary_file": [[20, "is-binary-file"]], "hfutils.utils.download": [[21, "module-hfutils.utils.download"]], "download_file": [[21, "download-file"]], "hfutils.utils": [[22, "module-hfutils.utils"]], "hfutils.utils.path": [[23, "module-hfutils.utils.path"]], "hf_normpath": [[23, "hf-normpath"]], "hf_fs_path": [[23, "hf-fs-path"]], "parse_hf_fs_path": [[23, "parse-hf-fs-path"]], "HfFileSystemPath": [[23, "hffilesystempath"]], "hfutils.utils.tqdm": [[24, "module-hfutils.utils.tqdm_"]], "tqdm": [[24, "tqdm"]], "hfutils.utils.walk": [[25, "module-hfutils.utils.walk"]], "walk_files": [[25, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[26, "welcome-to-hfutils-s-documentation"]], "Overview": [[26, "overview"]], "Tutorials": [[26, null]], "Information": [[26, null]], "API Documentation": [[26, null]], "Run Environment Information": [[27, "Run-Environment-Information"], [28, "Run-Environment-Information"]], "Installation": [[29, "installation"]], "Quick Start": [[30, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.upload"], [10, "module-hfutils.entry.whoami"], [11, "module-hfutils.index.fetch"], [12, "module-hfutils.index"], [13, "module-hfutils.index.make"], [14, "module-hfutils.index.validate"], [15, "module-hfutils.operate.base"], [16, "module-hfutils.operate.download"], [17, "module-hfutils.operate"], [18, "module-hfutils.operate.upload"], [19, "module-hfutils.operate.validate"], [20, "module-hfutils.utils.binary"], [21, "module-hfutils.utils.download"], [22, "module-hfutils.utils"], [23, "module-hfutils.utils.path"], [24, "module-hfutils.utils.tqdm_"], [25, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[9, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[9, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[10, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[11, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[11, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[11, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[11, "module-hfutils.index.fetch"]], "hfutils.index": [[12, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[13, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[13, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[13, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[13, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[13, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[14, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[14, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[14, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[15, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[15, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[16, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[16, "module-hfutils.operate.download"]], "hfutils.operate": [[17, "module-hfutils.operate"]], "hfutils.operate.upload": [[18, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[18, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[19, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[19, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[20, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[20, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[21, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[21, "module-hfutils.utils.download"]], "hfutils.utils": [[22, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[23, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[23, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[23, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[23, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[23, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[24, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[24, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[25, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[25, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.2.6/.buildinfo b/v0.2.6/.buildinfo
index b8fea2f57b..717236cdce 100644
--- a/v0.2.6/.buildinfo
+++ b/v0.2.6/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 489dde1fd5af7693dd037a691d4596a3
+config: bf582edd246b18c6e52e07c6a8348893
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.2.6/.doctrees/api_doc/archive/index.doctree b/v0.2.6/.doctrees/api_doc/archive/index.doctree
index d882cc5a1c..6199d5833e 100644
Binary files a/v0.2.6/.doctrees/api_doc/archive/index.doctree and b/v0.2.6/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/config/index.doctree b/v0.2.6/.doctrees/api_doc/config/index.doctree
index f27af9d0ae..4307db53a5 100644
Binary files a/v0.2.6/.doctrees/api_doc/config/index.doctree and b/v0.2.6/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/config/meta.doctree b/v0.2.6/.doctrees/api_doc/config/meta.doctree
index fa223a9d43..49cf35e810 100644
Binary files a/v0.2.6/.doctrees/api_doc/config/meta.doctree and b/v0.2.6/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/entry/base.doctree b/v0.2.6/.doctrees/api_doc/entry/base.doctree
index 3fe579a39d..36f854034d 100644
Binary files a/v0.2.6/.doctrees/api_doc/entry/base.doctree and b/v0.2.6/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/entry/cli.doctree b/v0.2.6/.doctrees/api_doc/entry/cli.doctree
index 0aaa99d7ae..68b65b3871 100644
Binary files a/v0.2.6/.doctrees/api_doc/entry/cli.doctree and b/v0.2.6/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/entry/dispatch.doctree b/v0.2.6/.doctrees/api_doc/entry/dispatch.doctree
index dd48f32eb5..42a0f62cb0 100644
Binary files a/v0.2.6/.doctrees/api_doc/entry/dispatch.doctree and b/v0.2.6/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/entry/download.doctree b/v0.2.6/.doctrees/api_doc/entry/download.doctree
index 7a4f6c0695..cf62f69e86 100644
Binary files a/v0.2.6/.doctrees/api_doc/entry/download.doctree and b/v0.2.6/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/entry/index.doctree b/v0.2.6/.doctrees/api_doc/entry/index.doctree
index 52367a11fb..9daa49512b 100644
Binary files a/v0.2.6/.doctrees/api_doc/entry/index.doctree and b/v0.2.6/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/entry/ls.doctree b/v0.2.6/.doctrees/api_doc/entry/ls.doctree
index 4794d03309..440b0d0053 100644
Binary files a/v0.2.6/.doctrees/api_doc/entry/ls.doctree and b/v0.2.6/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/entry/ls_repo.doctree b/v0.2.6/.doctrees/api_doc/entry/ls_repo.doctree
index 80f54854f2..54f42b294a 100644
Binary files a/v0.2.6/.doctrees/api_doc/entry/ls_repo.doctree and b/v0.2.6/.doctrees/api_doc/entry/ls_repo.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/entry/upload.doctree b/v0.2.6/.doctrees/api_doc/entry/upload.doctree
index cd98452d7a..52cb57e23e 100644
Binary files a/v0.2.6/.doctrees/api_doc/entry/upload.doctree and b/v0.2.6/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/entry/whoami.doctree b/v0.2.6/.doctrees/api_doc/entry/whoami.doctree
index 8bd7bd8312..026537a858 100644
Binary files a/v0.2.6/.doctrees/api_doc/entry/whoami.doctree and b/v0.2.6/.doctrees/api_doc/entry/whoami.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/index/fetch.doctree b/v0.2.6/.doctrees/api_doc/index/fetch.doctree
index 5c2f04977f..e1a72e550e 100644
Binary files a/v0.2.6/.doctrees/api_doc/index/fetch.doctree and b/v0.2.6/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/index/index.doctree b/v0.2.6/.doctrees/api_doc/index/index.doctree
index 12da87ccc3..06f2b854ef 100644
Binary files a/v0.2.6/.doctrees/api_doc/index/index.doctree and b/v0.2.6/.doctrees/api_doc/index/index.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/index/make.doctree b/v0.2.6/.doctrees/api_doc/index/make.doctree
index 0be07606f2..4ce4239798 100644
Binary files a/v0.2.6/.doctrees/api_doc/index/make.doctree and b/v0.2.6/.doctrees/api_doc/index/make.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/index/validate.doctree b/v0.2.6/.doctrees/api_doc/index/validate.doctree
index 45d2ce70ec..3b187ce5af 100644
Binary files a/v0.2.6/.doctrees/api_doc/index/validate.doctree and b/v0.2.6/.doctrees/api_doc/index/validate.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/operate/base.doctree b/v0.2.6/.doctrees/api_doc/operate/base.doctree
index bdf2de025e..abc00f3ca5 100644
Binary files a/v0.2.6/.doctrees/api_doc/operate/base.doctree and b/v0.2.6/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/operate/download.doctree b/v0.2.6/.doctrees/api_doc/operate/download.doctree
index ee3bcbbf72..b7f8902bf1 100644
Binary files a/v0.2.6/.doctrees/api_doc/operate/download.doctree and b/v0.2.6/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/operate/index.doctree b/v0.2.6/.doctrees/api_doc/operate/index.doctree
index 62270b8fa9..196486cd5f 100644
Binary files a/v0.2.6/.doctrees/api_doc/operate/index.doctree and b/v0.2.6/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/operate/upload.doctree b/v0.2.6/.doctrees/api_doc/operate/upload.doctree
index cbcd357609..cf21cf8e50 100644
Binary files a/v0.2.6/.doctrees/api_doc/operate/upload.doctree and b/v0.2.6/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/operate/validate.doctree b/v0.2.6/.doctrees/api_doc/operate/validate.doctree
index efe4c4a024..3e66217d23 100644
Binary files a/v0.2.6/.doctrees/api_doc/operate/validate.doctree and b/v0.2.6/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/utils/binary.doctree b/v0.2.6/.doctrees/api_doc/utils/binary.doctree
index 41eca1482e..33e2ec9211 100644
Binary files a/v0.2.6/.doctrees/api_doc/utils/binary.doctree and b/v0.2.6/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/utils/download.doctree b/v0.2.6/.doctrees/api_doc/utils/download.doctree
index 63f7bcfb52..7cc89836f3 100644
Binary files a/v0.2.6/.doctrees/api_doc/utils/download.doctree and b/v0.2.6/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/utils/index.doctree b/v0.2.6/.doctrees/api_doc/utils/index.doctree
index 46c481aacb..d90cdcdcd3 100644
Binary files a/v0.2.6/.doctrees/api_doc/utils/index.doctree and b/v0.2.6/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/utils/path.doctree b/v0.2.6/.doctrees/api_doc/utils/path.doctree
index 3c725645ac..1a30f92e7d 100644
Binary files a/v0.2.6/.doctrees/api_doc/utils/path.doctree and b/v0.2.6/.doctrees/api_doc/utils/path.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/utils/tqdm_.doctree b/v0.2.6/.doctrees/api_doc/utils/tqdm_.doctree
index 212454028c..3ce276f4f9 100644
Binary files a/v0.2.6/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.2.6/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.2.6/.doctrees/api_doc/utils/walk.doctree b/v0.2.6/.doctrees/api_doc/utils/walk.doctree
index 2dff82476f..2fb205a207 100644
Binary files a/v0.2.6/.doctrees/api_doc/utils/walk.doctree and b/v0.2.6/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.2.6/.doctrees/environment.pickle b/v0.2.6/.doctrees/environment.pickle
index bb7899cb33..d2a1f28df4 100644
Binary files a/v0.2.6/.doctrees/environment.pickle and b/v0.2.6/.doctrees/environment.pickle differ
diff --git a/v0.2.6/.doctrees/index.doctree b/v0.2.6/.doctrees/index.doctree
index ea2cd16ca3..d18b04535f 100644
Binary files a/v0.2.6/.doctrees/index.doctree and b/v0.2.6/.doctrees/index.doctree differ
diff --git a/v0.2.6/.doctrees/information/environment.doctree b/v0.2.6/.doctrees/information/environment.doctree
index d32a078939..18b337e801 100644
Binary files a/v0.2.6/.doctrees/information/environment.doctree and b/v0.2.6/.doctrees/information/environment.doctree differ
diff --git a/v0.2.6/.doctrees/information/environment.result.doctree b/v0.2.6/.doctrees/information/environment.result.doctree
index b55242c879..cc86fd5b7c 100644
Binary files a/v0.2.6/.doctrees/information/environment.result.doctree and b/v0.2.6/.doctrees/information/environment.result.doctree differ
diff --git a/v0.2.6/.doctrees/nbsphinx/information/environment.ipynb b/v0.2.6/.doctrees/nbsphinx/information/environment.ipynb
index c0435c7706..428bb24193 100644
--- a/v0.2.6/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.2.6/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:03:25.949139Z",
-     "iopub.status.busy": "2024-07-23T18:03:25.948931Z",
-     "iopub.status.idle": "2024-07-23T18:03:27.117224Z",
-     "shell.execute_reply": "2024-07-23T18:03:27.116503Z"
+     "iopub.execute_input": "2024-07-23T18:10:07.920304Z",
+     "iopub.status.busy": "2024-07-23T18:10:07.919743Z",
+     "iopub.status.idle": "2024-07-23T18:10:09.090270Z",
+     "shell.execute_reply": "2024-07-23T18:10:09.089511Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2938.0139999999997 MHz\n",
+      "CPU Freq: 2706.83625 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.6/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.2.6/.doctrees/nbsphinx/information/environment.result.ipynb
index 96bbcabcf2..6741f2fa8c 100644
--- a/v0.2.6/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.2.6/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:14:17.481299Z",
-     "iopub.status.busy": "2024-07-23T17:14:17.481106Z",
-     "iopub.status.idle": "2024-07-23T17:14:18.656535Z",
-     "shell.execute_reply": "2024-07-23T17:14:18.655672Z"
+     "iopub.execute_input": "2024-07-23T17:20:13.370190Z",
+     "iopub.status.busy": "2024-07-23T17:20:13.369576Z",
+     "iopub.status.idle": "2024-07-23T17:20:14.544605Z",
+     "shell.execute_reply": "2024-07-23T17:20:14.543855Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2889.73875 MHz\n",
+      "CPU Freq: 2930.4665 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.6/.doctrees/tutorials/installation/index.doctree b/v0.2.6/.doctrees/tutorials/installation/index.doctree
index af5f6f847b..c7006d6a8a 100644
Binary files a/v0.2.6/.doctrees/tutorials/installation/index.doctree and b/v0.2.6/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.2.6/.doctrees/tutorials/quick_start/index.doctree b/v0.2.6/.doctrees/tutorials/quick_start/index.doctree
index ed58829091..30a8c1b2c6 100644
Binary files a/v0.2.6/.doctrees/tutorials/quick_start/index.doctree and b/v0.2.6/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.2.6/_sources/information/environment.result.ipynb.txt b/v0.2.6/_sources/information/environment.result.ipynb.txt
index 96bbcabcf2..6741f2fa8c 100644
--- a/v0.2.6/_sources/information/environment.result.ipynb.txt
+++ b/v0.2.6/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:14:17.481299Z",
-     "iopub.status.busy": "2024-07-23T17:14:17.481106Z",
-     "iopub.status.idle": "2024-07-23T17:14:18.656535Z",
-     "shell.execute_reply": "2024-07-23T17:14:18.655672Z"
+     "iopub.execute_input": "2024-07-23T17:20:13.370190Z",
+     "iopub.status.busy": "2024-07-23T17:20:13.369576Z",
+     "iopub.status.idle": "2024-07-23T17:20:14.544605Z",
+     "shell.execute_reply": "2024-07-23T17:20:14.543855Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2889.73875 MHz\n",
+      "CPU Freq: 2930.4665 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.6/information/environment.html b/v0.2.6/information/environment.html
index 154ae77009..8223e8d7c3 100644
--- a/v0.2.6/information/environment.html
+++ b/v0.2.6/information/environment.html
@@ -126,11 +126,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2938.0139999999997 MHz
+CPU Freq: 2706.83625 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.6/information/environment.ipynb b/v0.2.6/information/environment.ipynb
index c0435c7706..428bb24193 100644
--- a/v0.2.6/information/environment.ipynb
+++ b/v0.2.6/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:03:25.949139Z",
-     "iopub.status.busy": "2024-07-23T18:03:25.948931Z",
-     "iopub.status.idle": "2024-07-23T18:03:27.117224Z",
-     "shell.execute_reply": "2024-07-23T18:03:27.116503Z"
+     "iopub.execute_input": "2024-07-23T18:10:07.920304Z",
+     "iopub.status.busy": "2024-07-23T18:10:07.919743Z",
+     "iopub.status.idle": "2024-07-23T18:10:09.090270Z",
+     "shell.execute_reply": "2024-07-23T18:10:09.089511Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2938.0139999999997 MHz\n",
+      "CPU Freq: 2706.83625 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.6/information/environment.result.html b/v0.2.6/information/environment.result.html
index f3c710f593..8c2ca8a7ed 100644
--- a/v0.2.6/information/environment.result.html
+++ b/v0.2.6/information/environment.result.html
@@ -128,11 +128,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2889.73875 MHz
+CPU Freq: 2930.4665 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.6/information/environment.result.ipynb b/v0.2.6/information/environment.result.ipynb
index 96bbcabcf2..6741f2fa8c 100644
--- a/v0.2.6/information/environment.result.ipynb
+++ b/v0.2.6/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:14:17.481299Z",
-     "iopub.status.busy": "2024-07-23T17:14:17.481106Z",
-     "iopub.status.idle": "2024-07-23T17:14:18.656535Z",
-     "shell.execute_reply": "2024-07-23T17:14:18.655672Z"
+     "iopub.execute_input": "2024-07-23T17:20:13.370190Z",
+     "iopub.status.busy": "2024-07-23T17:20:13.369576Z",
+     "iopub.status.idle": "2024-07-23T17:20:14.544605Z",
+     "shell.execute_reply": "2024-07-23T17:20:14.543855Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2889.73875 MHz\n",
+      "CPU Freq: 2930.4665 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.6/searchindex.js b/v0.2.6/searchindex.js
index a1377d8434..0df535bf24 100644
--- a/v0.2.6/searchindex.js
+++ b/v0.2.6/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 12, 14, 15], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 15, 17, 19, 22, 24, 25], "you": [0, 30], "requir": [0, 30], "simpli": [0, 30], "instal": [0, 27], "us": [0, 3, 12, 16, 17, 19, 22, 27, 30], "follow": [0, 8, 30], "code": [0, 3, 6, 10], "pip": [0, 30], "The": [0, 3, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26, 30], "creation": 0, "file": [0, 3, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 26], "i": [0, 6, 9, 10, 12, 14, 15, 17, 20, 21, 24, 27, 28, 29, 30], "we": 0, "util": [0, 27, 30], "rarfil": 0, "librari": [0, 22], "which": [0, 28, 29, 30], "doe": [0, 12], "offer": 0, "function": [0, 3, 15, 21, 22, 25], "creat": [0, 14], "str": [0, 3, 6, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26], "ext": 0, "list": [0, 3, 8, 12, 16, 17, 19], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "regist": 0, "custom": [0, 3, 6, 10], "type": [0, 3, 8, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "associ": 0, "paramet": [0, 3, 5, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "A": [0, 16], "take": 0, "directori": [0, 8, 14, 15, 17, 19, 26], "an": [0, 12, 14, 17, 19, 22, 25, 26], "filenam": [0, 22, 24], "input": 0, "extract": [0, 17], "type_nam": 0, "archive_fil": 0, "silent": [0, 14, 17, 19, 22, 25], "bool": [0, 5, 12, 14, 15, 17, 19, 20, 21, 22, 25], "fals": [0, 12, 14, 15, 17, 19, 20, 21, 22, 25], "clear": [0, 19], "specifi": [0, 15, 19, 22], "result": 0, "true": [0, 12, 14, 15, 17, 19, 20, 21, 22, 25], "suppress": [0, 14, 17, 19, 22], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 19], "exist": [0, 12, 17], "when": [0, 9, 12, 14, 17], "return": [0, 3, 12, 14, 15, 16, 20, 21, 22, 24, 25, 26], "path": [0, 6, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 23, 26, 27], "password": [0, 17], "none": [0, 3, 5, 6, 10, 12, 14, 15, 16, 17, 19, 20, 22, 24], "content": [0, 25], "option": [0, 3, 5, 6, 10, 12, 14, 15, 16, 17, 19, 20, 22, 24, 25], "determin": 0, "base": [0, 7, 8, 18, 27], "rais": [0, 9, 12, 15, 24], "valueerror": [0, 24], "ani": [0, 5, 21, 24], "get": [0, 12, 14, 16, 22, 24], "meta": [1, 27, 30], "__title__": [1, 30], "__version__": [1, 30], "__description__": [1, 30], "__author__": [1, 30], "__author_email__": 1, "inform": [2, 3, 5, 14], "packag": 2, "titl": 2, "thi": [2, 3, 6, 10, 15, 21, 22, 24, 25, 28, 29], "project": 2, "should": [2, 22, 30], "version": [2, 5, 25, 30], "short": 2, "descript": [2, 22], "includ": [2, 3, 14], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 12, 14], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 12, 14, 15, 16, 17, 22, 28, 29, 30], "object": [3, 8, 16, 17, 19, 22], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 26], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 22, 25], "keyword": [3, 22, 25], "argument": [3, 22, 25], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 14, 15, 28, 29], "two": 3, "2": [3, 8, 30], "class": [3, 6, 8, 9, 10, 12, 24], "messag": [3, 6, 9, 10, 14, 19], "except": [3, 6, 9, 10, 12], "displai": [3, 6, 10, 22, 25], "yellow": 3, "color": 3, "error": [3, 6, 10], "exit_cod": [3, 6, 10], "exit": [3, 6, 10], "show": [3, 6, 10], "io": [3, 6, 10, 30], "write": [3, 6, 10], "output": [3, 6, 10, 17, 19, 22, 25, 30], "red": [3, 6, 10], "err": 3, "baseexcept": 3, "print": [3, 5, 28, 29, 30], "traceback": 3, "provid": [3, 22], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 30], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 27], "current": [5, 28, 29, 30], "metadata": 5, "arg": [5, 25], "indic": [6, 10], "remot": [6, 10], "repositori": [6, 10, 12, 14, 15, 16, 17, 19, 20, 24], "assign": [6, 10, 16, 17, 19], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 27], "print_vers": 7, "download": [7, 12, 18, 23, 27], "noremotepathassignedwithdownload": 7, "l": [7, 27], "listitemtyp": 7, "listitem": 7, "ls_repo": [7, 27], "nolocalauthent": 7, "upload": [7, 14, 18, 27], "noremotepathassignedwithupload": 7, "whoami": [7, 27], "enum": 8, "repres": 8, "differ": [8, 28, 29], "item": [8, 15], "valid": [8, 13, 18, 27], "ar": 8, "folder": 8, "imag": 8, "3": [8, 28, 29, 30], "archiv": [8, 12, 14, 15, 17, 19, 27], "4": [8, 28, 29], "model": [8, 12, 14, 15, 16, 17, 19, 20, 24], "5": [8, 17, 28, 29], "data": [8, 28, 29], "6": [8, 28, 29, 30], "repofold": 8, "repofil": [8, 15], "base_dir": 8, "union": [8, 12], "local": [9, 12, 14, 17, 19, 20, 22, 28, 29], "authent": [9, 15], "token": [9, 12, 14, 15, 16, 17, 19, 20], "33": 10, "standalon": 12, "incomplet": 12, "hash": [12, 14, 15, 16, 17, 19], "match": [12, 15, 20], "repo_id": [12, 14, 15, 16, 17, 19, 20, 24], "archive_in_repo": [12, 14, 15, 19], "repo_typ": [12, 14, 15, 16, 17, 19, 20, 24], "liter": [12, 14, 15, 16, 17, 19, 20, 24], "dataset": [12, 14, 15, 16, 17, 19, 20, 24], "space": [12, 14, 15, 16, 17, 19, 20, 24], "revis": [12, 14, 15, 16, 17, 19, 20, 24], "main": [12, 14, 15, 16, 17, 19, 20, 30], "idx_repo_id": [12, 14, 15], "idx_file_in_repo": [12, 14, 15], "idx_repo_typ": [12, 14, 15], "idx_revis": [12, 14, 15], "hf_token": [12, 14, 15, 16, 17, 19, 20], "insid": 12, "hug": [12, 14, 15, 16, 17, 19, 20], "face": [12, 14, 15, 16, 17, 19, 20], "identifi": [12, 14, 16, 17, 19, 20], "repotypetyp": [12, 14, 15, 16, 17, 19, 20, 24], "access": [12, 14], "file_in_arch": 12, "local_fil": [12, 17, 19, 20], "proxi": 12, "user_ag": 12, "header": 12, "endpoint": 12, "save": [12, 14, 17, 22], "http": [12, 30], "request": [12, 22], "user": 12, "agent": 12, "addit": [12, 22, 25], "api": [12, 16, 17, 19, 20], "check": [12, 15, 20, 21, 22, 30], "otherwis": [12, 15, 20, 22], "fetch": [13, 27], "archivestandalonefileincompletedownload": 13, "archivestandalonefilehashnotmatch": 13, "hf_tar_list_fil": 13, "hf_tar_file_download": 13, "hf_tar_get_index": 13, "hf_tar_file_exist": 13, "make": [13, 27], "tar_create_index": 13, "hf_tar_create_index": 13, "tar_get_index_info": 13, "hf_tar_create_from_directori": 13, "hf_tar_item_valid": 13, "hf_tar_valid": 13, "src_tar_fil": 14, "dst_index_fil": 14, "chunk_for_hash": 14, "int": [14, 15, 17, 22], "1048576": 14, "with_hash": 14, "default": [14, 15, 17, 20, 24], "chunk": 14, "size": [14, 15, 22, 28, 29], "20": 14, "mb": 14, "whether": 14, "progress": [14, 17, 19, 22, 25], "bar": [14, 17, 19, 22, 25], "log": 14, "skip_when_sync": 14, "skip": 14, "sync": 14, "readi": [14, 20], "local_directori": [14, 17, 19], "file_item": 15, "hash_": 15, "hash_lf": 15, "expect": [15, 22], "sha": 15, "256": 15, "store": 15, "lf": 15, "id": [15, 24], "where": [15, 22], "entrynotfounderror": 15, "entri": [15, 27], "found": 15, "isadirectoryerror": 15, "hfapi": 16, "client": [16, 17, 19], "huggingfac": [16, 17, 19, 24, 27, 30], "variabl": [16, 17, 19], "hffilesystem": 16, "system": 16, "subdir": 16, "ignore_pattern": [16, 17, 19], "given": [16, 21, 22, 24], "subdirectori": 16, "e": [16, 17, 19], "g": [16, 17, 19], "branch": [16, 17, 19], "tag": [16, 17, 19], "commit": [16, 17, 19], "pattern": [16, 17, 19], "ignor": [16, 17, 19], "file_in_repo": [17, 19, 20], "resume_download": 17, "within": [17, 19], "resum": 17, "dir_in_repo": 17, "max_work": 17, "8": [17, 28, 29, 30], "max_retri": 17, "all": [17, 26], "max": 17, "worker": 17, "retri": 17, "time": 17, "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 18, "download_archive_as_directori": 18, "download_directory_as_directori": 18, "upload_file_to_fil": 18, "upload_directory_as_arch": 18, "upload_directory_as_directori": 18, "is_local_file_readi": 18, "path_in_repo": 19, "time_suffix": 19, "its": 19, "append": 19, "timestamp": 19, "present": 19, "compar": 20, "hub": 20, "read": 21, "first": 21, "1024": 21, "byte": [21, 22], "contain": 21, "non": 21, "text": 21, "charact": 21, "url": 22, "expected_s": 22, "desc": 22, "session": 22, "tqdm": [22, 23, 27], "It": [22, 30], "also": [22, 30], "perform": [22, 28, 29], "ensur": 22, "ha": [22, 28, 29], "pass": [22, 25], "binari": [23, 27], "is_binary_fil": 23, "download_fil": 23, "hf_normpath": 23, "hf_fs_path": 23, "parse_hf_fs_path": 23, "hffilesystempath": 23, "walk": [23, 27], "walk_fil": 23, "normal": 24, "filesystem": 24, "pars": 24, "invalid": 24, "tqdm_": 25, "enhanc": 25, "silenc": 25, "modifi": 25, "behavior": 25, "allow": 25, "posit": 25, "std": 25, "recurs": 26, "through": [26, 30], "yield": 26, "rel": 26, "root": 26, "start": [26, 27], "modul": 27, "quick": 27, "run": 27, "environ": 27, "register_archive_typ": 27, "archive_pack": 27, "archive_unpack": 27, "get_archive_typ": 27, "get_archive_extnam": 27, "config": [27, 30], "index": [27, 30], "oper": 27, "here": [28, 29], "import": [28, 29, 30], "o": [28, 29], "platform": [28, 29], "shutil": [28, 29], "cpuinfo": [28, 29], "psutil": [28, 29], "hbutil": [28, 29], "scale": [28, 29], "size_to_bytes_str": [28, 29], "python": [28, 29, 30], "python_implement": [28, 29], "python_vers": [28, 29], "cpu": [28, 29], "brand": [28, 29], "get_cpu_info": [28, 29], "brand_raw": [28, 29], "count": [28, 29], "cpu_count": [28, 29], "freq": [28, 29], "cpu_freq": [28, 29], "mhz": [28, 29], "memori": [28, 29], "virtual_memori": [28, 29], "total": [28, 29], "precis": [28, 29], "cuda": [28, 29], "ye": [28, 29], "nvidia": [28, 29], "smi": [28, 29], "els": [28, 29], "No": [28, 29], "linux": [28, 29], "0": [28, 29, 30], "1023": [28, 29], "azur": [28, 29], "x86_64": [28, 29], "glibc2": [28, 29], "34": [28, 29], "cpython": [28, 29], "18": [28, 29], "amd": [28, 29], "epyc": [28, 29], "7763": [28, 29], "64": [28, 29], "core": [28, 29], "processor": [28, 29], "2938": 28, "0139999999997": 28, "15": [28, 29], "606": [28, 29], "gib": [28, 29], "pleas": [28, 29], "note": [28, 29], "deploi": [28, 29], "document": [28, 29, 30], "automat": [28, 29], "execut": [28, 29], "github": [28, 29, 30], "action": [28, 29], "therefor": [28, 29], "some": [28, 29], "mai": [28, 29], "your": [28, 29, 30], "2889": 29, "73875": 29, "hfutil": 30, "host": 30, "pypi": 30, "can": 30, "newest": 30, "u": 30, "git": 30, "com": 30, "deepgh": 30, "script": 30, "__name__": 30, "__main__": 30, "develop": 30, "maintain": 30, "like": 30, "below": 30, "mean": 30, "success": 30, "narugo1992": 30, "still": 30, "under": 30, "out": 30, "stabl": 30, "html": 30, "faq": 31}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [13, 0, 0, "-", "index"], [18, 0, 0, "-", "operate"], [23, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "ls_repo"], [10, 0, 0, "-", "upload"], [11, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[9, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[10, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[10, 4, 1, "", "exit_code"], [10, 5, 1, "", "show"]], "hfutils.index": [[12, 0, 0, "-", "fetch"], [14, 0, 0, "-", "make"], [15, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[12, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [12, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [12, 1, 1, "", "hf_tar_file_download"], [12, 1, 1, "", "hf_tar_file_exists"], [12, 1, 1, "", "hf_tar_get_index"], [12, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[14, 1, 1, "", "hf_tar_create_from_directory"], [14, 1, 1, "", "hf_tar_create_index"], [14, 1, 1, "", "tar_create_index"], [14, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[15, 1, 1, "", "hf_tar_item_validate"], [15, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[16, 0, 0, "-", "base"], [17, 0, 0, "-", "download"], [19, 0, 0, "-", "upload"], [20, 0, 0, "-", "validate"]], "hfutils.operate.base": [[16, 1, 1, "", "get_hf_client"], [16, 1, 1, "", "get_hf_fs"], [16, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[17, 1, 1, "", "download_archive_as_directory"], [17, 1, 1, "", "download_directory_as_directory"], [17, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[19, 1, 1, "", "upload_directory_as_archive"], [19, 1, 1, "", "upload_directory_as_directory"], [19, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[20, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[21, 0, 0, "-", "binary"], [22, 0, 0, "-", "download"], [24, 0, 0, "-", "path"], [25, 0, 0, "-", "tqdm_"], [26, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[21, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[22, 1, 1, "", "download_file"]], "hfutils.utils.path": [[24, 3, 1, "", "HfFileSystemPath"], [24, 1, 1, "", "hf_fs_path"], [24, 1, 1, "", "hf_normpath"], [24, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[25, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[26, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9, 10, 11], "base": [3, 16], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 17, 22], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "ls_repo": 9, "nolocalauthent": 9, "upload": [10, 19], "noremotepathassignedwithupload": 10, "whoami": 11, "index": [12, 13, 14, 15], "fetch": 12, "archivestandalonefileincompletedownload": 12, "archivestandalonefilehashnotmatch": 12, "hf_tar_list_fil": 12, "hf_tar_file_download": 12, "hf_tar_get_index": 12, "hf_tar_file_exist": 12, "make": 14, "tar_create_index": 14, "hf_tar_create_index": 14, "tar_get_index_info": 14, "hf_tar_create_from_directori": 14, "valid": [15, 20], "hf_tar_item_valid": 15, "hf_tar_valid": 15, "oper": [16, 17, 18, 19, 20], "get_hf_client": 16, "get_hf_f": 16, "list_files_in_repositori": 16, "download_file_to_fil": 17, "download_archive_as_directori": 17, "download_directory_as_directori": 17, "upload_file_to_fil": 19, "upload_directory_as_arch": 19, "upload_directory_as_directori": 19, "is_local_file_readi": 20, "util": [21, 22, 23, 24, 25, 26], "binari": 21, "is_binary_fil": 21, "download_fil": 22, "path": 24, "hf_normpath": 24, "hf_fs_path": 24, "parse_hf_fs_path": 24, "hffilesystempath": 24, "tqdm": 25, "walk": 26, "walk_fil": 26, "welcom": 27, "": 27, "document": 27, "overview": 27, "tutori": 27, "inform": [27, 28, 29], "api": 27, "run": [28, 29], "environ": [28, 29], "instal": 30, "quick": 31, "start": 31}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.ls_repo": [[9, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[9, "nolocalauthentication"]], "hfutils.entry.upload": [[10, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[10, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[11, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[12, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[12, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[12, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[12, "hf-tar-list-files"]], "hf_tar_file_download": [[12, "hf-tar-file-download"]], "hf_tar_get_index": [[12, "hf-tar-get-index"]], "hf_tar_file_exists": [[12, "hf-tar-file-exists"]], "hfutils.index": [[13, "module-hfutils.index"]], "hfutils.index.make": [[14, "module-hfutils.index.make"]], "tar_create_index": [[14, "tar-create-index"]], "hf_tar_create_index": [[14, "hf-tar-create-index"]], "tar_get_index_info": [[14, "tar-get-index-info"]], "hf_tar_create_from_directory": [[14, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[15, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[15, "hf-tar-item-validate"]], "hf_tar_validate": [[15, "hf-tar-validate"]], "hfutils.operate.base": [[16, "module-hfutils.operate.base"]], "get_hf_client": [[16, "get-hf-client"]], "get_hf_fs": [[16, "get-hf-fs"]], "list_files_in_repository": [[16, "list-files-in-repository"]], "hfutils.operate.download": [[17, "module-hfutils.operate.download"]], "download_file_to_file": [[17, "download-file-to-file"]], "download_archive_as_directory": [[17, "download-archive-as-directory"]], "download_directory_as_directory": [[17, "download-directory-as-directory"]], "hfutils.operate": [[18, "module-hfutils.operate"]], "hfutils.operate.upload": [[19, "module-hfutils.operate.upload"]], "upload_file_to_file": [[19, "upload-file-to-file"]], "upload_directory_as_archive": [[19, "upload-directory-as-archive"]], "upload_directory_as_directory": [[19, "upload-directory-as-directory"]], "hfutils.operate.validate": [[20, "module-hfutils.operate.validate"]], "is_local_file_ready": [[20, "is-local-file-ready"]], "hfutils.utils.binary": [[21, "module-hfutils.utils.binary"]], "is_binary_file": [[21, "is-binary-file"]], "hfutils.utils.download": [[22, "module-hfutils.utils.download"]], "download_file": [[22, "download-file"]], "hfutils.utils": [[23, "module-hfutils.utils"]], "hfutils.utils.path": [[24, "module-hfutils.utils.path"]], "hf_normpath": [[24, "hf-normpath"]], "hf_fs_path": [[24, "hf-fs-path"]], "parse_hf_fs_path": [[24, "parse-hf-fs-path"]], "HfFileSystemPath": [[24, "hffilesystempath"]], "hfutils.utils.tqdm": [[25, "module-hfutils.utils.tqdm_"]], "tqdm": [[25, "tqdm"]], "hfutils.utils.walk": [[26, "module-hfutils.utils.walk"]], "walk_files": [[26, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[27, "welcome-to-hfutils-s-documentation"]], "Overview": [[27, "overview"]], "Tutorials": [[27, null]], "Information": [[27, null]], "API Documentation": [[27, null]], "Run Environment Information": [[28, "Run-Environment-Information"], [29, "Run-Environment-Information"]], "Installation": [[30, "installation"]], "Quick Start": [[31, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.ls_repo"], [10, "module-hfutils.entry.upload"], [11, "module-hfutils.entry.whoami"], [12, "module-hfutils.index.fetch"], [13, "module-hfutils.index"], [14, "module-hfutils.index.make"], [15, "module-hfutils.index.validate"], [16, "module-hfutils.operate.base"], [17, "module-hfutils.operate.download"], [18, "module-hfutils.operate"], [19, "module-hfutils.operate.upload"], [20, "module-hfutils.operate.validate"], [21, "module-hfutils.utils.binary"], [22, "module-hfutils.utils.download"], [23, "module-hfutils.utils"], [24, "module-hfutils.utils.path"], [25, "module-hfutils.utils.tqdm_"], [26, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[9, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[9, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[10, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[11, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[12, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[12, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[12, "module-hfutils.index.fetch"]], "hfutils.index": [[13, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[14, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[14, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[14, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[14, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[14, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[15, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[15, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[15, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[16, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[17, "module-hfutils.operate.download"]], "hfutils.operate": [[18, "module-hfutils.operate"]], "hfutils.operate.upload": [[19, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[20, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[20, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[21, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[21, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[22, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[22, "module-hfutils.utils.download"]], "hfutils.utils": [[23, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[24, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[24, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[25, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[25, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[26, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[26, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 12, 14, 15], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 15, 17, 19, 22, 24, 25], "you": [0, 30], "requir": [0, 30], "simpli": [0, 30], "instal": [0, 27], "us": [0, 3, 12, 16, 17, 19, 22, 27, 30], "follow": [0, 8, 30], "code": [0, 3, 6, 10], "pip": [0, 30], "The": [0, 3, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26, 30], "creation": 0, "file": [0, 3, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 26], "i": [0, 6, 9, 10, 12, 14, 15, 17, 20, 21, 24, 27, 28, 29, 30], "we": 0, "util": [0, 27, 30], "rarfil": 0, "librari": [0, 22], "which": [0, 28, 29, 30], "doe": [0, 12], "offer": 0, "function": [0, 3, 15, 21, 22, 25], "creat": [0, 14], "str": [0, 3, 6, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26], "ext": 0, "list": [0, 3, 8, 12, 16, 17, 19], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "regist": 0, "custom": [0, 3, 6, 10], "type": [0, 3, 8, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "associ": 0, "paramet": [0, 3, 5, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "A": [0, 16], "take": 0, "directori": [0, 8, 14, 15, 17, 19, 26], "an": [0, 12, 14, 17, 19, 22, 25, 26], "filenam": [0, 22, 24], "input": 0, "extract": [0, 17], "type_nam": 0, "archive_fil": 0, "silent": [0, 14, 17, 19, 22, 25], "bool": [0, 5, 12, 14, 15, 17, 19, 20, 21, 22, 25], "fals": [0, 12, 14, 15, 17, 19, 20, 21, 22, 25], "clear": [0, 19], "specifi": [0, 15, 19, 22], "result": 0, "true": [0, 12, 14, 15, 17, 19, 20, 21, 22, 25], "suppress": [0, 14, 17, 19, 22], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 19], "exist": [0, 12, 17], "when": [0, 9, 12, 14, 17], "return": [0, 3, 12, 14, 15, 16, 20, 21, 22, 24, 25, 26], "path": [0, 6, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 23, 26, 27], "password": [0, 17], "none": [0, 3, 5, 6, 10, 12, 14, 15, 16, 17, 19, 20, 22, 24], "content": [0, 25], "option": [0, 3, 5, 6, 10, 12, 14, 15, 16, 17, 19, 20, 22, 24, 25], "determin": 0, "base": [0, 7, 8, 18, 27], "rais": [0, 9, 12, 15, 24], "valueerror": [0, 24], "ani": [0, 5, 21, 24], "get": [0, 12, 14, 16, 22, 24], "meta": [1, 27, 30], "__title__": [1, 30], "__version__": [1, 30], "__description__": [1, 30], "__author__": [1, 30], "__author_email__": 1, "inform": [2, 3, 5, 14], "packag": 2, "titl": 2, "thi": [2, 3, 6, 10, 15, 21, 22, 24, 25, 28, 29], "project": 2, "should": [2, 22, 30], "version": [2, 5, 25, 30], "short": 2, "descript": [2, 22], "includ": [2, 3, 14], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 12, 14], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 12, 14, 15, 16, 17, 22, 28, 29, 30], "object": [3, 8, 16, 17, 19, 22], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 26], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 22, 25], "keyword": [3, 22, 25], "argument": [3, 22, 25], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 14, 15, 28, 29], "two": 3, "2": [3, 8, 30], "class": [3, 6, 8, 9, 10, 12, 24], "messag": [3, 6, 9, 10, 14, 19], "except": [3, 6, 9, 10, 12], "displai": [3, 6, 10, 22, 25], "yellow": 3, "color": 3, "error": [3, 6, 10], "exit_cod": [3, 6, 10], "exit": [3, 6, 10], "show": [3, 6, 10], "io": [3, 6, 10, 30], "write": [3, 6, 10], "output": [3, 6, 10, 17, 19, 22, 25, 30], "red": [3, 6, 10], "err": 3, "baseexcept": 3, "print": [3, 5, 28, 29, 30], "traceback": 3, "provid": [3, 22], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 30], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 27], "current": [5, 28, 29, 30], "metadata": 5, "arg": [5, 25], "indic": [6, 10], "remot": [6, 10], "repositori": [6, 10, 12, 14, 15, 16, 17, 19, 20, 24], "assign": [6, 10, 16, 17, 19], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 27], "print_vers": 7, "download": [7, 12, 18, 23, 27], "noremotepathassignedwithdownload": 7, "l": [7, 27], "listitemtyp": 7, "listitem": 7, "ls_repo": [7, 27], "nolocalauthent": 7, "upload": [7, 14, 18, 27], "noremotepathassignedwithupload": 7, "whoami": [7, 27], "enum": 8, "repres": 8, "differ": [8, 28, 29], "item": [8, 15], "valid": [8, 13, 18, 27], "ar": 8, "folder": 8, "imag": 8, "3": [8, 28, 29, 30], "archiv": [8, 12, 14, 15, 17, 19, 27], "4": [8, 28, 29], "model": [8, 12, 14, 15, 16, 17, 19, 20, 24], "5": [8, 17, 28, 29], "data": [8, 28, 29], "6": [8, 28, 29, 30], "repofold": 8, "repofil": [8, 15], "base_dir": 8, "union": [8, 12], "local": [9, 12, 14, 17, 19, 20, 22, 28, 29], "authent": [9, 15], "token": [9, 12, 14, 15, 16, 17, 19, 20], "33": 10, "standalon": 12, "incomplet": 12, "hash": [12, 14, 15, 16, 17, 19], "match": [12, 15, 20], "repo_id": [12, 14, 15, 16, 17, 19, 20, 24], "archive_in_repo": [12, 14, 15, 19], "repo_typ": [12, 14, 15, 16, 17, 19, 20, 24], "liter": [12, 14, 15, 16, 17, 19, 20, 24], "dataset": [12, 14, 15, 16, 17, 19, 20, 24], "space": [12, 14, 15, 16, 17, 19, 20, 24], "revis": [12, 14, 15, 16, 17, 19, 20, 24], "main": [12, 14, 15, 16, 17, 19, 20, 30], "idx_repo_id": [12, 14, 15], "idx_file_in_repo": [12, 14, 15], "idx_repo_typ": [12, 14, 15], "idx_revis": [12, 14, 15], "hf_token": [12, 14, 15, 16, 17, 19, 20], "insid": 12, "hug": [12, 14, 15, 16, 17, 19, 20], "face": [12, 14, 15, 16, 17, 19, 20], "identifi": [12, 14, 16, 17, 19, 20], "repotypetyp": [12, 14, 15, 16, 17, 19, 20, 24], "access": [12, 14], "file_in_arch": 12, "local_fil": [12, 17, 19, 20], "proxi": 12, "user_ag": 12, "header": 12, "endpoint": 12, "save": [12, 14, 17, 22], "http": [12, 30], "request": [12, 22], "user": 12, "agent": 12, "addit": [12, 22, 25], "api": [12, 16, 17, 19, 20], "check": [12, 15, 20, 21, 22, 30], "otherwis": [12, 15, 20, 22], "fetch": [13, 27], "archivestandalonefileincompletedownload": 13, "archivestandalonefilehashnotmatch": 13, "hf_tar_list_fil": 13, "hf_tar_file_download": 13, "hf_tar_get_index": 13, "hf_tar_file_exist": 13, "make": [13, 27], "tar_create_index": 13, "hf_tar_create_index": 13, "tar_get_index_info": 13, "hf_tar_create_from_directori": 13, "hf_tar_item_valid": 13, "hf_tar_valid": 13, "src_tar_fil": 14, "dst_index_fil": 14, "chunk_for_hash": 14, "int": [14, 15, 17, 22], "1048576": 14, "with_hash": 14, "default": [14, 15, 17, 20, 24], "chunk": 14, "size": [14, 15, 22, 28, 29], "20": 14, "mb": 14, "whether": 14, "progress": [14, 17, 19, 22, 25], "bar": [14, 17, 19, 22, 25], "log": 14, "skip_when_sync": 14, "skip": 14, "sync": 14, "readi": [14, 20], "local_directori": [14, 17, 19], "file_item": 15, "hash_": 15, "hash_lf": 15, "expect": [15, 22], "sha": 15, "256": 15, "store": 15, "lf": 15, "id": [15, 24], "where": [15, 22], "entrynotfounderror": 15, "entri": [15, 27], "found": 15, "isadirectoryerror": 15, "hfapi": 16, "client": [16, 17, 19], "huggingfac": [16, 17, 19, 24, 27, 30], "variabl": [16, 17, 19], "hffilesystem": 16, "system": 16, "subdir": 16, "ignore_pattern": [16, 17, 19], "given": [16, 21, 22, 24], "subdirectori": 16, "e": [16, 17, 19], "g": [16, 17, 19], "branch": [16, 17, 19], "tag": [16, 17, 19], "commit": [16, 17, 19], "pattern": [16, 17, 19], "ignor": [16, 17, 19], "file_in_repo": [17, 19, 20], "resume_download": 17, "within": [17, 19], "resum": 17, "dir_in_repo": 17, "max_work": 17, "8": [17, 28, 29, 30], "max_retri": 17, "all": [17, 26], "max": 17, "worker": 17, "retri": 17, "time": 17, "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 18, "download_archive_as_directori": 18, "download_directory_as_directori": 18, "upload_file_to_fil": 18, "upload_directory_as_arch": 18, "upload_directory_as_directori": 18, "is_local_file_readi": 18, "path_in_repo": 19, "time_suffix": 19, "its": 19, "append": 19, "timestamp": 19, "present": 19, "compar": 20, "hub": 20, "read": 21, "first": 21, "1024": [21, 28, 29], "byte": [21, 22], "contain": 21, "non": 21, "text": 21, "charact": 21, "url": 22, "expected_s": 22, "desc": 22, "session": 22, "tqdm": [22, 23, 27], "It": [22, 30], "also": [22, 30], "perform": [22, 28, 29], "ensur": 22, "ha": [22, 28, 29], "pass": [22, 25], "binari": [23, 27], "is_binary_fil": 23, "download_fil": 23, "hf_normpath": 23, "hf_fs_path": 23, "parse_hf_fs_path": 23, "hffilesystempath": 23, "walk": [23, 27], "walk_fil": 23, "normal": 24, "filesystem": 24, "pars": 24, "invalid": 24, "tqdm_": 25, "enhanc": 25, "silenc": 25, "modifi": 25, "behavior": 25, "allow": 25, "posit": 25, "std": 25, "recurs": 26, "through": [26, 30], "yield": 26, "rel": 26, "root": 26, "start": [26, 27], "modul": 27, "quick": 27, "run": 27, "environ": 27, "register_archive_typ": 27, "archive_pack": 27, "archive_unpack": 27, "get_archive_typ": 27, "get_archive_extnam": 27, "config": [27, 30], "index": [27, 30], "oper": 27, "here": [28, 29], "import": [28, 29, 30], "o": [28, 29], "platform": [28, 29], "shutil": [28, 29], "cpuinfo": [28, 29], "psutil": [28, 29], "hbutil": [28, 29], "scale": [28, 29], "size_to_bytes_str": [28, 29], "python": [28, 29, 30], "python_implement": [28, 29], "python_vers": [28, 29], "cpu": [28, 29], "brand": [28, 29], "get_cpu_info": [28, 29], "brand_raw": [28, 29], "count": [28, 29], "cpu_count": [28, 29], "freq": [28, 29], "cpu_freq": [28, 29], "mhz": [28, 29], "memori": [28, 29], "virtual_memori": [28, 29], "total": [28, 29], "precis": [28, 29], "cuda": [28, 29], "ye": [28, 29], "nvidia": [28, 29], "smi": [28, 29], "els": [28, 29], "No": [28, 29], "linux": [28, 29], "0": [28, 29, 30], "azur": [28, 29], "x86_64": [28, 29], "glibc2": [28, 29], "34": [28, 29], "cpython": [28, 29], "18": [28, 29], "amd": [28, 29], "epyc": [28, 29], "7763": [28, 29], "64": [28, 29], "core": [28, 29], "processor": [28, 29], "2706": 28, "83625": 28, "15": [28, 29], "606": [28, 29], "gib": [28, 29], "pleas": [28, 29], "note": [28, 29], "deploi": [28, 29], "document": [28, 29, 30], "automat": [28, 29], "execut": [28, 29], "github": [28, 29, 30], "action": [28, 29], "therefor": [28, 29], "some": [28, 29], "mai": [28, 29], "your": [28, 29, 30], "2930": 29, "4665": 29, "hfutil": 30, "host": 30, "pypi": 30, "can": 30, "newest": 30, "u": 30, "git": 30, "com": 30, "deepgh": 30, "script": 30, "__name__": 30, "__main__": 30, "develop": 30, "maintain": 30, "like": 30, "below": 30, "mean": 30, "success": 30, "narugo1992": 30, "still": 30, "under": 30, "out": 30, "stabl": 30, "html": 30, "faq": 31}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [13, 0, 0, "-", "index"], [18, 0, 0, "-", "operate"], [23, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "ls_repo"], [10, 0, 0, "-", "upload"], [11, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[9, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[10, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[10, 4, 1, "", "exit_code"], [10, 5, 1, "", "show"]], "hfutils.index": [[12, 0, 0, "-", "fetch"], [14, 0, 0, "-", "make"], [15, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[12, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [12, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [12, 1, 1, "", "hf_tar_file_download"], [12, 1, 1, "", "hf_tar_file_exists"], [12, 1, 1, "", "hf_tar_get_index"], [12, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[14, 1, 1, "", "hf_tar_create_from_directory"], [14, 1, 1, "", "hf_tar_create_index"], [14, 1, 1, "", "tar_create_index"], [14, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[15, 1, 1, "", "hf_tar_item_validate"], [15, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[16, 0, 0, "-", "base"], [17, 0, 0, "-", "download"], [19, 0, 0, "-", "upload"], [20, 0, 0, "-", "validate"]], "hfutils.operate.base": [[16, 1, 1, "", "get_hf_client"], [16, 1, 1, "", "get_hf_fs"], [16, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[17, 1, 1, "", "download_archive_as_directory"], [17, 1, 1, "", "download_directory_as_directory"], [17, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[19, 1, 1, "", "upload_directory_as_archive"], [19, 1, 1, "", "upload_directory_as_directory"], [19, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[20, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[21, 0, 0, "-", "binary"], [22, 0, 0, "-", "download"], [24, 0, 0, "-", "path"], [25, 0, 0, "-", "tqdm_"], [26, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[21, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[22, 1, 1, "", "download_file"]], "hfutils.utils.path": [[24, 3, 1, "", "HfFileSystemPath"], [24, 1, 1, "", "hf_fs_path"], [24, 1, 1, "", "hf_normpath"], [24, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[25, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[26, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9, 10, 11], "base": [3, 16], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 17, 22], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "ls_repo": 9, "nolocalauthent": 9, "upload": [10, 19], "noremotepathassignedwithupload": 10, "whoami": 11, "index": [12, 13, 14, 15], "fetch": 12, "archivestandalonefileincompletedownload": 12, "archivestandalonefilehashnotmatch": 12, "hf_tar_list_fil": 12, "hf_tar_file_download": 12, "hf_tar_get_index": 12, "hf_tar_file_exist": 12, "make": 14, "tar_create_index": 14, "hf_tar_create_index": 14, "tar_get_index_info": 14, "hf_tar_create_from_directori": 14, "valid": [15, 20], "hf_tar_item_valid": 15, "hf_tar_valid": 15, "oper": [16, 17, 18, 19, 20], "get_hf_client": 16, "get_hf_f": 16, "list_files_in_repositori": 16, "download_file_to_fil": 17, "download_archive_as_directori": 17, "download_directory_as_directori": 17, "upload_file_to_fil": 19, "upload_directory_as_arch": 19, "upload_directory_as_directori": 19, "is_local_file_readi": 20, "util": [21, 22, 23, 24, 25, 26], "binari": 21, "is_binary_fil": 21, "download_fil": 22, "path": 24, "hf_normpath": 24, "hf_fs_path": 24, "parse_hf_fs_path": 24, "hffilesystempath": 24, "tqdm": 25, "walk": 26, "walk_fil": 26, "welcom": 27, "": 27, "document": 27, "overview": 27, "tutori": 27, "inform": [27, 28, 29], "api": 27, "run": [28, 29], "environ": [28, 29], "instal": 30, "quick": 31, "start": 31}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.ls_repo": [[9, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[9, "nolocalauthentication"]], "hfutils.entry.upload": [[10, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[10, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[11, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[12, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[12, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[12, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[12, "hf-tar-list-files"]], "hf_tar_file_download": [[12, "hf-tar-file-download"]], "hf_tar_get_index": [[12, "hf-tar-get-index"]], "hf_tar_file_exists": [[12, "hf-tar-file-exists"]], "hfutils.index": [[13, "module-hfutils.index"]], "hfutils.index.make": [[14, "module-hfutils.index.make"]], "tar_create_index": [[14, "tar-create-index"]], "hf_tar_create_index": [[14, "hf-tar-create-index"]], "tar_get_index_info": [[14, "tar-get-index-info"]], "hf_tar_create_from_directory": [[14, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[15, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[15, "hf-tar-item-validate"]], "hf_tar_validate": [[15, "hf-tar-validate"]], "hfutils.operate.base": [[16, "module-hfutils.operate.base"]], "get_hf_client": [[16, "get-hf-client"]], "get_hf_fs": [[16, "get-hf-fs"]], "list_files_in_repository": [[16, "list-files-in-repository"]], "hfutils.operate.download": [[17, "module-hfutils.operate.download"]], "download_file_to_file": [[17, "download-file-to-file"]], "download_archive_as_directory": [[17, "download-archive-as-directory"]], "download_directory_as_directory": [[17, "download-directory-as-directory"]], "hfutils.operate": [[18, "module-hfutils.operate"]], "hfutils.operate.upload": [[19, "module-hfutils.operate.upload"]], "upload_file_to_file": [[19, "upload-file-to-file"]], "upload_directory_as_archive": [[19, "upload-directory-as-archive"]], "upload_directory_as_directory": [[19, "upload-directory-as-directory"]], "hfutils.operate.validate": [[20, "module-hfutils.operate.validate"]], "is_local_file_ready": [[20, "is-local-file-ready"]], "hfutils.utils.binary": [[21, "module-hfutils.utils.binary"]], "is_binary_file": [[21, "is-binary-file"]], "hfutils.utils.download": [[22, "module-hfutils.utils.download"]], "download_file": [[22, "download-file"]], "hfutils.utils": [[23, "module-hfutils.utils"]], "hfutils.utils.path": [[24, "module-hfutils.utils.path"]], "hf_normpath": [[24, "hf-normpath"]], "hf_fs_path": [[24, "hf-fs-path"]], "parse_hf_fs_path": [[24, "parse-hf-fs-path"]], "HfFileSystemPath": [[24, "hffilesystempath"]], "hfutils.utils.tqdm": [[25, "module-hfutils.utils.tqdm_"]], "tqdm": [[25, "tqdm"]], "hfutils.utils.walk": [[26, "module-hfutils.utils.walk"]], "walk_files": [[26, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[27, "welcome-to-hfutils-s-documentation"]], "Overview": [[27, "overview"]], "Tutorials": [[27, null]], "Information": [[27, null]], "API Documentation": [[27, null]], "Run Environment Information": [[28, "Run-Environment-Information"], [29, "Run-Environment-Information"]], "Installation": [[30, "installation"]], "Quick Start": [[31, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.ls_repo"], [10, "module-hfutils.entry.upload"], [11, "module-hfutils.entry.whoami"], [12, "module-hfutils.index.fetch"], [13, "module-hfutils.index"], [14, "module-hfutils.index.make"], [15, "module-hfutils.index.validate"], [16, "module-hfutils.operate.base"], [17, "module-hfutils.operate.download"], [18, "module-hfutils.operate"], [19, "module-hfutils.operate.upload"], [20, "module-hfutils.operate.validate"], [21, "module-hfutils.utils.binary"], [22, "module-hfutils.utils.download"], [23, "module-hfutils.utils"], [24, "module-hfutils.utils.path"], [25, "module-hfutils.utils.tqdm_"], [26, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[9, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[9, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[10, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[11, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[12, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[12, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[12, "module-hfutils.index.fetch"]], "hfutils.index": [[13, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[14, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[14, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[14, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[14, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[14, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[15, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[15, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[15, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[16, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[17, "module-hfutils.operate.download"]], "hfutils.operate": [[18, "module-hfutils.operate"]], "hfutils.operate.upload": [[19, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[20, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[20, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[21, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[21, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[22, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[22, "module-hfutils.utils.download"]], "hfutils.utils": [[23, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[24, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[24, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[25, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[25, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[26, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[26, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.2.7/.buildinfo b/v0.2.7/.buildinfo
index 32eab7378e..858a424c8a 100644
--- a/v0.2.7/.buildinfo
+++ b/v0.2.7/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 65d1ec8841088b11b46c95e506aaaa65
+config: de34c859f0b5f2c03da87cd9ee8e7504
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.2.7/.doctrees/api_doc/archive/index.doctree b/v0.2.7/.doctrees/api_doc/archive/index.doctree
index 77f362b0c3..cb153e80f8 100644
Binary files a/v0.2.7/.doctrees/api_doc/archive/index.doctree and b/v0.2.7/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/config/index.doctree b/v0.2.7/.doctrees/api_doc/config/index.doctree
index 96cb930319..b9e3d08072 100644
Binary files a/v0.2.7/.doctrees/api_doc/config/index.doctree and b/v0.2.7/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/config/meta.doctree b/v0.2.7/.doctrees/api_doc/config/meta.doctree
index ff461388d3..3d2dcaf889 100644
Binary files a/v0.2.7/.doctrees/api_doc/config/meta.doctree and b/v0.2.7/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/entry/base.doctree b/v0.2.7/.doctrees/api_doc/entry/base.doctree
index 661b08febb..194a5613fd 100644
Binary files a/v0.2.7/.doctrees/api_doc/entry/base.doctree and b/v0.2.7/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/entry/cli.doctree b/v0.2.7/.doctrees/api_doc/entry/cli.doctree
index b05108630d..faf75b6047 100644
Binary files a/v0.2.7/.doctrees/api_doc/entry/cli.doctree and b/v0.2.7/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/entry/dispatch.doctree b/v0.2.7/.doctrees/api_doc/entry/dispatch.doctree
index e9cfeda9ad..e55b16162e 100644
Binary files a/v0.2.7/.doctrees/api_doc/entry/dispatch.doctree and b/v0.2.7/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/entry/download.doctree b/v0.2.7/.doctrees/api_doc/entry/download.doctree
index 0aa9fba42d..e88c9d3fea 100644
Binary files a/v0.2.7/.doctrees/api_doc/entry/download.doctree and b/v0.2.7/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/entry/index.doctree b/v0.2.7/.doctrees/api_doc/entry/index.doctree
index df098e834c..780c8c3348 100644
Binary files a/v0.2.7/.doctrees/api_doc/entry/index.doctree and b/v0.2.7/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/entry/ls.doctree b/v0.2.7/.doctrees/api_doc/entry/ls.doctree
index 5bf6f035cd..782b7b1a80 100644
Binary files a/v0.2.7/.doctrees/api_doc/entry/ls.doctree and b/v0.2.7/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/entry/ls_repo.doctree b/v0.2.7/.doctrees/api_doc/entry/ls_repo.doctree
index 70a39d5a4c..c5a2cf1732 100644
Binary files a/v0.2.7/.doctrees/api_doc/entry/ls_repo.doctree and b/v0.2.7/.doctrees/api_doc/entry/ls_repo.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/entry/upload.doctree b/v0.2.7/.doctrees/api_doc/entry/upload.doctree
index e5d74565f3..7fc98fee04 100644
Binary files a/v0.2.7/.doctrees/api_doc/entry/upload.doctree and b/v0.2.7/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/entry/whoami.doctree b/v0.2.7/.doctrees/api_doc/entry/whoami.doctree
index 5f939e6381..64c03c1127 100644
Binary files a/v0.2.7/.doctrees/api_doc/entry/whoami.doctree and b/v0.2.7/.doctrees/api_doc/entry/whoami.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/index/fetch.doctree b/v0.2.7/.doctrees/api_doc/index/fetch.doctree
index 6a108eccf9..ea33d58aec 100644
Binary files a/v0.2.7/.doctrees/api_doc/index/fetch.doctree and b/v0.2.7/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/index/index.doctree b/v0.2.7/.doctrees/api_doc/index/index.doctree
index 21d27b65be..60b884e6ae 100644
Binary files a/v0.2.7/.doctrees/api_doc/index/index.doctree and b/v0.2.7/.doctrees/api_doc/index/index.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/index/make.doctree b/v0.2.7/.doctrees/api_doc/index/make.doctree
index 12e6990ddd..fedf324bc6 100644
Binary files a/v0.2.7/.doctrees/api_doc/index/make.doctree and b/v0.2.7/.doctrees/api_doc/index/make.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/index/validate.doctree b/v0.2.7/.doctrees/api_doc/index/validate.doctree
index 0c3d9881a2..754ef439ff 100644
Binary files a/v0.2.7/.doctrees/api_doc/index/validate.doctree and b/v0.2.7/.doctrees/api_doc/index/validate.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/operate/base.doctree b/v0.2.7/.doctrees/api_doc/operate/base.doctree
index 734a3ede81..e72eb5ae35 100644
Binary files a/v0.2.7/.doctrees/api_doc/operate/base.doctree and b/v0.2.7/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/operate/download.doctree b/v0.2.7/.doctrees/api_doc/operate/download.doctree
index 2967f9d14d..e30a517a19 100644
Binary files a/v0.2.7/.doctrees/api_doc/operate/download.doctree and b/v0.2.7/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/operate/index.doctree b/v0.2.7/.doctrees/api_doc/operate/index.doctree
index c75b0bf02b..f362a9ea2b 100644
Binary files a/v0.2.7/.doctrees/api_doc/operate/index.doctree and b/v0.2.7/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/operate/upload.doctree b/v0.2.7/.doctrees/api_doc/operate/upload.doctree
index 63ba749171..6b734eda3a 100644
Binary files a/v0.2.7/.doctrees/api_doc/operate/upload.doctree and b/v0.2.7/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/operate/validate.doctree b/v0.2.7/.doctrees/api_doc/operate/validate.doctree
index 1afdedc0ad..14d96abd83 100644
Binary files a/v0.2.7/.doctrees/api_doc/operate/validate.doctree and b/v0.2.7/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/utils/binary.doctree b/v0.2.7/.doctrees/api_doc/utils/binary.doctree
index f5629e5010..54a55b5861 100644
Binary files a/v0.2.7/.doctrees/api_doc/utils/binary.doctree and b/v0.2.7/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/utils/download.doctree b/v0.2.7/.doctrees/api_doc/utils/download.doctree
index d739f9a433..4fd17af5ea 100644
Binary files a/v0.2.7/.doctrees/api_doc/utils/download.doctree and b/v0.2.7/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/utils/index.doctree b/v0.2.7/.doctrees/api_doc/utils/index.doctree
index 3b2f1aa8ca..76328a9ed5 100644
Binary files a/v0.2.7/.doctrees/api_doc/utils/index.doctree and b/v0.2.7/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/utils/path.doctree b/v0.2.7/.doctrees/api_doc/utils/path.doctree
index 2fb9a380a0..363ac1735c 100644
Binary files a/v0.2.7/.doctrees/api_doc/utils/path.doctree and b/v0.2.7/.doctrees/api_doc/utils/path.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/utils/tqdm_.doctree b/v0.2.7/.doctrees/api_doc/utils/tqdm_.doctree
index 95a16dc605..c827eaae2b 100644
Binary files a/v0.2.7/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.2.7/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.2.7/.doctrees/api_doc/utils/walk.doctree b/v0.2.7/.doctrees/api_doc/utils/walk.doctree
index 625b419a38..2315e5089e 100644
Binary files a/v0.2.7/.doctrees/api_doc/utils/walk.doctree and b/v0.2.7/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.2.7/.doctrees/environment.pickle b/v0.2.7/.doctrees/environment.pickle
index 2623ffd6c0..dadb873fd4 100644
Binary files a/v0.2.7/.doctrees/environment.pickle and b/v0.2.7/.doctrees/environment.pickle differ
diff --git a/v0.2.7/.doctrees/index.doctree b/v0.2.7/.doctrees/index.doctree
index bde6838683..e46243bb07 100644
Binary files a/v0.2.7/.doctrees/index.doctree and b/v0.2.7/.doctrees/index.doctree differ
diff --git a/v0.2.7/.doctrees/information/environment.doctree b/v0.2.7/.doctrees/information/environment.doctree
index 7efedd776d..23be70ed44 100644
Binary files a/v0.2.7/.doctrees/information/environment.doctree and b/v0.2.7/.doctrees/information/environment.doctree differ
diff --git a/v0.2.7/.doctrees/information/environment.result.doctree b/v0.2.7/.doctrees/information/environment.result.doctree
index a612adf932..b31403beb5 100644
Binary files a/v0.2.7/.doctrees/information/environment.result.doctree and b/v0.2.7/.doctrees/information/environment.result.doctree differ
diff --git a/v0.2.7/.doctrees/nbsphinx/information/environment.ipynb b/v0.2.7/.doctrees/nbsphinx/information/environment.ipynb
index a05bb29200..ffa26b9028 100644
--- a/v0.2.7/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.2.7/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:05:40.628548Z",
-     "iopub.status.busy": "2024-07-23T18:05:40.628345Z",
-     "iopub.status.idle": "2024-07-23T18:05:41.799246Z",
-     "shell.execute_reply": "2024-07-23T18:05:41.798452Z"
+     "iopub.execute_input": "2024-07-23T18:12:24.460798Z",
+     "iopub.status.busy": "2024-07-23T18:12:24.460598Z",
+     "iopub.status.idle": "2024-07-23T18:12:25.629402Z",
+     "shell.execute_reply": "2024-07-23T18:12:25.628604Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2829.80525 MHz\n",
+      "CPU Freq: 2749.3817499999996 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.7/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.2.7/.doctrees/nbsphinx/information/environment.result.ipynb
index 05a2f9a9fe..90deb88df6 100644
--- a/v0.2.7/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.2.7/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:15:25.691193Z",
-     "iopub.status.busy": "2024-07-23T17:15:25.690701Z",
-     "iopub.status.idle": "2024-07-23T17:15:26.861691Z",
-     "shell.execute_reply": "2024-07-23T17:15:26.860952Z"
+     "iopub.execute_input": "2024-07-23T17:21:23.252969Z",
+     "iopub.status.busy": "2024-07-23T17:21:23.252765Z",
+     "iopub.status.idle": "2024-07-23T17:21:24.429483Z",
+     "shell.execute_reply": "2024-07-23T17:21:24.428736Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2744.03625 MHz\n",
+      "CPU Freq: 2718.4395000000004 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.7/.doctrees/tutorials/installation/index.doctree b/v0.2.7/.doctrees/tutorials/installation/index.doctree
index 815e2e5ce0..d9b57e9e7d 100644
Binary files a/v0.2.7/.doctrees/tutorials/installation/index.doctree and b/v0.2.7/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.2.7/.doctrees/tutorials/quick_start/index.doctree b/v0.2.7/.doctrees/tutorials/quick_start/index.doctree
index 8333890f69..5b37eaeffe 100644
Binary files a/v0.2.7/.doctrees/tutorials/quick_start/index.doctree and b/v0.2.7/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.2.7/_sources/information/environment.result.ipynb.txt b/v0.2.7/_sources/information/environment.result.ipynb.txt
index 05a2f9a9fe..90deb88df6 100644
--- a/v0.2.7/_sources/information/environment.result.ipynb.txt
+++ b/v0.2.7/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:15:25.691193Z",
-     "iopub.status.busy": "2024-07-23T17:15:25.690701Z",
-     "iopub.status.idle": "2024-07-23T17:15:26.861691Z",
-     "shell.execute_reply": "2024-07-23T17:15:26.860952Z"
+     "iopub.execute_input": "2024-07-23T17:21:23.252969Z",
+     "iopub.status.busy": "2024-07-23T17:21:23.252765Z",
+     "iopub.status.idle": "2024-07-23T17:21:24.429483Z",
+     "shell.execute_reply": "2024-07-23T17:21:24.428736Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2744.03625 MHz\n",
+      "CPU Freq: 2718.4395000000004 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.7/information/environment.html b/v0.2.7/information/environment.html
index da0b6b07c6..fa775fd563 100644
--- a/v0.2.7/information/environment.html
+++ b/v0.2.7/information/environment.html
@@ -126,11 +126,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2829.80525 MHz
+CPU Freq: 2749.3817499999996 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.7/information/environment.ipynb b/v0.2.7/information/environment.ipynb
index a05bb29200..ffa26b9028 100644
--- a/v0.2.7/information/environment.ipynb
+++ b/v0.2.7/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:05:40.628548Z",
-     "iopub.status.busy": "2024-07-23T18:05:40.628345Z",
-     "iopub.status.idle": "2024-07-23T18:05:41.799246Z",
-     "shell.execute_reply": "2024-07-23T18:05:41.798452Z"
+     "iopub.execute_input": "2024-07-23T18:12:24.460798Z",
+     "iopub.status.busy": "2024-07-23T18:12:24.460598Z",
+     "iopub.status.idle": "2024-07-23T18:12:25.629402Z",
+     "shell.execute_reply": "2024-07-23T18:12:25.628604Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2829.80525 MHz\n",
+      "CPU Freq: 2749.3817499999996 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.7/information/environment.result.html b/v0.2.7/information/environment.result.html
index 45bd9d8d02..cbbbe56a6d 100644
--- a/v0.2.7/information/environment.result.html
+++ b/v0.2.7/information/environment.result.html
@@ -128,11 +128,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2744.03625 MHz
+CPU Freq: 2718.4395000000004 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.7/information/environment.result.ipynb b/v0.2.7/information/environment.result.ipynb
index 05a2f9a9fe..90deb88df6 100644
--- a/v0.2.7/information/environment.result.ipynb
+++ b/v0.2.7/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:15:25.691193Z",
-     "iopub.status.busy": "2024-07-23T17:15:25.690701Z",
-     "iopub.status.idle": "2024-07-23T17:15:26.861691Z",
-     "shell.execute_reply": "2024-07-23T17:15:26.860952Z"
+     "iopub.execute_input": "2024-07-23T17:21:23.252969Z",
+     "iopub.status.busy": "2024-07-23T17:21:23.252765Z",
+     "iopub.status.idle": "2024-07-23T17:21:24.429483Z",
+     "shell.execute_reply": "2024-07-23T17:21:24.428736Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2744.03625 MHz\n",
+      "CPU Freq: 2718.4395000000004 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.7/searchindex.js b/v0.2.7/searchindex.js
index fbb652615d..55247e18ab 100644
--- a/v0.2.7/searchindex.js
+++ b/v0.2.7/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 12, 14, 15], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 15, 17, 19, 22, 24, 25], "you": [0, 30], "requir": [0, 30], "simpli": [0, 30], "instal": [0, 27], "us": [0, 3, 12, 16, 17, 19, 22, 27, 30], "follow": [0, 8, 30], "code": [0, 3, 6, 10], "pip": [0, 30], "The": [0, 3, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26, 30], "creation": 0, "file": [0, 3, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 26], "i": [0, 6, 9, 10, 12, 14, 15, 17, 20, 21, 24, 27, 28, 29, 30], "we": 0, "util": [0, 27, 30], "rarfil": 0, "librari": [0, 22], "which": [0, 28, 29, 30], "doe": [0, 12], "offer": 0, "function": [0, 3, 15, 21, 22, 25], "creat": [0, 14], "str": [0, 3, 6, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26], "ext": 0, "list": [0, 3, 8, 12, 16, 17, 19], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "regist": 0, "custom": [0, 3, 6, 10], "type": [0, 3, 8, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "associ": 0, "paramet": [0, 3, 5, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "A": [0, 16], "take": 0, "directori": [0, 8, 14, 15, 17, 19, 26], "an": [0, 12, 14, 17, 19, 22, 25, 26], "filenam": [0, 22, 24], "input": 0, "extract": [0, 17], "type_nam": 0, "archive_fil": 0, "silent": [0, 14, 17, 19, 22, 25], "bool": [0, 5, 12, 14, 15, 17, 19, 20, 21, 22, 25], "fals": [0, 12, 14, 15, 17, 19, 20, 21, 22, 25], "clear": [0, 19], "specifi": [0, 15, 19, 22], "result": 0, "true": [0, 12, 14, 15, 17, 19, 20, 21, 22, 25], "suppress": [0, 14, 17, 19, 22], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 19], "exist": [0, 12, 17], "when": [0, 9, 12, 14, 17], "return": [0, 3, 12, 14, 15, 16, 20, 21, 22, 24, 25, 26], "path": [0, 6, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 23, 26, 27], "password": [0, 17], "none": [0, 3, 5, 6, 10, 12, 14, 15, 16, 17, 19, 20, 22, 24], "content": [0, 25], "option": [0, 3, 5, 6, 10, 12, 14, 15, 16, 17, 19, 20, 22, 24, 25], "determin": 0, "base": [0, 7, 8, 18, 27], "rais": [0, 9, 12, 15, 24], "valueerror": [0, 24], "ani": [0, 5, 21, 24], "get": [0, 12, 14, 16, 22, 24], "meta": [1, 27, 30], "__title__": [1, 30], "__version__": [1, 30], "__description__": [1, 30], "__author__": [1, 30], "__author_email__": 1, "inform": [2, 3, 5, 14], "packag": 2, "titl": 2, "thi": [2, 3, 6, 10, 15, 21, 22, 24, 25, 28, 29], "project": 2, "should": [2, 22, 30], "version": [2, 5, 25, 30], "short": 2, "descript": [2, 22], "includ": [2, 3, 14], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 12, 14], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 12, 14, 15, 16, 17, 22, 28, 29, 30], "object": [3, 8, 16, 17, 19, 22], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 26], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 22, 25], "keyword": [3, 22, 25], "argument": [3, 22, 25], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 14, 15, 28, 29], "two": 3, "2": [3, 8, 30], "class": [3, 6, 8, 9, 10, 12, 24], "messag": [3, 6, 9, 10, 14, 19], "except": [3, 6, 9, 10, 12], "displai": [3, 6, 10, 22, 25], "yellow": 3, "color": 3, "error": [3, 6, 10], "exit_cod": [3, 6, 10], "exit": [3, 6, 10], "show": [3, 6, 10], "io": [3, 6, 10, 30], "write": [3, 6, 10], "output": [3, 6, 10, 17, 19, 22, 25, 30], "red": [3, 6, 10], "err": 3, "baseexcept": 3, "print": [3, 5, 28, 29, 30], "traceback": 3, "provid": [3, 22], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": [3, 30], "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 30], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 27], "current": [5, 28, 29, 30], "metadata": 5, "arg": [5, 25], "indic": [6, 10], "remot": [6, 10], "repositori": [6, 10, 12, 14, 15, 16, 17, 19, 20, 24], "assign": [6, 10, 16, 17, 19], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 27], "print_vers": 7, "download": [7, 12, 18, 23, 27], "noremotepathassignedwithdownload": 7, "l": [7, 27], "listitemtyp": 7, "listitem": 7, "ls_repo": [7, 27], "nolocalauthent": 7, "upload": [7, 14, 18, 27], "noremotepathassignedwithupload": 7, "whoami": [7, 27], "enum": 8, "repres": 8, "differ": [8, 28, 29], "item": [8, 15], "valid": [8, 13, 18, 27], "ar": 8, "folder": 8, "imag": 8, "3": [8, 28, 29, 30], "archiv": [8, 12, 14, 15, 17, 19, 27], "4": [8, 28, 29], "model": [8, 12, 14, 15, 16, 17, 19, 20, 24], "5": [8, 17, 28, 29], "data": [8, 28, 29], "6": [8, 28, 29], "repofold": 8, "repofil": [8, 15], "base_dir": 8, "union": [8, 12], "local": [9, 12, 14, 17, 19, 20, 22, 28, 29], "authent": [9, 15], "token": [9, 12, 14, 15, 16, 17, 19, 20], "33": 10, "standalon": 12, "incomplet": 12, "hash": [12, 14, 15, 16, 17, 19], "match": [12, 15, 20], "repo_id": [12, 14, 15, 16, 17, 19, 20, 24], "archive_in_repo": [12, 14, 15, 19], "repo_typ": [12, 14, 15, 16, 17, 19, 20, 24], "liter": [12, 14, 15, 16, 17, 19, 20, 24], "dataset": [12, 14, 15, 16, 17, 19, 20, 24], "space": [12, 14, 15, 16, 17, 19, 20, 24], "revis": [12, 14, 15, 16, 17, 19, 20, 24], "main": [12, 14, 15, 16, 17, 19, 20, 30], "idx_repo_id": [12, 14, 15], "idx_file_in_repo": [12, 14, 15], "idx_repo_typ": [12, 14, 15], "idx_revis": [12, 14, 15], "hf_token": [12, 14, 15, 16, 17, 19, 20], "insid": 12, "hug": [12, 14, 15, 16, 17, 19, 20], "face": [12, 14, 15, 16, 17, 19, 20], "identifi": [12, 14, 16, 17, 19, 20], "repotypetyp": [12, 14, 15, 16, 17, 19, 20, 24], "access": [12, 14], "file_in_arch": 12, "local_fil": [12, 17, 19, 20], "proxi": 12, "user_ag": 12, "header": 12, "endpoint": 12, "save": [12, 14, 17, 22], "http": [12, 30], "request": [12, 22], "user": 12, "agent": 12, "addit": [12, 22, 25], "api": [12, 16, 17, 19, 20], "check": [12, 15, 20, 21, 22, 30], "otherwis": [12, 15, 20, 22], "fetch": [13, 27], "archivestandalonefileincompletedownload": 13, "archivestandalonefilehashnotmatch": 13, "hf_tar_list_fil": 13, "hf_tar_file_download": 13, "hf_tar_get_index": 13, "hf_tar_file_exist": 13, "make": [13, 27], "tar_create_index": 13, "hf_tar_create_index": 13, "tar_get_index_info": 13, "hf_tar_create_from_directori": 13, "hf_tar_item_valid": 13, "hf_tar_valid": 13, "src_tar_fil": 14, "dst_index_fil": 14, "chunk_for_hash": 14, "int": [14, 15, 17, 22], "1048576": 14, "with_hash": 14, "default": [14, 15, 17, 20, 24], "chunk": 14, "size": [14, 15, 22, 28, 29], "20": 14, "mb": 14, "whether": 14, "progress": [14, 17, 19, 22, 25], "bar": [14, 17, 19, 22, 25], "log": 14, "skip_when_sync": 14, "skip": 14, "sync": 14, "readi": [14, 20], "local_directori": [14, 17, 19], "file_item": 15, "hash_": 15, "hash_lf": 15, "expect": [15, 22], "sha": 15, "256": 15, "store": 15, "lf": 15, "id": [15, 24], "where": [15, 22], "entrynotfounderror": 15, "entri": [15, 27], "found": 15, "isadirectoryerror": 15, "hfapi": 16, "client": [16, 17, 19], "huggingfac": [16, 17, 19, 24, 27, 30], "variabl": [16, 17, 19], "hffilesystem": 16, "system": 16, "subdir": 16, "ignore_pattern": [16, 17, 19], "given": [16, 21, 22, 24], "subdirectori": 16, "e": [16, 17, 19], "g": [16, 17, 19], "branch": [16, 17, 19], "tag": [16, 17, 19], "commit": [16, 17, 19], "pattern": [16, 17, 19], "ignor": [16, 17, 19], "file_in_repo": [17, 19, 20], "resume_download": 17, "within": [17, 19], "resum": 17, "dir_in_repo": 17, "max_work": 17, "8": [17, 28, 29, 30], "max_retri": 17, "all": [17, 26], "max": 17, "worker": 17, "retri": 17, "time": 17, "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 18, "download_archive_as_directori": 18, "download_directory_as_directori": 18, "upload_file_to_fil": 18, "upload_directory_as_arch": 18, "upload_directory_as_directori": 18, "is_local_file_readi": 18, "path_in_repo": 19, "time_suffix": 19, "its": 19, "append": 19, "timestamp": 19, "present": 19, "compar": 20, "hub": 20, "read": 21, "first": 21, "1024": 21, "byte": [21, 22], "contain": 21, "non": 21, "text": 21, "charact": 21, "url": 22, "expected_s": 22, "desc": 22, "session": 22, "tqdm": [22, 23, 27], "It": [22, 30], "also": [22, 30], "perform": [22, 28, 29], "ensur": 22, "ha": [22, 28, 29], "pass": [22, 25], "binari": [23, 27], "is_binary_fil": 23, "download_fil": 23, "hf_normpath": 23, "hf_fs_path": 23, "parse_hf_fs_path": 23, "hffilesystempath": 23, "walk": [23, 27], "walk_fil": 23, "normal": 24, "filesystem": 24, "pars": 24, "invalid": 24, "tqdm_": 25, "enhanc": 25, "silenc": 25, "modifi": 25, "behavior": 25, "allow": 25, "posit": 25, "std": 25, "recurs": 26, "through": [26, 30], "yield": 26, "rel": 26, "root": 26, "start": [26, 27], "modul": 27, "quick": 27, "run": 27, "environ": 27, "register_archive_typ": 27, "archive_pack": 27, "archive_unpack": 27, "get_archive_typ": 27, "get_archive_extnam": 27, "config": [27, 30], "index": [27, 30], "oper": 27, "here": [28, 29], "import": [28, 29, 30], "o": [28, 29], "platform": [28, 29], "shutil": [28, 29], "cpuinfo": [28, 29], "psutil": [28, 29], "hbutil": [28, 29], "scale": [28, 29], "size_to_bytes_str": [28, 29], "python": [28, 29, 30], "python_implement": [28, 29], "python_vers": [28, 29], "cpu": [28, 29], "brand": [28, 29], "get_cpu_info": [28, 29], "brand_raw": [28, 29], "count": [28, 29], "cpu_count": [28, 29], "freq": [28, 29], "cpu_freq": [28, 29], "mhz": [28, 29], "memori": [28, 29], "virtual_memori": [28, 29], "total": [28, 29], "precis": [28, 29], "cuda": [28, 29], "ye": [28, 29], "nvidia": [28, 29], "smi": [28, 29], "els": [28, 29], "No": [28, 29], "linux": [28, 29], "0": [28, 29, 30], "1023": [28, 29], "azur": [28, 29], "x86_64": [28, 29], "glibc2": [28, 29], "34": [28, 29], "cpython": [28, 29], "18": [28, 29], "amd": [28, 29], "epyc": [28, 29], "7763": [28, 29], "64": [28, 29], "core": [28, 29], "processor": [28, 29], "2829": 28, "80525": 28, "15": [28, 29], "606": [28, 29], "gib": [28, 29], "pleas": [28, 29], "note": [28, 29], "deploi": [28, 29], "document": [28, 29, 30], "automat": [28, 29], "execut": [28, 29], "github": [28, 29, 30], "action": [28, 29], "therefor": [28, 29], "some": [28, 29], "mai": [28, 29], "your": [28, 29, 30], "2744": 29, "03625": 29, "hfutil": 30, "host": 30, "pypi": 30, "can": 30, "newest": 30, "u": 30, "git": 30, "com": 30, "deepgh": 30, "script": 30, "__name__": 30, "__main__": 30, "develop": 30, "maintain": 30, "like": 30, "below": 30, "mean": 30, "success": 30, "narugo1992": 30, "still": 30, "under": 30, "out": 30, "stabl": 30, "html": 30, "faq": 31}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [13, 0, 0, "-", "index"], [18, 0, 0, "-", "operate"], [23, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "ls_repo"], [10, 0, 0, "-", "upload"], [11, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[9, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[10, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[10, 4, 1, "", "exit_code"], [10, 5, 1, "", "show"]], "hfutils.index": [[12, 0, 0, "-", "fetch"], [14, 0, 0, "-", "make"], [15, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[12, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [12, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [12, 1, 1, "", "hf_tar_file_download"], [12, 1, 1, "", "hf_tar_file_exists"], [12, 1, 1, "", "hf_tar_get_index"], [12, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[14, 1, 1, "", "hf_tar_create_from_directory"], [14, 1, 1, "", "hf_tar_create_index"], [14, 1, 1, "", "tar_create_index"], [14, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[15, 1, 1, "", "hf_tar_item_validate"], [15, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[16, 0, 0, "-", "base"], [17, 0, 0, "-", "download"], [19, 0, 0, "-", "upload"], [20, 0, 0, "-", "validate"]], "hfutils.operate.base": [[16, 1, 1, "", "get_hf_client"], [16, 1, 1, "", "get_hf_fs"], [16, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[17, 1, 1, "", "download_archive_as_directory"], [17, 1, 1, "", "download_directory_as_directory"], [17, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[19, 1, 1, "", "upload_directory_as_archive"], [19, 1, 1, "", "upload_directory_as_directory"], [19, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[20, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[21, 0, 0, "-", "binary"], [22, 0, 0, "-", "download"], [24, 0, 0, "-", "path"], [25, 0, 0, "-", "tqdm_"], [26, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[21, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[22, 1, 1, "", "download_file"]], "hfutils.utils.path": [[24, 3, 1, "", "HfFileSystemPath"], [24, 1, 1, "", "hf_fs_path"], [24, 1, 1, "", "hf_normpath"], [24, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[25, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[26, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9, 10, 11], "base": [3, 16], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 17, 22], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "ls_repo": 9, "nolocalauthent": 9, "upload": [10, 19], "noremotepathassignedwithupload": 10, "whoami": 11, "index": [12, 13, 14, 15], "fetch": 12, "archivestandalonefileincompletedownload": 12, "archivestandalonefilehashnotmatch": 12, "hf_tar_list_fil": 12, "hf_tar_file_download": 12, "hf_tar_get_index": 12, "hf_tar_file_exist": 12, "make": 14, "tar_create_index": 14, "hf_tar_create_index": 14, "tar_get_index_info": 14, "hf_tar_create_from_directori": 14, "valid": [15, 20], "hf_tar_item_valid": 15, "hf_tar_valid": 15, "oper": [16, 17, 18, 19, 20], "get_hf_client": 16, "get_hf_f": 16, "list_files_in_repositori": 16, "download_file_to_fil": 17, "download_archive_as_directori": 17, "download_directory_as_directori": 17, "upload_file_to_fil": 19, "upload_directory_as_arch": 19, "upload_directory_as_directori": 19, "is_local_file_readi": 20, "util": [21, 22, 23, 24, 25, 26], "binari": 21, "is_binary_fil": 21, "download_fil": 22, "path": 24, "hf_normpath": 24, "hf_fs_path": 24, "parse_hf_fs_path": 24, "hffilesystempath": 24, "tqdm": 25, "walk": 26, "walk_fil": 26, "welcom": 27, "": 27, "document": 27, "overview": 27, "tutori": 27, "inform": [27, 28, 29], "api": 27, "run": [28, 29], "environ": [28, 29], "instal": 30, "quick": 31, "start": 31}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.ls_repo": [[9, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[9, "nolocalauthentication"]], "hfutils.entry.upload": [[10, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[10, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[11, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[12, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[12, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[12, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[12, "hf-tar-list-files"]], "hf_tar_file_download": [[12, "hf-tar-file-download"]], "hf_tar_get_index": [[12, "hf-tar-get-index"]], "hf_tar_file_exists": [[12, "hf-tar-file-exists"]], "hfutils.index": [[13, "module-hfutils.index"]], "hfutils.index.make": [[14, "module-hfutils.index.make"]], "tar_create_index": [[14, "tar-create-index"]], "hf_tar_create_index": [[14, "hf-tar-create-index"]], "tar_get_index_info": [[14, "tar-get-index-info"]], "hf_tar_create_from_directory": [[14, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[15, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[15, "hf-tar-item-validate"]], "hf_tar_validate": [[15, "hf-tar-validate"]], "hfutils.operate.base": [[16, "module-hfutils.operate.base"]], "get_hf_client": [[16, "get-hf-client"]], "get_hf_fs": [[16, "get-hf-fs"]], "list_files_in_repository": [[16, "list-files-in-repository"]], "hfutils.operate.download": [[17, "module-hfutils.operate.download"]], "download_file_to_file": [[17, "download-file-to-file"]], "download_archive_as_directory": [[17, "download-archive-as-directory"]], "download_directory_as_directory": [[17, "download-directory-as-directory"]], "hfutils.operate": [[18, "module-hfutils.operate"]], "hfutils.operate.upload": [[19, "module-hfutils.operate.upload"]], "upload_file_to_file": [[19, "upload-file-to-file"]], "upload_directory_as_archive": [[19, "upload-directory-as-archive"]], "upload_directory_as_directory": [[19, "upload-directory-as-directory"]], "hfutils.operate.validate": [[20, "module-hfutils.operate.validate"]], "is_local_file_ready": [[20, "is-local-file-ready"]], "hfutils.utils.binary": [[21, "module-hfutils.utils.binary"]], "is_binary_file": [[21, "is-binary-file"]], "hfutils.utils.download": [[22, "module-hfutils.utils.download"]], "download_file": [[22, "download-file"]], "hfutils.utils": [[23, "module-hfutils.utils"]], "hfutils.utils.path": [[24, "module-hfutils.utils.path"]], "hf_normpath": [[24, "hf-normpath"]], "hf_fs_path": [[24, "hf-fs-path"]], "parse_hf_fs_path": [[24, "parse-hf-fs-path"]], "HfFileSystemPath": [[24, "hffilesystempath"]], "hfutils.utils.tqdm": [[25, "module-hfutils.utils.tqdm_"]], "tqdm": [[25, "tqdm"]], "hfutils.utils.walk": [[26, "module-hfutils.utils.walk"]], "walk_files": [[26, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[27, "welcome-to-hfutils-s-documentation"]], "Overview": [[27, "overview"]], "Tutorials": [[27, null]], "Information": [[27, null]], "API Documentation": [[27, null]], "Run Environment Information": [[28, "Run-Environment-Information"], [29, "Run-Environment-Information"]], "Installation": [[30, "installation"]], "Quick Start": [[31, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.ls_repo"], [10, "module-hfutils.entry.upload"], [11, "module-hfutils.entry.whoami"], [12, "module-hfutils.index.fetch"], [13, "module-hfutils.index"], [14, "module-hfutils.index.make"], [15, "module-hfutils.index.validate"], [16, "module-hfutils.operate.base"], [17, "module-hfutils.operate.download"], [18, "module-hfutils.operate"], [19, "module-hfutils.operate.upload"], [20, "module-hfutils.operate.validate"], [21, "module-hfutils.utils.binary"], [22, "module-hfutils.utils.download"], [23, "module-hfutils.utils"], [24, "module-hfutils.utils.path"], [25, "module-hfutils.utils.tqdm_"], [26, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[9, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[9, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[10, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[11, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[12, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[12, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[12, "module-hfutils.index.fetch"]], "hfutils.index": [[13, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[14, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[14, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[14, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[14, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[14, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[15, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[15, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[15, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[16, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[17, "module-hfutils.operate.download"]], "hfutils.operate": [[18, "module-hfutils.operate"]], "hfutils.operate.upload": [[19, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[20, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[20, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[21, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[21, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[22, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[22, "module-hfutils.utils.download"]], "hfutils.utils": [[23, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[24, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[24, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[25, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[25, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[26, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[26, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 12, 14, 15], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 15, 17, 19, 22, 24, 25], "you": [0, 30], "requir": [0, 30], "simpli": [0, 30], "instal": [0, 27], "us": [0, 3, 12, 16, 17, 19, 22, 27, 30], "follow": [0, 8, 30], "code": [0, 3, 6, 10], "pip": [0, 30], "The": [0, 3, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26, 30], "creation": 0, "file": [0, 3, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 26], "i": [0, 6, 9, 10, 12, 14, 15, 17, 20, 21, 24, 27, 28, 29, 30], "we": 0, "util": [0, 27, 30], "rarfil": 0, "librari": [0, 22], "which": [0, 28, 29, 30], "doe": [0, 12], "offer": 0, "function": [0, 3, 15, 21, 22, 25], "creat": [0, 14], "str": [0, 3, 6, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26], "ext": 0, "list": [0, 3, 8, 12, 16, 17, 19], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "regist": 0, "custom": [0, 3, 6, 10], "type": [0, 3, 8, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "associ": 0, "paramet": [0, 3, 5, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "A": [0, 16], "take": 0, "directori": [0, 8, 14, 15, 17, 19, 26], "an": [0, 12, 14, 17, 19, 22, 25, 26], "filenam": [0, 22, 24], "input": 0, "extract": [0, 17], "type_nam": 0, "archive_fil": 0, "silent": [0, 14, 17, 19, 22, 25], "bool": [0, 5, 12, 14, 15, 17, 19, 20, 21, 22, 25], "fals": [0, 12, 14, 15, 17, 19, 20, 21, 22, 25], "clear": [0, 19], "specifi": [0, 15, 19, 22], "result": 0, "true": [0, 12, 14, 15, 17, 19, 20, 21, 22, 25], "suppress": [0, 14, 17, 19, 22], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 19], "exist": [0, 12, 17], "when": [0, 9, 12, 14, 17], "return": [0, 3, 12, 14, 15, 16, 20, 21, 22, 24, 25, 26], "path": [0, 6, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 23, 26, 27], "password": [0, 17], "none": [0, 3, 5, 6, 10, 12, 14, 15, 16, 17, 19, 20, 22, 24], "content": [0, 25], "option": [0, 3, 5, 6, 10, 12, 14, 15, 16, 17, 19, 20, 22, 24, 25], "determin": 0, "base": [0, 7, 8, 18, 27], "rais": [0, 9, 12, 15, 24], "valueerror": [0, 24], "ani": [0, 5, 21, 24], "get": [0, 12, 14, 16, 22, 24], "meta": [1, 27, 30], "__title__": [1, 30], "__version__": [1, 30], "__description__": [1, 30], "__author__": [1, 30], "__author_email__": 1, "inform": [2, 3, 5, 14], "packag": 2, "titl": 2, "thi": [2, 3, 6, 10, 15, 21, 22, 24, 25, 28, 29], "project": 2, "should": [2, 22, 30], "version": [2, 5, 25, 30], "short": 2, "descript": [2, 22], "includ": [2, 3, 14], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 12, 14], "new": 3, "empti": 3, "dictionari": 3, "map": 3, "initi": 3, "from": [3, 12, 14, 15, 16, 17, 22, 28, 29, 30], "object": [3, 8, 16, 17, 19, 22], "": [3, 5], "kei": 3, "valu": [3, 5, 8], "pair": 3, "iter": [3, 26], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 22, 25], "keyword": [3, 22, 25], "argument": [3, 22, 25], "For": 3, "exampl": 3, "one": 3, "1": [3, 8, 14, 15, 28, 29], "two": 3, "2": [3, 8, 30], "class": [3, 6, 8, 9, 10, 12, 24], "messag": [3, 6, 9, 10, 14, 19], "except": [3, 6, 9, 10, 12], "displai": [3, 6, 10, 22, 25], "yellow": 3, "color": 3, "error": [3, 6, 10], "exit_cod": [3, 6, 10], "exit": [3, 6, 10], "show": [3, 6, 10], "io": [3, 6, 10, 30], "write": [3, 6, 10], "output": [3, 6, 10, 17, 19, 22, 25, 30], "red": [3, 6, 10], "err": 3, "baseexcept": 3, "print": [3, 5, 28, 29, 30], "traceback": 3, "provid": [3, 22], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": [3, 30], "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 30], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 27], "current": [5, 28, 29, 30], "metadata": 5, "arg": [5, 25], "indic": [6, 10], "remot": [6, 10], "repositori": [6, 10, 12, 14, 15, 16, 17, 19, 20, 24], "assign": [6, 10, 16, 17, 19], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 27], "print_vers": 7, "download": [7, 12, 18, 23, 27], "noremotepathassignedwithdownload": 7, "l": [7, 27], "listitemtyp": 7, "listitem": 7, "ls_repo": [7, 27], "nolocalauthent": 7, "upload": [7, 14, 18, 27], "noremotepathassignedwithupload": 7, "whoami": [7, 27], "enum": 8, "repres": 8, "differ": [8, 28, 29], "item": [8, 15], "valid": [8, 13, 18, 27], "ar": 8, "folder": 8, "imag": 8, "3": [8, 28, 29, 30], "archiv": [8, 12, 14, 15, 17, 19, 27], "4": [8, 28, 29], "model": [8, 12, 14, 15, 16, 17, 19, 20, 24], "5": [8, 17, 28, 29], "data": [8, 28, 29], "6": [8, 28, 29], "repofold": 8, "repofil": [8, 15], "base_dir": 8, "union": [8, 12], "local": [9, 12, 14, 17, 19, 20, 22, 28, 29], "authent": [9, 15], "token": [9, 12, 14, 15, 16, 17, 19, 20], "33": 10, "standalon": 12, "incomplet": 12, "hash": [12, 14, 15, 16, 17, 19], "match": [12, 15, 20], "repo_id": [12, 14, 15, 16, 17, 19, 20, 24], "archive_in_repo": [12, 14, 15, 19], "repo_typ": [12, 14, 15, 16, 17, 19, 20, 24], "liter": [12, 14, 15, 16, 17, 19, 20, 24], "dataset": [12, 14, 15, 16, 17, 19, 20, 24], "space": [12, 14, 15, 16, 17, 19, 20, 24], "revis": [12, 14, 15, 16, 17, 19, 20, 24], "main": [12, 14, 15, 16, 17, 19, 20, 30], "idx_repo_id": [12, 14, 15], "idx_file_in_repo": [12, 14, 15], "idx_repo_typ": [12, 14, 15], "idx_revis": [12, 14, 15], "hf_token": [12, 14, 15, 16, 17, 19, 20], "insid": 12, "hug": [12, 14, 15, 16, 17, 19, 20], "face": [12, 14, 15, 16, 17, 19, 20], "identifi": [12, 14, 16, 17, 19, 20], "repotypetyp": [12, 14, 15, 16, 17, 19, 20, 24], "access": [12, 14], "file_in_arch": 12, "local_fil": [12, 17, 19, 20], "proxi": 12, "user_ag": 12, "header": 12, "endpoint": 12, "save": [12, 14, 17, 22], "http": [12, 30], "request": [12, 22], "user": 12, "agent": 12, "addit": [12, 22, 25], "api": [12, 16, 17, 19, 20], "check": [12, 15, 20, 21, 22, 30], "otherwis": [12, 15, 20, 22], "fetch": [13, 27], "archivestandalonefileincompletedownload": 13, "archivestandalonefilehashnotmatch": 13, "hf_tar_list_fil": 13, "hf_tar_file_download": 13, "hf_tar_get_index": 13, "hf_tar_file_exist": 13, "make": [13, 27], "tar_create_index": 13, "hf_tar_create_index": 13, "tar_get_index_info": 13, "hf_tar_create_from_directori": 13, "hf_tar_item_valid": 13, "hf_tar_valid": 13, "src_tar_fil": 14, "dst_index_fil": 14, "chunk_for_hash": 14, "int": [14, 15, 17, 22], "1048576": 14, "with_hash": 14, "default": [14, 15, 17, 20, 24], "chunk": 14, "size": [14, 15, 22, 28, 29], "20": 14, "mb": 14, "whether": 14, "progress": [14, 17, 19, 22, 25], "bar": [14, 17, 19, 22, 25], "log": 14, "skip_when_sync": 14, "skip": 14, "sync": 14, "readi": [14, 20], "local_directori": [14, 17, 19], "file_item": 15, "hash_": 15, "hash_lf": 15, "expect": [15, 22], "sha": 15, "256": 15, "store": 15, "lf": 15, "id": [15, 24], "where": [15, 22], "entrynotfounderror": 15, "entri": [15, 27], "found": 15, "isadirectoryerror": 15, "hfapi": 16, "client": [16, 17, 19], "huggingfac": [16, 17, 19, 24, 27, 30], "variabl": [16, 17, 19], "hffilesystem": 16, "system": 16, "subdir": 16, "ignore_pattern": [16, 17, 19], "given": [16, 21, 22, 24], "subdirectori": 16, "e": [16, 17, 19], "g": [16, 17, 19], "branch": [16, 17, 19], "tag": [16, 17, 19], "commit": [16, 17, 19], "pattern": [16, 17, 19], "ignor": [16, 17, 19], "file_in_repo": [17, 19, 20], "resume_download": 17, "within": [17, 19], "resum": 17, "dir_in_repo": 17, "max_work": 17, "8": [17, 28, 29, 30], "max_retri": 17, "all": [17, 26], "max": 17, "worker": 17, "retri": 17, "time": 17, "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 18, "download_archive_as_directori": 18, "download_directory_as_directori": 18, "upload_file_to_fil": 18, "upload_directory_as_arch": 18, "upload_directory_as_directori": 18, "is_local_file_readi": 18, "path_in_repo": 19, "time_suffix": 19, "its": 19, "append": 19, "timestamp": 19, "present": 19, "compar": 20, "hub": 20, "read": 21, "first": 21, "1024": [21, 28, 29], "byte": [21, 22], "contain": 21, "non": 21, "text": 21, "charact": 21, "url": 22, "expected_s": 22, "desc": 22, "session": 22, "tqdm": [22, 23, 27], "It": [22, 30], "also": [22, 30], "perform": [22, 28, 29], "ensur": 22, "ha": [22, 28, 29], "pass": [22, 25], "binari": [23, 27], "is_binary_fil": 23, "download_fil": 23, "hf_normpath": 23, "hf_fs_path": 23, "parse_hf_fs_path": 23, "hffilesystempath": 23, "walk": [23, 27], "walk_fil": 23, "normal": 24, "filesystem": 24, "pars": 24, "invalid": 24, "tqdm_": 25, "enhanc": 25, "silenc": 25, "modifi": 25, "behavior": 25, "allow": 25, "posit": 25, "std": 25, "recurs": 26, "through": [26, 30], "yield": 26, "rel": 26, "root": 26, "start": [26, 27], "modul": 27, "quick": 27, "run": 27, "environ": 27, "register_archive_typ": 27, "archive_pack": 27, "archive_unpack": 27, "get_archive_typ": 27, "get_archive_extnam": 27, "config": [27, 30], "index": [27, 30], "oper": 27, "here": [28, 29], "import": [28, 29, 30], "o": [28, 29], "platform": [28, 29], "shutil": [28, 29], "cpuinfo": [28, 29], "psutil": [28, 29], "hbutil": [28, 29], "scale": [28, 29], "size_to_bytes_str": [28, 29], "python": [28, 29, 30], "python_implement": [28, 29], "python_vers": [28, 29], "cpu": [28, 29], "brand": [28, 29], "get_cpu_info": [28, 29], "brand_raw": [28, 29], "count": [28, 29], "cpu_count": [28, 29], "freq": [28, 29], "cpu_freq": [28, 29], "mhz": [28, 29], "memori": [28, 29], "virtual_memori": [28, 29], "total": [28, 29], "precis": [28, 29], "cuda": [28, 29], "ye": [28, 29], "nvidia": [28, 29], "smi": [28, 29], "els": [28, 29], "No": [28, 29], "linux": [28, 29], "0": [28, 29, 30], "azur": [28, 29], "x86_64": [28, 29], "glibc2": [28, 29], "34": [28, 29], "cpython": [28, 29], "18": [28, 29], "amd": [28, 29], "epyc": [28, 29], "7763": [28, 29], "64": [28, 29], "core": [28, 29], "processor": [28, 29], "2749": 28, "3817499999996": 28, "15": [28, 29], "606": [28, 29], "gib": [28, 29], "pleas": [28, 29], "note": [28, 29], "deploi": [28, 29], "document": [28, 29, 30], "automat": [28, 29], "execut": [28, 29], "github": [28, 29, 30], "action": [28, 29], "therefor": [28, 29], "some": [28, 29], "mai": [28, 29], "your": [28, 29, 30], "2718": 29, "4395000000004": 29, "hfutil": 30, "host": 30, "pypi": 30, "can": 30, "newest": 30, "u": 30, "git": 30, "com": 30, "deepgh": 30, "script": 30, "__name__": 30, "__main__": 30, "develop": 30, "maintain": 30, "like": 30, "below": 30, "mean": 30, "success": 30, "narugo1992": 30, "still": 30, "under": 30, "out": 30, "stabl": 30, "html": 30, "faq": 31}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [13, 0, 0, "-", "index"], [18, 0, 0, "-", "operate"], [23, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "ls_repo"], [10, 0, 0, "-", "upload"], [11, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[9, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[10, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[10, 4, 1, "", "exit_code"], [10, 5, 1, "", "show"]], "hfutils.index": [[12, 0, 0, "-", "fetch"], [14, 0, 0, "-", "make"], [15, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[12, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [12, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [12, 1, 1, "", "hf_tar_file_download"], [12, 1, 1, "", "hf_tar_file_exists"], [12, 1, 1, "", "hf_tar_get_index"], [12, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[14, 1, 1, "", "hf_tar_create_from_directory"], [14, 1, 1, "", "hf_tar_create_index"], [14, 1, 1, "", "tar_create_index"], [14, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[15, 1, 1, "", "hf_tar_item_validate"], [15, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[16, 0, 0, "-", "base"], [17, 0, 0, "-", "download"], [19, 0, 0, "-", "upload"], [20, 0, 0, "-", "validate"]], "hfutils.operate.base": [[16, 1, 1, "", "get_hf_client"], [16, 1, 1, "", "get_hf_fs"], [16, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[17, 1, 1, "", "download_archive_as_directory"], [17, 1, 1, "", "download_directory_as_directory"], [17, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[19, 1, 1, "", "upload_directory_as_archive"], [19, 1, 1, "", "upload_directory_as_directory"], [19, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[20, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[21, 0, 0, "-", "binary"], [22, 0, 0, "-", "download"], [24, 0, 0, "-", "path"], [25, 0, 0, "-", "tqdm_"], [26, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[21, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[22, 1, 1, "", "download_file"]], "hfutils.utils.path": [[24, 3, 1, "", "HfFileSystemPath"], [24, 1, 1, "", "hf_fs_path"], [24, 1, 1, "", "hf_normpath"], [24, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[25, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[26, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9, 10, 11], "base": [3, 16], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 17, 22], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "ls_repo": 9, "nolocalauthent": 9, "upload": [10, 19], "noremotepathassignedwithupload": 10, "whoami": 11, "index": [12, 13, 14, 15], "fetch": 12, "archivestandalonefileincompletedownload": 12, "archivestandalonefilehashnotmatch": 12, "hf_tar_list_fil": 12, "hf_tar_file_download": 12, "hf_tar_get_index": 12, "hf_tar_file_exist": 12, "make": 14, "tar_create_index": 14, "hf_tar_create_index": 14, "tar_get_index_info": 14, "hf_tar_create_from_directori": 14, "valid": [15, 20], "hf_tar_item_valid": 15, "hf_tar_valid": 15, "oper": [16, 17, 18, 19, 20], "get_hf_client": 16, "get_hf_f": 16, "list_files_in_repositori": 16, "download_file_to_fil": 17, "download_archive_as_directori": 17, "download_directory_as_directori": 17, "upload_file_to_fil": 19, "upload_directory_as_arch": 19, "upload_directory_as_directori": 19, "is_local_file_readi": 20, "util": [21, 22, 23, 24, 25, 26], "binari": 21, "is_binary_fil": 21, "download_fil": 22, "path": 24, "hf_normpath": 24, "hf_fs_path": 24, "parse_hf_fs_path": 24, "hffilesystempath": 24, "tqdm": 25, "walk": 26, "walk_fil": 26, "welcom": 27, "": 27, "document": 27, "overview": 27, "tutori": 27, "inform": [27, 28, 29], "api": 27, "run": [28, 29], "environ": [28, 29], "instal": 30, "quick": 31, "start": 31}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.ls_repo": [[9, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[9, "nolocalauthentication"]], "hfutils.entry.upload": [[10, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[10, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[11, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[12, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[12, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[12, "archivestandalonefilehashnotmatch"]], "hf_tar_list_files": [[12, "hf-tar-list-files"]], "hf_tar_file_download": [[12, "hf-tar-file-download"]], "hf_tar_get_index": [[12, "hf-tar-get-index"]], "hf_tar_file_exists": [[12, "hf-tar-file-exists"]], "hfutils.index": [[13, "module-hfutils.index"]], "hfutils.index.make": [[14, "module-hfutils.index.make"]], "tar_create_index": [[14, "tar-create-index"]], "hf_tar_create_index": [[14, "hf-tar-create-index"]], "tar_get_index_info": [[14, "tar-get-index-info"]], "hf_tar_create_from_directory": [[14, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[15, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[15, "hf-tar-item-validate"]], "hf_tar_validate": [[15, "hf-tar-validate"]], "hfutils.operate.base": [[16, "module-hfutils.operate.base"]], "get_hf_client": [[16, "get-hf-client"]], "get_hf_fs": [[16, "get-hf-fs"]], "list_files_in_repository": [[16, "list-files-in-repository"]], "hfutils.operate.download": [[17, "module-hfutils.operate.download"]], "download_file_to_file": [[17, "download-file-to-file"]], "download_archive_as_directory": [[17, "download-archive-as-directory"]], "download_directory_as_directory": [[17, "download-directory-as-directory"]], "hfutils.operate": [[18, "module-hfutils.operate"]], "hfutils.operate.upload": [[19, "module-hfutils.operate.upload"]], "upload_file_to_file": [[19, "upload-file-to-file"]], "upload_directory_as_archive": [[19, "upload-directory-as-archive"]], "upload_directory_as_directory": [[19, "upload-directory-as-directory"]], "hfutils.operate.validate": [[20, "module-hfutils.operate.validate"]], "is_local_file_ready": [[20, "is-local-file-ready"]], "hfutils.utils.binary": [[21, "module-hfutils.utils.binary"]], "is_binary_file": [[21, "is-binary-file"]], "hfutils.utils.download": [[22, "module-hfutils.utils.download"]], "download_file": [[22, "download-file"]], "hfutils.utils": [[23, "module-hfutils.utils"]], "hfutils.utils.path": [[24, "module-hfutils.utils.path"]], "hf_normpath": [[24, "hf-normpath"]], "hf_fs_path": [[24, "hf-fs-path"]], "parse_hf_fs_path": [[24, "parse-hf-fs-path"]], "HfFileSystemPath": [[24, "hffilesystempath"]], "hfutils.utils.tqdm": [[25, "module-hfutils.utils.tqdm_"]], "tqdm": [[25, "tqdm"]], "hfutils.utils.walk": [[26, "module-hfutils.utils.walk"]], "walk_files": [[26, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[27, "welcome-to-hfutils-s-documentation"]], "Overview": [[27, "overview"]], "Tutorials": [[27, null]], "Information": [[27, null]], "API Documentation": [[27, null]], "Run Environment Information": [[28, "Run-Environment-Information"], [29, "Run-Environment-Information"]], "Installation": [[30, "installation"]], "Quick Start": [[31, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.ls_repo"], [10, "module-hfutils.entry.upload"], [11, "module-hfutils.entry.whoami"], [12, "module-hfutils.index.fetch"], [13, "module-hfutils.index"], [14, "module-hfutils.index.make"], [15, "module-hfutils.index.validate"], [16, "module-hfutils.operate.base"], [17, "module-hfutils.operate.download"], [18, "module-hfutils.operate"], [19, "module-hfutils.operate.upload"], [20, "module-hfutils.operate.validate"], [21, "module-hfutils.utils.binary"], [22, "module-hfutils.utils.download"], [23, "module-hfutils.utils"], [24, "module-hfutils.utils.path"], [25, "module-hfutils.utils.tqdm_"], [26, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[9, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[9, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[10, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[11, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[12, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[12, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[12, "module-hfutils.index.fetch"]], "hfutils.index": [[13, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[14, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[14, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[14, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[14, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[14, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[15, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[15, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[15, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[16, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[17, "module-hfutils.operate.download"]], "hfutils.operate": [[18, "module-hfutils.operate"]], "hfutils.operate.upload": [[19, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[20, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[20, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[21, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[21, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[22, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[22, "module-hfutils.utils.download"]], "hfutils.utils": [[23, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[24, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[24, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[25, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[25, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[26, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[26, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.2.8/.buildinfo b/v0.2.8/.buildinfo
index b66188d432..9b2249ff99 100644
--- a/v0.2.8/.buildinfo
+++ b/v0.2.8/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 8e7cecb8a0fc7c338f9d3f3d58cada7d
+config: 3fd6d52f39c3f2da65251fcd68b89a0b
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.2.8/.doctrees/api_doc/archive/index.doctree b/v0.2.8/.doctrees/api_doc/archive/index.doctree
index 7a5ca0a2b4..d4960271b8 100644
Binary files a/v0.2.8/.doctrees/api_doc/archive/index.doctree and b/v0.2.8/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/config/index.doctree b/v0.2.8/.doctrees/api_doc/config/index.doctree
index 74bb85137b..7dc623881c 100644
Binary files a/v0.2.8/.doctrees/api_doc/config/index.doctree and b/v0.2.8/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/config/meta.doctree b/v0.2.8/.doctrees/api_doc/config/meta.doctree
index d41c6d415d..7c74bf3a8f 100644
Binary files a/v0.2.8/.doctrees/api_doc/config/meta.doctree and b/v0.2.8/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/entry/base.doctree b/v0.2.8/.doctrees/api_doc/entry/base.doctree
index 468b4fc546..e8594ae28d 100644
Binary files a/v0.2.8/.doctrees/api_doc/entry/base.doctree and b/v0.2.8/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/entry/cli.doctree b/v0.2.8/.doctrees/api_doc/entry/cli.doctree
index 481e4007a3..6e2297392d 100644
Binary files a/v0.2.8/.doctrees/api_doc/entry/cli.doctree and b/v0.2.8/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/entry/dispatch.doctree b/v0.2.8/.doctrees/api_doc/entry/dispatch.doctree
index c467d70cfd..ca63b2b53a 100644
Binary files a/v0.2.8/.doctrees/api_doc/entry/dispatch.doctree and b/v0.2.8/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/entry/download.doctree b/v0.2.8/.doctrees/api_doc/entry/download.doctree
index e03f17f1c2..e35a1310e7 100644
Binary files a/v0.2.8/.doctrees/api_doc/entry/download.doctree and b/v0.2.8/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/entry/index.doctree b/v0.2.8/.doctrees/api_doc/entry/index.doctree
index 3d14b3e2cd..6a84a45fc6 100644
Binary files a/v0.2.8/.doctrees/api_doc/entry/index.doctree and b/v0.2.8/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/entry/ls.doctree b/v0.2.8/.doctrees/api_doc/entry/ls.doctree
index a82aac00ee..1de152a59c 100644
Binary files a/v0.2.8/.doctrees/api_doc/entry/ls.doctree and b/v0.2.8/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/entry/ls_repo.doctree b/v0.2.8/.doctrees/api_doc/entry/ls_repo.doctree
index 4e263ed7cf..47178eb413 100644
Binary files a/v0.2.8/.doctrees/api_doc/entry/ls_repo.doctree and b/v0.2.8/.doctrees/api_doc/entry/ls_repo.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/entry/upload.doctree b/v0.2.8/.doctrees/api_doc/entry/upload.doctree
index 3f9e841e29..ce5bee4872 100644
Binary files a/v0.2.8/.doctrees/api_doc/entry/upload.doctree and b/v0.2.8/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/entry/whoami.doctree b/v0.2.8/.doctrees/api_doc/entry/whoami.doctree
index 672f89156d..a4ba6bc8a4 100644
Binary files a/v0.2.8/.doctrees/api_doc/entry/whoami.doctree and b/v0.2.8/.doctrees/api_doc/entry/whoami.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/index/fetch.doctree b/v0.2.8/.doctrees/api_doc/index/fetch.doctree
index e7dbae6dcd..0997467905 100644
Binary files a/v0.2.8/.doctrees/api_doc/index/fetch.doctree and b/v0.2.8/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/index/index.doctree b/v0.2.8/.doctrees/api_doc/index/index.doctree
index c86156b8f4..3e18983a4f 100644
Binary files a/v0.2.8/.doctrees/api_doc/index/index.doctree and b/v0.2.8/.doctrees/api_doc/index/index.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/index/make.doctree b/v0.2.8/.doctrees/api_doc/index/make.doctree
index 6fbc5a22dd..d3a80fbcae 100644
Binary files a/v0.2.8/.doctrees/api_doc/index/make.doctree and b/v0.2.8/.doctrees/api_doc/index/make.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/index/validate.doctree b/v0.2.8/.doctrees/api_doc/index/validate.doctree
index 450422bb22..634b77cc44 100644
Binary files a/v0.2.8/.doctrees/api_doc/index/validate.doctree and b/v0.2.8/.doctrees/api_doc/index/validate.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/operate/base.doctree b/v0.2.8/.doctrees/api_doc/operate/base.doctree
index 6d494cb7e0..cf8265caa4 100644
Binary files a/v0.2.8/.doctrees/api_doc/operate/base.doctree and b/v0.2.8/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/operate/download.doctree b/v0.2.8/.doctrees/api_doc/operate/download.doctree
index 09b958a4e6..cb7a746ae5 100644
Binary files a/v0.2.8/.doctrees/api_doc/operate/download.doctree and b/v0.2.8/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/operate/index.doctree b/v0.2.8/.doctrees/api_doc/operate/index.doctree
index 2ea8c82584..a133aece06 100644
Binary files a/v0.2.8/.doctrees/api_doc/operate/index.doctree and b/v0.2.8/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/operate/upload.doctree b/v0.2.8/.doctrees/api_doc/operate/upload.doctree
index da82b1b881..f6a4a80268 100644
Binary files a/v0.2.8/.doctrees/api_doc/operate/upload.doctree and b/v0.2.8/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/operate/validate.doctree b/v0.2.8/.doctrees/api_doc/operate/validate.doctree
index 9d5a6539a6..910029a89a 100644
Binary files a/v0.2.8/.doctrees/api_doc/operate/validate.doctree and b/v0.2.8/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/utils/binary.doctree b/v0.2.8/.doctrees/api_doc/utils/binary.doctree
index d09d319d38..e5c5cdb93a 100644
Binary files a/v0.2.8/.doctrees/api_doc/utils/binary.doctree and b/v0.2.8/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/utils/download.doctree b/v0.2.8/.doctrees/api_doc/utils/download.doctree
index e680ac47eb..22ae2f86fb 100644
Binary files a/v0.2.8/.doctrees/api_doc/utils/download.doctree and b/v0.2.8/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/utils/index.doctree b/v0.2.8/.doctrees/api_doc/utils/index.doctree
index 75676fc573..977ff86633 100644
Binary files a/v0.2.8/.doctrees/api_doc/utils/index.doctree and b/v0.2.8/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/utils/path.doctree b/v0.2.8/.doctrees/api_doc/utils/path.doctree
index 31b7436bea..95d3a871f3 100644
Binary files a/v0.2.8/.doctrees/api_doc/utils/path.doctree and b/v0.2.8/.doctrees/api_doc/utils/path.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/utils/tqdm_.doctree b/v0.2.8/.doctrees/api_doc/utils/tqdm_.doctree
index 844fc46e64..071adc8f07 100644
Binary files a/v0.2.8/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.2.8/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.2.8/.doctrees/api_doc/utils/walk.doctree b/v0.2.8/.doctrees/api_doc/utils/walk.doctree
index a83345274a..ce14860546 100644
Binary files a/v0.2.8/.doctrees/api_doc/utils/walk.doctree and b/v0.2.8/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.2.8/.doctrees/environment.pickle b/v0.2.8/.doctrees/environment.pickle
index 8d1b15f274..4b70960cc3 100644
Binary files a/v0.2.8/.doctrees/environment.pickle and b/v0.2.8/.doctrees/environment.pickle differ
diff --git a/v0.2.8/.doctrees/index.doctree b/v0.2.8/.doctrees/index.doctree
index 52d87a1b87..444eed462d 100644
Binary files a/v0.2.8/.doctrees/index.doctree and b/v0.2.8/.doctrees/index.doctree differ
diff --git a/v0.2.8/.doctrees/information/environment.doctree b/v0.2.8/.doctrees/information/environment.doctree
index 87da9bb890..abc6492f59 100644
Binary files a/v0.2.8/.doctrees/information/environment.doctree and b/v0.2.8/.doctrees/information/environment.doctree differ
diff --git a/v0.2.8/.doctrees/information/environment.result.doctree b/v0.2.8/.doctrees/information/environment.result.doctree
index 4cfdb61eb0..7c867d387f 100644
Binary files a/v0.2.8/.doctrees/information/environment.result.doctree and b/v0.2.8/.doctrees/information/environment.result.doctree differ
diff --git a/v0.2.8/.doctrees/nbsphinx/information/environment.ipynb b/v0.2.8/.doctrees/nbsphinx/information/environment.ipynb
index a720d9ea31..aeecb03c43 100644
--- a/v0.2.8/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.2.8/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:07:55.553528Z",
-     "iopub.status.busy": "2024-07-23T18:07:55.552968Z",
-     "iopub.status.idle": "2024-07-23T18:07:56.723417Z",
-     "shell.execute_reply": "2024-07-23T18:07:56.722665Z"
+     "iopub.execute_input": "2024-07-23T18:14:41.597381Z",
+     "iopub.status.busy": "2024-07-23T18:14:41.597038Z",
+     "iopub.status.idle": "2024-07-23T18:14:42.786169Z",
+     "shell.execute_reply": "2024-07-23T18:14:42.785413Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2917.57625 MHz\n",
+      "CPU Freq: 3242.3715 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.8/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.2.8/.doctrees/nbsphinx/information/environment.result.ipynb
index 58217e2465..1df69940db 100644
--- a/v0.2.8/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.2.8/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:16:32.906627Z",
-     "iopub.status.busy": "2024-07-23T17:16:32.906063Z",
-     "iopub.status.idle": "2024-07-23T17:16:34.086988Z",
-     "shell.execute_reply": "2024-07-23T17:16:34.086283Z"
+     "iopub.execute_input": "2024-07-23T17:22:33.029641Z",
+     "iopub.status.busy": "2024-07-23T17:22:33.029147Z",
+     "iopub.status.idle": "2024-07-23T17:22:34.206273Z",
+     "shell.execute_reply": "2024-07-23T17:22:34.205537Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2730.48725 MHz\n",
+      "CPU Freq: 2907.6952499999998 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.8/.doctrees/tutorials/installation/index.doctree b/v0.2.8/.doctrees/tutorials/installation/index.doctree
index 463b191ed7..7bd496f0fe 100644
Binary files a/v0.2.8/.doctrees/tutorials/installation/index.doctree and b/v0.2.8/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.2.8/.doctrees/tutorials/quick_start/index.doctree b/v0.2.8/.doctrees/tutorials/quick_start/index.doctree
index 8cf7d565d0..894f68e124 100644
Binary files a/v0.2.8/.doctrees/tutorials/quick_start/index.doctree and b/v0.2.8/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.2.8/_sources/information/environment.result.ipynb.txt b/v0.2.8/_sources/information/environment.result.ipynb.txt
index 58217e2465..1df69940db 100644
--- a/v0.2.8/_sources/information/environment.result.ipynb.txt
+++ b/v0.2.8/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:16:32.906627Z",
-     "iopub.status.busy": "2024-07-23T17:16:32.906063Z",
-     "iopub.status.idle": "2024-07-23T17:16:34.086988Z",
-     "shell.execute_reply": "2024-07-23T17:16:34.086283Z"
+     "iopub.execute_input": "2024-07-23T17:22:33.029641Z",
+     "iopub.status.busy": "2024-07-23T17:22:33.029147Z",
+     "iopub.status.idle": "2024-07-23T17:22:34.206273Z",
+     "shell.execute_reply": "2024-07-23T17:22:34.205537Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2730.48725 MHz\n",
+      "CPU Freq: 2907.6952499999998 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.8/information/environment.html b/v0.2.8/information/environment.html
index c4efb4b611..ddd6c26f14 100644
--- a/v0.2.8/information/environment.html
+++ b/v0.2.8/information/environment.html
@@ -126,11 +126,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2917.57625 MHz
+CPU Freq: 3242.3715 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.8/information/environment.ipynb b/v0.2.8/information/environment.ipynb
index a720d9ea31..aeecb03c43 100644
--- a/v0.2.8/information/environment.ipynb
+++ b/v0.2.8/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:07:55.553528Z",
-     "iopub.status.busy": "2024-07-23T18:07:55.552968Z",
-     "iopub.status.idle": "2024-07-23T18:07:56.723417Z",
-     "shell.execute_reply": "2024-07-23T18:07:56.722665Z"
+     "iopub.execute_input": "2024-07-23T18:14:41.597381Z",
+     "iopub.status.busy": "2024-07-23T18:14:41.597038Z",
+     "iopub.status.idle": "2024-07-23T18:14:42.786169Z",
+     "shell.execute_reply": "2024-07-23T18:14:42.785413Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2917.57625 MHz\n",
+      "CPU Freq: 3242.3715 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.8/information/environment.result.html b/v0.2.8/information/environment.result.html
index 81751a280d..93e9de8d34 100644
--- a/v0.2.8/information/environment.result.html
+++ b/v0.2.8/information/environment.result.html
@@ -128,11 +128,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2730.48725 MHz
+CPU Freq: 2907.6952499999998 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.8/information/environment.result.ipynb b/v0.2.8/information/environment.result.ipynb
index 58217e2465..1df69940db 100644
--- a/v0.2.8/information/environment.result.ipynb
+++ b/v0.2.8/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:16:32.906627Z",
-     "iopub.status.busy": "2024-07-23T17:16:32.906063Z",
-     "iopub.status.idle": "2024-07-23T17:16:34.086988Z",
-     "shell.execute_reply": "2024-07-23T17:16:34.086283Z"
+     "iopub.execute_input": "2024-07-23T17:22:33.029641Z",
+     "iopub.status.busy": "2024-07-23T17:22:33.029147Z",
+     "iopub.status.idle": "2024-07-23T17:22:34.206273Z",
+     "shell.execute_reply": "2024-07-23T17:22:34.205537Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2730.48725 MHz\n",
+      "CPU Freq: 2907.6952499999998 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.8/searchindex.js b/v0.2.8/searchindex.js
index 5755c3962f..a9f85e2e90 100644
--- a/v0.2.8/searchindex.js
+++ b/v0.2.8/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 12, 14, 15], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 15, 17, 19, 22, 24, 25], "you": [0, 12, 30], "requir": [0, 30], "simpli": [0, 30], "instal": [0, 27], "us": [0, 3, 12, 14, 15, 16, 17, 19, 22, 27, 30], "follow": [0, 8, 30], "code": [0, 3, 6, 10], "pip": [0, 30], "The": [0, 3, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26, 30], "creation": 0, "file": [0, 3, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 26], "i": [0, 6, 9, 10, 12, 14, 15, 17, 20, 21, 24, 27, 28, 29, 30], "we": 0, "util": [0, 27, 30], "rarfil": 0, "librari": [0, 22], "which": [0, 12, 28, 29, 30], "doe": [0, 12], "offer": 0, "function": [0, 3, 12, 14, 15, 21, 22, 25], "creat": [0, 14], "str": [0, 3, 6, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26], "ext": 0, "list": [0, 3, 8, 12, 16, 17, 19], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "regist": 0, "custom": [0, 3, 6, 10], "type": [0, 3, 8, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "associ": 0, "paramet": [0, 3, 5, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "A": [0, 16], "take": 0, "directori": [0, 8, 14, 15, 17, 19, 26], "an": [0, 12, 14, 15, 17, 19, 22, 25, 26], "filenam": [0, 22, 24], "input": 0, "extract": [0, 17], "type_nam": 0, "archive_fil": 0, "silent": [0, 14, 17, 19, 22, 25], "bool": [0, 5, 12, 14, 15, 17, 19, 20, 21, 22, 25], "fals": [0, 12, 14, 15, 17, 19, 20, 21, 22, 25], "clear": [0, 19], "specifi": [0, 15, 19, 22], "result": 0, "true": [0, 12, 14, 15, 17, 19, 20, 21, 22, 25], "suppress": [0, 14, 17, 19, 22], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 19], "exist": [0, 12, 17], "when": [0, 9, 12, 14, 17], "return": [0, 3, 12, 14, 15, 16, 20, 21, 22, 24, 25, 26], "path": [0, 6, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 23, 26, 27], "password": [0, 17], "none": [0, 3, 5, 6, 10, 12, 14, 15, 16, 17, 19, 20, 22, 24], "content": [0, 25], "option": [0, 3, 5, 6, 10, 12, 14, 15, 16, 17, 19, 20, 22, 24, 25], "determin": 0, "base": [0, 7, 8, 15, 18, 27], "rais": [0, 9, 12, 15, 24], "valueerror": [0, 24], "ani": [0, 5, 21, 24], "get": [0, 12, 14, 16, 22, 24], "meta": [1, 12, 27, 30], "__title__": [1, 30], "__version__": [1, 30], "__description__": [1, 30], "__author__": [1, 30], "__author_email__": 1, "inform": [2, 3, 5, 12, 14, 15], "packag": 2, "titl": 2, "thi": [2, 3, 6, 10, 12, 14, 15, 21, 22, 24, 25, 28, 29], "project": 2, "should": [2, 22, 30], "version": [2, 5, 25, 30], "short": 2, "descript": [2, 22], "includ": [2, 3, 12, 14], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 12, 14], "new": 3, "empti": 3, "dictionari": [3, 12], "map": 3, "initi": 3, "from": [3, 12, 14, 15, 16, 17, 22, 28, 29, 30], "object": [3, 8, 12, 16, 17, 19, 22], "": [3, 5, 12], "kei": [3, 12], "valu": [3, 5, 8, 14], "pair": 3, "iter": [3, 26], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 22, 25], "keyword": [3, 22, 25], "argument": [3, 12, 22, 25], "For": 3, "exampl": [3, 12], "one": 3, "1": [3, 8, 14, 15, 28, 29], "two": 3, "2": [3, 8, 30], "class": [3, 6, 8, 9, 10, 12, 24], "messag": [3, 6, 9, 10, 14, 19], "except": [3, 6, 9, 10, 12], "displai": [3, 6, 10, 22, 25], "yellow": 3, "color": 3, "error": [3, 6, 10], "exit_cod": [3, 6, 10], "exit": [3, 6, 10], "show": [3, 6, 10], "io": [3, 6, 10, 30], "write": [3, 6, 10], "output": [3, 6, 10, 17, 19, 22, 25, 30], "red": [3, 6, 10], "err": 3, "baseexcept": 3, "print": [3, 5, 28, 29, 30], "traceback": 3, "provid": [3, 22], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 30], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 27], "current": [5, 28, 29, 30], "metadata": 5, "arg": [5, 25], "indic": [6, 10], "remot": [6, 10], "repositori": [6, 10, 12, 14, 15, 16, 17, 19, 20, 24], "assign": [6, 10, 12, 16, 17, 19], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 27], "print_vers": 7, "download": [7, 12, 15, 18, 23, 27], "noremotepathassignedwithdownload": 7, "l": [7, 27], "listitemtyp": 7, "listitem": 7, "ls_repo": [7, 27], "nolocalauthent": 7, "upload": [7, 14, 18, 27], "noremotepathassignedwithupload": 7, "whoami": [7, 27], "enum": 8, "repres": [8, 12], "differ": [8, 12, 28, 29], "item": [8, 15], "valid": [8, 13, 18, 27], "ar": [8, 12], "folder": 8, "imag": [8, 12], "3": [8, 28, 29, 30], "archiv": [8, 12, 14, 15, 17, 19, 27], "4": [8, 28, 29], "model": [8, 12, 14, 15, 16, 17, 19, 20, 24], "5": [8, 17, 28, 29], "data": [8, 12, 28, 29], "6": [8, 28, 29], "repofold": 8, "repofil": [8, 15], "base_dir": 8, "union": [8, 12], "local": [9, 12, 14, 17, 19, 20, 22, 28, 29], "authent": [9, 15], "token": [9, 12, 14, 15, 16, 17, 19, 20], "33": 10, "standalon": 12, "incomplet": 12, "hash": [12, 14, 15, 16, 17, 19], "match": [12, 15, 20], "repo_id": [12, 14, 15, 16, 17, 19, 20, 24], "archive_in_repo": [12, 14, 15, 19], "repo_typ": [12, 14, 15, 16, 17, 19, 20, 24], "liter": [12, 14, 15, 16, 17, 19, 20, 24], "dataset": [12, 14, 15, 16, 17, 19, 20, 24], "space": [12, 14, 15, 16, 17, 19, 20, 24], "revis": [12, 14, 15, 16, 17, 19, 20, 24], "main": [12, 14, 15, 16, 17, 19, 20, 30], "idx_repo_id": [12, 14, 15], "idx_file_in_repo": [12, 14, 15], "idx_repo_typ": [12, 14, 15], "idx_revis": [12, 14, 15], "hf_token": [12, 14, 15, 16, 17, 19, 20], "hug": [12, 14, 15, 16, 17, 19, 20], "face": [12, 14, 15, 16, 17, 19, 20], "identifi": [12, 14, 16, 17, 19, 20], "repotypetyp": [12, 14, 15, 16, 17, 19, 20, 24], "access": [12, 14], "import": [12, 28, 29, 30], "idx": 12, "deepgh": [12, 30], "danbooru_newest": 12, "0000": 12, "dict_kei": 12, "files": 12, "hash_lf": [12, 15], "7507000": 12, "jpg": 12, "7506000": 12, "7505000": 12, "besid": 12, "can": [12, 15, 30], "also": [12, 22, 30], "explicitli": 12, "nyanko7": 12, "danbooru2023": 12, "danbooru2023_index": 12, "origin": 12, "1000": 12, "png": 12, "10000": 12, "100000": 12, "insid": 12, "all": [12, 17, 26], "file_in_arch": 12, "check": [12, 15, 20, 21, 22, 30], "otherwis": [12, 15, 20, 22], "17506000": 12, "10000000001000": 12, "int": [12, 14, 15, 17, 22], "size": [12, 14, 15, 22, 28, 29], "integ": 12, "filenotfounderror": 12, "435671": 12, "11966": 12, "detail": 12, "offset": 12, "sha256": 12, "265728": 12, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 12, "1024": [12, 21], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 12, "local_fil": [12, 17, 19, 20], "proxi": 12, "user_ag": 12, "header": 12, "endpoint": 12, "save": [12, 14, 17, 22], "http": [12, 30], "request": [12, 22], "user": 12, "agent": 12, "addit": [12, 22, 25], "api": [12, 15, 16, 17, 19, 20], "test_exampl": 12, "destin": 12, "given": [12, 16, 21, 22, 24], "fetch": [13, 27], "archivestandalonefileincompletedownload": 13, "archivestandalonefilehashnotmatch": 13, "hf_tar_get_index": 13, "hf_tar_list_fil": 13, "hf_tar_file_exist": 13, "hf_tar_file_s": 13, "hf_tar_file_info": 13, "hf_tar_file_download": 13, "make": [13, 15, 27], "tar_create_index": 13, "hf_tar_create_index": [13, 15], "tar_get_index_info": 13, "hf_tar_create_from_directori": 13, "hf_tar_item_valid": 13, "hf_tar_valid": 13, "src_tar_fil": 14, "dst_index_fil": 14, "chunk_for_hash": 14, "1048576": 14, "with_hash": 14, "default": [14, 15, 17, 20, 24], "chunk": 14, "20": 14, "mb": 14, "whether": 14, "progress": [14, 17, 19, 22, 25], "bar": [14, 17, 19, 22, 25], "log": 14, "skip_when_sync": 14, "skip": 14, "sync": 14, "readi": [14, 20], "directli": 14, "json": [14, 15], "local_directori": [14, 17, 19], "file_item": 15, "hash_": 15, "expect": [15, 22], "sha": 15, "256": 15, "store": 15, "lf": 15, "huggingfac": [15, 16, 17, 19, 24, 27, 30], "id": [15, 24], "where": [15, 22], "entrynotfounderror": 15, "entri": [15, 27], "found": 15, "isadirectoryerror": 15, "mean": [15, 30], "expir": 15, "need": 15, "re": 15, "gener": 15, "so": 15, "togeth": 15, "gracefulli": 15, "refresh": 15, "hfapi": 16, "client": [16, 17, 19], "variabl": [16, 17, 19], "hffilesystem": 16, "system": 16, "subdir": 16, "ignore_pattern": [16, 17, 19], "subdirectori": 16, "e": [16, 17, 19], "g": [16, 17, 19], "branch": [16, 17, 19], "tag": [16, 17, 19], "commit": [16, 17, 19], "pattern": [16, 17, 19], "ignor": [16, 17, 19], "file_in_repo": [17, 19, 20], "resume_download": 17, "within": [17, 19], "resum": 17, "dir_in_repo": 17, "max_work": 17, "8": [17, 28, 29, 30], "max_retri": 17, "max": 17, "worker": 17, "retri": 17, "time": 17, "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 18, "download_archive_as_directori": 18, "download_directory_as_directori": 18, "upload_file_to_fil": 18, "upload_directory_as_arch": 18, "upload_directory_as_directori": 18, "is_local_file_readi": 18, "path_in_repo": 19, "time_suffix": 19, "its": 19, "append": 19, "timestamp": 19, "present": 19, "compar": 20, "hub": 20, "read": 21, "first": 21, "byte": [21, 22], "contain": 21, "non": 21, "text": 21, "charact": 21, "url": 22, "expected_s": 22, "desc": 22, "session": 22, "tqdm": [22, 23, 27], "It": [22, 30], "perform": [22, 28, 29], "ensur": 22, "ha": [22, 28, 29], "pass": [22, 25], "binari": [23, 27], "is_binary_fil": 23, "download_fil": 23, "hf_normpath": 23, "hf_fs_path": 23, "parse_hf_fs_path": 23, "hffilesystempath": 23, "walk": [23, 27], "walk_fil": 23, "normal": 24, "filesystem": 24, "pars": 24, "invalid": 24, "tqdm_": 25, "enhanc": 25, "silenc": 25, "modifi": 25, "behavior": 25, "allow": 25, "posit": 25, "std": 25, "recurs": 26, "through": [26, 30], "yield": 26, "rel": 26, "root": 26, "start": [26, 27], "modul": 27, "quick": 27, "run": 27, "environ": 27, "register_archive_typ": 27, "archive_pack": 27, "archive_unpack": 27, "get_archive_typ": 27, "get_archive_extnam": 27, "config": [27, 30], "index": [27, 30], "oper": 27, "here": [28, 29], "o": [28, 29], "platform": [28, 29], "shutil": [28, 29], "cpuinfo": [28, 29], "psutil": [28, 29], "hbutil": [28, 29], "scale": [28, 29], "size_to_bytes_str": [28, 29], "python": [28, 29, 30], "python_implement": [28, 29], "python_vers": [28, 29], "cpu": [28, 29], "brand": [28, 29], "get_cpu_info": [28, 29], "brand_raw": [28, 29], "count": [28, 29], "cpu_count": [28, 29], "freq": [28, 29], "cpu_freq": [28, 29], "mhz": [28, 29], "memori": [28, 29], "virtual_memori": [28, 29], "total": [28, 29], "precis": [28, 29], "cuda": [28, 29], "ye": [28, 29], "nvidia": [28, 29], "smi": [28, 29], "els": [28, 29], "No": [28, 29], "linux": [28, 29], "0": [28, 29, 30], "1023": [28, 29], "azur": [28, 29], "x86_64": [28, 29], "glibc2": [28, 29], "34": [28, 29], "cpython": [28, 29], "18": [28, 29], "amd": [28, 29], "epyc": [28, 29], "7763": [28, 29], "64": [28, 29], "core": [28, 29], "processor": [28, 29], "2917": 28, "57625": 28, "15": [28, 29], "606": [28, 29], "gib": [28, 29], "pleas": [28, 29], "note": [28, 29], "deploi": [28, 29], "document": [28, 29, 30], "automat": [28, 29], "execut": [28, 29], "github": [28, 29, 30], "action": [28, 29], "therefor": [28, 29], "some": [28, 29], "mai": [28, 29], "your": [28, 29, 30], "2730": 29, "48725": 29, "hfutil": 30, "host": 30, "pypi": 30, "newest": 30, "u": 30, "git": 30, "com": 30, "script": 30, "__name__": 30, "__main__": 30, "develop": 30, "maintain": 30, "like": 30, "below": 30, "success": 30, "narugo1992": 30, "still": 30, "under": 30, "out": 30, "stabl": 30, "html": 30, "faq": 31}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [13, 0, 0, "-", "index"], [18, 0, 0, "-", "operate"], [23, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "ls_repo"], [10, 0, 0, "-", "upload"], [11, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[9, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[10, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[10, 4, 1, "", "exit_code"], [10, 5, 1, "", "show"]], "hfutils.index": [[12, 0, 0, "-", "fetch"], [14, 0, 0, "-", "make"], [15, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[12, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [12, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [12, 1, 1, "", "hf_tar_file_download"], [12, 1, 1, "", "hf_tar_file_exists"], [12, 1, 1, "", "hf_tar_file_info"], [12, 1, 1, "", "hf_tar_file_size"], [12, 1, 1, "", "hf_tar_get_index"], [12, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[14, 1, 1, "", "hf_tar_create_from_directory"], [14, 1, 1, "", "hf_tar_create_index"], [14, 1, 1, "", "tar_create_index"], [14, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[15, 1, 1, "", "hf_tar_item_validate"], [15, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[16, 0, 0, "-", "base"], [17, 0, 0, "-", "download"], [19, 0, 0, "-", "upload"], [20, 0, 0, "-", "validate"]], "hfutils.operate.base": [[16, 1, 1, "", "get_hf_client"], [16, 1, 1, "", "get_hf_fs"], [16, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[17, 1, 1, "", "download_archive_as_directory"], [17, 1, 1, "", "download_directory_as_directory"], [17, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[19, 1, 1, "", "upload_directory_as_archive"], [19, 1, 1, "", "upload_directory_as_directory"], [19, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[20, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[21, 0, 0, "-", "binary"], [22, 0, 0, "-", "download"], [24, 0, 0, "-", "path"], [25, 0, 0, "-", "tqdm_"], [26, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[21, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[22, 1, 1, "", "download_file"]], "hfutils.utils.path": [[24, 3, 1, "", "HfFileSystemPath"], [24, 1, 1, "", "hf_fs_path"], [24, 1, 1, "", "hf_normpath"], [24, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[25, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[26, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9, 10, 11], "base": [3, 16], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 17, 22], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "ls_repo": 9, "nolocalauthent": 9, "upload": [10, 19], "noremotepathassignedwithupload": 10, "whoami": 11, "index": [12, 13, 14, 15], "fetch": 12, "archivestandalonefileincompletedownload": 12, "archivestandalonefilehashnotmatch": 12, "hf_tar_get_index": 12, "hf_tar_list_fil": 12, "hf_tar_file_exist": 12, "hf_tar_file_s": 12, "hf_tar_file_info": 12, "hf_tar_file_download": 12, "make": 14, "tar_create_index": 14, "hf_tar_create_index": 14, "tar_get_index_info": 14, "hf_tar_create_from_directori": 14, "valid": [15, 20], "hf_tar_item_valid": 15, "hf_tar_valid": 15, "oper": [16, 17, 18, 19, 20], "get_hf_client": 16, "get_hf_f": 16, "list_files_in_repositori": 16, "download_file_to_fil": 17, "download_archive_as_directori": 17, "download_directory_as_directori": 17, "upload_file_to_fil": 19, "upload_directory_as_arch": 19, "upload_directory_as_directori": 19, "is_local_file_readi": 20, "util": [21, 22, 23, 24, 25, 26], "binari": 21, "is_binary_fil": 21, "download_fil": 22, "path": 24, "hf_normpath": 24, "hf_fs_path": 24, "parse_hf_fs_path": 24, "hffilesystempath": 24, "tqdm": 25, "walk": 26, "walk_fil": 26, "welcom": 27, "": 27, "document": 27, "overview": 27, "tutori": 27, "inform": [27, 28, 29], "api": 27, "run": [28, 29], "environ": [28, 29], "instal": 30, "quick": 31, "start": 31}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.ls_repo": [[9, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[9, "nolocalauthentication"]], "hfutils.entry.upload": [[10, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[10, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[11, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[12, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[12, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[12, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[12, "hf-tar-get-index"]], "hf_tar_list_files": [[12, "hf-tar-list-files"]], "hf_tar_file_exists": [[12, "hf-tar-file-exists"]], "hf_tar_file_size": [[12, "hf-tar-file-size"]], "hf_tar_file_info": [[12, "hf-tar-file-info"]], "hf_tar_file_download": [[12, "hf-tar-file-download"]], "hfutils.index": [[13, "module-hfutils.index"]], "hfutils.index.make": [[14, "module-hfutils.index.make"]], "tar_create_index": [[14, "tar-create-index"]], "hf_tar_create_index": [[14, "hf-tar-create-index"]], "tar_get_index_info": [[14, "tar-get-index-info"]], "hf_tar_create_from_directory": [[14, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[15, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[15, "hf-tar-item-validate"]], "hf_tar_validate": [[15, "hf-tar-validate"]], "hfutils.operate.base": [[16, "module-hfutils.operate.base"]], "get_hf_client": [[16, "get-hf-client"]], "get_hf_fs": [[16, "get-hf-fs"]], "list_files_in_repository": [[16, "list-files-in-repository"]], "hfutils.operate.download": [[17, "module-hfutils.operate.download"]], "download_file_to_file": [[17, "download-file-to-file"]], "download_archive_as_directory": [[17, "download-archive-as-directory"]], "download_directory_as_directory": [[17, "download-directory-as-directory"]], "hfutils.operate": [[18, "module-hfutils.operate"]], "hfutils.operate.upload": [[19, "module-hfutils.operate.upload"]], "upload_file_to_file": [[19, "upload-file-to-file"]], "upload_directory_as_archive": [[19, "upload-directory-as-archive"]], "upload_directory_as_directory": [[19, "upload-directory-as-directory"]], "hfutils.operate.validate": [[20, "module-hfutils.operate.validate"]], "is_local_file_ready": [[20, "is-local-file-ready"]], "hfutils.utils.binary": [[21, "module-hfutils.utils.binary"]], "is_binary_file": [[21, "is-binary-file"]], "hfutils.utils.download": [[22, "module-hfutils.utils.download"]], "download_file": [[22, "download-file"]], "hfutils.utils": [[23, "module-hfutils.utils"]], "hfutils.utils.path": [[24, "module-hfutils.utils.path"]], "hf_normpath": [[24, "hf-normpath"]], "hf_fs_path": [[24, "hf-fs-path"]], "parse_hf_fs_path": [[24, "parse-hf-fs-path"]], "HfFileSystemPath": [[24, "hffilesystempath"]], "hfutils.utils.tqdm": [[25, "module-hfutils.utils.tqdm_"]], "tqdm": [[25, "tqdm"]], "hfutils.utils.walk": [[26, "module-hfutils.utils.walk"]], "walk_files": [[26, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[27, "welcome-to-hfutils-s-documentation"]], "Overview": [[27, "overview"]], "Tutorials": [[27, null]], "Information": [[27, null]], "API Documentation": [[27, null]], "Run Environment Information": [[28, "Run-Environment-Information"], [29, "Run-Environment-Information"]], "Installation": [[30, "installation"]], "Quick Start": [[31, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.ls_repo"], [10, "module-hfutils.entry.upload"], [11, "module-hfutils.entry.whoami"], [12, "module-hfutils.index.fetch"], [13, "module-hfutils.index"], [14, "module-hfutils.index.make"], [15, "module-hfutils.index.validate"], [16, "module-hfutils.operate.base"], [17, "module-hfutils.operate.download"], [18, "module-hfutils.operate"], [19, "module-hfutils.operate.upload"], [20, "module-hfutils.operate.validate"], [21, "module-hfutils.utils.binary"], [22, "module-hfutils.utils.download"], [23, "module-hfutils.utils"], [24, "module-hfutils.utils.path"], [25, "module-hfutils.utils.tqdm_"], [26, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[9, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[9, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[10, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[11, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[12, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[12, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[12, "module-hfutils.index.fetch"]], "hfutils.index": [[13, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[14, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[14, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[14, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[14, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[14, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[15, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[15, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[15, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[16, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[17, "module-hfutils.operate.download"]], "hfutils.operate": [[18, "module-hfutils.operate"]], "hfutils.operate.upload": [[19, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[20, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[20, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[21, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[21, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[22, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[22, "module-hfutils.utils.download"]], "hfutils.utils": [[23, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[24, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[24, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[25, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[25, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[26, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[26, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2], "pack": 0, "unpack": 0, "manag": 0, "support": 0, "format": 0, "extens": 0, "name": [0, 3], "7z": 0, "bztar": 0, "tar": [0, 12, 14, 15], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 3, 15, 17, 19, 22, 24, 25], "you": [0, 12, 30], "requir": [0, 30], "simpli": [0, 30], "instal": [0, 27], "us": [0, 3, 12, 14, 15, 16, 17, 19, 22, 27, 30], "follow": [0, 8, 30], "code": [0, 3, 6, 10], "pip": [0, 30], "The": [0, 3, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26, 30], "creation": 0, "file": [0, 3, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 26], "i": [0, 6, 9, 10, 12, 14, 15, 17, 20, 21, 24, 27, 28, 29, 30], "we": 0, "util": [0, 27, 30], "rarfil": 0, "librari": [0, 22], "which": [0, 12, 28, 29, 30], "doe": [0, 12], "offer": 0, "function": [0, 3, 12, 14, 15, 21, 22, 25], "creat": [0, 14], "str": [0, 3, 6, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26], "ext": 0, "list": [0, 3, 8, 12, 16, 17, 19], "fn_pack": 0, "callabl": [0, 3], "fn_unpack": 0, "sourc": [0, 3, 5, 6, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "regist": 0, "custom": [0, 3, 6, 10], "type": [0, 3, 8, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "associ": 0, "paramet": [0, 3, 5, 6, 8, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26], "A": [0, 16], "take": 0, "directori": [0, 8, 14, 15, 17, 19, 26], "an": [0, 12, 14, 15, 17, 19, 22, 25, 26], "filenam": [0, 22, 24], "input": 0, "extract": [0, 17], "type_nam": 0, "archive_fil": 0, "silent": [0, 14, 17, 19, 22, 25], "bool": [0, 5, 12, 14, 15, 17, 19, 20, 21, 22, 25], "fals": [0, 12, 14, 15, 17, 19, 20, 21, 22, 25], "clear": [0, 19], "specifi": [0, 15, 19, 22], "result": 0, "true": [0, 12, 14, 15, 17, 19, 20, 21, 22, 25], "suppress": [0, 14, 17, 19, 22], "warn": [0, 3], "dure": 0, "process": 0, "remov": [0, 19], "exist": [0, 12, 17], "when": [0, 9, 12, 14, 17], "return": [0, 3, 12, 14, 15, 16, 20, 21, 22, 24, 25, 26], "path": [0, 6, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 23, 26, 27], "password": [0, 17], "none": [0, 3, 5, 6, 10, 12, 14, 15, 16, 17, 19, 20, 22, 24], "content": [0, 25], "option": [0, 3, 5, 6, 10, 12, 14, 15, 16, 17, 19, 20, 22, 24, 25], "determin": 0, "base": [0, 7, 8, 15, 18, 27], "rais": [0, 9, 12, 15, 24], "valueerror": [0, 24], "ani": [0, 5, 21, 24], "get": [0, 12, 14, 16, 22, 24], "meta": [1, 12, 27, 30], "__title__": [1, 30], "__version__": [1, 30], "__description__": [1, 30], "__author__": [1, 30], "__author_email__": 1, "inform": [2, 3, 5, 12, 14, 15], "packag": 2, "titl": 2, "thi": [2, 3, 6, 10, 12, 14, 15, 21, 22, 24, 25, 28, 29], "project": 2, "should": [2, 22, 30], "version": [2, 5, 25, 30], "short": 2, "descript": [2, 22], "includ": [2, 3, 12, 14], "setup": 2, "py": 2, "author": 2, "email": 2, "help_option_nam": 3, "h": 3, "help": 3, "dict": [3, 12, 14], "new": 3, "empti": 3, "dictionari": [3, 12], "map": 3, "initi": 3, "from": [3, 12, 14, 15, 16, 17, 22, 28, 29, 30], "object": [3, 8, 12, 16, 17, 19, 22], "": [3, 5, 12], "kei": [3, 12], "valu": [3, 5, 8, 14], "pair": 3, "iter": [3, 26], "via": 3, "d": 3, "k": 3, "v": 3, "kwarg": [3, 5, 22, 25], "keyword": [3, 22, 25], "argument": [3, 12, 22, 25], "For": 3, "exampl": [3, 12], "one": 3, "1": [3, 8, 14, 15, 28, 29], "two": 3, "2": [3, 8, 30], "class": [3, 6, 8, 9, 10, 12, 24], "messag": [3, 6, 9, 10, 14, 19], "except": [3, 6, 9, 10, 12], "displai": [3, 6, 10, 22, 25], "yellow": 3, "color": 3, "error": [3, 6, 10], "exit_cod": [3, 6, 10], "exit": [3, 6, 10], "show": [3, 6, 10], "io": [3, 6, 10, 30], "write": [3, 6, 10], "output": [3, 6, 10, 17, 19, 22, 25, 30], "red": [3, 6, 10], "err": 3, "baseexcept": 3, "print": [3, 5, 28, 29, 30], "traceback": 3, "provid": [3, 22], "built": 3, "msg": 3, "handl": 3, "keyboard": 3, "interrupt": 3, "__init__": 3, "7": 3, "decor": 3, "wrap": 3, "click": [3, 5], "command": [3, 30], "catch": 3, "consist": 3, "group": 4, "hfutilcli": [4, 7], "ctx": 5, "context": 5, "param": 5, "cli": [5, 7, 27], "current": [5, 28, 29, 30], "metadata": 5, "arg": [5, 25], "indic": [6, 10], "remot": [6, 10], "repositori": [6, 10, 12, 14, 15, 16, 17, 19, 20, 24], "assign": [6, 10, 12, 16, 17, 19], "17": 6, "context_set": 7, "clickwarningexcept": 7, "clickerrorexcept": 7, "print_except": 7, "keyboardinterrupt": 7, "command_wrap": 7, "dispatch": [7, 27], "print_vers": 7, "download": [7, 12, 15, 18, 23, 27], "noremotepathassignedwithdownload": 7, "l": [7, 27], "listitemtyp": 7, "listitem": 7, "ls_repo": [7, 27], "nolocalauthent": 7, "upload": [7, 14, 18, 27], "noremotepathassignedwithupload": 7, "whoami": [7, 27], "enum": 8, "repres": [8, 12], "differ": [8, 12, 28, 29], "item": [8, 15], "valid": [8, 13, 18, 27], "ar": [8, 12], "folder": 8, "imag": [8, 12], "3": [8, 28, 29, 30], "archiv": [8, 12, 14, 15, 17, 19, 27], "4": [8, 28, 29], "model": [8, 12, 14, 15, 16, 17, 19, 20, 24], "5": [8, 17, 28, 29], "data": [8, 12, 28, 29], "6": [8, 28, 29], "repofold": 8, "repofil": [8, 15], "base_dir": 8, "union": [8, 12], "local": [9, 12, 14, 17, 19, 20, 22, 28, 29], "authent": [9, 15], "token": [9, 12, 14, 15, 16, 17, 19, 20], "33": 10, "standalon": 12, "incomplet": 12, "hash": [12, 14, 15, 16, 17, 19], "match": [12, 15, 20], "repo_id": [12, 14, 15, 16, 17, 19, 20, 24], "archive_in_repo": [12, 14, 15, 19], "repo_typ": [12, 14, 15, 16, 17, 19, 20, 24], "liter": [12, 14, 15, 16, 17, 19, 20, 24], "dataset": [12, 14, 15, 16, 17, 19, 20, 24], "space": [12, 14, 15, 16, 17, 19, 20, 24], "revis": [12, 14, 15, 16, 17, 19, 20, 24], "main": [12, 14, 15, 16, 17, 19, 20, 30], "idx_repo_id": [12, 14, 15], "idx_file_in_repo": [12, 14, 15], "idx_repo_typ": [12, 14, 15], "idx_revis": [12, 14, 15], "hf_token": [12, 14, 15, 16, 17, 19, 20], "hug": [12, 14, 15, 16, 17, 19, 20], "face": [12, 14, 15, 16, 17, 19, 20], "identifi": [12, 14, 16, 17, 19, 20], "repotypetyp": [12, 14, 15, 16, 17, 19, 20, 24], "access": [12, 14], "import": [12, 28, 29, 30], "idx": 12, "deepgh": [12, 30], "danbooru_newest": 12, "0000": 12, "dict_kei": 12, "files": 12, "hash_lf": [12, 15], "7507000": 12, "jpg": 12, "7506000": 12, "7505000": 12, "besid": 12, "can": [12, 15, 30], "also": [12, 22, 30], "explicitli": 12, "nyanko7": 12, "danbooru2023": 12, "danbooru2023_index": 12, "origin": 12, "1000": 12, "png": 12, "10000": 12, "100000": 12, "insid": 12, "all": [12, 17, 26], "file_in_arch": 12, "check": [12, 15, 20, 21, 22, 30], "otherwis": [12, 15, 20, 22], "17506000": 12, "10000000001000": 12, "int": [12, 14, 15, 17, 22], "size": [12, 14, 15, 22, 28, 29], "integ": 12, "filenotfounderror": 12, "435671": 12, "11966": 12, "detail": 12, "offset": 12, "sha256": 12, "265728": 12, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 12, "1024": [12, 21, 28, 29], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 12, "local_fil": [12, 17, 19, 20], "proxi": 12, "user_ag": 12, "header": 12, "endpoint": 12, "save": [12, 14, 17, 22], "http": [12, 30], "request": [12, 22], "user": 12, "agent": 12, "addit": [12, 22, 25], "api": [12, 15, 16, 17, 19, 20], "test_exampl": 12, "destin": 12, "given": [12, 16, 21, 22, 24], "fetch": [13, 27], "archivestandalonefileincompletedownload": 13, "archivestandalonefilehashnotmatch": 13, "hf_tar_get_index": 13, "hf_tar_list_fil": 13, "hf_tar_file_exist": 13, "hf_tar_file_s": 13, "hf_tar_file_info": 13, "hf_tar_file_download": 13, "make": [13, 15, 27], "tar_create_index": 13, "hf_tar_create_index": [13, 15], "tar_get_index_info": 13, "hf_tar_create_from_directori": 13, "hf_tar_item_valid": 13, "hf_tar_valid": 13, "src_tar_fil": 14, "dst_index_fil": 14, "chunk_for_hash": 14, "1048576": 14, "with_hash": 14, "default": [14, 15, 17, 20, 24], "chunk": 14, "20": 14, "mb": 14, "whether": 14, "progress": [14, 17, 19, 22, 25], "bar": [14, 17, 19, 22, 25], "log": 14, "skip_when_sync": 14, "skip": 14, "sync": 14, "readi": [14, 20], "directli": 14, "json": [14, 15], "local_directori": [14, 17, 19], "file_item": 15, "hash_": 15, "expect": [15, 22], "sha": 15, "256": 15, "store": 15, "lf": 15, "huggingfac": [15, 16, 17, 19, 24, 27, 30], "id": [15, 24], "where": [15, 22], "entrynotfounderror": 15, "entri": [15, 27], "found": 15, "isadirectoryerror": 15, "mean": [15, 30], "expir": 15, "need": 15, "re": 15, "gener": 15, "so": 15, "togeth": 15, "gracefulli": 15, "refresh": 15, "hfapi": 16, "client": [16, 17, 19], "variabl": [16, 17, 19], "hffilesystem": 16, "system": 16, "subdir": 16, "ignore_pattern": [16, 17, 19], "subdirectori": 16, "e": [16, 17, 19], "g": [16, 17, 19], "branch": [16, 17, 19], "tag": [16, 17, 19], "commit": [16, 17, 19], "pattern": [16, 17, 19], "ignor": [16, 17, 19], "file_in_repo": [17, 19, 20], "resume_download": 17, "within": [17, 19], "resum": 17, "dir_in_repo": 17, "max_work": 17, "8": [17, 28, 29, 30], "max_retri": 17, "max": 17, "worker": 17, "retri": 17, "time": 17, "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 18, "download_archive_as_directori": 18, "download_directory_as_directori": 18, "upload_file_to_fil": 18, "upload_directory_as_arch": 18, "upload_directory_as_directori": 18, "is_local_file_readi": 18, "path_in_repo": 19, "time_suffix": 19, "its": 19, "append": 19, "timestamp": 19, "present": 19, "compar": 20, "hub": 20, "read": 21, "first": 21, "byte": [21, 22], "contain": 21, "non": 21, "text": 21, "charact": 21, "url": 22, "expected_s": 22, "desc": 22, "session": 22, "tqdm": [22, 23, 27], "It": [22, 30], "perform": [22, 28, 29], "ensur": 22, "ha": [22, 28, 29], "pass": [22, 25], "binari": [23, 27], "is_binary_fil": 23, "download_fil": 23, "hf_normpath": 23, "hf_fs_path": 23, "parse_hf_fs_path": 23, "hffilesystempath": 23, "walk": [23, 27], "walk_fil": 23, "normal": 24, "filesystem": 24, "pars": 24, "invalid": 24, "tqdm_": 25, "enhanc": 25, "silenc": 25, "modifi": 25, "behavior": 25, "allow": 25, "posit": 25, "std": 25, "recurs": 26, "through": [26, 30], "yield": 26, "rel": 26, "root": 26, "start": [26, 27], "modul": 27, "quick": 27, "run": 27, "environ": 27, "register_archive_typ": 27, "archive_pack": 27, "archive_unpack": 27, "get_archive_typ": 27, "get_archive_extnam": 27, "config": [27, 30], "index": [27, 30], "oper": 27, "here": [28, 29], "o": [28, 29], "platform": [28, 29], "shutil": [28, 29], "cpuinfo": [28, 29], "psutil": [28, 29], "hbutil": [28, 29], "scale": [28, 29], "size_to_bytes_str": [28, 29], "python": [28, 29, 30], "python_implement": [28, 29], "python_vers": [28, 29], "cpu": [28, 29], "brand": [28, 29], "get_cpu_info": [28, 29], "brand_raw": [28, 29], "count": [28, 29], "cpu_count": [28, 29], "freq": [28, 29], "cpu_freq": [28, 29], "mhz": [28, 29], "memori": [28, 29], "virtual_memori": [28, 29], "total": [28, 29], "precis": [28, 29], "cuda": [28, 29], "ye": [28, 29], "nvidia": [28, 29], "smi": [28, 29], "els": [28, 29], "No": [28, 29], "linux": [28, 29], "0": [28, 29, 30], "azur": [28, 29], "x86_64": [28, 29], "glibc2": [28, 29], "34": [28, 29], "cpython": [28, 29], "18": [28, 29], "amd": [28, 29], "epyc": [28, 29], "7763": [28, 29], "64": [28, 29], "core": [28, 29], "processor": [28, 29], "3242": 28, "3715": 28, "15": [28, 29], "606": [28, 29], "gib": [28, 29], "pleas": [28, 29], "note": [28, 29], "deploi": [28, 29], "document": [28, 29, 30], "automat": [28, 29], "execut": [28, 29], "github": [28, 29, 30], "action": [28, 29], "therefor": [28, 29], "some": [28, 29], "mai": [28, 29], "your": [28, 29, 30], "2907": 29, "6952499999998": 29, "hfutil": 30, "host": 30, "pypi": 30, "newest": 30, "u": 30, "git": 30, "com": 30, "script": 30, "__name__": 30, "__main__": 30, "develop": 30, "maintain": 30, "like": 30, "below": 30, "success": 30, "narugo1992": 30, "still": 30, "under": 30, "out": 30, "stabl": 30, "html": 30, "faq": 31}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [1, 0, 0, "-", "config"], [7, 0, 0, "-", "entry"], [13, 0, 0, "-", "index"], [18, 0, 0, "-", "operate"], [23, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.config": [[2, 0, 0, "-", "meta"]], "hfutils.config.meta": [[2, 2, 1, "", "__AUTHOR_EMAIL__"], [2, 2, 1, "", "__AUTHOR__"], [2, 2, 1, "", "__DESCRIPTION__"], [2, 2, 1, "", "__TITLE__"], [2, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[3, 0, 0, "-", "base"], [4, 0, 0, "-", "cli"], [5, 0, 0, "-", "dispatch"], [6, 0, 0, "-", "download"], [8, 0, 0, "-", "ls"], [9, 0, 0, "-", "ls_repo"], [10, 0, 0, "-", "upload"], [11, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[3, 2, 1, "", "CONTEXT_SETTINGS"], [3, 3, 1, "", "ClickErrorException"], [3, 3, 1, "", "ClickWarningException"], [3, 3, 1, "", "KeyboardInterrupted"], [3, 1, 1, "", "command_wrap"], [3, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[3, 5, 1, "", "__init__"], [3, 4, 1, "", "exit_code"], [3, 5, 1, "", "show"]], "hfutils.entry.cli": [[4, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[5, 1, 1, "", "hfutilcli"], [5, 1, 1, "", "print_version"]], "hfutils.entry.download": [[6, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[6, 4, 1, "", "exit_code"], [6, 5, 1, "", "show"]], "hfutils.entry.ls": [[8, 3, 1, "", "ListItem"], [8, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[8, 4, 1, "", "ARCHIVE"], [8, 4, 1, "", "DATA"], [8, 4, 1, "", "FILE"], [8, 4, 1, "", "FOLDER"], [8, 4, 1, "", "IMAGE"], [8, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[9, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[10, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[10, 4, 1, "", "exit_code"], [10, 5, 1, "", "show"]], "hfutils.index": [[12, 0, 0, "-", "fetch"], [14, 0, 0, "-", "make"], [15, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[12, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [12, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [12, 1, 1, "", "hf_tar_file_download"], [12, 1, 1, "", "hf_tar_file_exists"], [12, 1, 1, "", "hf_tar_file_info"], [12, 1, 1, "", "hf_tar_file_size"], [12, 1, 1, "", "hf_tar_get_index"], [12, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[14, 1, 1, "", "hf_tar_create_from_directory"], [14, 1, 1, "", "hf_tar_create_index"], [14, 1, 1, "", "tar_create_index"], [14, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[15, 1, 1, "", "hf_tar_item_validate"], [15, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[16, 0, 0, "-", "base"], [17, 0, 0, "-", "download"], [19, 0, 0, "-", "upload"], [20, 0, 0, "-", "validate"]], "hfutils.operate.base": [[16, 1, 1, "", "get_hf_client"], [16, 1, 1, "", "get_hf_fs"], [16, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[17, 1, 1, "", "download_archive_as_directory"], [17, 1, 1, "", "download_directory_as_directory"], [17, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[19, 1, 1, "", "upload_directory_as_archive"], [19, 1, 1, "", "upload_directory_as_directory"], [19, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[20, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[21, 0, 0, "-", "binary"], [22, 0, 0, "-", "download"], [24, 0, 0, "-", "path"], [25, 0, 0, "-", "tqdm_"], [26, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[21, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[22, 1, 1, "", "download_file"]], "hfutils.utils.path": [[24, 3, 1, "", "HfFileSystemPath"], [24, 1, 1, "", "hf_fs_path"], [24, 1, 1, "", "hf_normpath"], [24, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[25, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[26, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "config": [1, 2], "meta": 2, "__title__": 2, "__version__": 2, "__description__": 2, "__author__": 2, "__author_email__": 2, "entri": [3, 4, 5, 6, 7, 8, 9, 10, 11], "base": [3, 16], "context_set": 3, "clickwarningexcept": 3, "clickerrorexcept": 3, "print_except": 3, "keyboardinterrupt": 3, "command_wrap": 3, "cli": 4, "dispatch": 5, "print_vers": 5, "hfutilcli": 5, "download": [6, 17, 22], "noremotepathassignedwithdownload": 6, "l": 8, "listitemtyp": 8, "listitem": 8, "ls_repo": 9, "nolocalauthent": 9, "upload": [10, 19], "noremotepathassignedwithupload": 10, "whoami": 11, "index": [12, 13, 14, 15], "fetch": 12, "archivestandalonefileincompletedownload": 12, "archivestandalonefilehashnotmatch": 12, "hf_tar_get_index": 12, "hf_tar_list_fil": 12, "hf_tar_file_exist": 12, "hf_tar_file_s": 12, "hf_tar_file_info": 12, "hf_tar_file_download": 12, "make": 14, "tar_create_index": 14, "hf_tar_create_index": 14, "tar_get_index_info": 14, "hf_tar_create_from_directori": 14, "valid": [15, 20], "hf_tar_item_valid": 15, "hf_tar_valid": 15, "oper": [16, 17, 18, 19, 20], "get_hf_client": 16, "get_hf_f": 16, "list_files_in_repositori": 16, "download_file_to_fil": 17, "download_archive_as_directori": 17, "download_directory_as_directori": 17, "upload_file_to_fil": 19, "upload_directory_as_arch": 19, "upload_directory_as_directori": 19, "is_local_file_readi": 20, "util": [21, 22, 23, 24, 25, 26], "binari": 21, "is_binary_fil": 21, "download_fil": 22, "path": 24, "hf_normpath": 24, "hf_fs_path": 24, "parse_hf_fs_path": 24, "hffilesystempath": 24, "tqdm": 25, "walk": 26, "walk_fil": 26, "welcom": 27, "": 27, "document": 27, "overview": 27, "tutori": 27, "inform": [27, 28, 29], "api": 27, "run": [28, 29], "environ": [28, 29], "instal": 30, "quick": 31, "start": 31}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.config": [[1, "module-hfutils.config"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "__TITLE__": [[2, "title"]], "__VERSION__": [[2, "version"]], "__DESCRIPTION__": [[2, "description"]], "__AUTHOR__": [[2, "author"]], "__AUTHOR_EMAIL__": [[2, "author-email"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[3, "context-settings"]], "ClickWarningException": [[3, "clickwarningexception"]], "ClickErrorException": [[3, "clickerrorexception"]], "print_exception": [[3, "print-exception"]], "KeyboardInterrupted": [[3, "keyboardinterrupted"]], "command_wrap": [[3, "command-wrap"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "cli": [[4, "cli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version": [[5, "print-version"]], "hfutilcli": [[5, "hfutilcli"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[6, "noremotepathassignedwithdownload"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "ListItemType": [[8, "listitemtype"]], "ListItem": [[8, "listitem"]], "hfutils.entry.ls_repo": [[9, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[9, "nolocalauthentication"]], "hfutils.entry.upload": [[10, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[10, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[11, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[12, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[12, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[12, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[12, "hf-tar-get-index"]], "hf_tar_list_files": [[12, "hf-tar-list-files"]], "hf_tar_file_exists": [[12, "hf-tar-file-exists"]], "hf_tar_file_size": [[12, "hf-tar-file-size"]], "hf_tar_file_info": [[12, "hf-tar-file-info"]], "hf_tar_file_download": [[12, "hf-tar-file-download"]], "hfutils.index": [[13, "module-hfutils.index"]], "hfutils.index.make": [[14, "module-hfutils.index.make"]], "tar_create_index": [[14, "tar-create-index"]], "hf_tar_create_index": [[14, "hf-tar-create-index"]], "tar_get_index_info": [[14, "tar-get-index-info"]], "hf_tar_create_from_directory": [[14, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[15, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[15, "hf-tar-item-validate"]], "hf_tar_validate": [[15, "hf-tar-validate"]], "hfutils.operate.base": [[16, "module-hfutils.operate.base"]], "get_hf_client": [[16, "get-hf-client"]], "get_hf_fs": [[16, "get-hf-fs"]], "list_files_in_repository": [[16, "list-files-in-repository"]], "hfutils.operate.download": [[17, "module-hfutils.operate.download"]], "download_file_to_file": [[17, "download-file-to-file"]], "download_archive_as_directory": [[17, "download-archive-as-directory"]], "download_directory_as_directory": [[17, "download-directory-as-directory"]], "hfutils.operate": [[18, "module-hfutils.operate"]], "hfutils.operate.upload": [[19, "module-hfutils.operate.upload"]], "upload_file_to_file": [[19, "upload-file-to-file"]], "upload_directory_as_archive": [[19, "upload-directory-as-archive"]], "upload_directory_as_directory": [[19, "upload-directory-as-directory"]], "hfutils.operate.validate": [[20, "module-hfutils.operate.validate"]], "is_local_file_ready": [[20, "is-local-file-ready"]], "hfutils.utils.binary": [[21, "module-hfutils.utils.binary"]], "is_binary_file": [[21, "is-binary-file"]], "hfutils.utils.download": [[22, "module-hfutils.utils.download"]], "download_file": [[22, "download-file"]], "hfutils.utils": [[23, "module-hfutils.utils"]], "hfutils.utils.path": [[24, "module-hfutils.utils.path"]], "hf_normpath": [[24, "hf-normpath"]], "hf_fs_path": [[24, "hf-fs-path"]], "parse_hf_fs_path": [[24, "parse-hf-fs-path"]], "HfFileSystemPath": [[24, "hffilesystempath"]], "hfutils.utils.tqdm": [[25, "module-hfutils.utils.tqdm_"]], "tqdm": [[25, "tqdm"]], "hfutils.utils.walk": [[26, "module-hfutils.utils.walk"]], "walk_files": [[26, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[27, "welcome-to-hfutils-s-documentation"]], "Overview": [[27, "overview"]], "Tutorials": [[27, null]], "Information": [[27, null]], "API Documentation": [[27, null]], "Run Environment Information": [[28, "Run-Environment-Information"], [29, "Run-Environment-Information"]], "Installation": [[30, "installation"]], "Quick Start": [[31, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.config"], [2, "module-hfutils.config.meta"], [3, "module-hfutils.entry.base"], [4, "module-hfutils.entry.cli"], [5, "module-hfutils.entry.dispatch"], [6, "module-hfutils.entry.download"], [7, "module-hfutils.entry"], [8, "module-hfutils.entry.ls"], [9, "module-hfutils.entry.ls_repo"], [10, "module-hfutils.entry.upload"], [11, "module-hfutils.entry.whoami"], [12, "module-hfutils.index.fetch"], [13, "module-hfutils.index"], [14, "module-hfutils.index.make"], [15, "module-hfutils.index.validate"], [16, "module-hfutils.operate.base"], [17, "module-hfutils.operate.download"], [18, "module-hfutils.operate"], [19, "module-hfutils.operate.upload"], [20, "module-hfutils.operate.validate"], [21, "module-hfutils.utils.binary"], [22, "module-hfutils.utils.download"], [23, "module-hfutils.utils"], [24, "module-hfutils.utils.path"], [25, "module-hfutils.utils.tqdm_"], [26, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "hfutils.config": [[1, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[2, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[2, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[3, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[3, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[3, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[3, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[3, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[3, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[3, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[3, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[3, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[3, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[3, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[4, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[4, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[5, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[5, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[6, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[6, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[7, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[8, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[8, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[8, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[9, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[9, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[10, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[10, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[11, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[12, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[12, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[12, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[12, "module-hfutils.index.fetch"]], "hfutils.index": [[13, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[14, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[14, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[14, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[14, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[14, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[15, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[15, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[15, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[16, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[16, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[17, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[17, "module-hfutils.operate.download"]], "hfutils.operate": [[18, "module-hfutils.operate"]], "hfutils.operate.upload": [[19, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[19, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[20, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[20, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[21, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[21, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[22, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[22, "module-hfutils.utils.download"]], "hfutils.utils": [[23, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[24, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[24, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[24, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[25, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[25, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[26, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[26, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.2.9/.buildinfo b/v0.2.9/.buildinfo
index f820a2e85a..0ed4f74fbc 100644
--- a/v0.2.9/.buildinfo
+++ b/v0.2.9/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 84a26eb5ec29df26064edde8c3144e01
+config: 005dcd884b6b877ac3b5d0363d3f622b
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.2.9/.doctrees/api_doc/archive/index.doctree b/v0.2.9/.doctrees/api_doc/archive/index.doctree
index c0a9f6faba..4cbe63ca63 100644
Binary files a/v0.2.9/.doctrees/api_doc/archive/index.doctree and b/v0.2.9/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/cache/delete.doctree b/v0.2.9/.doctrees/api_doc/cache/delete.doctree
index 997a0e7459..0d3801bd4d 100644
Binary files a/v0.2.9/.doctrees/api_doc/cache/delete.doctree and b/v0.2.9/.doctrees/api_doc/cache/delete.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/cache/index.doctree b/v0.2.9/.doctrees/api_doc/cache/index.doctree
index 71a2eafab9..feb83b75e8 100644
Binary files a/v0.2.9/.doctrees/api_doc/cache/index.doctree and b/v0.2.9/.doctrees/api_doc/cache/index.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/config/index.doctree b/v0.2.9/.doctrees/api_doc/config/index.doctree
index 3ad9b23084..45c674c96c 100644
Binary files a/v0.2.9/.doctrees/api_doc/config/index.doctree and b/v0.2.9/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/config/meta.doctree b/v0.2.9/.doctrees/api_doc/config/meta.doctree
index 195e92e6fd..07a1e73190 100644
Binary files a/v0.2.9/.doctrees/api_doc/config/meta.doctree and b/v0.2.9/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/entry/base.doctree b/v0.2.9/.doctrees/api_doc/entry/base.doctree
index a2d4dfb1d7..617a2080a7 100644
Binary files a/v0.2.9/.doctrees/api_doc/entry/base.doctree and b/v0.2.9/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/entry/cli.doctree b/v0.2.9/.doctrees/api_doc/entry/cli.doctree
index 754a5607cb..415f58a3c5 100644
Binary files a/v0.2.9/.doctrees/api_doc/entry/cli.doctree and b/v0.2.9/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/entry/dispatch.doctree b/v0.2.9/.doctrees/api_doc/entry/dispatch.doctree
index e86b46a695..f8df9e70ad 100644
Binary files a/v0.2.9/.doctrees/api_doc/entry/dispatch.doctree and b/v0.2.9/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/entry/download.doctree b/v0.2.9/.doctrees/api_doc/entry/download.doctree
index 9ef787477f..5c130023b3 100644
Binary files a/v0.2.9/.doctrees/api_doc/entry/download.doctree and b/v0.2.9/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/entry/index.doctree b/v0.2.9/.doctrees/api_doc/entry/index.doctree
index d1c76e94d7..f24c2b80c5 100644
Binary files a/v0.2.9/.doctrees/api_doc/entry/index.doctree and b/v0.2.9/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/entry/ls.doctree b/v0.2.9/.doctrees/api_doc/entry/ls.doctree
index d90b3d8364..735a295970 100644
Binary files a/v0.2.9/.doctrees/api_doc/entry/ls.doctree and b/v0.2.9/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/entry/ls_repo.doctree b/v0.2.9/.doctrees/api_doc/entry/ls_repo.doctree
index 1ab0010c44..654e260f01 100644
Binary files a/v0.2.9/.doctrees/api_doc/entry/ls_repo.doctree and b/v0.2.9/.doctrees/api_doc/entry/ls_repo.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/entry/upload.doctree b/v0.2.9/.doctrees/api_doc/entry/upload.doctree
index 26fdfaf412..d3e1e9429c 100644
Binary files a/v0.2.9/.doctrees/api_doc/entry/upload.doctree and b/v0.2.9/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/entry/whoami.doctree b/v0.2.9/.doctrees/api_doc/entry/whoami.doctree
index 36fa4e4259..b3df5394b6 100644
Binary files a/v0.2.9/.doctrees/api_doc/entry/whoami.doctree and b/v0.2.9/.doctrees/api_doc/entry/whoami.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/index/fetch.doctree b/v0.2.9/.doctrees/api_doc/index/fetch.doctree
index 05defacbb8..3e6e3be51d 100644
Binary files a/v0.2.9/.doctrees/api_doc/index/fetch.doctree and b/v0.2.9/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/index/index.doctree b/v0.2.9/.doctrees/api_doc/index/index.doctree
index ba9a4bf143..fc8271064d 100644
Binary files a/v0.2.9/.doctrees/api_doc/index/index.doctree and b/v0.2.9/.doctrees/api_doc/index/index.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/index/make.doctree b/v0.2.9/.doctrees/api_doc/index/make.doctree
index 26f13abd62..bfca6c4367 100644
Binary files a/v0.2.9/.doctrees/api_doc/index/make.doctree and b/v0.2.9/.doctrees/api_doc/index/make.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/index/validate.doctree b/v0.2.9/.doctrees/api_doc/index/validate.doctree
index 26fe52dbde..8c4c500e4a 100644
Binary files a/v0.2.9/.doctrees/api_doc/index/validate.doctree and b/v0.2.9/.doctrees/api_doc/index/validate.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/operate/base.doctree b/v0.2.9/.doctrees/api_doc/operate/base.doctree
index 16134ea19d..b1b7256a55 100644
Binary files a/v0.2.9/.doctrees/api_doc/operate/base.doctree and b/v0.2.9/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/operate/download.doctree b/v0.2.9/.doctrees/api_doc/operate/download.doctree
index 10279c4fc3..8ab467a773 100644
Binary files a/v0.2.9/.doctrees/api_doc/operate/download.doctree and b/v0.2.9/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/operate/index.doctree b/v0.2.9/.doctrees/api_doc/operate/index.doctree
index 079de7b93f..362af7e323 100644
Binary files a/v0.2.9/.doctrees/api_doc/operate/index.doctree and b/v0.2.9/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/operate/upload.doctree b/v0.2.9/.doctrees/api_doc/operate/upload.doctree
index f023f4048a..fdd9dc4ddb 100644
Binary files a/v0.2.9/.doctrees/api_doc/operate/upload.doctree and b/v0.2.9/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/operate/validate.doctree b/v0.2.9/.doctrees/api_doc/operate/validate.doctree
index 352e9126b0..86d4655ccd 100644
Binary files a/v0.2.9/.doctrees/api_doc/operate/validate.doctree and b/v0.2.9/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/utils/binary.doctree b/v0.2.9/.doctrees/api_doc/utils/binary.doctree
index 39d16ee049..01f030973e 100644
Binary files a/v0.2.9/.doctrees/api_doc/utils/binary.doctree and b/v0.2.9/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/utils/download.doctree b/v0.2.9/.doctrees/api_doc/utils/download.doctree
index ed652b2fc7..34d6388a9b 100644
Binary files a/v0.2.9/.doctrees/api_doc/utils/download.doctree and b/v0.2.9/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/utils/index.doctree b/v0.2.9/.doctrees/api_doc/utils/index.doctree
index e7d3710141..1cc8d8bab5 100644
Binary files a/v0.2.9/.doctrees/api_doc/utils/index.doctree and b/v0.2.9/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/utils/path.doctree b/v0.2.9/.doctrees/api_doc/utils/path.doctree
index a64bfc68b8..6de3ba7bcf 100644
Binary files a/v0.2.9/.doctrees/api_doc/utils/path.doctree and b/v0.2.9/.doctrees/api_doc/utils/path.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/utils/tqdm_.doctree b/v0.2.9/.doctrees/api_doc/utils/tqdm_.doctree
index 531f5b3d61..ed7780b0d0 100644
Binary files a/v0.2.9/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.2.9/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.2.9/.doctrees/api_doc/utils/walk.doctree b/v0.2.9/.doctrees/api_doc/utils/walk.doctree
index 95a92ffff2..8a602f36b7 100644
Binary files a/v0.2.9/.doctrees/api_doc/utils/walk.doctree and b/v0.2.9/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.2.9/.doctrees/environment.pickle b/v0.2.9/.doctrees/environment.pickle
index 8356bd9389..dc572d5081 100644
Binary files a/v0.2.9/.doctrees/environment.pickle and b/v0.2.9/.doctrees/environment.pickle differ
diff --git a/v0.2.9/.doctrees/index.doctree b/v0.2.9/.doctrees/index.doctree
index 6824df1c4b..20a96561bb 100644
Binary files a/v0.2.9/.doctrees/index.doctree and b/v0.2.9/.doctrees/index.doctree differ
diff --git a/v0.2.9/.doctrees/information/environment.doctree b/v0.2.9/.doctrees/information/environment.doctree
index e852e1b8f7..9d583faeb3 100644
Binary files a/v0.2.9/.doctrees/information/environment.doctree and b/v0.2.9/.doctrees/information/environment.doctree differ
diff --git a/v0.2.9/.doctrees/information/environment.result.doctree b/v0.2.9/.doctrees/information/environment.result.doctree
index 4b62ee4711..b093520ff4 100644
Binary files a/v0.2.9/.doctrees/information/environment.result.doctree and b/v0.2.9/.doctrees/information/environment.result.doctree differ
diff --git a/v0.2.9/.doctrees/nbsphinx/information/environment.ipynb b/v0.2.9/.doctrees/nbsphinx/information/environment.ipynb
index cb8299ac27..35e1d84641 100644
--- a/v0.2.9/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.2.9/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:10:11.531429Z",
-     "iopub.status.busy": "2024-07-23T18:10:11.530943Z",
-     "iopub.status.idle": "2024-07-23T18:10:12.700772Z",
-     "shell.execute_reply": "2024-07-23T18:10:12.700002Z"
+     "iopub.execute_input": "2024-07-23T18:17:03.855954Z",
+     "iopub.status.busy": "2024-07-23T18:17:03.855746Z",
+     "iopub.status.idle": "2024-07-23T18:17:05.028470Z",
+     "shell.execute_reply": "2024-07-23T18:17:05.027695Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2708.8945 MHz\n",
+      "CPU Freq: 2913.7765000000004 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.9/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.2.9/.doctrees/nbsphinx/information/environment.result.ipynb
index eb1ed6d427..51c8b744a3 100644
--- a/v0.2.9/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.2.9/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:17:41.391509Z",
-     "iopub.status.busy": "2024-07-23T17:17:41.391301Z",
-     "iopub.status.idle": "2024-07-23T17:17:42.568351Z",
-     "shell.execute_reply": "2024-07-23T17:17:42.567562Z"
+     "iopub.execute_input": "2024-07-23T17:23:42.080589Z",
+     "iopub.status.busy": "2024-07-23T17:23:42.080177Z",
+     "iopub.status.idle": "2024-07-23T17:23:43.255492Z",
+     "shell.execute_reply": "2024-07-23T17:23:43.254725Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2736.849 MHz\n",
+      "CPU Freq: 2732.23175 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.9/.doctrees/tutorials/installation/index.doctree b/v0.2.9/.doctrees/tutorials/installation/index.doctree
index 6635a4a484..4648d53689 100644
Binary files a/v0.2.9/.doctrees/tutorials/installation/index.doctree and b/v0.2.9/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.2.9/.doctrees/tutorials/quick_start/index.doctree b/v0.2.9/.doctrees/tutorials/quick_start/index.doctree
index 1ef6c0db1f..f3d600d94b 100644
Binary files a/v0.2.9/.doctrees/tutorials/quick_start/index.doctree and b/v0.2.9/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.2.9/_sources/information/environment.result.ipynb.txt b/v0.2.9/_sources/information/environment.result.ipynb.txt
index eb1ed6d427..51c8b744a3 100644
--- a/v0.2.9/_sources/information/environment.result.ipynb.txt
+++ b/v0.2.9/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:17:41.391509Z",
-     "iopub.status.busy": "2024-07-23T17:17:41.391301Z",
-     "iopub.status.idle": "2024-07-23T17:17:42.568351Z",
-     "shell.execute_reply": "2024-07-23T17:17:42.567562Z"
+     "iopub.execute_input": "2024-07-23T17:23:42.080589Z",
+     "iopub.status.busy": "2024-07-23T17:23:42.080177Z",
+     "iopub.status.idle": "2024-07-23T17:23:43.255492Z",
+     "shell.execute_reply": "2024-07-23T17:23:43.254725Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2736.849 MHz\n",
+      "CPU Freq: 2732.23175 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.9/information/environment.html b/v0.2.9/information/environment.html
index 63e1daa6ad..52d9b3991f 100644
--- a/v0.2.9/information/environment.html
+++ b/v0.2.9/information/environment.html
@@ -127,11 +127,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2708.8945 MHz
+CPU Freq: 2913.7765000000004 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.9/information/environment.ipynb b/v0.2.9/information/environment.ipynb
index cb8299ac27..35e1d84641 100644
--- a/v0.2.9/information/environment.ipynb
+++ b/v0.2.9/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:10:11.531429Z",
-     "iopub.status.busy": "2024-07-23T18:10:11.530943Z",
-     "iopub.status.idle": "2024-07-23T18:10:12.700772Z",
-     "shell.execute_reply": "2024-07-23T18:10:12.700002Z"
+     "iopub.execute_input": "2024-07-23T18:17:03.855954Z",
+     "iopub.status.busy": "2024-07-23T18:17:03.855746Z",
+     "iopub.status.idle": "2024-07-23T18:17:05.028470Z",
+     "shell.execute_reply": "2024-07-23T18:17:05.027695Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2708.8945 MHz\n",
+      "CPU Freq: 2913.7765000000004 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.9/information/environment.result.html b/v0.2.9/information/environment.result.html
index 34e235571e..f7553b4073 100644
--- a/v0.2.9/information/environment.result.html
+++ b/v0.2.9/information/environment.result.html
@@ -129,11 +129,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2736.849 MHz
+CPU Freq: 2732.23175 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.2.9/information/environment.result.ipynb b/v0.2.9/information/environment.result.ipynb
index eb1ed6d427..51c8b744a3 100644
--- a/v0.2.9/information/environment.result.ipynb
+++ b/v0.2.9/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:17:41.391509Z",
-     "iopub.status.busy": "2024-07-23T17:17:41.391301Z",
-     "iopub.status.idle": "2024-07-23T17:17:42.568351Z",
-     "shell.execute_reply": "2024-07-23T17:17:42.567562Z"
+     "iopub.execute_input": "2024-07-23T17:23:42.080589Z",
+     "iopub.status.busy": "2024-07-23T17:23:42.080177Z",
+     "iopub.status.idle": "2024-07-23T17:23:43.255492Z",
+     "shell.execute_reply": "2024-07-23T17:23:43.254725Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2736.849 MHz\n",
+      "CPU Freq: 2732.23175 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.2.9/searchindex.js b/v0.2.9/searchindex.js
index fd7169c5a4..5b194588f1 100644
--- a/v0.2.9/searchindex.js
+++ b/v0.2.9/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/cache/delete", "api_doc/cache/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/cache/delete.rst", "api_doc/cache/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.cache.delete", "hfutils.cache", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2, 4], "pack": 0, "unpack": 0, "manag": [0, 2], "support": 0, "format": 0, "extens": 0, "name": [0, 5], "7z": 0, "bztar": 0, "tar": [0, 14, 16, 17], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 1, 5, 17, 19, 21, 24, 26, 27], "you": [0, 14, 32], "requir": [0, 32], "simpli": [0, 32], "instal": [0, 29], "us": [0, 1, 5, 14, 16, 17, 18, 19, 21, 24, 29, 32], "follow": [0, 10, 32], "code": [0, 5, 8, 12], "pip": [0, 32], "The": [0, 1, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28, 32], "creation": 0, "file": [0, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 28], "i": [0, 1, 8, 11, 12, 14, 16, 17, 19, 22, 23, 26, 29, 30, 31, 32], "we": 0, "util": [0, 29, 32], "rarfil": 0, "librari": [0, 24], "which": [0, 14, 30, 31, 32], "doe": [0, 14], "offer": 0, "function": [0, 5, 14, 16, 17, 23, 24, 27], "creat": [0, 16], "str": [0, 1, 5, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28], "ext": 0, "list": [0, 5, 10, 14, 18, 19, 21], "fn_pack": 0, "callabl": [0, 5], "fn_unpack": 0, "sourc": [0, 1, 5, 7, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "regist": 0, "custom": [0, 5, 8, 12], "type": [0, 1, 5, 10, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "associ": 0, "paramet": [0, 1, 5, 7, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "A": [0, 18], "take": 0, "directori": [0, 1, 10, 16, 17, 19, 21, 28], "an": [0, 14, 16, 17, 19, 21, 24, 27, 28], "filenam": [0, 24, 26], "input": 0, "extract": [0, 19], "type_nam": 0, "archive_fil": 0, "silent": [0, 16, 19, 21, 24, 27], "bool": [0, 7, 14, 16, 17, 19, 21, 22, 23, 24, 27], "fals": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "clear": [0, 21], "specifi": [0, 1, 17, 21, 24], "result": 0, "true": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "suppress": [0, 16, 19, 21, 24], "warn": [0, 5], "dure": 0, "process": 0, "remov": [0, 21], "exist": [0, 14, 19], "when": [0, 11, 14, 16, 19], "return": [0, 5, 14, 16, 17, 18, 22, 23, 24, 26, 27, 28], "path": [0, 8, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 25, 28, 29], "password": [0, 19], "none": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26], "content": [0, 27], "option": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26, 27], "determin": 0, "base": [0, 9, 10, 17, 20, 29], "rais": [0, 11, 14, 17, 26], "valueerror": [0, 26], "ani": [0, 1, 7, 23, 26], "get": [0, 14, 16, 18, 24, 26], "repo_id": [1, 14, 16, 17, 18, 19, 21, 22, 26], "repo_typ": [1, 14, 16, 17, 18, 19, 21, 22, 26], "cache_dir": 1, "all": [1, 14, 19, 28], "detach": 1, "revis": [1, 14, 16, 17, 18, 19, 21, 22, 26], "from": [1, 5, 14, 16, 17, 18, 19, 24, 30, 31, 32], "match": [1, 14, 17, 22], "repositori": [1, 8, 12, 14, 16, 17, 18, 19, 21, 22, 26], "id": [1, 17, 26], "where": [1, 17, 24], "store": [1, 17], "default": [1, 16, 17, 19, 22, 26], "huggingfac": [2, 17, 18, 19, 21, 26, 29, 32], "local": [2, 11, 14, 16, 19, 21, 22, 24, 30, 31], "can": [2, 14, 17, 32], "quickli": 2, "make": [2, 15, 17, 29], "disk": 2, "space": [2, 14, 16, 17, 18, 19, 21, 22, 26], "under": [2, 32], "control": 2, "delet": [2, 29], "delete_detached_cach": 2, "delete_cach": 2, "meta": [3, 14, 29, 32], "__title__": [3, 32], "__version__": [3, 32], "__description__": [3, 32], "__author__": [3, 32], "__author_email__": 3, "inform": [4, 5, 7, 14, 16, 17], "packag": 4, "titl": 4, "thi": [4, 5, 8, 12, 14, 16, 17, 23, 24, 26, 27, 30, 31], "project": 4, "should": [4, 24, 32], "version": [4, 7, 27, 32], "short": 4, "descript": [4, 24], "includ": [4, 5, 14, 16], "setup": 4, "py": 4, "author": 4, "email": 4, "help_option_nam": 5, "h": 5, "help": 5, "dict": [5, 14, 16], "new": 5, "empti": 5, "dictionari": [5, 14], "map": 5, "initi": 5, "object": [5, 10, 14, 18, 19, 21, 24], "": [5, 7, 14], "kei": [5, 14], "valu": [5, 7, 10, 16], "pair": 5, "iter": [5, 28], "via": 5, "d": 5, "k": 5, "v": 5, "kwarg": [5, 7, 24, 27], "keyword": [5, 24, 27], "argument": [5, 14, 24, 27], "For": 5, "exampl": [5, 14], "one": 5, "1": [5, 10, 16, 17, 30, 31], "two": 5, "2": [5, 10, 32], "class": [5, 8, 10, 11, 12, 14, 26], "messag": [5, 8, 11, 12, 16, 21], "except": [5, 8, 11, 12, 14], "displai": [5, 8, 12, 24, 27], "yellow": 5, "color": 5, "error": [5, 8, 12], "exit_cod": [5, 8, 12], "exit": [5, 8, 12], "show": [5, 8, 12], "io": [5, 8, 12, 32], "write": [5, 8, 12], "output": [5, 8, 12, 19, 21, 24, 27, 32], "red": [5, 8, 12], "err": 5, "baseexcept": 5, "print": [5, 7, 30, 31, 32], "traceback": 5, "provid": [5, 24], "built": 5, "msg": 5, "handl": 5, "keyboard": 5, "interrupt": 5, "__init__": 5, "7": 5, "decor": 5, "wrap": 5, "click": [5, 7], "command": [5, 32], "catch": 5, "consist": 5, "group": 6, "hfutilcli": [6, 9], "ctx": 7, "context": 7, "param": 7, "cli": [7, 9, 29], "current": [7, 30, 31, 32], "metadata": 7, "arg": [7, 27], "indic": [8, 12], "remot": [8, 12], "assign": [8, 12, 14, 18, 19, 21], "17": 8, "context_set": 9, "clickwarningexcept": 9, "clickerrorexcept": 9, "print_except": 9, "keyboardinterrupt": 9, "command_wrap": 9, "dispatch": [9, 29], "print_vers": 9, "download": [9, 14, 17, 20, 25, 29], "noremotepathassignedwithdownload": 9, "l": [9, 29], "listitemtyp": 9, "listitem": 9, "ls_repo": [9, 29], "nolocalauthent": 9, "upload": [9, 16, 20, 29], "noremotepathassignedwithupload": 9, "whoami": [9, 29], "enum": 10, "repres": [10, 14], "differ": [10, 14, 30, 31], "item": [10, 17], "valid": [10, 15, 20, 29], "ar": [10, 14], "folder": 10, "imag": [10, 14], "3": [10, 30, 31, 32], "archiv": [10, 14, 16, 17, 19, 21, 29], "4": [10, 30, 31], "model": [10, 14, 16, 17, 18, 19, 21, 22, 26], "5": [10, 19, 30, 31], "data": [10, 14, 30, 31], "6": [10, 30, 31], "repofold": 10, "repofil": [10, 17], "base_dir": 10, "union": [10, 14], "authent": [11, 17], "token": [11, 14, 16, 17, 18, 19, 21, 22], "33": 12, "standalon": 14, "incomplet": 14, "hash": [14, 16, 17, 18, 19, 21], "archive_in_repo": [14, 16, 17, 21], "liter": [14, 16, 17, 18, 19, 21, 22, 26], "dataset": [14, 16, 17, 18, 19, 21, 22, 26], "main": [14, 16, 17, 18, 19, 21, 22, 32], "idx_repo_id": [14, 16, 17], "idx_file_in_repo": [14, 16, 17], "idx_repo_typ": [14, 16, 17], "idx_revis": [14, 16, 17], "hf_token": [14, 16, 17, 18, 19, 21, 22], "hug": [14, 16, 17, 18, 19, 21, 22], "face": [14, 16, 17, 18, 19, 21, 22], "identifi": [14, 16, 18, 19, 21, 22], "repotypetyp": [14, 16, 17, 18, 19, 21, 22, 26], "access": [14, 16], "import": [14, 30, 31, 32], "idx": 14, "deepgh": [14, 32], "danbooru_newest": 14, "0000": 14, "dict_kei": 14, "files": 14, "hash_lf": [14, 17], "7507000": 14, "jpg": 14, "7506000": 14, "7505000": 14, "besid": 14, "also": [14, 24, 32], "explicitli": 14, "nyanko7": 14, "danbooru2023": 14, "danbooru2023_index": 14, "origin": 14, "1000": 14, "png": 14, "10000": 14, "100000": 14, "insid": 14, "file_in_arch": 14, "check": [14, 17, 22, 23, 24, 32], "otherwis": [14, 17, 22, 24], "17506000": 14, "10000000001000": 14, "int": [14, 16, 17, 19, 24], "size": [14, 16, 17, 24, 30, 31], "integ": 14, "filenotfounderror": 14, "435671": 14, "11966": 14, "detail": 14, "offset": 14, "sha256": 14, "265728": 14, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 14, "1024": [14, 23], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 14, "local_fil": [14, 19, 21, 22], "proxi": 14, "user_ag": 14, "header": 14, "endpoint": 14, "save": [14, 16, 19, 24], "http": [14, 32], "request": [14, 24], "user": 14, "agent": 14, "addit": [14, 24, 27], "api": [14, 17, 18, 19, 21, 22], "test_exampl": 14, "destin": 14, "given": [14, 18, 23, 24, 26], "fetch": [15, 29], "archivestandalonefileincompletedownload": 15, "archivestandalonefilehashnotmatch": 15, "hf_tar_get_index": 15, "hf_tar_list_fil": 15, "hf_tar_file_exist": 15, "hf_tar_file_s": 15, "hf_tar_file_info": 15, "hf_tar_file_download": 15, "tar_create_index": 15, "hf_tar_create_index": [15, 17], "tar_get_index_info": 15, "hf_tar_create_from_directori": 15, "hf_tar_item_valid": 15, "hf_tar_valid": 15, "src_tar_fil": 16, "dst_index_fil": 16, "chunk_for_hash": 16, "1048576": 16, "with_hash": 16, "chunk": 16, "20": 16, "mb": 16, "whether": 16, "progress": [16, 19, 21, 24, 27], "bar": [16, 19, 21, 24, 27], "log": 16, "skip_when_sync": 16, "skip": 16, "sync": 16, "readi": [16, 22], "directli": 16, "json": [16, 17], "local_directori": [16, 19, 21], "file_item": 17, "hash_": 17, "expect": [17, 24], "sha": 17, "256": 17, "lf": 17, "entrynotfounderror": 17, "entri": [17, 29], "found": 17, "isadirectoryerror": 17, "mean": [17, 32], "expir": 17, "need": 17, "re": 17, "gener": 17, "so": 17, "togeth": 17, "gracefulli": 17, "refresh": 17, "hfapi": 18, "client": [18, 19, 21], "variabl": [18, 19, 21], "hffilesystem": 18, "system": 18, "subdir": 18, "ignore_pattern": [18, 19, 21], "subdirectori": 18, "e": [18, 19, 21], "g": [18, 19, 21], "branch": [18, 19, 21], "tag": [18, 19, 21], "commit": [18, 19, 21], "pattern": [18, 19, 21], "ignor": [18, 19, 21], "file_in_repo": [19, 21, 22], "resume_download": 19, "within": [19, 21], "resum": 19, "dir_in_repo": 19, "max_work": 19, "8": [19, 30, 31, 32], "max_retri": 19, "max": 19, "worker": 19, "retri": 19, "time": 19, "get_hf_client": 20, "get_hf_f": 20, "list_files_in_repositori": 20, "download_file_to_fil": 20, "download_archive_as_directori": 20, "download_directory_as_directori": 20, "upload_file_to_fil": 20, "upload_directory_as_arch": 20, "upload_directory_as_directori": 20, "is_local_file_readi": 20, "path_in_repo": 21, "time_suffix": 21, "its": 21, "append": 21, "timestamp": 21, "present": 21, "compar": 22, "hub": 22, "read": 23, "first": 23, "byte": [23, 24], "contain": 23, "non": 23, "text": 23, "charact": 23, "url": 24, "expected_s": 24, "desc": 24, "session": 24, "tqdm": [24, 25, 29], "It": [24, 32], "perform": [24, 30, 31], "ensur": 24, "ha": [24, 30, 31], "pass": [24, 27], "binari": [25, 29], "is_binary_fil": 25, "download_fil": 25, "hf_normpath": 25, "hf_fs_path": 25, "parse_hf_fs_path": 25, "hffilesystempath": 25, "walk": [25, 29], "walk_fil": 25, "normal": 26, "filesystem": 26, "pars": 26, "invalid": 26, "tqdm_": 27, "enhanc": 27, "silenc": 27, "modifi": 27, "behavior": 27, "allow": 27, "posit": 27, "std": 27, "recurs": 28, "through": [28, 32], "yield": 28, "rel": 28, "root": 28, "start": [28, 29], "modul": 29, "quick": 29, "run": 29, "environ": 29, "register_archive_typ": 29, "archive_pack": 29, "archive_unpack": 29, "get_archive_typ": 29, "get_archive_extnam": 29, "cach": 29, "config": [29, 32], "index": [29, 32], "oper": 29, "here": [30, 31], "o": [30, 31], "platform": [30, 31], "shutil": [30, 31], "cpuinfo": [30, 31], "psutil": [30, 31], "hbutil": [30, 31], "scale": [30, 31], "size_to_bytes_str": [30, 31], "python": [30, 31, 32], "python_implement": [30, 31], "python_vers": [30, 31], "cpu": [30, 31], "brand": [30, 31], "get_cpu_info": [30, 31], "brand_raw": [30, 31], "count": [30, 31], "cpu_count": [30, 31], "freq": [30, 31], "cpu_freq": [30, 31], "mhz": [30, 31], "memori": [30, 31], "virtual_memori": [30, 31], "total": [30, 31], "precis": [30, 31], "cuda": [30, 31], "ye": [30, 31], "nvidia": [30, 31], "smi": [30, 31], "els": [30, 31], "No": [30, 31], "linux": [30, 31], "0": [30, 31, 32], "1023": [30, 31], "azur": [30, 31], "x86_64": [30, 31], "glibc2": [30, 31], "34": [30, 31], "cpython": [30, 31], "18": [30, 31], "amd": [30, 31], "epyc": [30, 31], "7763": [30, 31], "64": [30, 31], "core": [30, 31], "processor": [30, 31], "2708": 30, "8945": 30, "15": [30, 31], "606": [30, 31], "gib": [30, 31], "pleas": [30, 31], "note": [30, 31], "deploi": [30, 31], "document": [30, 31, 32], "automat": [30, 31], "execut": [30, 31], "github": [30, 31, 32], "action": [30, 31], "therefor": [30, 31], "some": [30, 31], "mai": [30, 31], "your": [30, 31, 32], "2736": 31, "849": 31, "hfutil": 32, "host": 32, "pypi": 32, "newest": 32, "u": 32, "git": 32, "com": 32, "script": 32, "__name__": 32, "__main__": 32, "develop": 32, "maintain": 32, "like": 32, "below": 32, "success": 32, "9": 32, "narugo1992": 32, "still": 32, "out": 32, "stabl": 32, "html": 32, "faq": 33}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [2, 0, 0, "-", "cache"], [3, 0, 0, "-", "config"], [9, 0, 0, "-", "entry"], [15, 0, 0, "-", "index"], [20, 0, 0, "-", "operate"], [25, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.cache": [[1, 0, 0, "-", "delete"]], "hfutils.cache.delete": [[1, 1, 1, "", "delete_cache"], [1, 1, 1, "", "delete_detached_cache"]], "hfutils.config": [[4, 0, 0, "-", "meta"]], "hfutils.config.meta": [[4, 2, 1, "", "__AUTHOR_EMAIL__"], [4, 2, 1, "", "__AUTHOR__"], [4, 2, 1, "", "__DESCRIPTION__"], [4, 2, 1, "", "__TITLE__"], [4, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[5, 0, 0, "-", "base"], [6, 0, 0, "-", "cli"], [7, 0, 0, "-", "dispatch"], [8, 0, 0, "-", "download"], [10, 0, 0, "-", "ls"], [11, 0, 0, "-", "ls_repo"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[5, 2, 1, "", "CONTEXT_SETTINGS"], [5, 3, 1, "", "ClickErrorException"], [5, 3, 1, "", "ClickWarningException"], [5, 3, 1, "", "KeyboardInterrupted"], [5, 1, 1, "", "command_wrap"], [5, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[5, 5, 1, "", "__init__"], [5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.cli": [[6, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[7, 1, 1, "", "hfutilcli"], [7, 1, 1, "", "print_version"]], "hfutils.entry.download": [[8, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.entry.ls": [[10, 3, 1, "", "ListItem"], [10, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[10, 4, 1, "", "ARCHIVE"], [10, 4, 1, "", "DATA"], [10, 4, 1, "", "FILE"], [10, 4, 1, "", "FOLDER"], [10, 4, 1, "", "IMAGE"], [10, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[11, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[12, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[12, 4, 1, "", "exit_code"], [12, 5, 1, "", "show"]], "hfutils.index": [[14, 0, 0, "-", "fetch"], [16, 0, 0, "-", "make"], [17, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[14, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [14, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [14, 1, 1, "", "hf_tar_file_download"], [14, 1, 1, "", "hf_tar_file_exists"], [14, 1, 1, "", "hf_tar_file_info"], [14, 1, 1, "", "hf_tar_file_size"], [14, 1, 1, "", "hf_tar_get_index"], [14, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[16, 1, 1, "", "hf_tar_create_from_directory"], [16, 1, 1, "", "hf_tar_create_index"], [16, 1, 1, "", "tar_create_index"], [16, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[17, 1, 1, "", "hf_tar_item_validate"], [17, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[18, 0, 0, "-", "base"], [19, 0, 0, "-", "download"], [21, 0, 0, "-", "upload"], [22, 0, 0, "-", "validate"]], "hfutils.operate.base": [[18, 1, 1, "", "get_hf_client"], [18, 1, 1, "", "get_hf_fs"], [18, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[19, 1, 1, "", "download_archive_as_directory"], [19, 1, 1, "", "download_directory_as_directory"], [19, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[21, 1, 1, "", "upload_directory_as_archive"], [21, 1, 1, "", "upload_directory_as_directory"], [21, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[22, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[23, 0, 0, "-", "binary"], [24, 0, 0, "-", "download"], [26, 0, 0, "-", "path"], [27, 0, 0, "-", "tqdm_"], [28, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[23, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[24, 1, 1, "", "download_file"]], "hfutils.utils.path": [[26, 3, 1, "", "HfFileSystemPath"], [26, 1, 1, "", "hf_fs_path"], [26, 1, 1, "", "hf_normpath"], [26, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[28, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "cach": [1, 2], "delet": 1, "delete_detached_cach": 1, "delete_cach": 1, "config": [3, 4], "meta": 4, "__title__": 4, "__version__": 4, "__description__": 4, "__author__": 4, "__author_email__": 4, "entri": [5, 6, 7, 8, 9, 10, 11, 12, 13], "base": [5, 18], "context_set": 5, "clickwarningexcept": 5, "clickerrorexcept": 5, "print_except": 5, "keyboardinterrupt": 5, "command_wrap": 5, "cli": 6, "dispatch": 7, "print_vers": 7, "hfutilcli": 7, "download": [8, 19, 24], "noremotepathassignedwithdownload": 8, "l": 10, "listitemtyp": 10, "listitem": 10, "ls_repo": 11, "nolocalauthent": 11, "upload": [12, 21], "noremotepathassignedwithupload": 12, "whoami": 13, "index": [14, 15, 16, 17], "fetch": 14, "archivestandalonefileincompletedownload": 14, "archivestandalonefilehashnotmatch": 14, "hf_tar_get_index": 14, "hf_tar_list_fil": 14, "hf_tar_file_exist": 14, "hf_tar_file_s": 14, "hf_tar_file_info": 14, "hf_tar_file_download": 14, "make": 16, "tar_create_index": 16, "hf_tar_create_index": 16, "tar_get_index_info": 16, "hf_tar_create_from_directori": 16, "valid": [17, 22], "hf_tar_item_valid": 17, "hf_tar_valid": 17, "oper": [18, 19, 20, 21, 22], "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 19, "download_archive_as_directori": 19, "download_directory_as_directori": 19, "upload_file_to_fil": 21, "upload_directory_as_arch": 21, "upload_directory_as_directori": 21, "is_local_file_readi": 22, "util": [23, 24, 25, 26, 27, 28], "binari": 23, "is_binary_fil": 23, "download_fil": 24, "path": 26, "hf_normpath": 26, "hf_fs_path": 26, "parse_hf_fs_path": 26, "hffilesystempath": 26, "tqdm": 27, "walk": 28, "walk_fil": 28, "welcom": 29, "": 29, "document": 29, "overview": 29, "tutori": 29, "inform": [29, 30, 31], "api": 29, "run": [30, 31], "environ": [30, 31], "instal": 32, "quick": 33, "start": 33}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "delete_detached_cache": [[1, "delete-detached-cache"]], "delete_cache": [[1, "delete-cache"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "__TITLE__": [[4, "title"]], "__VERSION__": [[4, "version"]], "__DESCRIPTION__": [[4, "description"]], "__AUTHOR__": [[4, "author"]], "__AUTHOR_EMAIL__": [[4, "author-email"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[5, "context-settings"]], "ClickWarningException": [[5, "clickwarningexception"]], "ClickErrorException": [[5, "clickerrorexception"]], "print_exception": [[5, "print-exception"]], "KeyboardInterrupted": [[5, "keyboardinterrupted"]], "command_wrap": [[5, "command-wrap"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "cli": [[6, "cli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version": [[7, "print-version"]], "hfutilcli": [[7, "hfutilcli"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[8, "noremotepathassignedwithdownload"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "ListItemType": [[10, "listitemtype"]], "ListItem": [[10, "listitem"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[11, "nolocalauthentication"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[12, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[14, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[14, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[14, "hf-tar-get-index"]], "hf_tar_list_files": [[14, "hf-tar-list-files"]], "hf_tar_file_exists": [[14, "hf-tar-file-exists"]], "hf_tar_file_size": [[14, "hf-tar-file-size"]], "hf_tar_file_info": [[14, "hf-tar-file-info"]], "hf_tar_file_download": [[14, "hf-tar-file-download"]], "hfutils.index": [[15, "module-hfutils.index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index": [[16, "tar-create-index"]], "hf_tar_create_index": [[16, "hf-tar-create-index"]], "tar_get_index_info": [[16, "tar-get-index-info"]], "hf_tar_create_from_directory": [[16, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[17, "hf-tar-item-validate"]], "hf_tar_validate": [[17, "hf-tar-validate"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "get_hf_client": [[18, "get-hf-client"]], "get_hf_fs": [[18, "get-hf-fs"]], "list_files_in_repository": [[18, "list-files-in-repository"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "download_file_to_file": [[19, "download-file-to-file"]], "download_archive_as_directory": [[19, "download-archive-as-directory"]], "download_directory_as_directory": [[19, "download-directory-as-directory"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_file_to_file": [[21, "upload-file-to-file"]], "upload_directory_as_archive": [[21, "upload-directory-as-archive"]], "upload_directory_as_directory": [[21, "upload-directory-as-directory"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready": [[22, "is-local-file-ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file": [[23, "is-binary-file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "download_file": [[24, "download-file"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "hf_normpath": [[26, "hf-normpath"]], "hf_fs_path": [[26, "hf-fs-path"]], "parse_hf_fs_path": [[26, "parse-hf-fs-path"]], "HfFileSystemPath": [[26, "hffilesystempath"]], "hfutils.utils.tqdm": [[27, "module-hfutils.utils.tqdm_"]], "tqdm": [[27, "tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files": [[28, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[29, "welcome-to-hfutils-s-documentation"]], "Overview": [[29, "overview"]], "Tutorials": [[29, null]], "Information": [[29, null]], "API Documentation": [[29, null]], "Run Environment Information": [[30, "Run-Environment-Information"], [31, "Run-Environment-Information"]], "Installation": [[32, "installation"]], "Quick Start": [[33, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.cache.delete"], [2, "module-hfutils.cache"], [3, "module-hfutils.config"], [4, "module-hfutils.config.meta"], [5, "module-hfutils.entry.base"], [6, "module-hfutils.entry.cli"], [7, "module-hfutils.entry.dispatch"], [8, "module-hfutils.entry.download"], [9, "module-hfutils.entry"], [10, "module-hfutils.entry.ls"], [11, "module-hfutils.entry.ls_repo"], [12, "module-hfutils.entry.upload"], [13, "module-hfutils.entry.whoami"], [14, "module-hfutils.index.fetch"], [15, "module-hfutils.index"], [16, "module-hfutils.index.make"], [17, "module-hfutils.index.validate"], [18, "module-hfutils.operate.base"], [19, "module-hfutils.operate.download"], [20, "module-hfutils.operate"], [21, "module-hfutils.operate.upload"], [22, "module-hfutils.operate.validate"], [23, "module-hfutils.utils.binary"], [24, "module-hfutils.utils.download"], [25, "module-hfutils.utils"], [26, "module-hfutils.utils.path"], [27, "module-hfutils.utils.tqdm_"], [28, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "delete_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_cache"]], "delete_detached_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_detached_cache"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[5, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[5, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[5, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[5, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[5, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[5, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[5, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[6, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[10, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[11, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "hfutils.index": [[15, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[22, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[23, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[24, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[26, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[27, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[28, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/cache/delete", "api_doc/cache/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/cache/delete.rst", "api_doc/cache/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.cache.delete", "hfutils.cache", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2, 4], "pack": 0, "unpack": 0, "manag": [0, 2], "support": 0, "format": 0, "extens": 0, "name": [0, 5], "7z": 0, "bztar": 0, "tar": [0, 14, 16, 17], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 1, 5, 17, 19, 21, 24, 26, 27], "you": [0, 14, 32], "requir": [0, 32], "simpli": [0, 32], "instal": [0, 29], "us": [0, 1, 5, 14, 16, 17, 18, 19, 21, 24, 29, 32], "follow": [0, 10, 32], "code": [0, 5, 8, 12], "pip": [0, 32], "The": [0, 1, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28, 32], "creation": 0, "file": [0, 5, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 28], "i": [0, 1, 8, 11, 12, 14, 16, 17, 19, 22, 23, 26, 29, 30, 31, 32], "we": 0, "util": [0, 29, 32], "rarfil": 0, "librari": [0, 24], "which": [0, 14, 30, 31, 32], "doe": [0, 14], "offer": 0, "function": [0, 5, 14, 16, 17, 23, 24, 27], "creat": [0, 16], "str": [0, 1, 5, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 28], "ext": 0, "list": [0, 5, 10, 14, 18, 19, 21], "fn_pack": 0, "callabl": [0, 5], "fn_unpack": 0, "sourc": [0, 1, 5, 7, 8, 10, 11, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "regist": 0, "custom": [0, 5, 8, 12], "type": [0, 1, 5, 10, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "associ": 0, "paramet": [0, 1, 5, 7, 8, 10, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 26, 27, 28], "A": [0, 18], "take": 0, "directori": [0, 1, 10, 16, 17, 19, 21, 28], "an": [0, 14, 16, 17, 19, 21, 24, 27, 28], "filenam": [0, 24, 26], "input": 0, "extract": [0, 19], "type_nam": 0, "archive_fil": 0, "silent": [0, 16, 19, 21, 24, 27], "bool": [0, 7, 14, 16, 17, 19, 21, 22, 23, 24, 27], "fals": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "clear": [0, 21], "specifi": [0, 1, 17, 21, 24], "result": 0, "true": [0, 14, 16, 17, 19, 21, 22, 23, 24, 27], "suppress": [0, 16, 19, 21, 24], "warn": [0, 5], "dure": 0, "process": 0, "remov": [0, 21], "exist": [0, 14, 19], "when": [0, 11, 14, 16, 19], "return": [0, 5, 14, 16, 17, 18, 22, 23, 24, 26, 27, 28], "path": [0, 8, 12, 14, 16, 17, 18, 19, 21, 22, 23, 24, 25, 28, 29], "password": [0, 19], "none": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26], "content": [0, 27], "option": [0, 1, 5, 7, 8, 12, 14, 16, 17, 18, 19, 21, 22, 24, 26, 27], "determin": 0, "base": [0, 9, 10, 17, 20, 29], "rais": [0, 11, 14, 17, 26], "valueerror": [0, 26], "ani": [0, 1, 7, 23, 26], "get": [0, 14, 16, 18, 24, 26], "repo_id": [1, 14, 16, 17, 18, 19, 21, 22, 26], "repo_typ": [1, 14, 16, 17, 18, 19, 21, 22, 26], "cache_dir": 1, "all": [1, 14, 19, 28], "detach": 1, "revis": [1, 14, 16, 17, 18, 19, 21, 22, 26], "from": [1, 5, 14, 16, 17, 18, 19, 24, 30, 31, 32], "match": [1, 14, 17, 22], "repositori": [1, 8, 12, 14, 16, 17, 18, 19, 21, 22, 26], "id": [1, 17, 26], "where": [1, 17, 24], "store": [1, 17], "default": [1, 16, 17, 19, 22, 26], "huggingfac": [2, 17, 18, 19, 21, 26, 29, 32], "local": [2, 11, 14, 16, 19, 21, 22, 24, 30, 31], "can": [2, 14, 17, 32], "quickli": 2, "make": [2, 15, 17, 29], "disk": 2, "space": [2, 14, 16, 17, 18, 19, 21, 22, 26], "under": [2, 32], "control": 2, "delet": [2, 29], "delete_detached_cach": 2, "delete_cach": 2, "meta": [3, 14, 29, 32], "__title__": [3, 32], "__version__": [3, 32], "__description__": [3, 32], "__author__": [3, 32], "__author_email__": 3, "inform": [4, 5, 7, 14, 16, 17], "packag": 4, "titl": 4, "thi": [4, 5, 8, 12, 14, 16, 17, 23, 24, 26, 27, 30, 31], "project": 4, "should": [4, 24, 32], "version": [4, 7, 27, 32], "short": 4, "descript": [4, 24], "includ": [4, 5, 14, 16], "setup": 4, "py": 4, "author": 4, "email": 4, "help_option_nam": 5, "h": 5, "help": 5, "dict": [5, 14, 16], "new": 5, "empti": 5, "dictionari": [5, 14], "map": 5, "initi": 5, "object": [5, 10, 14, 18, 19, 21, 24], "": [5, 7, 14], "kei": [5, 14], "valu": [5, 7, 10, 16], "pair": 5, "iter": [5, 28], "via": 5, "d": 5, "k": 5, "v": 5, "kwarg": [5, 7, 24, 27], "keyword": [5, 24, 27], "argument": [5, 14, 24, 27], "For": 5, "exampl": [5, 14], "one": 5, "1": [5, 10, 16, 17, 30, 31], "two": 5, "2": [5, 10, 32], "class": [5, 8, 10, 11, 12, 14, 26], "messag": [5, 8, 11, 12, 16, 21], "except": [5, 8, 11, 12, 14], "displai": [5, 8, 12, 24, 27], "yellow": 5, "color": 5, "error": [5, 8, 12], "exit_cod": [5, 8, 12], "exit": [5, 8, 12], "show": [5, 8, 12], "io": [5, 8, 12, 32], "write": [5, 8, 12], "output": [5, 8, 12, 19, 21, 24, 27, 32], "red": [5, 8, 12], "err": 5, "baseexcept": 5, "print": [5, 7, 30, 31, 32], "traceback": 5, "provid": [5, 24], "built": 5, "msg": 5, "handl": 5, "keyboard": 5, "interrupt": 5, "__init__": 5, "7": 5, "decor": 5, "wrap": 5, "click": [5, 7], "command": [5, 32], "catch": 5, "consist": 5, "group": 6, "hfutilcli": [6, 9], "ctx": 7, "context": 7, "param": 7, "cli": [7, 9, 29], "current": [7, 30, 31, 32], "metadata": 7, "arg": [7, 27], "indic": [8, 12], "remot": [8, 12], "assign": [8, 12, 14, 18, 19, 21], "17": 8, "context_set": 9, "clickwarningexcept": 9, "clickerrorexcept": 9, "print_except": 9, "keyboardinterrupt": 9, "command_wrap": 9, "dispatch": [9, 29], "print_vers": 9, "download": [9, 14, 17, 20, 25, 29], "noremotepathassignedwithdownload": 9, "l": [9, 29], "listitemtyp": 9, "listitem": 9, "ls_repo": [9, 29], "nolocalauthent": 9, "upload": [9, 16, 20, 29], "noremotepathassignedwithupload": 9, "whoami": [9, 29], "enum": 10, "repres": [10, 14], "differ": [10, 14, 30, 31], "item": [10, 17], "valid": [10, 15, 20, 29], "ar": [10, 14], "folder": 10, "imag": [10, 14], "3": [10, 30, 31, 32], "archiv": [10, 14, 16, 17, 19, 21, 29], "4": [10, 30, 31], "model": [10, 14, 16, 17, 18, 19, 21, 22, 26], "5": [10, 19, 30, 31], "data": [10, 14, 30, 31], "6": [10, 30, 31], "repofold": 10, "repofil": [10, 17], "base_dir": 10, "union": [10, 14], "authent": [11, 17], "token": [11, 14, 16, 17, 18, 19, 21, 22], "33": 12, "standalon": 14, "incomplet": 14, "hash": [14, 16, 17, 18, 19, 21], "archive_in_repo": [14, 16, 17, 21], "liter": [14, 16, 17, 18, 19, 21, 22, 26], "dataset": [14, 16, 17, 18, 19, 21, 22, 26], "main": [14, 16, 17, 18, 19, 21, 22, 32], "idx_repo_id": [14, 16, 17], "idx_file_in_repo": [14, 16, 17], "idx_repo_typ": [14, 16, 17], "idx_revis": [14, 16, 17], "hf_token": [14, 16, 17, 18, 19, 21, 22], "hug": [14, 16, 17, 18, 19, 21, 22], "face": [14, 16, 17, 18, 19, 21, 22], "identifi": [14, 16, 18, 19, 21, 22], "repotypetyp": [14, 16, 17, 18, 19, 21, 22, 26], "access": [14, 16], "import": [14, 30, 31, 32], "idx": 14, "deepgh": [14, 32], "danbooru_newest": 14, "0000": 14, "dict_kei": 14, "files": 14, "hash_lf": [14, 17], "7507000": 14, "jpg": 14, "7506000": 14, "7505000": 14, "besid": 14, "also": [14, 24, 32], "explicitli": 14, "nyanko7": 14, "danbooru2023": 14, "danbooru2023_index": 14, "origin": 14, "1000": 14, "png": 14, "10000": 14, "100000": 14, "insid": 14, "file_in_arch": 14, "check": [14, 17, 22, 23, 24, 32], "otherwis": [14, 17, 22, 24], "17506000": 14, "10000000001000": 14, "int": [14, 16, 17, 19, 24], "size": [14, 16, 17, 24, 30, 31], "integ": 14, "filenotfounderror": 14, "435671": 14, "11966": 14, "detail": 14, "offset": 14, "sha256": 14, "265728": 14, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 14, "1024": [14, 23, 30, 31], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 14, "local_fil": [14, 19, 21, 22], "proxi": 14, "user_ag": 14, "header": 14, "endpoint": 14, "save": [14, 16, 19, 24], "http": [14, 32], "request": [14, 24], "user": 14, "agent": 14, "addit": [14, 24, 27], "api": [14, 17, 18, 19, 21, 22], "test_exampl": 14, "destin": 14, "given": [14, 18, 23, 24, 26], "fetch": [15, 29], "archivestandalonefileincompletedownload": 15, "archivestandalonefilehashnotmatch": 15, "hf_tar_get_index": 15, "hf_tar_list_fil": 15, "hf_tar_file_exist": 15, "hf_tar_file_s": 15, "hf_tar_file_info": 15, "hf_tar_file_download": 15, "tar_create_index": 15, "hf_tar_create_index": [15, 17], "tar_get_index_info": 15, "hf_tar_create_from_directori": 15, "hf_tar_item_valid": 15, "hf_tar_valid": 15, "src_tar_fil": 16, "dst_index_fil": 16, "chunk_for_hash": 16, "1048576": 16, "with_hash": 16, "chunk": 16, "20": 16, "mb": 16, "whether": 16, "progress": [16, 19, 21, 24, 27], "bar": [16, 19, 21, 24, 27], "log": 16, "skip_when_sync": 16, "skip": 16, "sync": 16, "readi": [16, 22], "directli": 16, "json": [16, 17], "local_directori": [16, 19, 21], "file_item": 17, "hash_": 17, "expect": [17, 24], "sha": 17, "256": 17, "lf": 17, "entrynotfounderror": 17, "entri": [17, 29], "found": 17, "isadirectoryerror": 17, "mean": [17, 32], "expir": 17, "need": 17, "re": 17, "gener": 17, "so": 17, "togeth": 17, "gracefulli": 17, "refresh": 17, "hfapi": 18, "client": [18, 19, 21], "variabl": [18, 19, 21], "hffilesystem": 18, "system": 18, "subdir": 18, "ignore_pattern": [18, 19, 21], "subdirectori": 18, "e": [18, 19, 21], "g": [18, 19, 21], "branch": [18, 19, 21], "tag": [18, 19, 21], "commit": [18, 19, 21], "pattern": [18, 19, 21], "ignor": [18, 19, 21], "file_in_repo": [19, 21, 22], "resume_download": 19, "within": [19, 21], "resum": 19, "dir_in_repo": 19, "max_work": 19, "8": [19, 30, 31, 32], "max_retri": 19, "max": 19, "worker": 19, "retri": 19, "time": 19, "get_hf_client": 20, "get_hf_f": 20, "list_files_in_repositori": 20, "download_file_to_fil": 20, "download_archive_as_directori": 20, "download_directory_as_directori": 20, "upload_file_to_fil": 20, "upload_directory_as_arch": 20, "upload_directory_as_directori": 20, "is_local_file_readi": 20, "path_in_repo": 21, "time_suffix": 21, "its": 21, "append": 21, "timestamp": 21, "present": 21, "compar": 22, "hub": 22, "read": 23, "first": 23, "byte": [23, 24], "contain": 23, "non": 23, "text": 23, "charact": 23, "url": 24, "expected_s": 24, "desc": 24, "session": 24, "tqdm": [24, 25, 29], "It": [24, 32], "perform": [24, 30, 31], "ensur": 24, "ha": [24, 30, 31], "pass": [24, 27], "binari": [25, 29], "is_binary_fil": 25, "download_fil": 25, "hf_normpath": 25, "hf_fs_path": 25, "parse_hf_fs_path": 25, "hffilesystempath": 25, "walk": [25, 29], "walk_fil": 25, "normal": 26, "filesystem": 26, "pars": 26, "invalid": 26, "tqdm_": 27, "enhanc": 27, "silenc": 27, "modifi": 27, "behavior": 27, "allow": 27, "posit": 27, "std": 27, "recurs": 28, "through": [28, 32], "yield": 28, "rel": 28, "root": 28, "start": [28, 29], "modul": 29, "quick": 29, "run": 29, "environ": 29, "register_archive_typ": 29, "archive_pack": 29, "archive_unpack": 29, "get_archive_typ": 29, "get_archive_extnam": 29, "cach": 29, "config": [29, 32], "index": [29, 32], "oper": 29, "here": [30, 31], "o": [30, 31], "platform": [30, 31], "shutil": [30, 31], "cpuinfo": [30, 31], "psutil": [30, 31], "hbutil": [30, 31], "scale": [30, 31], "size_to_bytes_str": [30, 31], "python": [30, 31, 32], "python_implement": [30, 31], "python_vers": [30, 31], "cpu": [30, 31], "brand": [30, 31], "get_cpu_info": [30, 31], "brand_raw": [30, 31], "count": [30, 31], "cpu_count": [30, 31], "freq": [30, 31], "cpu_freq": [30, 31], "mhz": [30, 31], "memori": [30, 31], "virtual_memori": [30, 31], "total": [30, 31], "precis": [30, 31], "cuda": [30, 31], "ye": [30, 31], "nvidia": [30, 31], "smi": [30, 31], "els": [30, 31], "No": [30, 31], "linux": [30, 31], "0": [30, 31, 32], "azur": [30, 31], "x86_64": [30, 31], "glibc2": [30, 31], "34": [30, 31], "cpython": [30, 31], "18": [30, 31], "amd": [30, 31], "epyc": [30, 31], "7763": [30, 31], "64": [30, 31], "core": [30, 31], "processor": [30, 31], "2913": 30, "7765000000004": 30, "15": [30, 31], "606": [30, 31], "gib": [30, 31], "pleas": [30, 31], "note": [30, 31], "deploi": [30, 31], "document": [30, 31, 32], "automat": [30, 31], "execut": [30, 31], "github": [30, 31, 32], "action": [30, 31], "therefor": [30, 31], "some": [30, 31], "mai": [30, 31], "your": [30, 31, 32], "2732": 31, "23175": 31, "hfutil": 32, "host": 32, "pypi": 32, "newest": 32, "u": 32, "git": 32, "com": 32, "script": 32, "__name__": 32, "__main__": 32, "develop": 32, "maintain": 32, "like": 32, "below": 32, "success": 32, "9": 32, "narugo1992": 32, "still": 32, "out": 32, "stabl": 32, "html": 32, "faq": 33}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [2, 0, 0, "-", "cache"], [3, 0, 0, "-", "config"], [9, 0, 0, "-", "entry"], [15, 0, 0, "-", "index"], [20, 0, 0, "-", "operate"], [25, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.cache": [[1, 0, 0, "-", "delete"]], "hfutils.cache.delete": [[1, 1, 1, "", "delete_cache"], [1, 1, 1, "", "delete_detached_cache"]], "hfutils.config": [[4, 0, 0, "-", "meta"]], "hfutils.config.meta": [[4, 2, 1, "", "__AUTHOR_EMAIL__"], [4, 2, 1, "", "__AUTHOR__"], [4, 2, 1, "", "__DESCRIPTION__"], [4, 2, 1, "", "__TITLE__"], [4, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[5, 0, 0, "-", "base"], [6, 0, 0, "-", "cli"], [7, 0, 0, "-", "dispatch"], [8, 0, 0, "-", "download"], [10, 0, 0, "-", "ls"], [11, 0, 0, "-", "ls_repo"], [12, 0, 0, "-", "upload"], [13, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[5, 2, 1, "", "CONTEXT_SETTINGS"], [5, 3, 1, "", "ClickErrorException"], [5, 3, 1, "", "ClickWarningException"], [5, 3, 1, "", "KeyboardInterrupted"], [5, 1, 1, "", "command_wrap"], [5, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[5, 5, 1, "", "__init__"], [5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.cli": [[6, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[7, 1, 1, "", "hfutilcli"], [7, 1, 1, "", "print_version"]], "hfutils.entry.download": [[8, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[8, 4, 1, "", "exit_code"], [8, 5, 1, "", "show"]], "hfutils.entry.ls": [[10, 3, 1, "", "ListItem"], [10, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[10, 4, 1, "", "ARCHIVE"], [10, 4, 1, "", "DATA"], [10, 4, 1, "", "FILE"], [10, 4, 1, "", "FOLDER"], [10, 4, 1, "", "IMAGE"], [10, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[11, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[12, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[12, 4, 1, "", "exit_code"], [12, 5, 1, "", "show"]], "hfutils.index": [[14, 0, 0, "-", "fetch"], [16, 0, 0, "-", "make"], [17, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[14, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [14, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [14, 1, 1, "", "hf_tar_file_download"], [14, 1, 1, "", "hf_tar_file_exists"], [14, 1, 1, "", "hf_tar_file_info"], [14, 1, 1, "", "hf_tar_file_size"], [14, 1, 1, "", "hf_tar_get_index"], [14, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[16, 1, 1, "", "hf_tar_create_from_directory"], [16, 1, 1, "", "hf_tar_create_index"], [16, 1, 1, "", "tar_create_index"], [16, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[17, 1, 1, "", "hf_tar_item_validate"], [17, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[18, 0, 0, "-", "base"], [19, 0, 0, "-", "download"], [21, 0, 0, "-", "upload"], [22, 0, 0, "-", "validate"]], "hfutils.operate.base": [[18, 1, 1, "", "get_hf_client"], [18, 1, 1, "", "get_hf_fs"], [18, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[19, 1, 1, "", "download_archive_as_directory"], [19, 1, 1, "", "download_directory_as_directory"], [19, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[21, 1, 1, "", "upload_directory_as_archive"], [21, 1, 1, "", "upload_directory_as_directory"], [21, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[22, 1, 1, "", "is_local_file_ready"]], "hfutils.utils": [[23, 0, 0, "-", "binary"], [24, 0, 0, "-", "download"], [26, 0, 0, "-", "path"], [27, 0, 0, "-", "tqdm_"], [28, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[23, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[24, 1, 1, "", "download_file"]], "hfutils.utils.path": [[26, 3, 1, "", "HfFileSystemPath"], [26, 1, 1, "", "hf_fs_path"], [26, 1, 1, "", "hf_normpath"], [26, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[28, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "cach": [1, 2], "delet": 1, "delete_detached_cach": 1, "delete_cach": 1, "config": [3, 4], "meta": 4, "__title__": 4, "__version__": 4, "__description__": 4, "__author__": 4, "__author_email__": 4, "entri": [5, 6, 7, 8, 9, 10, 11, 12, 13], "base": [5, 18], "context_set": 5, "clickwarningexcept": 5, "clickerrorexcept": 5, "print_except": 5, "keyboardinterrupt": 5, "command_wrap": 5, "cli": 6, "dispatch": 7, "print_vers": 7, "hfutilcli": 7, "download": [8, 19, 24], "noremotepathassignedwithdownload": 8, "l": 10, "listitemtyp": 10, "listitem": 10, "ls_repo": 11, "nolocalauthent": 11, "upload": [12, 21], "noremotepathassignedwithupload": 12, "whoami": 13, "index": [14, 15, 16, 17], "fetch": 14, "archivestandalonefileincompletedownload": 14, "archivestandalonefilehashnotmatch": 14, "hf_tar_get_index": 14, "hf_tar_list_fil": 14, "hf_tar_file_exist": 14, "hf_tar_file_s": 14, "hf_tar_file_info": 14, "hf_tar_file_download": 14, "make": 16, "tar_create_index": 16, "hf_tar_create_index": 16, "tar_get_index_info": 16, "hf_tar_create_from_directori": 16, "valid": [17, 22], "hf_tar_item_valid": 17, "hf_tar_valid": 17, "oper": [18, 19, 20, 21, 22], "get_hf_client": 18, "get_hf_f": 18, "list_files_in_repositori": 18, "download_file_to_fil": 19, "download_archive_as_directori": 19, "download_directory_as_directori": 19, "upload_file_to_fil": 21, "upload_directory_as_arch": 21, "upload_directory_as_directori": 21, "is_local_file_readi": 22, "util": [23, 24, 25, 26, 27, 28], "binari": 23, "is_binary_fil": 23, "download_fil": 24, "path": 26, "hf_normpath": 26, "hf_fs_path": 26, "parse_hf_fs_path": 26, "hffilesystempath": 26, "tqdm": 27, "walk": 28, "walk_fil": 28, "welcom": 29, "": 29, "document": 29, "overview": 29, "tutori": 29, "inform": [29, 30, 31], "api": 29, "run": [30, 31], "environ": [30, 31], "instal": 32, "quick": 33, "start": 33}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "delete_detached_cache": [[1, "delete-detached-cache"]], "delete_cache": [[1, "delete-cache"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "__TITLE__": [[4, "title"]], "__VERSION__": [[4, "version"]], "__DESCRIPTION__": [[4, "description"]], "__AUTHOR__": [[4, "author"]], "__AUTHOR_EMAIL__": [[4, "author-email"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[5, "context-settings"]], "ClickWarningException": [[5, "clickwarningexception"]], "ClickErrorException": [[5, "clickerrorexception"]], "print_exception": [[5, "print-exception"]], "KeyboardInterrupted": [[5, "keyboardinterrupted"]], "command_wrap": [[5, "command-wrap"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "cli": [[6, "cli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version": [[7, "print-version"]], "hfutilcli": [[7, "hfutilcli"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[8, "noremotepathassignedwithdownload"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "ListItemType": [[10, "listitemtype"]], "ListItem": [[10, "listitem"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[11, "nolocalauthentication"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[12, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[14, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[14, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[14, "hf-tar-get-index"]], "hf_tar_list_files": [[14, "hf-tar-list-files"]], "hf_tar_file_exists": [[14, "hf-tar-file-exists"]], "hf_tar_file_size": [[14, "hf-tar-file-size"]], "hf_tar_file_info": [[14, "hf-tar-file-info"]], "hf_tar_file_download": [[14, "hf-tar-file-download"]], "hfutils.index": [[15, "module-hfutils.index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index": [[16, "tar-create-index"]], "hf_tar_create_index": [[16, "hf-tar-create-index"]], "tar_get_index_info": [[16, "tar-get-index-info"]], "hf_tar_create_from_directory": [[16, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[17, "hf-tar-item-validate"]], "hf_tar_validate": [[17, "hf-tar-validate"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "get_hf_client": [[18, "get-hf-client"]], "get_hf_fs": [[18, "get-hf-fs"]], "list_files_in_repository": [[18, "list-files-in-repository"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "download_file_to_file": [[19, "download-file-to-file"]], "download_archive_as_directory": [[19, "download-archive-as-directory"]], "download_directory_as_directory": [[19, "download-directory-as-directory"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_file_to_file": [[21, "upload-file-to-file"]], "upload_directory_as_archive": [[21, "upload-directory-as-archive"]], "upload_directory_as_directory": [[21, "upload-directory-as-directory"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready": [[22, "is-local-file-ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file": [[23, "is-binary-file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "download_file": [[24, "download-file"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "hf_normpath": [[26, "hf-normpath"]], "hf_fs_path": [[26, "hf-fs-path"]], "parse_hf_fs_path": [[26, "parse-hf-fs-path"]], "HfFileSystemPath": [[26, "hffilesystempath"]], "hfutils.utils.tqdm": [[27, "module-hfutils.utils.tqdm_"]], "tqdm": [[27, "tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files": [[28, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[29, "welcome-to-hfutils-s-documentation"]], "Overview": [[29, "overview"]], "Tutorials": [[29, null]], "Information": [[29, null]], "API Documentation": [[29, null]], "Run Environment Information": [[30, "Run-Environment-Information"], [31, "Run-Environment-Information"]], "Installation": [[32, "installation"]], "Quick Start": [[33, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.cache.delete"], [2, "module-hfutils.cache"], [3, "module-hfutils.config"], [4, "module-hfutils.config.meta"], [5, "module-hfutils.entry.base"], [6, "module-hfutils.entry.cli"], [7, "module-hfutils.entry.dispatch"], [8, "module-hfutils.entry.download"], [9, "module-hfutils.entry"], [10, "module-hfutils.entry.ls"], [11, "module-hfutils.entry.ls_repo"], [12, "module-hfutils.entry.upload"], [13, "module-hfutils.entry.whoami"], [14, "module-hfutils.index.fetch"], [15, "module-hfutils.index"], [16, "module-hfutils.index.make"], [17, "module-hfutils.index.validate"], [18, "module-hfutils.operate.base"], [19, "module-hfutils.operate.download"], [20, "module-hfutils.operate"], [21, "module-hfutils.operate.upload"], [22, "module-hfutils.operate.validate"], [23, "module-hfutils.utils.binary"], [24, "module-hfutils.utils.download"], [25, "module-hfutils.utils"], [26, "module-hfutils.utils.path"], [27, "module-hfutils.utils.tqdm_"], [28, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "delete_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_cache"]], "delete_detached_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_detached_cache"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[5, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[5, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[5, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[5, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[5, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[5, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[5, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[6, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[7, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[7, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[8, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[8, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[9, "module-hfutils.entry"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[10, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[10, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[10, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[11, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[11, "module-hfutils.entry.ls_repo"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[12, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[12, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[13, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[14, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[14, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[14, "module-hfutils.index.fetch"]], "hfutils.index": [[15, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[16, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[16, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[17, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[17, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[18, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[18, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[19, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[19, "module-hfutils.operate.download"]], "hfutils.operate": [[20, "module-hfutils.operate"]], "hfutils.operate.upload": [[21, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[21, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[22, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[22, "hfutils.operate.validate.is_local_file_ready"]], "hfutils.utils.binary": [[23, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[23, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[24, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[24, "module-hfutils.utils.download"]], "hfutils.utils": [[25, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[26, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[26, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[26, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[27, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[27, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[28, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[28, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
diff --git a/v0.3.0/.buildinfo b/v0.3.0/.buildinfo
index ac3585ed6b..e9c626dfb1 100644
--- a/v0.3.0/.buildinfo
+++ b/v0.3.0/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: b7f658b57c3853d99a2f2d382f367ad2
+config: 855bd1c67dadf5e97547a2de75c46a8a
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.3.0/.doctrees/api_doc/archive/index.doctree b/v0.3.0/.doctrees/api_doc/archive/index.doctree
index ed4f3bc35a..1f55238ef7 100644
Binary files a/v0.3.0/.doctrees/api_doc/archive/index.doctree and b/v0.3.0/.doctrees/api_doc/archive/index.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/cache/delete.doctree b/v0.3.0/.doctrees/api_doc/cache/delete.doctree
index 04fcb7ae4d..ec423f1ca5 100644
Binary files a/v0.3.0/.doctrees/api_doc/cache/delete.doctree and b/v0.3.0/.doctrees/api_doc/cache/delete.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/cache/index.doctree b/v0.3.0/.doctrees/api_doc/cache/index.doctree
index 0637e00e62..7a4c4e7655 100644
Binary files a/v0.3.0/.doctrees/api_doc/cache/index.doctree and b/v0.3.0/.doctrees/api_doc/cache/index.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/config/index.doctree b/v0.3.0/.doctrees/api_doc/config/index.doctree
index b6899e5104..c3579bfa60 100644
Binary files a/v0.3.0/.doctrees/api_doc/config/index.doctree and b/v0.3.0/.doctrees/api_doc/config/index.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/config/meta.doctree b/v0.3.0/.doctrees/api_doc/config/meta.doctree
index 168aa05cdf..7270b65ef5 100644
Binary files a/v0.3.0/.doctrees/api_doc/config/meta.doctree and b/v0.3.0/.doctrees/api_doc/config/meta.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/entry/base.doctree b/v0.3.0/.doctrees/api_doc/entry/base.doctree
index dc3c47cae7..c5981a7c19 100644
Binary files a/v0.3.0/.doctrees/api_doc/entry/base.doctree and b/v0.3.0/.doctrees/api_doc/entry/base.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/entry/cli.doctree b/v0.3.0/.doctrees/api_doc/entry/cli.doctree
index af7ba20851..ac2707955f 100644
Binary files a/v0.3.0/.doctrees/api_doc/entry/cli.doctree and b/v0.3.0/.doctrees/api_doc/entry/cli.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/entry/clone.doctree b/v0.3.0/.doctrees/api_doc/entry/clone.doctree
index 19ce200348..0b122db694 100644
Binary files a/v0.3.0/.doctrees/api_doc/entry/clone.doctree and b/v0.3.0/.doctrees/api_doc/entry/clone.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/entry/dispatch.doctree b/v0.3.0/.doctrees/api_doc/entry/dispatch.doctree
index 5636451c65..ba32c3f74b 100644
Binary files a/v0.3.0/.doctrees/api_doc/entry/dispatch.doctree and b/v0.3.0/.doctrees/api_doc/entry/dispatch.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/entry/download.doctree b/v0.3.0/.doctrees/api_doc/entry/download.doctree
index 011facbc15..54940aa0ff 100644
Binary files a/v0.3.0/.doctrees/api_doc/entry/download.doctree and b/v0.3.0/.doctrees/api_doc/entry/download.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/entry/index.doctree b/v0.3.0/.doctrees/api_doc/entry/index.doctree
index 0549b117e2..635c20f3d3 100644
Binary files a/v0.3.0/.doctrees/api_doc/entry/index.doctree and b/v0.3.0/.doctrees/api_doc/entry/index.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/entry/index_.doctree b/v0.3.0/.doctrees/api_doc/entry/index_.doctree
index f781546363..583dac8f99 100644
Binary files a/v0.3.0/.doctrees/api_doc/entry/index_.doctree and b/v0.3.0/.doctrees/api_doc/entry/index_.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/entry/ls.doctree b/v0.3.0/.doctrees/api_doc/entry/ls.doctree
index 6aff636cc7..5dab5d1191 100644
Binary files a/v0.3.0/.doctrees/api_doc/entry/ls.doctree and b/v0.3.0/.doctrees/api_doc/entry/ls.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/entry/ls_repo.doctree b/v0.3.0/.doctrees/api_doc/entry/ls_repo.doctree
index a25d7dbb53..f4d5458576 100644
Binary files a/v0.3.0/.doctrees/api_doc/entry/ls_repo.doctree and b/v0.3.0/.doctrees/api_doc/entry/ls_repo.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/entry/rollback.doctree b/v0.3.0/.doctrees/api_doc/entry/rollback.doctree
index d2cdee55d6..4df28aad3e 100644
Binary files a/v0.3.0/.doctrees/api_doc/entry/rollback.doctree and b/v0.3.0/.doctrees/api_doc/entry/rollback.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/entry/upload.doctree b/v0.3.0/.doctrees/api_doc/entry/upload.doctree
index c7218ab34b..3b95942112 100644
Binary files a/v0.3.0/.doctrees/api_doc/entry/upload.doctree and b/v0.3.0/.doctrees/api_doc/entry/upload.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/entry/whoami.doctree b/v0.3.0/.doctrees/api_doc/entry/whoami.doctree
index 31e9b5a2f6..40227f0f34 100644
Binary files a/v0.3.0/.doctrees/api_doc/entry/whoami.doctree and b/v0.3.0/.doctrees/api_doc/entry/whoami.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/index/fetch.doctree b/v0.3.0/.doctrees/api_doc/index/fetch.doctree
index 0348139485..53c0b19d23 100644
Binary files a/v0.3.0/.doctrees/api_doc/index/fetch.doctree and b/v0.3.0/.doctrees/api_doc/index/fetch.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/index/index.doctree b/v0.3.0/.doctrees/api_doc/index/index.doctree
index ea01966089..6217f5c45b 100644
Binary files a/v0.3.0/.doctrees/api_doc/index/index.doctree and b/v0.3.0/.doctrees/api_doc/index/index.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/index/make.doctree b/v0.3.0/.doctrees/api_doc/index/make.doctree
index 9a1883bd7b..47665170bc 100644
Binary files a/v0.3.0/.doctrees/api_doc/index/make.doctree and b/v0.3.0/.doctrees/api_doc/index/make.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/index/validate.doctree b/v0.3.0/.doctrees/api_doc/index/validate.doctree
index 90bd605d66..83b4c9bb8a 100644
Binary files a/v0.3.0/.doctrees/api_doc/index/validate.doctree and b/v0.3.0/.doctrees/api_doc/index/validate.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/operate/base.doctree b/v0.3.0/.doctrees/api_doc/operate/base.doctree
index 528c107833..2440610261 100644
Binary files a/v0.3.0/.doctrees/api_doc/operate/base.doctree and b/v0.3.0/.doctrees/api_doc/operate/base.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/operate/download.doctree b/v0.3.0/.doctrees/api_doc/operate/download.doctree
index bca9da329f..c31d66bc30 100644
Binary files a/v0.3.0/.doctrees/api_doc/operate/download.doctree and b/v0.3.0/.doctrees/api_doc/operate/download.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/operate/index.doctree b/v0.3.0/.doctrees/api_doc/operate/index.doctree
index 2257a82096..1e9d4c4d1a 100644
Binary files a/v0.3.0/.doctrees/api_doc/operate/index.doctree and b/v0.3.0/.doctrees/api_doc/operate/index.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/operate/upload.doctree b/v0.3.0/.doctrees/api_doc/operate/upload.doctree
index 8785181bff..ae49277399 100644
Binary files a/v0.3.0/.doctrees/api_doc/operate/upload.doctree and b/v0.3.0/.doctrees/api_doc/operate/upload.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/operate/validate.doctree b/v0.3.0/.doctrees/api_doc/operate/validate.doctree
index 66a146312c..674c6ccc85 100644
Binary files a/v0.3.0/.doctrees/api_doc/operate/validate.doctree and b/v0.3.0/.doctrees/api_doc/operate/validate.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/repository/base.doctree b/v0.3.0/.doctrees/api_doc/repository/base.doctree
index 9eb4c8b141..c4103dc0f7 100644
Binary files a/v0.3.0/.doctrees/api_doc/repository/base.doctree and b/v0.3.0/.doctrees/api_doc/repository/base.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/repository/clone.doctree b/v0.3.0/.doctrees/api_doc/repository/clone.doctree
index 58637f4c20..fd30cfca93 100644
Binary files a/v0.3.0/.doctrees/api_doc/repository/clone.doctree and b/v0.3.0/.doctrees/api_doc/repository/clone.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/repository/index.doctree b/v0.3.0/.doctrees/api_doc/repository/index.doctree
index 011cf32311..7c73dead17 100644
Binary files a/v0.3.0/.doctrees/api_doc/repository/index.doctree and b/v0.3.0/.doctrees/api_doc/repository/index.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/repository/rollback.doctree b/v0.3.0/.doctrees/api_doc/repository/rollback.doctree
index abfb10136d..872016f5e9 100644
Binary files a/v0.3.0/.doctrees/api_doc/repository/rollback.doctree and b/v0.3.0/.doctrees/api_doc/repository/rollback.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/utils/binary.doctree b/v0.3.0/.doctrees/api_doc/utils/binary.doctree
index e66a461c20..c4bc1604f8 100644
Binary files a/v0.3.0/.doctrees/api_doc/utils/binary.doctree and b/v0.3.0/.doctrees/api_doc/utils/binary.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/utils/download.doctree b/v0.3.0/.doctrees/api_doc/utils/download.doctree
index 3b8e9283a3..4aeb52f1e3 100644
Binary files a/v0.3.0/.doctrees/api_doc/utils/download.doctree and b/v0.3.0/.doctrees/api_doc/utils/download.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/utils/index.doctree b/v0.3.0/.doctrees/api_doc/utils/index.doctree
index 11a40785ae..f7f5edabef 100644
Binary files a/v0.3.0/.doctrees/api_doc/utils/index.doctree and b/v0.3.0/.doctrees/api_doc/utils/index.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/utils/path.doctree b/v0.3.0/.doctrees/api_doc/utils/path.doctree
index 76c24f5436..f483438624 100644
Binary files a/v0.3.0/.doctrees/api_doc/utils/path.doctree and b/v0.3.0/.doctrees/api_doc/utils/path.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/utils/tqdm_.doctree b/v0.3.0/.doctrees/api_doc/utils/tqdm_.doctree
index adb19a6c7b..bed91ebec1 100644
Binary files a/v0.3.0/.doctrees/api_doc/utils/tqdm_.doctree and b/v0.3.0/.doctrees/api_doc/utils/tqdm_.doctree differ
diff --git a/v0.3.0/.doctrees/api_doc/utils/walk.doctree b/v0.3.0/.doctrees/api_doc/utils/walk.doctree
index 655b1063e1..7c79a342fc 100644
Binary files a/v0.3.0/.doctrees/api_doc/utils/walk.doctree and b/v0.3.0/.doctrees/api_doc/utils/walk.doctree differ
diff --git a/v0.3.0/.doctrees/environment.pickle b/v0.3.0/.doctrees/environment.pickle
index d97b58e268..fe828c8f73 100644
Binary files a/v0.3.0/.doctrees/environment.pickle and b/v0.3.0/.doctrees/environment.pickle differ
diff --git a/v0.3.0/.doctrees/index.doctree b/v0.3.0/.doctrees/index.doctree
index d03072141c..fad10262f7 100644
Binary files a/v0.3.0/.doctrees/index.doctree and b/v0.3.0/.doctrees/index.doctree differ
diff --git a/v0.3.0/.doctrees/information/environment.doctree b/v0.3.0/.doctrees/information/environment.doctree
index b44b291e10..3d09e7e8e2 100644
Binary files a/v0.3.0/.doctrees/information/environment.doctree and b/v0.3.0/.doctrees/information/environment.doctree differ
diff --git a/v0.3.0/.doctrees/information/environment.result.doctree b/v0.3.0/.doctrees/information/environment.result.doctree
index f6f1e2fd15..524d7db98a 100644
Binary files a/v0.3.0/.doctrees/information/environment.result.doctree and b/v0.3.0/.doctrees/information/environment.result.doctree differ
diff --git a/v0.3.0/.doctrees/nbsphinx/information/environment.ipynb b/v0.3.0/.doctrees/nbsphinx/information/environment.ipynb
index f09764edd9..56ec0f569d 100644
--- a/v0.3.0/.doctrees/nbsphinx/information/environment.ipynb
+++ b/v0.3.0/.doctrees/nbsphinx/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:12:27.104639Z",
-     "iopub.status.busy": "2024-07-23T18:12:27.104441Z",
-     "iopub.status.idle": "2024-07-23T18:12:28.273560Z",
-     "shell.execute_reply": "2024-07-23T18:12:28.272788Z"
+     "iopub.execute_input": "2024-07-23T18:19:25.044476Z",
+     "iopub.status.busy": "2024-07-23T18:19:25.043910Z",
+     "iopub.status.idle": "2024-07-23T18:19:26.215036Z",
+     "shell.execute_reply": "2024-07-23T18:19:26.214203Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2784.103 MHz\n",
+      "CPU Freq: 2939.1825000000003 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.3.0/.doctrees/nbsphinx/information/environment.result.ipynb b/v0.3.0/.doctrees/nbsphinx/information/environment.result.ipynb
index 1a22ebab76..6c3a4ce5b9 100644
--- a/v0.3.0/.doctrees/nbsphinx/information/environment.result.ipynb
+++ b/v0.3.0/.doctrees/nbsphinx/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:18:50.180302Z",
-     "iopub.status.busy": "2024-07-23T17:18:50.179808Z",
-     "iopub.status.idle": "2024-07-23T17:18:51.357476Z",
-     "shell.execute_reply": "2024-07-23T17:18:51.356621Z"
+     "iopub.execute_input": "2024-07-23T17:24:50.817657Z",
+     "iopub.status.busy": "2024-07-23T17:24:50.817453Z",
+     "iopub.status.idle": "2024-07-23T17:24:51.991300Z",
+     "shell.execute_reply": "2024-07-23T17:24:51.990512Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2783.6985 MHz\n",
+      "CPU Freq: 2726.45175 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.3.0/.doctrees/tutorials/installation/index.doctree b/v0.3.0/.doctrees/tutorials/installation/index.doctree
index f419e454d6..65d507543f 100644
Binary files a/v0.3.0/.doctrees/tutorials/installation/index.doctree and b/v0.3.0/.doctrees/tutorials/installation/index.doctree differ
diff --git a/v0.3.0/.doctrees/tutorials/quick_start/index.doctree b/v0.3.0/.doctrees/tutorials/quick_start/index.doctree
index 0e6ef59061..a59ed0726e 100644
Binary files a/v0.3.0/.doctrees/tutorials/quick_start/index.doctree and b/v0.3.0/.doctrees/tutorials/quick_start/index.doctree differ
diff --git a/v0.3.0/_sources/information/environment.result.ipynb.txt b/v0.3.0/_sources/information/environment.result.ipynb.txt
index 1a22ebab76..6c3a4ce5b9 100644
--- a/v0.3.0/_sources/information/environment.result.ipynb.txt
+++ b/v0.3.0/_sources/information/environment.result.ipynb.txt
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:18:50.180302Z",
-     "iopub.status.busy": "2024-07-23T17:18:50.179808Z",
-     "iopub.status.idle": "2024-07-23T17:18:51.357476Z",
-     "shell.execute_reply": "2024-07-23T17:18:51.356621Z"
+     "iopub.execute_input": "2024-07-23T17:24:50.817657Z",
+     "iopub.status.busy": "2024-07-23T17:24:50.817453Z",
+     "iopub.status.idle": "2024-07-23T17:24:51.991300Z",
+     "shell.execute_reply": "2024-07-23T17:24:51.990512Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2783.6985 MHz\n",
+      "CPU Freq: 2726.45175 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.3.0/information/environment.html b/v0.3.0/information/environment.html
index 04a72ac2e0..22776575ce 100644
--- a/v0.3.0/information/environment.html
+++ b/v0.3.0/information/environment.html
@@ -128,11 +128,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2784.103 MHz
+CPU Freq: 2939.1825000000003 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.3.0/information/environment.ipynb b/v0.3.0/information/environment.ipynb
index f09764edd9..56ec0f569d 100644
--- a/v0.3.0/information/environment.ipynb
+++ b/v0.3.0/information/environment.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T18:12:27.104639Z",
-     "iopub.status.busy": "2024-07-23T18:12:27.104441Z",
-     "iopub.status.idle": "2024-07-23T18:12:28.273560Z",
-     "shell.execute_reply": "2024-07-23T18:12:28.272788Z"
+     "iopub.execute_input": "2024-07-23T18:19:25.044476Z",
+     "iopub.status.busy": "2024-07-23T18:19:25.043910Z",
+     "iopub.status.idle": "2024-07-23T18:19:26.215036Z",
+     "shell.execute_reply": "2024-07-23T18:19:26.214203Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2784.103 MHz\n",
+      "CPU Freq: 2939.1825000000003 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.3.0/information/environment.result.html b/v0.3.0/information/environment.result.html
index d2f8a91ae4..8946d2e415 100644
--- a/v0.3.0/information/environment.result.html
+++ b/v0.3.0/information/environment.result.html
@@ -130,11 +130,11 @@ <h1>Run Environment Information<a class="headerlink" href="#Run-Environment-Info
 </div>
 <div class="output_area docutils container">
 <div class="highlight"><pre>
-OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34
+OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34
 Python: CPython 3.8.18
 CPU Brand: AMD EPYC 7763 64-Core Processor
 CPU Count: 4
-CPU Freq: 2783.6985 MHz
+CPU Freq: 2726.45175 MHz
 Memory Size: 15.606 GiB
 Has CUDA: No
 </pre></div></div>
diff --git a/v0.3.0/information/environment.result.ipynb b/v0.3.0/information/environment.result.ipynb
index 1a22ebab76..6c3a4ce5b9 100644
--- a/v0.3.0/information/environment.result.ipynb
+++ b/v0.3.0/information/environment.result.ipynb
@@ -29,10 +29,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-07-23T17:18:50.180302Z",
-     "iopub.status.busy": "2024-07-23T17:18:50.179808Z",
-     "iopub.status.idle": "2024-07-23T17:18:51.357476Z",
-     "shell.execute_reply": "2024-07-23T17:18:51.356621Z"
+     "iopub.execute_input": "2024-07-23T17:24:50.817657Z",
+     "iopub.status.busy": "2024-07-23T17:24:50.817453Z",
+     "iopub.status.idle": "2024-07-23T17:24:51.991300Z",
+     "shell.execute_reply": "2024-07-23T17:24:51.990512Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -43,7 +43,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "OS: Linux-6.5.0-1023-azure-x86_64-with-glibc2.34\n",
+      "OS: Linux-6.5.0-1024-azure-x86_64-with-glibc2.34\n",
       "Python: CPython 3.8.18\n"
      ]
     },
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2783.6985 MHz\n",
+      "CPU Freq: 2726.45175 MHz\n",
       "Memory Size: 15.606 GiB\n",
       "Has CUDA: No\n"
      ]
diff --git a/v0.3.0/searchindex.js b/v0.3.0/searchindex.js
index 87986b6f5f..4c2d05c172 100644
--- a/v0.3.0/searchindex.js
+++ b/v0.3.0/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/cache/delete", "api_doc/cache/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/clone", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/index_", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/rollback", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/repository/base", "api_doc/repository/clone", "api_doc/repository/index", "api_doc/repository/rollback", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/cache/delete.rst", "api_doc/cache/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/clone.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/index_.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/rollback.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/repository/base.rst", "api_doc/repository/clone.rst", "api_doc/repository/index.rst", "api_doc/repository/rollback.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.cache.delete", "hfutils.cache", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.clone", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.index", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.rollback", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.repository.base", "hfutils.repository.clone", "hfutils.repository", "hfutils.repository.rollback", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2, 4, 28], "pack": 0, "unpack": 0, "manag": [0, 2, 11], "support": 0, "format": 0, "extens": 0, "name": [0, 5], "7z": 0, "bztar": 0, "tar": [0, 11, 17, 19, 20], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 1, 5, 20, 22, 24, 26, 27, 29, 31, 33, 34], "you": [0, 17, 24, 39], "requir": [0, 29, 39], "simpli": [0, 39], "instal": [0, 26, 29, 36], "us": [0, 1, 5, 11, 17, 19, 20, 21, 22, 24, 26, 27, 29, 31, 36, 39], "follow": [0, 12, 29, 39], "code": [0, 5, 9, 15], "pip": [0, 39], "The": [0, 1, 5, 9, 11, 12, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 35, 39], "creation": [0, 24], "file": [0, 5, 9, 11, 12, 15, 17, 19, 20, 21, 22, 24, 25, 27, 30, 31, 35], "i": [0, 1, 9, 13, 15, 17, 19, 20, 22, 24, 25, 26, 30, 33, 36, 37, 38, 39], "we": 0, "util": [0, 26, 36, 39], "rarfil": 0, "librari": [0, 31], "which": [0, 17, 37, 38, 39], "doe": [0, 17], "offer": 0, "function": [0, 5, 11, 17, 19, 20, 24, 26, 27, 29, 30, 31, 34], "creat": [0, 11, 19, 24, 29], "str": [0, 1, 5, 9, 12, 13, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 35], "ext": 0, "list": [0, 5, 12, 17, 21, 22, 24], "fn_pack": 0, "callabl": [0, 5], "fn_unpack": 0, "sourc": [0, 1, 5, 8, 9, 12, 13, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 34, 35], "regist": 0, "custom": [0, 5, 9, 15], "type": [0, 1, 5, 12, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 34, 35], "associ": 0, "paramet": [0, 1, 5, 8, 9, 12, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 34, 35], "A": [0, 21], "take": 0, "directori": [0, 1, 12, 19, 20, 22, 24, 27, 29, 35], "an": [0, 11, 17, 19, 20, 22, 24, 26, 31, 34, 35], "filenam": [0, 31, 33], "input": 0, "extract": [0, 22], "type_nam": 0, "archive_fil": 0, "silent": [0, 19, 22, 24, 27, 29, 31, 34], "bool": [0, 8, 17, 19, 20, 22, 24, 25, 27, 29, 30, 31, 34], "fals": [0, 17, 19, 20, 22, 24, 25, 27, 29, 30, 31, 34], "clear": [0, 24], "specifi": [0, 1, 11, 20, 24, 26, 29, 31], "result": 0, "true": [0, 17, 19, 20, 22, 24, 25, 27, 29, 30, 31, 34], "suppress": [0, 19, 22, 24, 27, 29, 31], "warn": [0, 5], "dure": [0, 29], "process": [0, 11, 29], "remov": [0, 24], "exist": [0, 17, 22], "when": [0, 13, 17, 19, 22, 24], "return": [0, 5, 17, 19, 20, 21, 25, 26, 30, 31, 33, 34, 35], "path": [0, 9, 15, 17, 19, 20, 21, 22, 24, 25, 27, 30, 31, 32, 35, 36], "password": [0, 22], "none": [0, 1, 5, 8, 9, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 31, 33], "content": [0, 34], "option": [0, 1, 5, 8, 9, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 31, 33, 34], "determin": 0, "base": [0, 10, 12, 20, 23, 28, 36], "rais": [0, 13, 17, 20, 26, 27, 29, 33], "valueerror": [0, 26, 33], "ani": [0, 1, 8, 29, 30, 33], "get": [0, 17, 19, 21, 31, 33], "repo_id": [1, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "repo_typ": [1, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "cache_dir": 1, "all": [1, 17, 22, 24, 27, 35], "detach": 1, "revis": [1, 17, 19, 20, 21, 22, 24, 25, 27, 29, 33], "from": [1, 5, 17, 19, 20, 21, 22, 26, 27, 31, 37, 38, 39], "match": [1, 17, 20, 25], "repositori": [1, 9, 11, 15, 17, 19, 20, 21, 22, 24, 25, 33, 36], "id": [1, 20, 26, 27, 29, 33], "where": [1, 20, 31], "store": [1, 11, 20, 27, 29], "default": [1, 19, 20, 22, 25, 26, 27, 29, 33], "huggingfac": [2, 20, 21, 22, 24, 26, 33, 36, 39], "local": [2, 13, 17, 19, 22, 24, 25, 27, 31, 37, 38], "can": [2, 17, 20, 26, 29, 39], "quickli": 2, "make": [2, 18, 20, 24, 36], "disk": 2, "space": [2, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "under": [2, 39], "control": 2, "delet": [2, 36], "delete_detached_cach": 2, "delete_cach": 2, "meta": [3, 17, 36, 39], "__title__": [3, 39], "__version__": [3, 39], "__description__": [3, 39], "__author__": [3, 39], "__author_email__": 3, "inform": [4, 5, 8, 17, 19, 20], "packag": [4, 26], "titl": 4, "thi": [4, 5, 9, 11, 15, 17, 19, 20, 24, 26, 27, 29, 30, 31, 33, 34, 37, 38], "project": 4, "should": [4, 31, 39], "version": [4, 8, 34, 39], "short": 4, "descript": [4, 31], "includ": [4, 5, 11, 17, 19, 26, 27, 29], "setup": 4, "py": 4, "author": 4, "email": 4, "help_option_nam": 5, "h": 5, "help": 5, "dict": [5, 17, 19], "new": 5, "empti": 5, "dictionari": [5, 17], "map": 5, "initi": 5, "object": [5, 12, 17, 21, 22, 24, 31], "": [5, 8, 17, 24], "kei": [5, 17], "valu": [5, 8, 12, 19, 24], "pair": 5, "iter": [5, 35], "via": 5, "d": 5, "k": 5, "v": 5, "kwarg": [5, 8, 31, 34], "keyword": [5, 31, 34], "argument": [5, 17, 31, 34], "For": 5, "exampl": [5, 17], "one": 5, "1": [5, 12, 19, 20, 37, 38], "two": 5, "2": [5, 12], "class": [5, 9, 12, 13, 15, 17, 33], "messag": [5, 9, 13, 15, 19, 24], "except": [5, 9, 13, 15, 17], "displai": [5, 9, 15, 31, 34], "yellow": 5, "color": 5, "error": [5, 9, 15], "exit_cod": [5, 9, 15], "exit": [5, 9, 15], "show": [5, 9, 15], "io": [5, 9, 15, 39], "write": [5, 9, 15], "output": [5, 9, 15, 22, 24, 27, 29, 31, 34, 39], "red": [5, 9, 15], "err": 5, "baseexcept": 5, "print": [5, 8, 37, 38, 39], "traceback": 5, "provid": [5, 11, 26, 27, 29, 31], "built": 5, "msg": 5, "handl": 5, "keyboard": 5, "interrupt": 5, "__init__": 5, "7": 5, "decor": 5, "wrap": 5, "click": [5, 8, 11], "command": [5, 27, 29, 39], "catch": 5, "consist": 5, "group": 6, "hfutilcli": [6, 10], "ctx": 8, "context": 8, "param": 8, "cli": [8, 10, 11, 36], "current": [8, 37, 38, 39], "metadata": 8, "arg": [8, 34], "indic": [9, 15], "remot": [9, 15, 29], "assign": [9, 15, 17, 21, 22, 24], "17": 9, "context_set": 10, "clickwarningexcept": 10, "clickerrorexcept": 10, "print_except": 10, "keyboardinterrupt": 10, "command_wrap": 10, "clone": [10, 28, 29, 36], "dispatch": [10, 36], "print_vers": 10, "download": [10, 17, 20, 23, 27, 32, 36], "noremotepathassignedwithdownload": 10, "index": [10, 36, 39], "l": [10, 36], "listitemtyp": 10, "listitem": 10, "ls_repo": [10, 36], "nolocalauthent": 10, "upload": [10, 11, 19, 23, 36], "noremotepathassignedwithupload": 10, "whoami": [10, 36], "rollback": [10, 28, 36], "modul": [11, 26, 27, 29, 36], "archiv": [11, 12, 17, 19, 20, 22, 24, 36], "hug": [11, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29], "face": [11, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29], "main": [11, 17, 19, 20, 21, 22, 24, 25, 27, 29, 39], "featur": [11, 24], "ad": 11, "subcommand": 11, "applic": 11, "minimum": 11, "interv": [11, 24], "between": 11, "system": [11, 21, 26], "client": [11, 21, 22, 24], "interact": 11, "enum": 12, "repres": [12, 17], "differ": [12, 17, 37, 38], "item": [12, 20], "valid": [12, 18, 23, 36], "ar": [12, 17], "folder": 12, "imag": [12, 17], "3": [12, 37, 38, 39], "4": [12, 37, 38], "model": [12, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "5": [12, 22, 24, 37, 38], "data": [12, 17, 24, 37, 38], "6": [12, 37, 38], "repofold": 12, "repofil": [12, 20], "base_dir": 12, "union": [12, 17], "authent": [13, 20, 27, 29], "token": [13, 17, 19, 20, 21, 22, 24, 25, 27, 29], "33": 15, "standalon": 17, "incomplet": 17, "hash": [17, 19, 20, 21, 22, 24, 29], "archive_in_repo": [17, 19, 20, 24], "liter": [17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "dataset": [17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "idx_repo_id": [17, 19, 20], "idx_file_in_repo": [17, 19, 20], "idx_repo_typ": [17, 19, 20], "idx_revis": [17, 19, 20], "hf_token": [17, 19, 20, 21, 22, 24, 25, 27, 29], "identifi": [17, 19, 21, 22, 24, 25], "repotypetyp": [17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "access": [17, 19], "import": [17, 37, 38, 39], "idx": 17, "deepgh": [17, 39], "danbooru_newest": 17, "0000": 17, "dict_kei": 17, "files": 17, "hash_lf": [17, 20], "7507000": 17, "jpg": 17, "7506000": 17, "7505000": 17, "besid": 17, "also": [17, 31, 39], "explicitli": 17, "nyanko7": 17, "danbooru2023": 17, "danbooru2023_index": 17, "origin": 17, "1000": 17, "png": 17, "10000": 17, "100000": 17, "insid": 17, "file_in_arch": 17, "check": [17, 20, 25, 26, 29, 30, 31, 39], "otherwis": [17, 20, 25, 31], "17506000": 17, "10000000001000": 17, "int": [17, 19, 20, 22, 24, 27, 31], "size": [17, 19, 20, 24, 31, 37, 38], "integ": 17, "filenotfounderror": 17, "435671": 17, "11966": 17, "detail": 17, "offset": 17, "sha256": 17, "265728": 17, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 17, "1024": [17, 30], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 17, "local_fil": [17, 22, 24, 25], "proxi": 17, "user_ag": 17, "header": 17, "endpoint": [17, 26, 27, 29], "save": [17, 19, 22, 31], "http": [17, 26, 39], "request": [17, 31], "user": 17, "agent": 17, "addit": [17, 31, 34], "api": [17, 20, 21, 22, 24, 25], "test_exampl": 17, "destin": 17, "given": [17, 21, 30, 31, 33], "fetch": [18, 27, 36], "archivestandalonefileincompletedownload": 18, "archivestandalonefilehashnotmatch": 18, "hf_tar_get_index": 18, "hf_tar_list_fil": 18, "hf_tar_file_exist": 18, "hf_tar_file_s": 18, "hf_tar_file_info": 18, "hf_tar_file_download": 18, "tar_create_index": 18, "hf_tar_create_index": [18, 20], "tar_get_index_info": 18, "hf_tar_create_from_directori": 18, "hf_tar_item_valid": 18, "hf_tar_valid": 18, "src_tar_fil": 19, "dst_index_fil": 19, "chunk_for_hash": 19, "1048576": 19, "with_hash": 19, "chunk": [19, 24], "20": 19, "mb": 19, "whether": 19, "progress": [19, 22, 24, 31, 34], "bar": [19, 22, 24, 31, 34], "log": 19, "skip_when_sync": 19, "skip": [19, 27], "sync": 19, "readi": [19, 25], "directli": 19, "json": [19, 20], "local_directori": [19, 22, 24], "file_item": 20, "hash_": 20, "expect": [20, 31], "sha": 20, "256": 20, "lf": [20, 26, 27, 29], "entrynotfounderror": 20, "entri": [20, 36], "found": 20, "isadirectoryerror": 20, "mean": [20, 39], "expir": 20, "need": 20, "re": 20, "gener": [20, 26], "so": [20, 24], "togeth": 20, "gracefulli": 20, "refresh": 20, "hfapi": 21, "variabl": [21, 22, 24], "hffilesystem": 21, "subdir": 21, "ignore_pattern": [21, 22, 24], "subdirectori": 21, "e": [21, 22, 24], "g": [21, 22, 24], "branch": [21, 22, 24, 29], "tag": [21, 22, 24, 29], "commit": [21, 22, 24, 27, 29], "pattern": [21, 22, 24], "ignor": [21, 22, 24], "file_in_repo": [22, 24, 25], "resume_download": 22, "within": [22, 24], "resum": 22, "dir_in_repo": 22, "max_work": 22, "8": [22, 37, 38, 39], "max_retri": 22, "max": 22, "worker": 22, "retri": 22, "time": [22, 24], "get_hf_client": 23, "get_hf_f": 23, "list_files_in_repositori": 23, "download_file_to_fil": 23, "download_archive_as_directori": 23, "download_directory_as_directori": 23, "upload_file_to_fil": 23, "upload_directory_as_arch": 23, "upload_directory_as_directori": 23, "is_local_file_readi": 23, "path_in_repo": 24, "time_suffix": 24, "operation_chunk_s": 24, "upload_timespan": 24, "float": 24, "0": [24, 27, 37, 38, 39], "its": 24, "append": 24, "timestamp": 24, "present": 24, "seper": 24, "multipl": 24, "set": 24, "minim": 24, "enabl": 24, "some": [24, 28, 37, 38], "fail": [24, 27, 29], "roll": 24, "back": [24, 29], "startup": 24, "hf_hub_rollback": [24, 28], "But": 24, "cannot": 24, "guarante": 24, "atom": 24, "your": [24, 37, 38, 39], "thread": 24, "safe": 24, "rate": 24, "limit": 24, "approxim": 24, "120": 24, "hour": 24, "realli": 24, "have": 24, "larg": 24, "number": [24, 27], "pleas": [24, 37, 38], "less": 24, "than": 24, "30": 24, "sure": 24, "compar": 25, "hub": [25, 26, 27, 29], "work": 26, "git": [26, 27, 28, 29, 39], "It": [26, 27, 29, 31, 39], "url": [26, 31], "git_info": 26, "hbutil": [26, 37, 38], "constant": 26, "huggingface_hub": 26, "full": 26, "unknown": 26, "usag": [26, 27, 29], "usernam": [26, 27, 29], "repo": [26, 27, 29], "co": 26, "other": 27, "dst_dir": 27, "no_lf": 27, "max_depth": 27, "specif": [27, 29], "attempt": [27, 29], "credenti": [27, 29], "maximum": 27, "subprocess": [27, 29], "calledprocesserror": [27, 29], "dir": 27, "v1": 27, "oper": [28, 29, 36], "hf_hub_repo_url": 28, "hf_hub_clon": 28, "reset": 29, "forc": 29, "push": 29, "chang": 29, "rollback_to": 29, "refer": 29, "abc123": 29, "perform": [29, 31, 37, 38], "step": 29, "without": 29, "temporari": 29, "hard": 29, "overwrit": 29, "histori": 29, "cancel": 29, "caution": 29, "read": 30, "first": 30, "byte": [30, 31], "contain": 30, "non": 30, "text": 30, "charact": 30, "expected_s": 31, "desc": 31, "session": 31, "tqdm": [31, 32, 36], "ensur": 31, "ha": [31, 37, 38], "pass": [31, 34], "binari": [32, 36], "is_binary_fil": 32, "download_fil": 32, "hf_normpath": 32, "hf_fs_path": 32, "parse_hf_fs_path": 32, "hffilesystempath": 32, "walk": [32, 36], "walk_fil": 32, "normal": 33, "filesystem": 33, "pars": 33, "invalid": 33, "tqdm_": 34, "enhanc": 34, "silenc": 34, "modifi": 34, "behavior": 34, "allow": 34, "posit": 34, "std": 34, "recurs": 35, "through": [35, 39], "yield": 35, "rel": 35, "root": 35, "start": [35, 36], "quick": 36, "run": 36, "environ": 36, "register_archive_typ": 36, "archive_pack": 36, "archive_unpack": 36, "get_archive_typ": 36, "get_archive_extnam": 36, "cach": 36, "config": [36, 39], "here": [37, 38], "o": [37, 38], "platform": [37, 38], "shutil": [37, 38], "cpuinfo": [37, 38], "psutil": [37, 38], "scale": [37, 38], "size_to_bytes_str": [37, 38], "python": [37, 38, 39], "python_implement": [37, 38], "python_vers": [37, 38], "cpu": [37, 38], "brand": [37, 38], "get_cpu_info": [37, 38], "brand_raw": [37, 38], "count": [37, 38], "cpu_count": [37, 38], "freq": [37, 38], "cpu_freq": [37, 38], "mhz": [37, 38], "memori": [37, 38], "virtual_memori": [37, 38], "total": [37, 38], "precis": [37, 38], "cuda": [37, 38], "ye": [37, 38], "nvidia": [37, 38], "smi": [37, 38], "els": [37, 38], "No": [37, 38], "linux": [37, 38], "1023": [37, 38], "azur": [37, 38], "x86_64": [37, 38], "glibc2": [37, 38], "34": [37, 38], "cpython": [37, 38], "18": [37, 38], "amd": [37, 38], "epyc": [37, 38], "7763": [37, 38], "64": [37, 38], "core": [37, 38], "processor": [37, 38], "2784": 37, "103": 37, "15": [37, 38], "606": [37, 38], "gib": [37, 38], "note": [37, 38], "deploi": [37, 38], "document": [37, 38, 39], "automat": [37, 38], "execut": [37, 38], "github": [37, 38, 39], "action": [37, 38], "therefor": [37, 38], "mai": [37, 38], "2783": 38, "6985": 38, "hfutil": 39, "host": 39, "pypi": 39, "newest": 39, "u": 39, "com": 39, "script": 39, "__name__": 39, "__main__": 39, "develop": 39, "maintain": 39, "like": 39, "below": 39, "success": 39, "narugo1992": 39, "still": 39, "out": 39, "stabl": 39, "html": 39, "faq": 40}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [2, 0, 0, "-", "cache"], [3, 0, 0, "-", "config"], [10, 0, 0, "-", "entry"], [18, 0, 0, "-", "index"], [23, 0, 0, "-", "operate"], [28, 0, 0, "-", "repository"], [32, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.cache": [[1, 0, 0, "-", "delete"]], "hfutils.cache.delete": [[1, 1, 1, "", "delete_cache"], [1, 1, 1, "", "delete_detached_cache"]], "hfutils.config": [[4, 0, 0, "-", "meta"]], "hfutils.config.meta": [[4, 2, 1, "", "__AUTHOR_EMAIL__"], [4, 2, 1, "", "__AUTHOR__"], [4, 2, 1, "", "__DESCRIPTION__"], [4, 2, 1, "", "__TITLE__"], [4, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[5, 0, 0, "-", "base"], [6, 0, 0, "-", "cli"], [7, 0, 0, "-", "clone"], [8, 0, 0, "-", "dispatch"], [9, 0, 0, "-", "download"], [11, 0, 0, "-", "index"], [12, 0, 0, "-", "ls"], [13, 0, 0, "-", "ls_repo"], [14, 0, 0, "-", "rollback"], [15, 0, 0, "-", "upload"], [16, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[5, 2, 1, "", "CONTEXT_SETTINGS"], [5, 3, 1, "", "ClickErrorException"], [5, 3, 1, "", "ClickWarningException"], [5, 3, 1, "", "KeyboardInterrupted"], [5, 1, 1, "", "command_wrap"], [5, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[5, 5, 1, "", "__init__"], [5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.cli": [[6, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[8, 1, 1, "", "hfutilcli"], [8, 1, 1, "", "print_version"]], "hfutils.entry.download": [[9, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.entry.ls": [[12, 3, 1, "", "ListItem"], [12, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[12, 4, 1, "", "ARCHIVE"], [12, 4, 1, "", "DATA"], [12, 4, 1, "", "FILE"], [12, 4, 1, "", "FOLDER"], [12, 4, 1, "", "IMAGE"], [12, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[13, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[15, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[15, 4, 1, "", "exit_code"], [15, 5, 1, "", "show"]], "hfutils.index": [[17, 0, 0, "-", "fetch"], [19, 0, 0, "-", "make"], [20, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[17, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [17, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [17, 1, 1, "", "hf_tar_file_download"], [17, 1, 1, "", "hf_tar_file_exists"], [17, 1, 1, "", "hf_tar_file_info"], [17, 1, 1, "", "hf_tar_file_size"], [17, 1, 1, "", "hf_tar_get_index"], [17, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[19, 1, 1, "", "hf_tar_create_from_directory"], [19, 1, 1, "", "hf_tar_create_index"], [19, 1, 1, "", "tar_create_index"], [19, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[20, 1, 1, "", "hf_tar_item_validate"], [20, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[21, 0, 0, "-", "base"], [22, 0, 0, "-", "download"], [24, 0, 0, "-", "upload"], [25, 0, 0, "-", "validate"]], "hfutils.operate.base": [[21, 1, 1, "", "get_hf_client"], [21, 1, 1, "", "get_hf_fs"], [21, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[22, 1, 1, "", "download_archive_as_directory"], [22, 1, 1, "", "download_directory_as_directory"], [22, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[24, 1, 1, "", "upload_directory_as_archive"], [24, 1, 1, "", "upload_directory_as_directory"], [24, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[25, 1, 1, "", "is_local_file_ready"]], "hfutils.repository": [[26, 0, 0, "-", "base"], [27, 0, 0, "-", "clone"], [29, 0, 0, "-", "rollback"]], "hfutils.repository.base": [[26, 1, 1, "", "hf_hub_repo_url"]], "hfutils.repository.clone": [[27, 1, 1, "", "hf_hub_clone"]], "hfutils.repository.rollback": [[29, 1, 1, "", "hf_hub_rollback"]], "hfutils.utils": [[30, 0, 0, "-", "binary"], [31, 0, 0, "-", "download"], [33, 0, 0, "-", "path"], [34, 0, 0, "-", "tqdm_"], [35, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[30, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[31, 1, 1, "", "download_file"]], "hfutils.utils.path": [[33, 3, 1, "", "HfFileSystemPath"], [33, 1, 1, "", "hf_fs_path"], [33, 1, 1, "", "hf_normpath"], [33, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[34, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[35, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "cach": [1, 2], "delet": 1, "delete_detached_cach": 1, "delete_cach": 1, "config": [3, 4], "meta": 4, "__title__": 4, "__version__": 4, "__description__": 4, "__author__": 4, "__author_email__": 4, "entri": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "base": [5, 21, 26], "context_set": 5, "clickwarningexcept": 5, "clickerrorexcept": 5, "print_except": 5, "keyboardinterrupt": 5, "command_wrap": 5, "cli": 6, "clone": [7, 27], "dispatch": 8, "print_vers": 8, "hfutilcli": 8, "download": [9, 22, 31], "noremotepathassignedwithdownload": 9, "index": [11, 17, 18, 19, 20], "l": 12, "listitemtyp": 12, "listitem": 12, "ls_repo": 13, "nolocalauthent": 13, "rollback": [14, 29], "upload": [15, 24], "noremotepathassignedwithupload": 15, "whoami": 16, "fetch": 17, "archivestandalonefileincompletedownload": 17, "archivestandalonefilehashnotmatch": 17, "hf_tar_get_index": 17, "hf_tar_list_fil": 17, "hf_tar_file_exist": 17, "hf_tar_file_s": 17, "hf_tar_file_info": 17, "hf_tar_file_download": 17, "make": 19, "tar_create_index": 19, "hf_tar_create_index": 19, "tar_get_index_info": 19, "hf_tar_create_from_directori": 19, "valid": [20, 25], "hf_tar_item_valid": 20, "hf_tar_valid": 20, "oper": [21, 22, 23, 24, 25], "get_hf_client": 21, "get_hf_f": 21, "list_files_in_repositori": 21, "download_file_to_fil": 22, "download_archive_as_directori": 22, "download_directory_as_directori": 22, "upload_file_to_fil": 24, "upload_directory_as_arch": 24, "upload_directory_as_directori": 24, "is_local_file_readi": 25, "repositori": [26, 27, 28, 29], "hf_hub_repo_url": 26, "hf_hub_clon": 27, "hf_hub_rollback": 29, "util": [30, 31, 32, 33, 34, 35], "binari": 30, "is_binary_fil": 30, "download_fil": 31, "path": 33, "hf_normpath": 33, "hf_fs_path": 33, "parse_hf_fs_path": 33, "hffilesystempath": 33, "tqdm": 34, "walk": 35, "walk_fil": 35, "welcom": 36, "": 36, "document": 36, "overview": 36, "tutori": 36, "inform": [36, 37, 38], "api": 36, "run": [37, 38], "environ": [37, 38], "instal": 39, "quick": 40, "start": 40}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "delete_detached_cache": [[1, "delete-detached-cache"]], "delete_cache": [[1, "delete-cache"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "__TITLE__": [[4, "title"]], "__VERSION__": [[4, "version"]], "__DESCRIPTION__": [[4, "description"]], "__AUTHOR__": [[4, "author"]], "__AUTHOR_EMAIL__": [[4, "author-email"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[5, "context-settings"]], "ClickWarningException": [[5, "clickwarningexception"]], "ClickErrorException": [[5, "clickerrorexception"]], "print_exception": [[5, "print-exception"]], "KeyboardInterrupted": [[5, "keyboardinterrupted"]], "command_wrap": [[5, "command-wrap"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "cli": [[6, "cli"]], "hfutils.entry.clone": [[7, "module-hfutils.entry.clone"]], "hfutils.entry.dispatch": [[8, "module-hfutils.entry.dispatch"]], "print_version": [[8, "print-version"]], "hfutilcli": [[8, "hfutilcli"]], "hfutils.entry.download": [[9, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[9, "noremotepathassignedwithdownload"]], "hfutils.entry": [[10, "module-hfutils.entry"]], "hfutils.entry.index": [[11, "module-hfutils.entry.index"]], "hfutils.entry.ls": [[12, "module-hfutils.entry.ls"]], "ListItemType": [[12, "listitemtype"]], "ListItem": [[12, "listitem"]], "hfutils.entry.ls_repo": [[13, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[13, "nolocalauthentication"]], "hfutils.entry.rollback": [[14, "module-hfutils.entry.rollback"]], "hfutils.entry.upload": [[15, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[15, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[16, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[17, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[17, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[17, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[17, "hf-tar-get-index"]], "hf_tar_list_files": [[17, "hf-tar-list-files"]], "hf_tar_file_exists": [[17, "hf-tar-file-exists"]], "hf_tar_file_size": [[17, "hf-tar-file-size"]], "hf_tar_file_info": [[17, "hf-tar-file-info"]], "hf_tar_file_download": [[17, "hf-tar-file-download"]], "hfutils.index": [[18, "module-hfutils.index"]], "hfutils.index.make": [[19, "module-hfutils.index.make"]], "tar_create_index": [[19, "tar-create-index"]], "hf_tar_create_index": [[19, "hf-tar-create-index"]], "tar_get_index_info": [[19, "tar-get-index-info"]], "hf_tar_create_from_directory": [[19, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[20, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[20, "hf-tar-item-validate"]], "hf_tar_validate": [[20, "hf-tar-validate"]], "hfutils.operate.base": [[21, "module-hfutils.operate.base"]], "get_hf_client": [[21, "get-hf-client"]], "get_hf_fs": [[21, "get-hf-fs"]], "list_files_in_repository": [[21, "list-files-in-repository"]], "hfutils.operate.download": [[22, "module-hfutils.operate.download"]], "download_file_to_file": [[22, "download-file-to-file"]], "download_archive_as_directory": [[22, "download-archive-as-directory"]], "download_directory_as_directory": [[22, "download-directory-as-directory"]], "hfutils.operate": [[23, "module-hfutils.operate"]], "hfutils.operate.upload": [[24, "module-hfutils.operate.upload"]], "upload_file_to_file": [[24, "upload-file-to-file"]], "upload_directory_as_archive": [[24, "upload-directory-as-archive"]], "upload_directory_as_directory": [[24, "upload-directory-as-directory"]], "hfutils.operate.validate": [[25, "module-hfutils.operate.validate"]], "is_local_file_ready": [[25, "is-local-file-ready"]], "hfutils.repository.base": [[26, "module-hfutils.repository.base"]], "hf_hub_repo_url": [[26, "hf-hub-repo-url"]], "hfutils.repository.clone": [[27, "module-hfutils.repository.clone"]], "hf_hub_clone": [[27, "hf-hub-clone"]], "hfutils.repository": [[28, "module-hfutils.repository"]], "hfutils.repository.rollback": [[29, "module-hfutils.repository.rollback"]], "hf_hub_rollback": [[29, "hf-hub-rollback"]], "hfutils.utils.binary": [[30, "module-hfutils.utils.binary"]], "is_binary_file": [[30, "is-binary-file"]], "hfutils.utils.download": [[31, "module-hfutils.utils.download"]], "download_file": [[31, "download-file"]], "hfutils.utils": [[32, "module-hfutils.utils"]], "hfutils.utils.path": [[33, "module-hfutils.utils.path"]], "hf_normpath": [[33, "hf-normpath"]], "hf_fs_path": [[33, "hf-fs-path"]], "parse_hf_fs_path": [[33, "parse-hf-fs-path"]], "HfFileSystemPath": [[33, "hffilesystempath"]], "hfutils.utils.tqdm": [[34, "module-hfutils.utils.tqdm_"]], "tqdm": [[34, "tqdm"]], "hfutils.utils.walk": [[35, "module-hfutils.utils.walk"]], "walk_files": [[35, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[36, "welcome-to-hfutils-s-documentation"]], "Overview": [[36, "overview"]], "Tutorials": [[36, null]], "Information": [[36, null]], "API Documentation": [[36, null]], "Run Environment Information": [[37, "Run-Environment-Information"], [38, "Run-Environment-Information"]], "Installation": [[39, "installation"]], "Quick Start": [[40, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.cache.delete"], [2, "module-hfutils.cache"], [3, "module-hfutils.config"], [4, "module-hfutils.config.meta"], [5, "module-hfutils.entry.base"], [6, "module-hfutils.entry.cli"], [7, "module-hfutils.entry.clone"], [8, "module-hfutils.entry.dispatch"], [9, "module-hfutils.entry.download"], [10, "module-hfutils.entry"], [11, "module-hfutils.entry.index"], [12, "module-hfutils.entry.ls"], [13, "module-hfutils.entry.ls_repo"], [14, "module-hfutils.entry.rollback"], [15, "module-hfutils.entry.upload"], [16, "module-hfutils.entry.whoami"], [17, "module-hfutils.index.fetch"], [18, "module-hfutils.index"], [19, "module-hfutils.index.make"], [20, "module-hfutils.index.validate"], [21, "module-hfutils.operate.base"], [22, "module-hfutils.operate.download"], [23, "module-hfutils.operate"], [24, "module-hfutils.operate.upload"], [25, "module-hfutils.operate.validate"], [26, "module-hfutils.repository.base"], [27, "module-hfutils.repository.clone"], [28, "module-hfutils.repository"], [29, "module-hfutils.repository.rollback"], [30, "module-hfutils.utils.binary"], [31, "module-hfutils.utils.download"], [32, "module-hfutils.utils"], [33, "module-hfutils.utils.path"], [34, "module-hfutils.utils.tqdm_"], [35, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "delete_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_cache"]], "delete_detached_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_detached_cache"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[5, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[5, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[5, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[5, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[5, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[5, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[5, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[6, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "hfutils.entry.clone": [[7, "module-hfutils.entry.clone"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[8, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[8, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[8, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[9, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[9, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[9, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[9, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[10, "module-hfutils.entry"]], "hfutils.entry.index": [[11, "module-hfutils.entry.index"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[12, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[12, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[13, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[13, "module-hfutils.entry.ls_repo"]], "hfutils.entry.rollback": [[14, "module-hfutils.entry.rollback"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[15, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[15, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[15, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[15, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[16, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[17, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[17, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[17, "module-hfutils.index.fetch"]], "hfutils.index": [[18, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[19, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[19, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[19, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[19, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[19, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[20, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[20, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[20, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[21, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[21, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[21, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[21, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[22, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[22, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[22, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[22, "module-hfutils.operate.download"]], "hfutils.operate": [[23, "module-hfutils.operate"]], "hfutils.operate.upload": [[24, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[24, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[24, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[24, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[25, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[25, "hfutils.operate.validate.is_local_file_ready"]], "hf_hub_repo_url() (in module hfutils.repository.base)": [[26, "hfutils.repository.base.hf_hub_repo_url"]], "hfutils.repository.base": [[26, "module-hfutils.repository.base"]], "hf_hub_clone() (in module hfutils.repository.clone)": [[27, "hfutils.repository.clone.hf_hub_clone"]], "hfutils.repository.clone": [[27, "module-hfutils.repository.clone"]], "hfutils.repository": [[28, "module-hfutils.repository"]], "hf_hub_rollback() (in module hfutils.repository.rollback)": [[29, "hfutils.repository.rollback.hf_hub_rollback"]], "hfutils.repository.rollback": [[29, "module-hfutils.repository.rollback"]], "hfutils.utils.binary": [[30, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[30, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[31, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[31, "module-hfutils.utils.download"]], "hfutils.utils": [[32, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[33, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[33, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[33, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[33, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[33, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[34, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[34, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[35, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[35, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api_doc/archive/index", "api_doc/cache/delete", "api_doc/cache/index", "api_doc/config/index", "api_doc/config/meta", "api_doc/entry/base", "api_doc/entry/cli", "api_doc/entry/clone", "api_doc/entry/dispatch", "api_doc/entry/download", "api_doc/entry/index", "api_doc/entry/index_", "api_doc/entry/ls", "api_doc/entry/ls_repo", "api_doc/entry/rollback", "api_doc/entry/upload", "api_doc/entry/whoami", "api_doc/index/fetch", "api_doc/index/index", "api_doc/index/make", "api_doc/index/validate", "api_doc/operate/base", "api_doc/operate/download", "api_doc/operate/index", "api_doc/operate/upload", "api_doc/operate/validate", "api_doc/repository/base", "api_doc/repository/clone", "api_doc/repository/index", "api_doc/repository/rollback", "api_doc/utils/binary", "api_doc/utils/download", "api_doc/utils/index", "api_doc/utils/path", "api_doc/utils/tqdm_", "api_doc/utils/walk", "index", "information/environment", "information/environment.result", "tutorials/installation/index", "tutorials/quick_start/index"], "filenames": ["api_doc/archive/index.rst", "api_doc/cache/delete.rst", "api_doc/cache/index.rst", "api_doc/config/index.rst", "api_doc/config/meta.rst", "api_doc/entry/base.rst", "api_doc/entry/cli.rst", "api_doc/entry/clone.rst", "api_doc/entry/dispatch.rst", "api_doc/entry/download.rst", "api_doc/entry/index.rst", "api_doc/entry/index_.rst", "api_doc/entry/ls.rst", "api_doc/entry/ls_repo.rst", "api_doc/entry/rollback.rst", "api_doc/entry/upload.rst", "api_doc/entry/whoami.rst", "api_doc/index/fetch.rst", "api_doc/index/index.rst", "api_doc/index/make.rst", "api_doc/index/validate.rst", "api_doc/operate/base.rst", "api_doc/operate/download.rst", "api_doc/operate/index.rst", "api_doc/operate/upload.rst", "api_doc/operate/validate.rst", "api_doc/repository/base.rst", "api_doc/repository/clone.rst", "api_doc/repository/index.rst", "api_doc/repository/rollback.rst", "api_doc/utils/binary.rst", "api_doc/utils/download.rst", "api_doc/utils/index.rst", "api_doc/utils/path.rst", "api_doc/utils/tqdm_.rst", "api_doc/utils/walk.rst", "index.rst", "information/environment.ipynb", "information/environment.result.ipynb", "tutorials/installation/index.rst", "tutorials/quick_start/index.rst"], "titles": ["hfutils.archive", "hfutils.cache.delete", "hfutils.cache", "hfutils.config", "hfutils.config.meta", "hfutils.entry.base", "hfutils.entry.cli", "hfutils.entry.clone", "hfutils.entry.dispatch", "hfutils.entry.download", "hfutils.entry", "hfutils.entry.index", "hfutils.entry.ls", "hfutils.entry.ls_repo", "hfutils.entry.rollback", "hfutils.entry.upload", "hfutils.entry.whoami", "hfutils.index.fetch", "hfutils.index", "hfutils.index.make", "hfutils.index.validate", "hfutils.operate.base", "hfutils.operate.download", "hfutils.operate", "hfutils.operate.upload", "hfutils.operate.validate", "hfutils.repository.base", "hfutils.repository.clone", "hfutils.repository", "hfutils.repository.rollback", "hfutils.utils.binary", "hfutils.utils.download", "hfutils.utils", "hfutils.utils.path", "hfutils.utils.tqdm", "hfutils.utils.walk", "Welcome to hfutils\u2019s Documentation", "Run Environment Information", "Run Environment Information", "Installation", "Quick Start"], "terms": {"overview": [0, 2, 4, 28], "pack": 0, "unpack": 0, "manag": [0, 2, 11], "support": 0, "format": 0, "extens": 0, "name": [0, 5], "7z": 0, "bztar": 0, "tar": [0, 11, 17, 19, 20], "bz2": 0, "tbz2": 0, "gztar": 0, "gz": 0, "tgz": 0, "rar": 0, "xztar": 0, "xz": 0, "txz": 0, "zip": 0, "If": [0, 1, 5, 20, 22, 24, 26, 27, 29, 31, 33, 34], "you": [0, 17, 24, 39], "requir": [0, 29, 39], "simpli": [0, 39], "instal": [0, 26, 29, 36], "us": [0, 1, 5, 11, 17, 19, 20, 21, 22, 24, 26, 27, 29, 31, 36, 39], "follow": [0, 12, 29, 39], "code": [0, 5, 9, 15], "pip": [0, 39], "The": [0, 1, 5, 9, 11, 12, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 35, 39], "creation": [0, 24], "file": [0, 5, 9, 11, 12, 15, 17, 19, 20, 21, 22, 24, 25, 27, 30, 31, 35], "i": [0, 1, 9, 13, 15, 17, 19, 20, 22, 24, 25, 26, 30, 33, 36, 37, 38, 39], "we": 0, "util": [0, 26, 36, 39], "rarfil": 0, "librari": [0, 31], "which": [0, 17, 37, 38, 39], "doe": [0, 17], "offer": 0, "function": [0, 5, 11, 17, 19, 20, 24, 26, 27, 29, 30, 31, 34], "creat": [0, 11, 19, 24, 29], "str": [0, 1, 5, 9, 12, 13, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 35], "ext": 0, "list": [0, 5, 12, 17, 21, 22, 24], "fn_pack": 0, "callabl": [0, 5], "fn_unpack": 0, "sourc": [0, 1, 5, 8, 9, 12, 13, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 34, 35], "regist": 0, "custom": [0, 5, 9, 15], "type": [0, 1, 5, 12, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 34, 35], "associ": 0, "paramet": [0, 1, 5, 8, 9, 12, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 30, 31, 33, 34, 35], "A": [0, 21], "take": 0, "directori": [0, 1, 12, 19, 20, 22, 24, 27, 29, 35], "an": [0, 11, 17, 19, 20, 22, 24, 26, 31, 34, 35], "filenam": [0, 31, 33], "input": 0, "extract": [0, 22], "type_nam": 0, "archive_fil": 0, "silent": [0, 19, 22, 24, 27, 29, 31, 34], "bool": [0, 8, 17, 19, 20, 22, 24, 25, 27, 29, 30, 31, 34], "fals": [0, 17, 19, 20, 22, 24, 25, 27, 29, 30, 31, 34], "clear": [0, 24], "specifi": [0, 1, 11, 20, 24, 26, 29, 31], "result": 0, "true": [0, 17, 19, 20, 22, 24, 25, 27, 29, 30, 31, 34], "suppress": [0, 19, 22, 24, 27, 29, 31], "warn": [0, 5], "dure": [0, 29], "process": [0, 11, 29], "remov": [0, 24], "exist": [0, 17, 22], "when": [0, 13, 17, 19, 22, 24], "return": [0, 5, 17, 19, 20, 21, 25, 26, 30, 31, 33, 34, 35], "path": [0, 9, 15, 17, 19, 20, 21, 22, 24, 25, 27, 30, 31, 32, 35, 36], "password": [0, 22], "none": [0, 1, 5, 8, 9, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 31, 33], "content": [0, 34], "option": [0, 1, 5, 8, 9, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 31, 33, 34], "determin": 0, "base": [0, 10, 12, 20, 23, 28, 36], "rais": [0, 13, 17, 20, 26, 27, 29, 33], "valueerror": [0, 26, 33], "ani": [0, 1, 8, 29, 30, 33], "get": [0, 17, 19, 21, 31, 33], "repo_id": [1, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "repo_typ": [1, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "cache_dir": 1, "all": [1, 17, 22, 24, 27, 35], "detach": 1, "revis": [1, 17, 19, 20, 21, 22, 24, 25, 27, 29, 33], "from": [1, 5, 17, 19, 20, 21, 22, 26, 27, 31, 37, 38, 39], "match": [1, 17, 20, 25], "repositori": [1, 9, 11, 15, 17, 19, 20, 21, 22, 24, 25, 33, 36], "id": [1, 20, 26, 27, 29, 33], "where": [1, 20, 31], "store": [1, 11, 20, 27, 29], "default": [1, 19, 20, 22, 25, 26, 27, 29, 33], "huggingfac": [2, 20, 21, 22, 24, 26, 33, 36, 39], "local": [2, 13, 17, 19, 22, 24, 25, 27, 31, 37, 38], "can": [2, 17, 20, 26, 29, 39], "quickli": 2, "make": [2, 18, 20, 24, 36], "disk": 2, "space": [2, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "under": [2, 39], "control": 2, "delet": [2, 36], "delete_detached_cach": 2, "delete_cach": 2, "meta": [3, 17, 36, 39], "__title__": [3, 39], "__version__": [3, 39], "__description__": [3, 39], "__author__": [3, 39], "__author_email__": 3, "inform": [4, 5, 8, 17, 19, 20], "packag": [4, 26], "titl": 4, "thi": [4, 5, 9, 11, 15, 17, 19, 20, 24, 26, 27, 29, 30, 31, 33, 34, 37, 38], "project": 4, "should": [4, 31, 39], "version": [4, 8, 34, 39], "short": 4, "descript": [4, 31], "includ": [4, 5, 11, 17, 19, 26, 27, 29], "setup": 4, "py": 4, "author": 4, "email": 4, "help_option_nam": 5, "h": 5, "help": 5, "dict": [5, 17, 19], "new": 5, "empti": 5, "dictionari": [5, 17], "map": 5, "initi": 5, "object": [5, 12, 17, 21, 22, 24, 31], "": [5, 8, 17, 24], "kei": [5, 17], "valu": [5, 8, 12, 19, 24], "pair": 5, "iter": [5, 35], "via": 5, "d": 5, "k": 5, "v": 5, "kwarg": [5, 8, 31, 34], "keyword": [5, 31, 34], "argument": [5, 17, 31, 34], "For": 5, "exampl": [5, 17], "one": 5, "1": [5, 12, 19, 20, 37, 38], "two": 5, "2": [5, 12], "class": [5, 9, 12, 13, 15, 17, 33], "messag": [5, 9, 13, 15, 19, 24], "except": [5, 9, 13, 15, 17], "displai": [5, 9, 15, 31, 34], "yellow": 5, "color": 5, "error": [5, 9, 15], "exit_cod": [5, 9, 15], "exit": [5, 9, 15], "show": [5, 9, 15], "io": [5, 9, 15, 39], "write": [5, 9, 15], "output": [5, 9, 15, 22, 24, 27, 29, 31, 34, 39], "red": [5, 9, 15], "err": 5, "baseexcept": 5, "print": [5, 8, 37, 38, 39], "traceback": 5, "provid": [5, 11, 26, 27, 29, 31], "built": 5, "msg": 5, "handl": 5, "keyboard": 5, "interrupt": 5, "__init__": 5, "7": 5, "decor": 5, "wrap": 5, "click": [5, 8, 11], "command": [5, 27, 29, 39], "catch": 5, "consist": 5, "group": 6, "hfutilcli": [6, 10], "ctx": 8, "context": 8, "param": 8, "cli": [8, 10, 11, 36], "current": [8, 37, 38, 39], "metadata": 8, "arg": [8, 34], "indic": [9, 15], "remot": [9, 15, 29], "assign": [9, 15, 17, 21, 22, 24], "17": 9, "context_set": 10, "clickwarningexcept": 10, "clickerrorexcept": 10, "print_except": 10, "keyboardinterrupt": 10, "command_wrap": 10, "clone": [10, 28, 29, 36], "dispatch": [10, 36], "print_vers": 10, "download": [10, 17, 20, 23, 27, 32, 36], "noremotepathassignedwithdownload": 10, "index": [10, 36, 39], "l": [10, 36], "listitemtyp": 10, "listitem": 10, "ls_repo": [10, 36], "nolocalauthent": 10, "upload": [10, 11, 19, 23, 36], "noremotepathassignedwithupload": 10, "whoami": [10, 36], "rollback": [10, 28, 36], "modul": [11, 26, 27, 29, 36], "archiv": [11, 12, 17, 19, 20, 22, 24, 36], "hug": [11, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29], "face": [11, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29], "main": [11, 17, 19, 20, 21, 22, 24, 25, 27, 29, 39], "featur": [11, 24], "ad": 11, "subcommand": 11, "applic": 11, "minimum": 11, "interv": [11, 24], "between": 11, "system": [11, 21, 26], "client": [11, 21, 22, 24], "interact": 11, "enum": 12, "repres": [12, 17], "differ": [12, 17, 37, 38], "item": [12, 20], "valid": [12, 18, 23, 36], "ar": [12, 17], "folder": 12, "imag": [12, 17], "3": [12, 37, 38, 39], "4": [12, 37, 38], "model": [12, 17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "5": [12, 22, 24, 37, 38], "data": [12, 17, 24, 37, 38], "6": [12, 37, 38], "repofold": 12, "repofil": [12, 20], "base_dir": 12, "union": [12, 17], "authent": [13, 20, 27, 29], "token": [13, 17, 19, 20, 21, 22, 24, 25, 27, 29], "33": 15, "standalon": 17, "incomplet": 17, "hash": [17, 19, 20, 21, 22, 24, 29], "archive_in_repo": [17, 19, 20, 24], "liter": [17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "dataset": [17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "idx_repo_id": [17, 19, 20], "idx_file_in_repo": [17, 19, 20], "idx_repo_typ": [17, 19, 20], "idx_revis": [17, 19, 20], "hf_token": [17, 19, 20, 21, 22, 24, 25, 27, 29], "identifi": [17, 19, 21, 22, 24, 25], "repotypetyp": [17, 19, 20, 21, 22, 24, 25, 26, 27, 29, 33], "access": [17, 19], "import": [17, 37, 38, 39], "idx": 17, "deepgh": [17, 39], "danbooru_newest": 17, "0000": 17, "dict_kei": 17, "files": 17, "hash_lf": [17, 20], "7507000": 17, "jpg": 17, "7506000": 17, "7505000": 17, "besid": 17, "also": [17, 31, 39], "explicitli": 17, "nyanko7": 17, "danbooru2023": 17, "danbooru2023_index": 17, "origin": 17, "1000": 17, "png": 17, "10000": 17, "100000": 17, "insid": 17, "file_in_arch": 17, "check": [17, 20, 25, 26, 29, 30, 31, 39], "otherwis": [17, 20, 25, 31], "17506000": 17, "10000000001000": 17, "int": [17, 19, 20, 22, 24, 27, 31], "size": [17, 19, 20, 24, 31, 37, 38], "integ": 17, "filenotfounderror": 17, "435671": 17, "11966": 17, "detail": 17, "offset": 17, "sha256": 17, "265728": 17, "ef6a4e031fdffb705c8ce2c64e8cb8d993f431a887d7c1c0b1e6fa56e6107fcd": 17, "1024": [17, 30, 37, 38], "478d3313860519372f6a75ede287d4a7c18a2d851bbc79b3dd65caff4c716858": 17, "local_fil": [17, 22, 24, 25], "proxi": 17, "user_ag": 17, "header": 17, "endpoint": [17, 26, 27, 29], "save": [17, 19, 22, 31], "http": [17, 26, 39], "request": [17, 31], "user": 17, "agent": 17, "addit": [17, 31, 34], "api": [17, 20, 21, 22, 24, 25], "test_exampl": 17, "destin": 17, "given": [17, 21, 30, 31, 33], "fetch": [18, 27, 36], "archivestandalonefileincompletedownload": 18, "archivestandalonefilehashnotmatch": 18, "hf_tar_get_index": 18, "hf_tar_list_fil": 18, "hf_tar_file_exist": 18, "hf_tar_file_s": 18, "hf_tar_file_info": 18, "hf_tar_file_download": 18, "tar_create_index": 18, "hf_tar_create_index": [18, 20], "tar_get_index_info": 18, "hf_tar_create_from_directori": 18, "hf_tar_item_valid": 18, "hf_tar_valid": 18, "src_tar_fil": 19, "dst_index_fil": 19, "chunk_for_hash": 19, "1048576": 19, "with_hash": 19, "chunk": [19, 24], "20": 19, "mb": 19, "whether": 19, "progress": [19, 22, 24, 31, 34], "bar": [19, 22, 24, 31, 34], "log": 19, "skip_when_sync": 19, "skip": [19, 27], "sync": 19, "readi": [19, 25], "directli": 19, "json": [19, 20], "local_directori": [19, 22, 24], "file_item": 20, "hash_": 20, "expect": [20, 31], "sha": 20, "256": 20, "lf": [20, 26, 27, 29], "entrynotfounderror": 20, "entri": [20, 36], "found": 20, "isadirectoryerror": 20, "mean": [20, 39], "expir": 20, "need": 20, "re": 20, "gener": [20, 26], "so": [20, 24], "togeth": 20, "gracefulli": 20, "refresh": 20, "hfapi": 21, "variabl": [21, 22, 24], "hffilesystem": 21, "subdir": 21, "ignore_pattern": [21, 22, 24], "subdirectori": 21, "e": [21, 22, 24], "g": [21, 22, 24], "branch": [21, 22, 24, 29], "tag": [21, 22, 24, 29], "commit": [21, 22, 24, 27, 29], "pattern": [21, 22, 24], "ignor": [21, 22, 24], "file_in_repo": [22, 24, 25], "resume_download": 22, "within": [22, 24], "resum": 22, "dir_in_repo": 22, "max_work": 22, "8": [22, 37, 38, 39], "max_retri": 22, "max": 22, "worker": 22, "retri": 22, "time": [22, 24], "get_hf_client": 23, "get_hf_f": 23, "list_files_in_repositori": 23, "download_file_to_fil": 23, "download_archive_as_directori": 23, "download_directory_as_directori": 23, "upload_file_to_fil": 23, "upload_directory_as_arch": 23, "upload_directory_as_directori": 23, "is_local_file_readi": 23, "path_in_repo": 24, "time_suffix": 24, "operation_chunk_s": 24, "upload_timespan": 24, "float": 24, "0": [24, 27, 37, 38, 39], "its": 24, "append": 24, "timestamp": 24, "present": 24, "seper": 24, "multipl": 24, "set": 24, "minim": 24, "enabl": 24, "some": [24, 28, 37, 38], "fail": [24, 27, 29], "roll": 24, "back": [24, 29], "startup": 24, "hf_hub_rollback": [24, 28], "But": 24, "cannot": 24, "guarante": 24, "atom": 24, "your": [24, 37, 38, 39], "thread": 24, "safe": 24, "rate": 24, "limit": 24, "approxim": 24, "120": 24, "hour": 24, "realli": 24, "have": 24, "larg": 24, "number": [24, 27], "pleas": [24, 37, 38], "less": 24, "than": 24, "30": 24, "sure": 24, "compar": 25, "hub": [25, 26, 27, 29], "work": 26, "git": [26, 27, 28, 29, 39], "It": [26, 27, 29, 31, 39], "url": [26, 31], "git_info": 26, "hbutil": [26, 37, 38], "constant": 26, "huggingface_hub": 26, "full": 26, "unknown": 26, "usag": [26, 27, 29], "usernam": [26, 27, 29], "repo": [26, 27, 29], "co": 26, "other": 27, "dst_dir": 27, "no_lf": 27, "max_depth": 27, "specif": [27, 29], "attempt": [27, 29], "credenti": [27, 29], "maximum": 27, "subprocess": [27, 29], "calledprocesserror": [27, 29], "dir": 27, "v1": 27, "oper": [28, 29, 36], "hf_hub_repo_url": 28, "hf_hub_clon": 28, "reset": 29, "forc": 29, "push": 29, "chang": 29, "rollback_to": 29, "refer": 29, "abc123": 29, "perform": [29, 31, 37, 38], "step": 29, "without": 29, "temporari": 29, "hard": 29, "overwrit": 29, "histori": 29, "cancel": 29, "caution": 29, "read": 30, "first": 30, "byte": [30, 31], "contain": 30, "non": 30, "text": 30, "charact": 30, "expected_s": 31, "desc": 31, "session": 31, "tqdm": [31, 32, 36], "ensur": 31, "ha": [31, 37, 38], "pass": [31, 34], "binari": [32, 36], "is_binary_fil": 32, "download_fil": 32, "hf_normpath": 32, "hf_fs_path": 32, "parse_hf_fs_path": 32, "hffilesystempath": 32, "walk": [32, 36], "walk_fil": 32, "normal": 33, "filesystem": 33, "pars": 33, "invalid": 33, "tqdm_": 34, "enhanc": 34, "silenc": 34, "modifi": 34, "behavior": 34, "allow": 34, "posit": 34, "std": 34, "recurs": 35, "through": [35, 39], "yield": 35, "rel": 35, "root": 35, "start": [35, 36], "quick": 36, "run": 36, "environ": 36, "register_archive_typ": 36, "archive_pack": 36, "archive_unpack": 36, "get_archive_typ": 36, "get_archive_extnam": 36, "cach": 36, "config": [36, 39], "here": [37, 38], "o": [37, 38], "platform": [37, 38], "shutil": [37, 38], "cpuinfo": [37, 38], "psutil": [37, 38], "scale": [37, 38], "size_to_bytes_str": [37, 38], "python": [37, 38, 39], "python_implement": [37, 38], "python_vers": [37, 38], "cpu": [37, 38], "brand": [37, 38], "get_cpu_info": [37, 38], "brand_raw": [37, 38], "count": [37, 38], "cpu_count": [37, 38], "freq": [37, 38], "cpu_freq": [37, 38], "mhz": [37, 38], "memori": [37, 38], "virtual_memori": [37, 38], "total": [37, 38], "precis": [37, 38], "cuda": [37, 38], "ye": [37, 38], "nvidia": [37, 38], "smi": [37, 38], "els": [37, 38], "No": [37, 38], "linux": [37, 38], "azur": [37, 38], "x86_64": [37, 38], "glibc2": [37, 38], "34": [37, 38], "cpython": [37, 38], "18": [37, 38], "amd": [37, 38], "epyc": [37, 38], "7763": [37, 38], "64": [37, 38], "core": [37, 38], "processor": [37, 38], "2939": 37, "1825000000003": 37, "15": [37, 38], "606": [37, 38], "gib": [37, 38], "note": [37, 38], "deploi": [37, 38], "document": [37, 38, 39], "automat": [37, 38], "execut": [37, 38], "github": [37, 38, 39], "action": [37, 38], "therefor": [37, 38], "mai": [37, 38], "2726": 38, "45175": 38, "hfutil": 39, "host": 39, "pypi": 39, "newest": 39, "u": 39, "com": 39, "script": 39, "__name__": 39, "__main__": 39, "develop": 39, "maintain": 39, "like": 39, "below": 39, "success": 39, "narugo1992": 39, "still": 39, "out": 39, "stabl": 39, "html": 39, "faq": 40}, "objects": {"hfutils": [[0, 0, 0, "-", "archive"], [2, 0, 0, "-", "cache"], [3, 0, 0, "-", "config"], [10, 0, 0, "-", "entry"], [18, 0, 0, "-", "index"], [23, 0, 0, "-", "operate"], [28, 0, 0, "-", "repository"], [32, 0, 0, "-", "utils"]], "hfutils.archive": [[0, 1, 1, "", "archive_pack"], [0, 1, 1, "", "archive_unpack"], [0, 1, 1, "", "get_archive_extname"], [0, 1, 1, "", "get_archive_type"], [0, 1, 1, "", "register_archive_type"]], "hfutils.cache": [[1, 0, 0, "-", "delete"]], "hfutils.cache.delete": [[1, 1, 1, "", "delete_cache"], [1, 1, 1, "", "delete_detached_cache"]], "hfutils.config": [[4, 0, 0, "-", "meta"]], "hfutils.config.meta": [[4, 2, 1, "", "__AUTHOR_EMAIL__"], [4, 2, 1, "", "__AUTHOR__"], [4, 2, 1, "", "__DESCRIPTION__"], [4, 2, 1, "", "__TITLE__"], [4, 2, 1, "", "__VERSION__"]], "hfutils.entry": [[5, 0, 0, "-", "base"], [6, 0, 0, "-", "cli"], [7, 0, 0, "-", "clone"], [8, 0, 0, "-", "dispatch"], [9, 0, 0, "-", "download"], [11, 0, 0, "-", "index"], [12, 0, 0, "-", "ls"], [13, 0, 0, "-", "ls_repo"], [14, 0, 0, "-", "rollback"], [15, 0, 0, "-", "upload"], [16, 0, 0, "-", "whoami"]], "hfutils.entry.base": [[5, 2, 1, "", "CONTEXT_SETTINGS"], [5, 3, 1, "", "ClickErrorException"], [5, 3, 1, "", "ClickWarningException"], [5, 3, 1, "", "KeyboardInterrupted"], [5, 1, 1, "", "command_wrap"], [5, 1, 1, "", "print_exception"]], "hfutils.entry.base.ClickErrorException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.ClickWarningException": [[5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.base.KeyboardInterrupted": [[5, 5, 1, "", "__init__"], [5, 4, 1, "", "exit_code"], [5, 5, 1, "", "show"]], "hfutils.entry.cli": [[6, 2, 1, "", "cli"]], "hfutils.entry.dispatch": [[8, 1, 1, "", "hfutilcli"], [8, 1, 1, "", "print_version"]], "hfutils.entry.download": [[9, 3, 1, "", "NoRemotePathAssignedWithDownload"]], "hfutils.entry.download.NoRemotePathAssignedWithDownload": [[9, 4, 1, "", "exit_code"], [9, 5, 1, "", "show"]], "hfutils.entry.ls": [[12, 3, 1, "", "ListItem"], [12, 6, 1, "", "ListItemType"]], "hfutils.entry.ls.ListItemType": [[12, 4, 1, "", "ARCHIVE"], [12, 4, 1, "", "DATA"], [12, 4, 1, "", "FILE"], [12, 4, 1, "", "FOLDER"], [12, 4, 1, "", "IMAGE"], [12, 4, 1, "", "MODEL"]], "hfutils.entry.ls_repo": [[13, 3, 1, "", "NoLocalAuthentication"]], "hfutils.entry.upload": [[15, 3, 1, "", "NoRemotePathAssignedWithUpload"]], "hfutils.entry.upload.NoRemotePathAssignedWithUpload": [[15, 4, 1, "", "exit_code"], [15, 5, 1, "", "show"]], "hfutils.index": [[17, 0, 0, "-", "fetch"], [19, 0, 0, "-", "make"], [20, 0, 0, "-", "validate"]], "hfutils.index.fetch": [[17, 3, 1, "", "ArchiveStandaloneFileHashNotMatch"], [17, 3, 1, "", "ArchiveStandaloneFileIncompleteDownload"], [17, 1, 1, "", "hf_tar_file_download"], [17, 1, 1, "", "hf_tar_file_exists"], [17, 1, 1, "", "hf_tar_file_info"], [17, 1, 1, "", "hf_tar_file_size"], [17, 1, 1, "", "hf_tar_get_index"], [17, 1, 1, "", "hf_tar_list_files"]], "hfutils.index.make": [[19, 1, 1, "", "hf_tar_create_from_directory"], [19, 1, 1, "", "hf_tar_create_index"], [19, 1, 1, "", "tar_create_index"], [19, 1, 1, "", "tar_get_index_info"]], "hfutils.index.validate": [[20, 1, 1, "", "hf_tar_item_validate"], [20, 1, 1, "", "hf_tar_validate"]], "hfutils.operate": [[21, 0, 0, "-", "base"], [22, 0, 0, "-", "download"], [24, 0, 0, "-", "upload"], [25, 0, 0, "-", "validate"]], "hfutils.operate.base": [[21, 1, 1, "", "get_hf_client"], [21, 1, 1, "", "get_hf_fs"], [21, 1, 1, "", "list_files_in_repository"]], "hfutils.operate.download": [[22, 1, 1, "", "download_archive_as_directory"], [22, 1, 1, "", "download_directory_as_directory"], [22, 1, 1, "", "download_file_to_file"]], "hfutils.operate.upload": [[24, 1, 1, "", "upload_directory_as_archive"], [24, 1, 1, "", "upload_directory_as_directory"], [24, 1, 1, "", "upload_file_to_file"]], "hfutils.operate.validate": [[25, 1, 1, "", "is_local_file_ready"]], "hfutils.repository": [[26, 0, 0, "-", "base"], [27, 0, 0, "-", "clone"], [29, 0, 0, "-", "rollback"]], "hfutils.repository.base": [[26, 1, 1, "", "hf_hub_repo_url"]], "hfutils.repository.clone": [[27, 1, 1, "", "hf_hub_clone"]], "hfutils.repository.rollback": [[29, 1, 1, "", "hf_hub_rollback"]], "hfutils.utils": [[30, 0, 0, "-", "binary"], [31, 0, 0, "-", "download"], [33, 0, 0, "-", "path"], [34, 0, 0, "-", "tqdm_"], [35, 0, 0, "-", "walk"]], "hfutils.utils.binary": [[30, 1, 1, "", "is_binary_file"]], "hfutils.utils.download": [[31, 1, 1, "", "download_file"]], "hfutils.utils.path": [[33, 3, 1, "", "HfFileSystemPath"], [33, 1, 1, "", "hf_fs_path"], [33, 1, 1, "", "hf_normpath"], [33, 1, 1, "", "parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[34, 1, 1, "", "tqdm"]], "hfutils.utils.walk": [[35, 1, 1, "", "walk_files"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:data", "3": "py:class", "4": "py:attribute", "5": "py:method", "6": "py:enum"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "data", "Python data"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "method", "Python method"], "6": ["py", "enum", "Python enum"]}, "titleterms": {"hfutil": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36], "archiv": 0, "register_archive_typ": 0, "archive_pack": 0, "archive_unpack": 0, "get_archive_typ": 0, "get_archive_extnam": 0, "cach": [1, 2], "delet": 1, "delete_detached_cach": 1, "delete_cach": 1, "config": [3, 4], "meta": 4, "__title__": 4, "__version__": 4, "__description__": 4, "__author__": 4, "__author_email__": 4, "entri": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "base": [5, 21, 26], "context_set": 5, "clickwarningexcept": 5, "clickerrorexcept": 5, "print_except": 5, "keyboardinterrupt": 5, "command_wrap": 5, "cli": 6, "clone": [7, 27], "dispatch": 8, "print_vers": 8, "hfutilcli": 8, "download": [9, 22, 31], "noremotepathassignedwithdownload": 9, "index": [11, 17, 18, 19, 20], "l": 12, "listitemtyp": 12, "listitem": 12, "ls_repo": 13, "nolocalauthent": 13, "rollback": [14, 29], "upload": [15, 24], "noremotepathassignedwithupload": 15, "whoami": 16, "fetch": 17, "archivestandalonefileincompletedownload": 17, "archivestandalonefilehashnotmatch": 17, "hf_tar_get_index": 17, "hf_tar_list_fil": 17, "hf_tar_file_exist": 17, "hf_tar_file_s": 17, "hf_tar_file_info": 17, "hf_tar_file_download": 17, "make": 19, "tar_create_index": 19, "hf_tar_create_index": 19, "tar_get_index_info": 19, "hf_tar_create_from_directori": 19, "valid": [20, 25], "hf_tar_item_valid": 20, "hf_tar_valid": 20, "oper": [21, 22, 23, 24, 25], "get_hf_client": 21, "get_hf_f": 21, "list_files_in_repositori": 21, "download_file_to_fil": 22, "download_archive_as_directori": 22, "download_directory_as_directori": 22, "upload_file_to_fil": 24, "upload_directory_as_arch": 24, "upload_directory_as_directori": 24, "is_local_file_readi": 25, "repositori": [26, 27, 28, 29], "hf_hub_repo_url": 26, "hf_hub_clon": 27, "hf_hub_rollback": 29, "util": [30, 31, 32, 33, 34, 35], "binari": 30, "is_binary_fil": 30, "download_fil": 31, "path": 33, "hf_normpath": 33, "hf_fs_path": 33, "parse_hf_fs_path": 33, "hffilesystempath": 33, "tqdm": 34, "walk": 35, "walk_fil": 35, "welcom": 36, "": 36, "document": 36, "overview": 36, "tutori": 36, "inform": [36, 37, 38], "api": 36, "run": [37, 38], "environ": [37, 38], "instal": 39, "quick": 40, "start": 40}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "nbsphinx": 4, "sphinx": 58}, "alltitles": {"hfutils.archive": [[0, "module-hfutils.archive"]], "register_archive_type": [[0, "register-archive-type"]], "archive_pack": [[0, "archive-pack"]], "archive_unpack": [[0, "archive-unpack"]], "get_archive_type": [[0, "get-archive-type"]], "get_archive_extname": [[0, "get-archive-extname"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "delete_detached_cache": [[1, "delete-detached-cache"]], "delete_cache": [[1, "delete-cache"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "__TITLE__": [[4, "title"]], "__VERSION__": [[4, "version"]], "__DESCRIPTION__": [[4, "description"]], "__AUTHOR__": [[4, "author"]], "__AUTHOR_EMAIL__": [[4, "author-email"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "CONTEXT_SETTINGS": [[5, "context-settings"]], "ClickWarningException": [[5, "clickwarningexception"]], "ClickErrorException": [[5, "clickerrorexception"]], "print_exception": [[5, "print-exception"]], "KeyboardInterrupted": [[5, "keyboardinterrupted"]], "command_wrap": [[5, "command-wrap"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "cli": [[6, "cli"]], "hfutils.entry.clone": [[7, "module-hfutils.entry.clone"]], "hfutils.entry.dispatch": [[8, "module-hfutils.entry.dispatch"]], "print_version": [[8, "print-version"]], "hfutilcli": [[8, "hfutilcli"]], "hfutils.entry.download": [[9, "module-hfutils.entry.download"]], "NoRemotePathAssignedWithDownload": [[9, "noremotepathassignedwithdownload"]], "hfutils.entry": [[10, "module-hfutils.entry"]], "hfutils.entry.index": [[11, "module-hfutils.entry.index"]], "hfutils.entry.ls": [[12, "module-hfutils.entry.ls"]], "ListItemType": [[12, "listitemtype"]], "ListItem": [[12, "listitem"]], "hfutils.entry.ls_repo": [[13, "module-hfutils.entry.ls_repo"]], "NoLocalAuthentication": [[13, "nolocalauthentication"]], "hfutils.entry.rollback": [[14, "module-hfutils.entry.rollback"]], "hfutils.entry.upload": [[15, "module-hfutils.entry.upload"]], "NoRemotePathAssignedWithUpload": [[15, "noremotepathassignedwithupload"]], "hfutils.entry.whoami": [[16, "module-hfutils.entry.whoami"]], "hfutils.index.fetch": [[17, "module-hfutils.index.fetch"]], "ArchiveStandaloneFileIncompleteDownload": [[17, "archivestandalonefileincompletedownload"]], "ArchiveStandaloneFileHashNotMatch": [[17, "archivestandalonefilehashnotmatch"]], "hf_tar_get_index": [[17, "hf-tar-get-index"]], "hf_tar_list_files": [[17, "hf-tar-list-files"]], "hf_tar_file_exists": [[17, "hf-tar-file-exists"]], "hf_tar_file_size": [[17, "hf-tar-file-size"]], "hf_tar_file_info": [[17, "hf-tar-file-info"]], "hf_tar_file_download": [[17, "hf-tar-file-download"]], "hfutils.index": [[18, "module-hfutils.index"]], "hfutils.index.make": [[19, "module-hfutils.index.make"]], "tar_create_index": [[19, "tar-create-index"]], "hf_tar_create_index": [[19, "hf-tar-create-index"]], "tar_get_index_info": [[19, "tar-get-index-info"]], "hf_tar_create_from_directory": [[19, "hf-tar-create-from-directory"]], "hfutils.index.validate": [[20, "module-hfutils.index.validate"]], "hf_tar_item_validate": [[20, "hf-tar-item-validate"]], "hf_tar_validate": [[20, "hf-tar-validate"]], "hfutils.operate.base": [[21, "module-hfutils.operate.base"]], "get_hf_client": [[21, "get-hf-client"]], "get_hf_fs": [[21, "get-hf-fs"]], "list_files_in_repository": [[21, "list-files-in-repository"]], "hfutils.operate.download": [[22, "module-hfutils.operate.download"]], "download_file_to_file": [[22, "download-file-to-file"]], "download_archive_as_directory": [[22, "download-archive-as-directory"]], "download_directory_as_directory": [[22, "download-directory-as-directory"]], "hfutils.operate": [[23, "module-hfutils.operate"]], "hfutils.operate.upload": [[24, "module-hfutils.operate.upload"]], "upload_file_to_file": [[24, "upload-file-to-file"]], "upload_directory_as_archive": [[24, "upload-directory-as-archive"]], "upload_directory_as_directory": [[24, "upload-directory-as-directory"]], "hfutils.operate.validate": [[25, "module-hfutils.operate.validate"]], "is_local_file_ready": [[25, "is-local-file-ready"]], "hfutils.repository.base": [[26, "module-hfutils.repository.base"]], "hf_hub_repo_url": [[26, "hf-hub-repo-url"]], "hfutils.repository.clone": [[27, "module-hfutils.repository.clone"]], "hf_hub_clone": [[27, "hf-hub-clone"]], "hfutils.repository": [[28, "module-hfutils.repository"]], "hfutils.repository.rollback": [[29, "module-hfutils.repository.rollback"]], "hf_hub_rollback": [[29, "hf-hub-rollback"]], "hfutils.utils.binary": [[30, "module-hfutils.utils.binary"]], "is_binary_file": [[30, "is-binary-file"]], "hfutils.utils.download": [[31, "module-hfutils.utils.download"]], "download_file": [[31, "download-file"]], "hfutils.utils": [[32, "module-hfutils.utils"]], "hfutils.utils.path": [[33, "module-hfutils.utils.path"]], "hf_normpath": [[33, "hf-normpath"]], "hf_fs_path": [[33, "hf-fs-path"]], "parse_hf_fs_path": [[33, "parse-hf-fs-path"]], "HfFileSystemPath": [[33, "hffilesystempath"]], "hfutils.utils.tqdm": [[34, "module-hfutils.utils.tqdm_"]], "tqdm": [[34, "tqdm"]], "hfutils.utils.walk": [[35, "module-hfutils.utils.walk"]], "walk_files": [[35, "walk-files"]], "Welcome to hfutils\u2019s Documentation": [[36, "welcome-to-hfutils-s-documentation"]], "Overview": [[36, "overview"]], "Tutorials": [[36, null]], "Information": [[36, null]], "API Documentation": [[36, null]], "Run Environment Information": [[37, "Run-Environment-Information"], [38, "Run-Environment-Information"]], "Installation": [[39, "installation"]], "Quick Start": [[40, "quick-start"]]}, "indexentries": {"archive_pack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_pack"]], "archive_unpack() (in module hfutils.archive)": [[0, "hfutils.archive.archive_unpack"]], "get_archive_extname() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_extname"]], "get_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.get_archive_type"]], "hfutils.archive": [[0, "module-hfutils.archive"]], "module": [[0, "module-hfutils.archive"], [1, "module-hfutils.cache.delete"], [2, "module-hfutils.cache"], [3, "module-hfutils.config"], [4, "module-hfutils.config.meta"], [5, "module-hfutils.entry.base"], [6, "module-hfutils.entry.cli"], [7, "module-hfutils.entry.clone"], [8, "module-hfutils.entry.dispatch"], [9, "module-hfutils.entry.download"], [10, "module-hfutils.entry"], [11, "module-hfutils.entry.index"], [12, "module-hfutils.entry.ls"], [13, "module-hfutils.entry.ls_repo"], [14, "module-hfutils.entry.rollback"], [15, "module-hfutils.entry.upload"], [16, "module-hfutils.entry.whoami"], [17, "module-hfutils.index.fetch"], [18, "module-hfutils.index"], [19, "module-hfutils.index.make"], [20, "module-hfutils.index.validate"], [21, "module-hfutils.operate.base"], [22, "module-hfutils.operate.download"], [23, "module-hfutils.operate"], [24, "module-hfutils.operate.upload"], [25, "module-hfutils.operate.validate"], [26, "module-hfutils.repository.base"], [27, "module-hfutils.repository.clone"], [28, "module-hfutils.repository"], [29, "module-hfutils.repository.rollback"], [30, "module-hfutils.utils.binary"], [31, "module-hfutils.utils.download"], [32, "module-hfutils.utils"], [33, "module-hfutils.utils.path"], [34, "module-hfutils.utils.tqdm_"], [35, "module-hfutils.utils.walk"]], "register_archive_type() (in module hfutils.archive)": [[0, "hfutils.archive.register_archive_type"]], "delete_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_cache"]], "delete_detached_cache() (in module hfutils.cache.delete)": [[1, "hfutils.cache.delete.delete_detached_cache"]], "hfutils.cache.delete": [[1, "module-hfutils.cache.delete"]], "hfutils.cache": [[2, "module-hfutils.cache"]], "hfutils.config": [[3, "module-hfutils.config"]], "__author_email__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR_EMAIL__"]], "__author__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__AUTHOR__"]], "__description__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__DESCRIPTION__"]], "__title__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__TITLE__"]], "__version__ (in module hfutils.config.meta)": [[4, "hfutils.config.meta.__VERSION__"]], "hfutils.config.meta": [[4, "module-hfutils.config.meta"]], "context_settings (in module hfutils.entry.base)": [[5, "hfutils.entry.base.CONTEXT_SETTINGS"]], "clickerrorexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickErrorException"]], "clickwarningexception (class in hfutils.entry.base)": [[5, "hfutils.entry.base.ClickWarningException"]], "keyboardinterrupted (class in hfutils.entry.base)": [[5, "hfutils.entry.base.KeyboardInterrupted"]], "__init__() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.__init__"]], "command_wrap() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.command_wrap"]], "exit_code (hfutils.entry.base.clickerrorexception attribute)": [[5, "hfutils.entry.base.ClickErrorException.exit_code"]], "exit_code (hfutils.entry.base.clickwarningexception attribute)": [[5, "hfutils.entry.base.ClickWarningException.exit_code"]], "exit_code (hfutils.entry.base.keyboardinterrupted attribute)": [[5, "hfutils.entry.base.KeyboardInterrupted.exit_code"]], "hfutils.entry.base": [[5, "module-hfutils.entry.base"]], "print_exception() (in module hfutils.entry.base)": [[5, "hfutils.entry.base.print_exception"]], "show() (hfutils.entry.base.clickerrorexception method)": [[5, "hfutils.entry.base.ClickErrorException.show"]], "show() (hfutils.entry.base.clickwarningexception method)": [[5, "hfutils.entry.base.ClickWarningException.show"]], "show() (hfutils.entry.base.keyboardinterrupted method)": [[5, "hfutils.entry.base.KeyboardInterrupted.show"]], "cli (in module hfutils.entry.cli)": [[6, "hfutils.entry.cli.cli"]], "hfutils.entry.cli": [[6, "module-hfutils.entry.cli"]], "hfutils.entry.clone": [[7, "module-hfutils.entry.clone"]], "hfutilcli() (in module hfutils.entry.dispatch)": [[8, "hfutils.entry.dispatch.hfutilcli"]], "hfutils.entry.dispatch": [[8, "module-hfutils.entry.dispatch"]], "print_version() (in module hfutils.entry.dispatch)": [[8, "hfutils.entry.dispatch.print_version"]], "noremotepathassignedwithdownload (class in hfutils.entry.download)": [[9, "hfutils.entry.download.NoRemotePathAssignedWithDownload"]], "exit_code (hfutils.entry.download.noremotepathassignedwithdownload attribute)": [[9, "hfutils.entry.download.NoRemotePathAssignedWithDownload.exit_code"]], "hfutils.entry.download": [[9, "module-hfutils.entry.download"]], "show() (hfutils.entry.download.noremotepathassignedwithdownload method)": [[9, "hfutils.entry.download.NoRemotePathAssignedWithDownload.show"]], "hfutils.entry": [[10, "module-hfutils.entry"]], "hfutils.entry.index": [[11, "module-hfutils.entry.index"]], "archive (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.ARCHIVE"]], "data (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.DATA"]], "file (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.FILE"]], "folder (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.FOLDER"]], "image (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.IMAGE"]], "listitem (class in hfutils.entry.ls)": [[12, "hfutils.entry.ls.ListItem"]], "model (hfutils.entry.ls.listitemtype attribute)": [[12, "hfutils.entry.ls.ListItemType.MODEL"]], "hfutils.entry.ls": [[12, "module-hfutils.entry.ls"]], "nolocalauthentication (class in hfutils.entry.ls_repo)": [[13, "hfutils.entry.ls_repo.NoLocalAuthentication"]], "hfutils.entry.ls_repo": [[13, "module-hfutils.entry.ls_repo"]], "hfutils.entry.rollback": [[14, "module-hfutils.entry.rollback"]], "noremotepathassignedwithupload (class in hfutils.entry.upload)": [[15, "hfutils.entry.upload.NoRemotePathAssignedWithUpload"]], "exit_code (hfutils.entry.upload.noremotepathassignedwithupload attribute)": [[15, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.exit_code"]], "hfutils.entry.upload": [[15, "module-hfutils.entry.upload"]], "show() (hfutils.entry.upload.noremotepathassignedwithupload method)": [[15, "hfutils.entry.upload.NoRemotePathAssignedWithUpload.show"]], "hfutils.entry.whoami": [[16, "module-hfutils.entry.whoami"]], "archivestandalonefilehashnotmatch (class in hfutils.index.fetch)": [[17, "hfutils.index.fetch.ArchiveStandaloneFileHashNotMatch"]], "archivestandalonefileincompletedownload (class in hfutils.index.fetch)": [[17, "hfutils.index.fetch.ArchiveStandaloneFileIncompleteDownload"]], "hf_tar_file_download() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_download"]], "hf_tar_file_exists() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_exists"]], "hf_tar_file_info() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_info"]], "hf_tar_file_size() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_file_size"]], "hf_tar_get_index() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_get_index"]], "hf_tar_list_files() (in module hfutils.index.fetch)": [[17, "hfutils.index.fetch.hf_tar_list_files"]], "hfutils.index.fetch": [[17, "module-hfutils.index.fetch"]], "hfutils.index": [[18, "module-hfutils.index"]], "hf_tar_create_from_directory() (in module hfutils.index.make)": [[19, "hfutils.index.make.hf_tar_create_from_directory"]], "hf_tar_create_index() (in module hfutils.index.make)": [[19, "hfutils.index.make.hf_tar_create_index"]], "hfutils.index.make": [[19, "module-hfutils.index.make"]], "tar_create_index() (in module hfutils.index.make)": [[19, "hfutils.index.make.tar_create_index"]], "tar_get_index_info() (in module hfutils.index.make)": [[19, "hfutils.index.make.tar_get_index_info"]], "hf_tar_item_validate() (in module hfutils.index.validate)": [[20, "hfutils.index.validate.hf_tar_item_validate"]], "hf_tar_validate() (in module hfutils.index.validate)": [[20, "hfutils.index.validate.hf_tar_validate"]], "hfutils.index.validate": [[20, "module-hfutils.index.validate"]], "get_hf_client() (in module hfutils.operate.base)": [[21, "hfutils.operate.base.get_hf_client"]], "get_hf_fs() (in module hfutils.operate.base)": [[21, "hfutils.operate.base.get_hf_fs"]], "hfutils.operate.base": [[21, "module-hfutils.operate.base"]], "list_files_in_repository() (in module hfutils.operate.base)": [[21, "hfutils.operate.base.list_files_in_repository"]], "download_archive_as_directory() (in module hfutils.operate.download)": [[22, "hfutils.operate.download.download_archive_as_directory"]], "download_directory_as_directory() (in module hfutils.operate.download)": [[22, "hfutils.operate.download.download_directory_as_directory"]], "download_file_to_file() (in module hfutils.operate.download)": [[22, "hfutils.operate.download.download_file_to_file"]], "hfutils.operate.download": [[22, "module-hfutils.operate.download"]], "hfutils.operate": [[23, "module-hfutils.operate"]], "hfutils.operate.upload": [[24, "module-hfutils.operate.upload"]], "upload_directory_as_archive() (in module hfutils.operate.upload)": [[24, "hfutils.operate.upload.upload_directory_as_archive"]], "upload_directory_as_directory() (in module hfutils.operate.upload)": [[24, "hfutils.operate.upload.upload_directory_as_directory"]], "upload_file_to_file() (in module hfutils.operate.upload)": [[24, "hfutils.operate.upload.upload_file_to_file"]], "hfutils.operate.validate": [[25, "module-hfutils.operate.validate"]], "is_local_file_ready() (in module hfutils.operate.validate)": [[25, "hfutils.operate.validate.is_local_file_ready"]], "hf_hub_repo_url() (in module hfutils.repository.base)": [[26, "hfutils.repository.base.hf_hub_repo_url"]], "hfutils.repository.base": [[26, "module-hfutils.repository.base"]], "hf_hub_clone() (in module hfutils.repository.clone)": [[27, "hfutils.repository.clone.hf_hub_clone"]], "hfutils.repository.clone": [[27, "module-hfutils.repository.clone"]], "hfutils.repository": [[28, "module-hfutils.repository"]], "hf_hub_rollback() (in module hfutils.repository.rollback)": [[29, "hfutils.repository.rollback.hf_hub_rollback"]], "hfutils.repository.rollback": [[29, "module-hfutils.repository.rollback"]], "hfutils.utils.binary": [[30, "module-hfutils.utils.binary"]], "is_binary_file() (in module hfutils.utils.binary)": [[30, "hfutils.utils.binary.is_binary_file"]], "download_file() (in module hfutils.utils.download)": [[31, "hfutils.utils.download.download_file"]], "hfutils.utils.download": [[31, "module-hfutils.utils.download"]], "hfutils.utils": [[32, "module-hfutils.utils"]], "hffilesystempath (class in hfutils.utils.path)": [[33, "hfutils.utils.path.HfFileSystemPath"]], "hf_fs_path() (in module hfutils.utils.path)": [[33, "hfutils.utils.path.hf_fs_path"]], "hf_normpath() (in module hfutils.utils.path)": [[33, "hfutils.utils.path.hf_normpath"]], "hfutils.utils.path": [[33, "module-hfutils.utils.path"]], "parse_hf_fs_path() (in module hfutils.utils.path)": [[33, "hfutils.utils.path.parse_hf_fs_path"]], "hfutils.utils.tqdm_": [[34, "module-hfutils.utils.tqdm_"]], "tqdm() (in module hfutils.utils.tqdm_)": [[34, "hfutils.utils.tqdm_.tqdm"]], "hfutils.utils.walk": [[35, "module-hfutils.utils.walk"]], "walk_files() (in module hfutils.utils.walk)": [[35, "hfutils.utils.walk.walk_files"]]}})
\ No newline at end of file