Reduce readme content and add detailed tutorial notes.

Former-commit-id: b18ed67
EduardKononov · Sep 27, 2019 · e1cc331 · e1cc331
1 parent f218e84
commit e1cc331
Show file tree

Hide file tree

Showing 44 changed files with 5,787 additions and 1,758 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/404.html b/docs/404.html
@@ -276,11 +276,11 @@
       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">
 
     <label class="md-nav__link" for="nav-2">
-      Documentation
+      Tutorials
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
       <label class="md-nav__title" for="nav-2">
-        Documentation
+        Tutorials
       </label>
       <ul class="md-nav__list" data-md-scrollfix>
 
@@ -290,28 +290,45 @@
 
 
 
-  <li class="md-nav__item md-nav__item--nested">
-
-      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2-1" type="checkbox" id="nav-2-1">
-
-    <label class="md-nav__link" for="nav-2-1">
-      Evaluation
-    </label>
-    <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
-      <label class="md-nav__title" for="nav-2-1">
-        Evaluation
-      </label>
-      <ul class="md-nav__list" data-md-scrollfix>
+  <li class="md-nav__item">
+    <a href="/tutorials/finding_duplicates/" title="Find duplicates" class="md-nav__link">
+      Find duplicates
+    </a>
+  </li>
+
 
+
+
+
+
+
+  <li class="md-nav__item">
+    <a href="/tutorials/feature_generation/" title="Feature generation" class="md-nav__link">
+      Feature generation
+    </a>
+  </li>
+
 
 
 
 
 
 
   <li class="md-nav__item">
-    <a href="/evaluation/evaluation/" title="Evaluation" class="md-nav__link">
-      Evaluation
+    <a href="/tutorials/evaluating_performance/" title="Evaluating performance" class="md-nav__link">
+      Evaluating performance
+    </a>
+  </li>
+
+
+
+
+
+
+
+  <li class="md-nav__item">
+    <a href="/tutorials/plotting_duplicates/" title="Plotting duplicates" class="md-nav__link">
+      Plotting duplicates
     </a>
   </li>
 
@@ -320,6 +337,25 @@
     </nav>
   </li>
 
+
+
+
+
+
+
+  <li class="md-nav__item md-nav__item--nested">
+
+      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
+
+    <label class="md-nav__link" for="nav-3">
+      Documentation
+    </label>
+    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
+      <label class="md-nav__title" for="nav-3">
+        Documentation
+      </label>
+      <ul class="md-nav__list" data-md-scrollfix>
+
 
 
 
@@ -328,13 +364,13 @@
 
   <li class="md-nav__item md-nav__item--nested">
 
-      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2-2" type="checkbox" id="nav-2-2">
+      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3-1" type="checkbox" id="nav-3-1">
 
-    <label class="md-nav__link" for="nav-2-2">
+    <label class="md-nav__link" for="nav-3-1">
       Methods
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
-      <label class="md-nav__title" for="nav-2-2">
+      <label class="md-nav__title" for="nav-3-1">
         Methods
       </label>
       <ul class="md-nav__list" data-md-scrollfix>
@@ -376,13 +412,49 @@
 
   <li class="md-nav__item md-nav__item--nested">
 
-      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2-3" type="checkbox" id="nav-2-3">
+      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3-2" type="checkbox" id="nav-3-2">
+
+    <label class="md-nav__link" for="nav-3-2">
+      Evaluation
+    </label>
+    <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
+      <label class="md-nav__title" for="nav-3-2">
+        Evaluation
+      </label>
+      <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+  <li class="md-nav__item">
+    <a href="/evaluation/evaluation/" title="Evaluation" class="md-nav__link">
+      Evaluation
+    </a>
+  </li>
+
+
+      </ul>
+    </nav>
+  </li>
+
+
+
+
+
+
+
+  <li class="md-nav__item md-nav__item--nested">
+
+      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3-3" type="checkbox" id="nav-3-3">
 
-    <label class="md-nav__link" for="nav-2-3">
+    <label class="md-nav__link" for="nav-3-3">
       Utils
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
-      <label class="md-nav__title" for="nav-2-3">
+      <label class="md-nav__title" for="nav-3-3">
         Utils
       </label>
       <ul class="md-nav__list" data-md-scrollfix>

