Update documentation (#220)

aiverify-foundation · Nov 27, 2023 · 042e3bd · 042e3bd
1 parent 7270827
commit 042e3bd
Show file tree

Hide file tree

Showing 56 changed files with 2,420 additions and 50 deletions.
diff --git a/404.html b/404.html
@@ -505,6 +505,8 @@
 
 
 
+
+
 
 
         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
@@ -925,6 +927,20 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="/aiverify/how-to/connect-to-ai-model-api/" class="md-nav__link">
+        How to Connect to AI Model API
+      </a>
+    </li>
+
+
+
+
         </ul>
       </nav>
     </li>

diff --git a/getting-started/accessing-ai-model/index.html b/getting-started/accessing-ai-model/index.html
@@ -436,6 +436,13 @@
     Upload Pipeline
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#connect-to-ai-model-api" class="md-nav__link">
+    Connect to AI Model API
+  </a>
+
 </li>
 
     </ul>
@@ -562,6 +569,8 @@
 
 
 
+
+
 
 
         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
@@ -982,6 +991,20 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../../how-to/connect-to-ai-model-api/" class="md-nav__link">
+        How to Connect to AI Model API
+      </a>
+    </li>
+
+
+
+
         </ul>
       </nav>
     </li>
@@ -1291,6 +1314,13 @@
     Upload Pipeline
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#connect-to-ai-model-api" class="md-nav__link">
+    Connect to AI Model API
+  </a>
+
 </li>
 
     </ul>
@@ -1330,6 +1360,11 @@ <h1>Accessing AI Model</h1>
 <td>Scikit-learn pipeline</td>
 <td>Tabular, image</td>
 </tr>
+<tr>
+<td>Connect to AI Model API</td>
+<td>Any AI Framework</td>
+<td>Tabular Only</td>
+</tr>
 </tbody>
 </table>
 <p>The list of datatype formats supported are as follows:</p>
@@ -1357,6 +1392,8 @@ <h2 id="upload-pipeline">Upload Pipeline</h2>
 <p>If your dataset requires pre-processing before being fed into the prediction model, you can upload the pre-processing functions together with your model as a pipeline folder.</p>
 <p><img alt="Upload Pipeline" src="../../res/getting-started/pipeline.png" /></p>
 <p>Currently, the toolkit supports a limited set of models. Check out the<a href="../../others/compatibility/"> full list of framework and algorithm types supported.</a></p>
+<h2 id="connect-to-ai-model-api">Connect to AI Model API</h2>
+<p><img alt="Connect to AI Model API" src="../../res/getting-started/api-connector.png" /></p>
 
 
 

diff --git a/getting-started/docker-setup/index.html b/getting-started/docker-setup/index.html
@@ -584,6 +584,8 @@
 
 
 
+
+
 
 
         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
@@ -1004,6 +1006,20 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../../how-to/connect-to-ai-model-api/" class="md-nav__link">
+        How to Connect to AI Model API
+      </a>
+    </li>
+
+
+
+
         </ul>
       </nav>
     </li>

diff --git a/getting-started/preparation-of-input-files/index.html b/getting-started/preparation-of-input-files/index.html
@@ -523,6 +523,8 @@
 
 
 
+
+
 
 
         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
@@ -943,6 +945,20 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../../how-to/connect-to-ai-model-api/" class="md-nav__link">
+        How to Connect to AI Model API
+      </a>
+    </li>
+
+
+
+
         </ul>
       </nav>
     </li>

diff --git a/getting-started/prepare-image/index.html b/getting-started/prepare-image/index.html
@@ -602,6 +602,8 @@
 
 
 
+
+
 
 
         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
@@ -1022,6 +1024,20 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../../how-to/connect-to-ai-model-api/" class="md-nav__link">
+        How to Connect to AI Model API
+      </a>
+    </li>
+
+
+
+
         </ul>
       </nav>
     </li>

diff --git a/getting-started/prepare-tabular/index.html b/getting-started/prepare-tabular/index.html
@@ -595,6 +595,8 @@
 
 
 
+
+
 
 
         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
@@ -1015,6 +1017,20 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../../how-to/connect-to-ai-model-api/" class="md-nav__link">
+        How to Connect to AI Model API
+      </a>
+    </li>
+
+
+
+
         </ul>
       </nav>
     </li>

diff --git a/getting-started/quick-start-guide/index.html b/getting-started/quick-start-guide/index.html
@@ -521,6 +521,8 @@
 
 
 
+
+
 
 
         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
@@ -941,6 +943,20 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../../how-to/connect-to-ai-model-api/" class="md-nav__link">
+        How to Connect to AI Model API
+      </a>
+    </li>
+
+
+
+
         </ul>
       </nav>
     </li>

diff --git a/getting-started/source-code-setup/index.html b/getting-started/source-code-setup/index.html
@@ -639,6 +639,8 @@
 
 
 
+
+
 
 
         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
@@ -1059,6 +1061,20 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../../how-to/connect-to-ai-model-api/" class="md-nav__link">
+        How to Connect to AI Model API
+      </a>
+    </li>
+
+
+
+
         </ul>
       </nav>
     </li>
-Original file line number
+Diff line change
@@ Expand Up / @@ -505,6 +505,8 @@ @@
             <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
@@ Expand Down Expand Up / @@ -925,6 +927,20 @@ @@
+        <li class="md-nav__item">
+          <a href="/aiverify/how-to/connect-to-ai-model-api/" class="md-nav__link">
+            How to Connect to AI Model API
+          </a>
+        </li>
             </ul>
           </nav>
         </li>
@@ Expand Down @@