document permissions

vanna-ai · Jul 27, 2023 · 72b7a26 · 72b7a26
1 parent 32128b8
commit 72b7a26
Showing 1 changed file with 39 additions and 0 deletions.
diff --git a/src/vanna/__init__.py b/src/vanna/__init__.py
@@ -33,6 +33,45 @@
 | `vn.update_` | Updates something in the model | [`vn.update_model_visibility(...)`][vanna.update_model_visibility] |
 | `vn.connect_` | Connects to a database | [`vn.connect_to_snowflake(...)`][vanna.connect_to_snowflake] |
 
+# Permissions
+By default when you create a model it is private. You can add members or admins to your model or make it public.
+
+<table>
+  <tr>
+    <th rowspan="2">User Role</th>
+    <th colspan="2">Public Model</th>
+    <th colspan="2">Private Model</th>
+  </tr>
+  <tr>
+    <td>Use</td>
+    <td>Train</td>
+    <td>Use</td>
+    <td>Train</td>
+  </tr>
+  <tr>
+    <td>Non-Member</td>
+    <td>✅</td>
+    <td>❌</td>
+    <td>❌</td>
+    <td>❌</td>
+  </tr>
+  <tr>
+    <td>Member</td>
+    <td>✅</td>
+    <td>❌</td>
+    <td>✅</td>
+    <td>❌</td>
+  </tr>
+  <tr>
+    <td>Admin</td>
+    <td>✅</td>
+    <td>✅</td>
+    <td>✅</td>
+    <td>✅</td>
+  </tr>
+</table>
+
+
 # API Reference
 '''