Update docs

README.md

@@ -25,12 +25,19 @@ The `outputs` folder contains all of the intermediate outputs of our code, excep
 ## Reproduce Results
 The prefered method to reproduce our paper's results is to use Docker. Please install [Docker](https://docs.docker.com/get-docker/) if you do not already have it install.
 
+```bash
+git clone https://github.com/ncoop57/tango.git
+cd tango
+```
+
 **Reproduce via Docker:**
 ```bash
+cd docker_build
 docker build -f Dockerfile.prod -t tango .
-docker run -d -u $(id -u):$(id -g) -v <out_path>:/data tango <vis_model>
+cd ..
+docker run -v <out_path>:/data tango <vis_model>
 ```
-* **out_path**: The directory on your machine you want all files to be saved to
+* **out_path**: The absolute path on your machine you want all files to be saved to
 * **vis_model**: The type of visual model. Can be either SimCLR or SIFT, taking ~6 hours or >2 weeks, respectively, for all apps on our machine with 755G of RAM and 72 CPUs.
 
 **Reproduce without Docker:**

docs/index.html

@@ -60,12 +60,17 @@ <h2 id="Data">Data<a class="anchor-link" href="#Data"> </a></h2>
 <div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
 <div class="text_cell_render border-box-sizing rendered_html">
 <h2 id="Reproduce-Results">Reproduce Results<a class="anchor-link" href="#Reproduce-Results"> </a></h2><p>The prefered method to reproduce our paper's results is to use Docker. Please install <a href="https://docs.docker.com/get-docker/">Docker</a> if you do not already have it install.</p>
+<div class="highlight"><pre><span></span>git clone https://github.com/ncoop57/tango.git
+<span class="nb">cd</span> tango
+</pre></div>
 <p><strong>Reproduce via Docker:</strong></p>
-<div class="highlight"><pre><span></span>docker build -f Dockerfile.prod -t tango .
-docker run -d -u <span class="k">$(</span>id -u<span class="k">)</span>:<span class="k">$(</span>id -g<span class="k">)</span> -v &lt;out_path&gt;:/data tango &lt;vis_model&gt;
+<div class="highlight"><pre><span></span><span class="nb">cd</span> docker_build
+docker build -f Dockerfile.prod -t tango .
+<span class="nb">cd</span> ..
+docker run -v &lt;out_path&gt;:/data tango &lt;vis_model&gt;
 </pre></div>
 <ul>
-<li><strong>out_path</strong>: The directory on your machine you want all files to be saved to</li>
+<li><strong>out_path</strong>: The absolute path on your machine you want all files to be saved to</li>
 <li><strong>vis_model</strong>: The type of visual model. Can be either SimCLR or SIFT, taking ~6 hours or &gt;2 weeks, respectively, for all apps on our machine with 755G of RAM and 72 CPUs.</li>
 </ul>
 <p><strong>Reproduce without Docker:</strong></p>

docs/sidebar.json

@@ -1,14 +1,14 @@
 {
   "two_to_tango": {
     "Overview": "/",
-    "Prep": "prep",
-    "Features": "features",
-    "Eval": "eval",
-    "Model": "model",
-    "Approach": "approach",
-    "CLI": "cli",
-    "Results": "results",
-    "Utilities": "utils",
-    "Combinations": "combo"
+    "Prep": "prep.html",
+    "Features": "features.html",
+    "Eval": "eval.html",
+    "Model": "model.html",
+    "Approach": "approach.html",
+    "CLI": "cli.html",
+    "Results": "results.html",
+    "Utilities": "utils.html",
+    "Combinations": "combo.html"
   }
-}
+}

nbs/index.ipynb

@@ -51,12 +51,19 @@
     "## Reproduce Results\n",
     "The prefered method to reproduce our paper's results is to use Docker. Please install [Docker](https://docs.docker.com/get-docker/) if you do not already have it install.\n",
     "\n",
+    "```bash\n",
+    "git clone https://github.com/ncoop57/tango.git\n",
+    "cd tango\n",
+    "```\n",
+    "\n",
     "**Reproduce via Docker:**\n",
     "```bash\n",
+    "cd docker_build\n",
     "docker build -f Dockerfile.prod -t tango .\n",
-    "docker run -d -u $(id -u):$(id -g) -v <out_path>:/data tango <vis_model>\n",
+    "cd ..\n",
+    "docker run -v <out_path>:/data tango <vis_model>\n",
     "```\n",
-    "* **out_path**: The directory on your machine you want all files to be saved to\n",
+    "* **out_path**: The absolute path on your machine you want all files to be saved to\n",
     "* **vis_model**: The type of visual model. Can be either SimCLR or SIFT, taking ~6 hours or >2 weeks, respectively, for all apps on our machine with 755G of RAM and 72 CPUs.\n",
     "\n",
     "**Reproduce without Docker:**\n",