chore(docs): update docs due to workflow_dispatch on jina-ai/finetuner

jina-ai · Jul 14, 2023 · c1a6f14 · c1a6f14
1 parent eab0f95
commit c1a6f14
Show file tree

Hide file tree

Showing 65 changed files with 113 additions and 128 deletions.
diff --git a/docs/404.html b/docs/404.html
@@ -321,7 +321,7 @@ <h1>Page Not Found</h1>
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/404/index.html b/docs/404/index.html
@@ -321,7 +321,7 @@ <h1>Page Not Found</h1>
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/_modules/finetuner/client/client/index.html b/docs/_modules/finetuner/client/client/index.html
@@ -618,7 +618,7 @@ <h1>Source code for finetuner.client.client</h1><div class="highlight"><pre>
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/_modules/finetuner/console/index.html b/docs/_modules/finetuner/console/index.html
@@ -385,7 +385,7 @@ <h1>Source code for finetuner.console</h1><div class="highlight"><pre>
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/_modules/finetuner/excepts/index.html b/docs/_modules/finetuner/excepts/index.html
@@ -341,7 +341,7 @@ <h1>Source code for finetuner.excepts</h1><div class="highlight"><pre>
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/_modules/finetuner/experiment/index.html b/docs/_modules/finetuner/experiment/index.html
@@ -745,7 +745,7 @@ <h1>Source code for finetuner.experiment</h1><div class="highlight"><pre>
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/_modules/finetuner/finetuner/index.html b/docs/_modules/finetuner/finetuner/index.html
@@ -666,7 +666,7 @@ <h1>Source code for finetuner.finetuner</h1><div class="highlight"><pre>
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/_modules/finetuner/index.html b/docs/_modules/finetuner/index.html
@@ -997,7 +997,7 @@ <h1>Source code for finetuner</h1><div class="highlight"><pre>
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/_modules/finetuner/model/index.html b/docs/_modules/finetuner/model/index.html
@@ -376,7 +376,7 @@ <h1>Source code for finetuner.model</h1><div class="highlight"><pre>
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/_modules/finetuner/run/index.html b/docs/_modules/finetuner/run/index.html
@@ -531,7 +531,7 @@ <h1>Source code for finetuner.run</h1><div class="highlight"><pre>
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -325,7 +325,7 @@ <h1>All modules for which code is available</h1>
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/_sources/get-started/pretrained.md.txt b/docs/_sources/get-started/pretrained.md.txt
@@ -6,9 +6,9 @@ we have introduced a suite of pre-trained text embedding models licensed under A
 The model have a range of useThese models have a variety of use cases, including information retrieval, semantic textual similarity, text reranking, and more.
 The suite consists of the following models:
 
