update docs and bump validation percentage to 20%

cloud-annotations · Feb 26, 2020 · cfbd886 · cfbd886
1 parent 0b178b2
commit cfbd886
Show file tree

Hide file tree

Showing 13 changed files with 74 additions and 40 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -87,3 +87,4 @@ defaults:
       type: "guides"
     values:
       layout: guides
+      title: poodoo
diff --git a/docs/_guides/auto-labeling.md b/docs/_guides/auto-labeling.md
@@ -1,4 +1,5 @@
 ---
+title_overide: Auto labeling
 title: Documentation
 description: Getting started - Preparing training data - Object Detection - Classification
 # date: 1970-01-20

diff --git a/docs/_guides/downloading-a-model-via-cli.md b/docs/_guides/downloading-a-model-via-cli.md
@@ -3,6 +3,10 @@ title: Downloading a model via CLI
 # date: 1970-01-18
 ---
 
-With the Cloud Annotations CLI [installed](#installing-the-cloud-annotations-cli-cacli), we will download our trained model. First we need the model ID. This can be obtained by running `cacli list` to list all training runs, find the ID of the model that you would like to download. Then run:
+To download a trained model with the [Cloud Annotations CLI](#installing-the-cli), simply use the `cacli download` command.
 
-`cacli download <model id>`.
+```
+cacli download <model-id>
+```
+
+> **Note** The `model-id` can be obtained by running `cacli list` to list all available training runs.
diff --git a/docs/_guides/getting-started.md b/docs/_guides/getting-started.md
@@ -2,7 +2,6 @@
 title: Getting started
 # date: 1970-01-01
 ---
-> **Note:** `Guides` are a work in progress and coming soon! Until they are completed check out some of the [workshops](/workshops).
 
 Cloud Annotations makes labeling images and training machine learning models easy.
 Whether you've never touched a line of code in your life or you're a TensorFlow ninja, these docs will help you build what you need. Let's get started!

diff --git a/docs/_guides/installing-the-cli.md b/docs/_guides/installing-the-cli.md
@@ -1,5 +1,5 @@
 ---
-title: Installing the Cloud Annotations CLI (cacli)
+title: Installing the CLI
 # date: 1970-01-12
 ---
 

diff --git a/docs/_guides/non-interactive-training.md b/docs/_guides/non-interactive-training.md
@@ -1,5 +1,5 @@
 ---
-title: Non-interactive training (useful for CI)
+title: Non-interactive training
 # date: 1970-01-15
 ---
 

diff --git a/docs/_guides/using-a-model.md b/docs/_guides/using-a-model.md
@@ -3,4 +3,18 @@ title: Using a model
 # date: 1970-01-19
 ---
 
-Documentation coming soon
+You can use a model by copying the downloaded model folder into one of the following demos. Further usage instructions are provided on the demo's GitHub repo.
+
+## Classification demos
+- [React webapp](https://github.com/cloud-annotations/classification-react){:target="_blank"}
+- [iOS app](https://github.com/cloud-annotations/classification-ios){:target="_blank"}
+- [Android app](https://github.com/cloud-annotations/classification-android){:target="_blank"}
+
+## Object detection demos
+- [React webapp](https://github.com/cloud-annotations/object-detection-react){:target="_blank"}
+- [iOS app](https://github.com/cloud-annotations/object-detection-ios){:target="_blank"}
+- [Android app](https://github.com/cloud-annotations/object-detection-android){:target="_blank"}
+- [Livestream](https://github.com/cloud-annotations/object-detection-live-stream){:target="_blank"}
+- [Raspberry Pi](https://github.com/cloud-annotations/raspberrypi-streaming-object-detection){:target="_blank"}
+- [Python](https://github.com/cloud-annotations/object-detection-python){:target="_blank"}
+
diff --git a/docs/_layouts/base-guides.html b/docs/_layouts/base-guides.html
@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: " en " }}">
+
+{%- include head.html -%}
+
+<body>
+  {{ content }}
+
+  <script>
+
+const ID = function () {
+  // Math.random should be unique because of its seeding algorithm.
+  // Convert it to base 36 (numbers + letters), and grab the first 9 characters
+  // after the decimal.
+  return '-' + Math.random().toString(36).substr(2, 9);
+};
+
+$('body .markdown-body').find("h1").each(function() {
+  const h1ID = this.id
+  let listItems = []
+  $(this).next("section").find("h2").each(function() {
+    this.id = this.id + ID()
+    listItems.push('<li><a href="#' + this.id + '">'+$(this).text()+'</a></li>')
+  })
+  $("#nav-" + h1ID + ' .nav-stacked').html(listItems.join(''))
+})
+
+$('body').scrollspy({
+    target: '#the-nav-bar',
+    offset: 140
+})
+
+   </script>
+</body>
+
+</html>
diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html
@@ -5,32 +5,6 @@
 
 <body>
   {{ content }}
-
-  <script>
-
-const ID = function () {
-  // Math.random should be unique because of its seeding algorithm.
-  // Convert it to base 36 (numbers + letters), and grab the first 9 characters
-  // after the decimal.
-  return '-' + Math.random().toString(36).substr(2, 9);
-};
-
-$('body .markdown-body').find("h1").each(function() {
-  const h1ID = this.id
-  let listItems = []
-  $(this).next("section").find("h2").each(function() {
-    this.id = this.id + ID()
-    listItems.push('<li><a href="#' + this.id + '">'+$(this).text()+'</a></li>')
-  })
-  $("#nav-" + h1ID + ' .nav-stacked').html(listItems.join(''))
-})
-
-$('body').scrollspy({
-    target: '#the-nav-bar',
-    offset: 140
-})
-
-   </script>
 </body>
 
 </html>
diff --git a/docs/_layouts/guides.html b/docs/_layouts/guides.html
@@ -1,5 +1,5 @@
 ---
-layout: base
+layout: base-guides
 ---
 
 {% include titlebar.html active="guides" %}
@@ -9,8 +9,10 @@
   <nav class="col-xs-3 bs-docs-sidebar" id="the-nav-bar">
     <ul id="sidebar" class="nav nav-stacked fixed">
       {% for item in site[page.collection] %}
-      <li id="nav-{{ item.title | slugify }}">
-        <a href="#{{ item.title | slugify }}">{{ item.title }}</a>
+      <li id="nav-{{ item.title_overide | default: item.title | slugify }}">
+        <a href="#{{ item.title_overide | default: item.title | slugify }}"
+          >{{ item.title_overide | default: item.title }}</a
+        >
         <ul class="nav nav-stacked"></ul>
       </li>
       {% endfor %}
@@ -20,7 +22,9 @@
   <!--Main Content -->
   <article class="content markdown-body">
     {% for item in site[page.collection] %}
-    <h1 id="{{ item.title | slugify }}">{{ item.title }}</h1>
+    <h1 id="{{ item.title_overide | default: item.title | slugify }}">
+      {{ item.title_overide | default: item.title }}
+    </h1>
     <section class="guide-section">
       {{ item.content }}
     </section>

diff --git a/docs/demos.html b/docs/demos.html
@@ -6,8 +6,8 @@
 
 {% include titlebar.html active="demos" %}
 
-<main>
-  <ul style="margin-top: 100px">
+<main class="content markdown-body">
+  <ul style="padding-top: 80px">
     <li>
       <a href="https://github.com/cloud-annotations/object-detection-react"
         >object-detection-react</a

diff --git a/docs/sdks.html b/docs/sdks.html
@@ -6,8 +6,8 @@
 
 {% include titlebar.html active="sdks" %}
 
-<main>
-  <ul style="margin-top: 100px">
+<main class="content markdown-body">
+  <ul style="padding-top: 80px">
     <li>
       <a href="https://github.com/cloud-annotations/object-detection-js"
         >JavaScript</a

diff --git a/trainer/src/start.sh b/trainer/src/start.sh
@@ -54,6 +54,7 @@ python -m classification.retrain \
   --image_dir=data \
   --saved_model_dir=$OUTPUT_DIRECTORY/saved_model \
   --tfhub_module=https://tfhub.dev/google/imagenet/mobilenet_v1_100_224/feature_vector/1 \
+  --validation_percentage=20 \
   --how_many_training_steps=$1 \
   --output_labels=$OUTPUT_DIRECTORY/labels.txt
 fi