Deploying to gh-pages from @ da9a4bb 🚀

deepghs · Dec 25, 2023 · 53812b0 · 53812b0
1 parent c91192f
commit 53812b0
Show file tree

Hide file tree

Showing 46 changed files with 709 additions and 36 deletions.
diff --git 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: 42a765bb300ba349ee1846b983e5867a
+config: b8baaf70720e16240e40daba34433d1c
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/main/.doctrees/api_doc/archive/index.doctree b/main/.doctrees/api_doc/archive/index.doctree
diff --git a/main/.doctrees/api_doc/config/index.doctree b/main/.doctrees/api_doc/config/index.doctree
diff --git a/main/.doctrees/api_doc/config/meta.doctree b/main/.doctrees/api_doc/config/meta.doctree
diff --git a/main/.doctrees/api_doc/utils/binary.doctree b/main/.doctrees/api_doc/utils/binary.doctree
diff --git a/main/.doctrees/api_doc/utils/download.doctree b/main/.doctrees/api_doc/utils/download.doctree
diff --git a/main/.doctrees/api_doc/utils/index.doctree b/main/.doctrees/api_doc/utils/index.doctree
diff --git a/main/.doctrees/api_doc/utils/tqdm_.doctree b/main/.doctrees/api_doc/utils/tqdm_.doctree
diff --git a/main/.doctrees/api_doc/utils/walk.doctree b/main/.doctrees/api_doc/utils/walk.doctree
diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle
diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree
diff --git a/main/.doctrees/information/environment.doctree b/main/.doctrees/information/environment.doctree
diff --git a/main/.doctrees/information/environment.result.doctree b/main/.doctrees/information/environment.result.doctree
diff --git 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": "2023-12-25T05:57:27.507164Z",
-     "iopub.status.busy": "2023-12-25T05:57:27.506968Z",
-     "iopub.status.idle": "2023-12-25T05:57:28.670290Z",
-     "shell.execute_reply": "2023-12-25T05:57:28.669480Z"
+     "iopub.execute_input": "2023-12-25T06:19:50.790363Z",
+     "iopub.status.busy": "2023-12-25T06:19:50.790167Z",
+     "iopub.status.idle": "2023-12-25T06:19:51.954601Z",
+     "shell.execute_reply": "2023-12-25T06:19:51.953768Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -53,7 +53,7 @@
      "text": [
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2917.7122499999996 MHz\n",
+      "CPU Freq: 2928.0722499999997 MHz\n",
       "Memory Size: 15.607 GiB\n",
       "Has CUDA: No\n"
      ]

diff --git 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": "2023-12-25T05:57:13.654549Z",
-     "iopub.status.busy": "2023-12-25T05:57:13.654331Z",
-     "iopub.status.idle": "2023-12-25T05:57:14.824544Z",
-     "shell.execute_reply": "2023-12-25T05:57:14.823780Z"
+     "iopub.execute_input": "2023-12-25T06:19:36.211684Z",
+     "iopub.status.busy": "2023-12-25T06:19:36.211207Z",
+     "iopub.status.idle": "2023-12-25T06:19:37.380150Z",
+     "shell.execute_reply": "2023-12-25T06:19:37.379465Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -47,7 +47,7 @@
       "Python: CPython 3.8.18\n",
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2934.4134999999997 MHz\n",
+      "CPU Freq: 2916.24275 MHz\n",
       "Memory Size: 15.607 GiB\n",
       "Has CUDA: No\n"
      ]

diff --git a/main/.doctrees/tutorials/installation/index.doctree b/main/.doctrees/tutorials/installation/index.doctree
diff --git a/main/.doctrees/tutorials/quick_start/index.doctree b/main/.doctrees/tutorials/quick_start/index.doctree
diff --git a/main/_modules/hfutils/archive/base.html b/main/_modules/hfutils/archive/base.html
diff --git a/main/_modules/hfutils/utils/binary.html b/main/_modules/hfutils/utils/binary.html
@@ -58,6 +58,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../api_doc/archive/index.html">hfutils.archive</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../api_doc/config/index.html">hfutils.config</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../api_doc/utils/index.html">hfutils.utils</a></li>
 </ul>

