Retvec demos (#37)

* Support loading multiple demos * Emotion demo - first steps * Make vuerouter compatible with a base url * Vue router and github pages * Deploy SPA to github pages * Simplify loading of models in demos * Load public path from base url * Retvec tokenizer * wip * Adds links to multiple demos * Add vuetify * Add simple homepage * Add demos * Add demos to main README * Bars component * Add jsconfig * Fix links * Cosmetic fixes --------- Co-authored-by: Luca Invernizzi <[email protected]>
google-research · Nov 10, 2023 · 0a96f41 · 0a96f41
1 parent 1296dc7
commit 0a96f41
Show file tree

Hide file tree

Showing 17 changed files with 3,670 additions and 218 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,10 @@ RETVec's speed and size (~200k instead of millions of parameters) also makes it
 
 Please see our example colabs on how to get started with training your own models with RETVec. [train_retvec_model_tf.ipynb](notebooks/train_retvec_model_tf.ipynb) is a great starting point for training a TF model using RETVec.
 
+## Demos
+
+To see RetVec in action, visit [our demos](https://google-research.github.io/retvec/).
+
 ## Getting started
 
 
@@ -62,7 +66,7 @@ Please cite this reference if you use RETVec in your research:
 
 ```bibtex
 @article{retvec2023,
-    title={RETVec: Resilient and Efficient Text Vectorizer}, 
+    title={RETVec: Resilient and Efficient Text Vectorizer},
     author={Elie Bursztein, Marina Zhang, Owen Vallis, Xinyu Jia, and Alexey Kurakin},
     year={2023},
     eprint={2302.09207}

diff --git a/demos/js/.gitignore b/demos/js/.gitignore
@@ -23,5 +23,7 @@ dist-ssr
 *.sln
 *.sw?
 
-# Ignore local copy of retvecjs
+# Ignore local copy of retvecjs.
 retvecjs
+# Ignore public files.
+public/
diff --git a/demos/js/jsconfig.json b/demos/js/jsconfig.json
@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "esnext",
+    "baseUrl": "./",
+    "moduleResolution": "node",
+    "paths": {
+      "@/*": [
+        "src/*"
+      ]
+    },
+    "lib": [
+      "esnext",
+      "dom",
+      "dom.iterable",
+      "scripthost"
+    ]
+  }
+}