-- `jina-embedding-s-en-v1` **[Huggingface](jinaai/jina-embedding-s-en-v1)**: This is a compact model with just 35 million parameters, that performs lightning-fast inference while delivering impressive performance.
-- `jina-embedding-b-en-v1` **[Huggingface](jinaai/jina-embedding-b-en-v1)**: This model has a size of 110 million parameters, performs fast inference and delivers better performance than our smaller model.
-- `jina-embedding-l-en-v1` **[Huggingface](jinaai/jina-embedding-l-en-v1)**: This is a relatively large model with a size of 330 million parameters, that performs single-gpu inference and delivers better performance than our other model.
+- `jina-embedding-s-en-v1` **[Huggingface](https://huggingface.co/jinaai/jina-embedding-s-en-v1)**: This is a compact model with just 35 million parameters, that performs lightning-fast inference while delivering impressive performance.
+- `jina-embedding-b-en-v1` **[Huggingface](https://huggingface.co/jinaai/jina-embedding-b-en-v1)**: This model has a size of 110 million parameters, performs fast inference and delivers better performance than our smaller model.
+- `jina-embedding-l-en-v1` **[Huggingface](https://huggingface.co/jinaai/jina-embedding-l-en-v1)**: This is a relatively large model with a size of 330 million parameters, that performs single-gpu inference and delivers better performance than our other model.
 
 ## Usage
 
@@ -44,4 +44,4 @@ The models have different output dimensionalities, as shown in the table below:
 
 ## Performance
 
-Please refer to the [Huggingface](jinaai/jina-embedding-s-en-v1) page.
+Please refer to the [Huggingface](https://huggingface.co/jinaai/jina-embedding-s-en-v1) page.
diff --git a/docs/advanced-topics/advanced-losses-optimizers-and-poolers/index.html b/docs/advanced-topics/advanced-losses-optimizers-and-poolers/index.html
@@ -468,7 +468,7 @@ <h3>GeM pooling<a class="headerlink" href="#gem-pooling" title="Permalink to thi
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/advanced-topics/budget/index.html b/docs/advanced-topics/budget/index.html
@@ -512,7 +512,7 @@ <h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headin
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/advanced-topics/finetuner-executor/index.html b/docs/advanced-topics/finetuner-executor/index.html
@@ -484,7 +484,7 @@ <h2>Special case: Artifacts with CLIP models<a class="headerlink" href="#special
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/advanced-topics/linear-probe/index.html b/docs/advanced-topics/linear-probe/index.html
@@ -427,7 +427,7 @@ <h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headin
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/advanced-topics/negative-mining/index.html b/docs/advanced-topics/negative-mining/index.html
@@ -439,7 +439,7 @@ <h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headin
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/advanced-topics/using-callbacks/index.html b/docs/advanced-topics/using-callbacks/index.html
@@ -569,7 +569,7 @@ <h2>WandBLogger<a class="headerlink" href="#wandblogger" title="Permalink to thi
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/api-rst/index.html b/docs/api-rst/index.html
@@ -472,7 +472,7 @@ <h2><a class="reference internal" href="../api/finetuner.experiment/#finetuner.e
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/api/finetuner.client.client.rst b/docs/api/finetuner.client.client.rst
diff --git a/docs/api/finetuner.client.client/index.html b/docs/api/finetuner.client.client/index.html
@@ -647,7 +647,7 @@
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/api/finetuner.client.rst b/docs/api/finetuner.client.rst
diff --git a/docs/api/finetuner.client.session.rst b/docs/api/finetuner.client.session.rst
diff --git a/docs/api/finetuner.client.session/index.html b/docs/api/finetuner.client.session/index.html
@@ -343,7 +343,7 @@
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/api/finetuner.client/index.html b/docs/api/finetuner.client/index.html
@@ -377,7 +377,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/api/finetuner.console.rst b/docs/api/finetuner.console.rst
@@ -0,0 +1,7 @@
+finetuner.console module
+========================
+
+.. automodule:: finetuner.console
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/finetuner.console/index.html b/docs/api/finetuner.console/index.html
@@ -382,7 +382,7 @@
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/api/finetuner.data.rst b/docs/api/finetuner.data.rst
diff --git a/docs/api/finetuner.data/index.html b/docs/api/finetuner.data/index.html
@@ -559,7 +559,7 @@
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/api/finetuner.excepts.rst b/docs/api/finetuner.excepts.rst
@@ -0,0 +1,7 @@
+finetuner.excepts module
+========================
+
+.. automodule:: finetuner.excepts
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/finetuner.excepts/index.html b/docs/api/finetuner.excepts/index.html
@@ -367,7 +367,7 @@
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/api/finetuner.experiment.rst b/docs/api/finetuner.experiment.rst
diff --git a/docs/api/finetuner.experiment/index.html b/docs/api/finetuner.experiment/index.html
@@ -466,7 +466,7 @@
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/api/finetuner.finetuner.rst b/docs/api/finetuner.finetuner.rst
diff --git a/docs/api/finetuner.finetuner/index.html b/docs/api/finetuner.finetuner/index.html
@@ -554,7 +554,7 @@
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/api/finetuner.model.rst b/docs/api/finetuner.model.rst
diff --git a/docs/api/finetuner.model/index.html b/docs/api/finetuner.model/index.html
@@ -401,7 +401,7 @@
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">

diff --git a/docs/api/finetuner.rst b/docs/api/finetuner.rst
@@ -0,0 +1,32 @@
+finetuner package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   finetuner.client
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   finetuner.console
+   finetuner.data
+   finetuner.excepts
+   finetuner.experiment
+   finetuner.finetuner
+   finetuner.model
+   finetuner.run
+
+Module contents
+---------------
+
+.. automodule:: finetuner
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/finetuner.run.rst b/docs/api/finetuner.run.rst
diff --git a/docs/api/finetuner.run/index.html b/docs/api/finetuner.run/index.html
@@ -521,7 +521,7 @@
                         <div class="copyright">
                             Copyright &#169; Jina AI Limited. All rights reserved.
                         </div><div class="last-updated">
-                            Last updated on Jul 13, 2023</div>
+                            Last updated on Jul 14, 2023</div>
                     </div>
                     <div class="right-details">
                         <div class="social-btns">