diff --git a/docs/CONTRIBUTING/index.html b/docs/CONTRIBUTING/index.html
@@ -280,11 +280,11 @@
       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">
 
     <label class="md-nav__link" for="nav-2">
-      Documentation
+      Tutorials
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
       <label class="md-nav__title" for="nav-2">
-        Documentation
+        Tutorials
       </label>
       <ul class="md-nav__list" data-md-scrollfix>
 
@@ -294,28 +294,45 @@
 
 
 
-  <li class="md-nav__item md-nav__item--nested">
-
-      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2-1" type="checkbox" id="nav-2-1">
-
-    <label class="md-nav__link" for="nav-2-1">
-      Evaluation
-    </label>
-    <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
-      <label class="md-nav__title" for="nav-2-1">
-        Evaluation
-      </label>
-      <ul class="md-nav__list" data-md-scrollfix>
+  <li class="md-nav__item">
+    <a href="../tutorials/finding_duplicates/" title="Find duplicates" class="md-nav__link">
+      Find duplicates
+    </a>
+  </li>
+
 
+
+
+
+
+
+  <li class="md-nav__item">
+    <a href="../tutorials/feature_generation/" title="Feature generation" class="md-nav__link">
+      Feature generation
+    </a>
+  </li>
+
 
 
 
 
 
 
   <li class="md-nav__item">
-    <a href="../evaluation/evaluation/" title="Evaluation" class="md-nav__link">
-      Evaluation
+    <a href="../tutorials/evaluating_performance/" title="Evaluating performance" class="md-nav__link">
+      Evaluating performance
+    </a>
+  </li>
+
+
+
+
+
+
+
+  <li class="md-nav__item">
+    <a href="../tutorials/plotting_duplicates/" title="Plotting duplicates" class="md-nav__link">
+      Plotting duplicates
     </a>
   </li>
 
@@ -324,6 +341,25 @@
     </nav>
   </li>
 
+
+
+
+
+
+
+  <li class="md-nav__item md-nav__item--nested">
+
+      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
+
+    <label class="md-nav__link" for="nav-3">
+      Documentation
+    </label>
+    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
+      <label class="md-nav__title" for="nav-3">
+        Documentation
+      </label>
+      <ul class="md-nav__list" data-md-scrollfix>
+
 
 
 
@@ -332,13 +368,13 @@
 
   <li class="md-nav__item md-nav__item--nested">
 
-      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2-2" type="checkbox" id="nav-2-2">
+      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3-1" type="checkbox" id="nav-3-1">
 
-    <label class="md-nav__link" for="nav-2-2">
+    <label class="md-nav__link" for="nav-3-1">
       Methods
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
-      <label class="md-nav__title" for="nav-2-2">
+      <label class="md-nav__title" for="nav-3-1">
         Methods
       </label>
       <ul class="md-nav__list" data-md-scrollfix>
@@ -380,13 +416,49 @@
 
   <li class="md-nav__item md-nav__item--nested">
 
-      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2-3" type="checkbox" id="nav-2-3">
+      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3-2" type="checkbox" id="nav-3-2">
+
+    <label class="md-nav__link" for="nav-3-2">
+      Evaluation
+    </label>
+    <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
+      <label class="md-nav__title" for="nav-3-2">
+        Evaluation
+      </label>
+      <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+  <li class="md-nav__item">
+    <a href="../evaluation/evaluation/" title="Evaluation" class="md-nav__link">
+      Evaluation
+    </a>
+  </li>
+
+
+      </ul>
+    </nav>
+  </li>
+
+
+
+
+
+
+
+  <li class="md-nav__item md-nav__item--nested">
+
+      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3-3" type="checkbox" id="nav-3-3">
 
-    <label class="md-nav__link" for="nav-2-3">
+    <label class="md-nav__link" for="nav-3-3">
       Utils
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
-      <label class="md-nav__title" for="nav-2-3">
+      <label class="md-nav__title" for="nav-3-3">
         Utils
       </label>
       <ul class="md-nav__list" data-md-scrollfix>