diff --git a/main/_modules/hfutils/utils/download.html b/main/_modules/hfutils/utils/download.html
@@ -58,6 +58,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../api_doc/archive/index.html">hfutils.archive</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../api_doc/config/index.html">hfutils.config</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../api_doc/utils/index.html">hfutils.utils</a></li>
 </ul>

diff --git a/main/_modules/hfutils/utils/tqdm_.html b/main/_modules/hfutils/utils/tqdm_.html
@@ -58,6 +58,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../api_doc/archive/index.html">hfutils.archive</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../api_doc/config/index.html">hfutils.config</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../api_doc/utils/index.html">hfutils.utils</a></li>
 </ul>

diff --git a/main/_modules/hfutils/utils/walk.html b/main/_modules/hfutils/utils/walk.html
@@ -58,6 +58,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../api_doc/archive/index.html">hfutils.archive</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../api_doc/config/index.html">hfutils.config</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../api_doc/utils/index.html">hfutils.utils</a></li>
 </ul>

diff --git a/main/_modules/index.html b/main/_modules/index.html
@@ -58,6 +58,7 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../api_doc/archive/index.html">hfutils.archive</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../api_doc/config/index.html">hfutils.config</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../api_doc/utils/index.html">hfutils.utils</a></li>
 </ul>
@@ -88,7 +89,8 @@
 
 
   <h1>All modules for which code is available</h1>
-<ul><li><a href="hfutils/utils/binary.html">hfutils.utils.binary</a></li>
+<ul><li><a href="hfutils/archive/base.html">hfutils.archive.base</a></li>
+<li><a href="hfutils/utils/binary.html">hfutils.utils.binary</a></li>
 <li><a href="hfutils/utils/download.html">hfutils.utils.download</a></li>
 <li><a href="hfutils/utils/tqdm_.html">hfutils.utils.tqdm_</a></li>
 <li><a href="hfutils/utils/walk.html">hfutils.utils.walk</a></li>

diff --git a/main/_sources/api_doc/archive/index.rst.txt b/main/_sources/api_doc/archive/index.rst.txt
@@ -0,0 +1,43 @@
+hfutils.archive
+=====================
+
+.. currentmodule:: hfutils.archive
+
+.. automodule:: hfutils.archive
+
+
+register_archive_type
+----------------------------------------
+
+.. autofunction:: register_archive_type
+
+
+
+archive_pack
+----------------------------------------
+
+.. autofunction:: archive_pack
+
+
+
+archive_unpack
+----------------------------------------
+
+.. autofunction:: archive_unpack
+
+
+
+get_archive_type
+----------------------------------------
+
+.. autofunction:: get_archive_type
+
+
+
+get_archive_extname
+----------------------------------------
+
+.. autofunction:: get_archive_extname
+
+
+
diff --git a/main/_sources/index.rst.txt b/main/_sources/index.rst.txt
@@ -28,6 +28,7 @@ configuration file's structure and their versions.
     :maxdepth: 2
     :caption: API Documentation
 
+    api_doc/archive/index
     api_doc/config/index
     api_doc/utils/index
 

diff --git 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": "2023-12-25T05:57:13.654549Z",
-     "iopub.status.busy": "2023-12-25T05:57:13.654331Z",
-     "iopub.status.idle": "2023-12-25T05:57:14.824544Z",
-     "shell.execute_reply": "2023-12-25T05:57:14.823780Z"
+     "iopub.execute_input": "2023-12-25T06:19:36.211684Z",
+     "iopub.status.busy": "2023-12-25T06:19:36.211207Z",
+     "iopub.status.idle": "2023-12-25T06:19:37.380150Z",
+     "shell.execute_reply": "2023-12-25T06:19:37.379465Z"
     },
     "pycharm": {
      "name": "#%%\n"
@@ -47,7 +47,7 @@
       "Python: CPython 3.8.18\n",
       "CPU Brand: AMD EPYC 7763 64-Core Processor\n",
       "CPU Count: 4\n",
-      "CPU Freq: 2934.4134999999997 MHz\n",
+      "CPU Freq: 2916.24275 MHz\n",
       "Memory Size: 15.607 GiB\n",
       "Has CUDA: No\n"
      ]