Skip to content
This repository has been archived by the owner on Sep 18, 2024. It is now read-only.

Commit

Permalink
chore(docs): update docs due to workflow_dispatch on jina-ai/finetuner
Browse files Browse the repository at this point in the history
  • Loading branch information
@jina-bot
jina-bot committed Jul 26, 2023
1 parent 4937042 commit f882c67
Show file tree
Hide file tree
Showing 66 changed files with 123 additions and 106 deletions.
2 changes: 1 addition & 1 deletion docs/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/404/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/finetuner/client/client/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/finetuner/console/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/finetuner/excepts/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/finetuner/experiment/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/finetuner/finetuner/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/finetuner/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/finetuner/model/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/finetuner/run/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
1 change: 1 addition & 0 deletions docs/_sources/walkthrough/choose-backbone.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ to get a list of supported models:
┏━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ name ┃ task ┃ output_dim ┃ architecture ┃ description ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ jina-embedding-t-en-v1 │ text-to-text │ 312 │ transformer │ Text embedding model trained using Linnaeus-Clean dataset by Jina AI │
│ jina-embedding-s-en-v1 │ text-to-text │ 512 │ transformer │ Text embedding model trained using Linnaeus-Clean dataset by Jina AI │
│ jina-embedding-b-en-v1 │ text-to-text │ 768 │ transformer │ Text embedding model trained using Linnaeus-Clean dataset by Jina AI │
│ jina-embedding-l-en-v1 │ text-to-text │ 1024 │ transformer │ Text embedding model trained using Linnaeus-Clean dataset by Jina AI │
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-topics/advanced-losses-optimizers-and-poolers/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-topics/budget/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-topics/finetuner-executor/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-topics/linear-probe/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-topics/negative-mining/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-topics/using-callbacks/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/api-rst/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
7 changes: 7 additions & 0 deletions docs/api/finetuner.client.client.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
finetuner.client.client module
==============================

.. automodule:: finetuner.client.client
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api/finetuner.client.client/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -647,7 +647,7 @@
<div class="copyright">
Copyright &#169; Jina AI Limited. All rights reserved.
</div><div class="last-updated">
Last updated on Jul 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
19 changes: 19 additions & 0 deletions docs/api/finetuner.client.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
finetuner.client package
========================

Submodules
----------

.. toctree::
:maxdepth: 4

finetuner.client.client
finetuner.client.session

Module contents
---------------

.. automodule:: finetuner.client
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/finetuner.client.session.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
finetuner.client.session module
===============================

.. automodule:: finetuner.client.session
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api/finetuner.client.session/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@
<div class="copyright">
Copyright &#169; Jina AI Limited. All rights reserved.
</div><div class="last-updated">
Last updated on Jul 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/api/finetuner.client/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
7 changes: 0 additions & 7 deletions docs/api/finetuner.console.rst
View file

This file was deleted.

2 changes: 1 addition & 1 deletion docs/api/finetuner.console/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@
<div class="copyright">
Copyright &#169; Jina AI Limited. All rights reserved.
</div><div class="last-updated">
Last updated on Jul 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
7 changes: 7 additions & 0 deletions docs/api/finetuner.data.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
finetuner.data module
=====================

.. automodule:: finetuner.data
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api/finetuner.data/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@
<div class="copyright">
Copyright &#169; Jina AI Limited. All rights reserved.
</div><div class="last-updated">
Last updated on Jul 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
7 changes: 0 additions & 7 deletions docs/api/finetuner.excepts.rst
View file

This file was deleted.

2 changes: 1 addition & 1 deletion docs/api/finetuner.excepts/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@
<div class="copyright">
Copyright &#169; Jina AI Limited. All rights reserved.
</div><div class="last-updated">
Last updated on Jul 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
7 changes: 7 additions & 0 deletions docs/api/finetuner.experiment.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
finetuner.experiment module
===========================

.. automodule:: finetuner.experiment
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api/finetuner.experiment/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,7 @@
<div class="copyright">
Copyright &#169; Jina AI Limited. All rights reserved.
</div><div class="last-updated">
Last updated on Jul 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
7 changes: 7 additions & 0 deletions docs/api/finetuner.finetuner.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
finetuner.finetuner module
==========================

.. automodule:: finetuner.finetuner
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api/finetuner.finetuner/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@
<div class="copyright">
Copyright &#169; Jina AI Limited. All rights reserved.
</div><div class="last-updated">
Last updated on Jul 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
7 changes: 7 additions & 0 deletions docs/api/finetuner.model.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
finetuner.model module
======================

.. automodule:: finetuner.model
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api/finetuner.model/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@
<div class="copyright">
Copyright &#169; Jina AI Limited. All rights reserved.
</div><div class="last-updated">
Last updated on Jul 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
32 changes: 0 additions & 32 deletions docs/api/finetuner.rst
View file

This file was deleted.

7 changes: 7 additions & 0 deletions docs/api/finetuner.run.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
finetuner.run module
====================

.. automodule:: finetuner.run
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api/finetuner.run/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,7 @@
<div class="copyright">
Copyright &#169; Jina AI Limited. All rights reserved.
</div><div class="last-updated">
Last updated on Jul 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
2 changes: 1 addition & 1 deletion docs/api/finetuner/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1318,7 +1318,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 25, 2023</div>
Last updated on Jul 26, 2023</div>
</div>
<div class="right-details">
<div class="social-btns">
Expand Down
Loading

0 comments on commit f882c67

Please sign in to comment.