Add high-level documentation

1 files changed, 180 insertions, 0 deletions

diff --git a/resources/model_pipeline.svg b/resources/model_pipeline.svg
new file mode 100644
index 00000000..a0e3d244
--- /dev/null
+++ b/resources/model_pipeline.svg
@@ -0,0 +1,180 @@
+<svg height="100pt" viewBox="0 0 239 100" width="318pt" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+  <style type="text/css">
+    svg {
+      background: inherit;
+      fill: #000;
+    }
+
+    symbol {
+      fill: #000;
+      stroke: none;
+    }
+
+    svg > path , g {
+      stroke: #000;
+    }
+
+    @media (prefers-color-scheme: dark) {
+      svg {
+        fill: #CCC;
+      }
+
+      symbol {
+        fill: #CCC;
+      }
+
+      svg > path , g {
+        stroke: #CCC;
+      }
+    }
+  </style>
+  <symbol id="a" overflow="visible">
+    <path d="M5.344-4.625c0-1.281-.89-2.016-2.39-2.016-1.438 0-2.329.735-2.329 1.907 0 .812.422 1.312 1.281 1.53l1.625.438c.828.204 1.203.547 1.203 1.047 0 .36-.187.719-.468.907-.25.187-.672.28-1.204.28-.703 0-1.187-.171-1.5-.546-.25-.281-.359-.594-.343-1H.437c0 .594.126 1 .376 1.36.453.609 1.203.921 2.203.921.78 0 1.421-.172 1.843-.5.438-.344.704-.937.704-1.5 0-.797-.5-1.39-1.391-1.64l-1.64-.438c-.782-.219-1.063-.469-1.063-.969 0-.656.578-1.11 1.453-1.11 1.047 0 1.625.485 1.64 1.329zm0 0"/>
+  </symbol>
+  <symbol id="b" overflow="visible">
+    <path d="M2.281-4.703H1.5v-1.281H.766v1.28H.125v.61h.64V-.53c0 .469.313.734.907.734.172 0 .36-.016.61-.062v-.625c-.11.03-.22.03-.36.03-.328 0-.422-.077-.422-.421v-3.219h.781zm0 0"/>
+  </symbol>
+  <symbol id="c" overflow="visible">
+    <path d="M4.797-.438a.634.634 0 01-.156.016c-.266 0-.407-.14-.407-.375v-2.75c0-.844-.609-1.281-1.765-1.281-.688 0-1.25.187-1.563.547-.219.234-.312.5-.328.968h.766c.062-.578.39-.828 1.093-.828.672 0 1.047.25 1.047.704v.187c0 .313-.187.453-.78.531-1.048.125-1.22.156-1.5.281-.548.22-.829.641-.829 1.25 0 .86.594 1.391 1.547 1.391.594 0 1.062-.203 1.594-.687.046.468.28.687.765.687.157 0 .282-.016.516-.078zM3.484-1.484c0 .25-.062.406-.296.609-.297.281-.672.422-1.11.422-.578 0-.922-.266-.922-.75s.328-.75 1.125-.86.953-.14 1.203-.265zm0 0"/>
+  </symbol>
+  <symbol id="d" overflow="visible">
+    <path d="M4.594-2.094c0-.719-.047-1.156-.188-1.5-.297-.781-1.015-1.234-1.89-1.234-1.313 0-2.157 1-2.157 2.547C.36-.75 1.172.203 2.5.203c1.063 0 1.813-.61 2-1.625h-.75c-.203.61-.625.938-1.234.938-.47 0-.875-.22-1.125-.61-.188-.265-.25-.531-.25-1zm-3.438-.61C1.22-3.577 1.75-4.14 2.5-4.14c.734 0 1.297.61 1.297 1.375v.063zm0 0"/>
+  </symbol>
+  <symbol id="e" overflow="visible">
+    <path d="M.625-4.703V0h.75v-2.953c0-.672.5-1.219 1.11-1.219.562 0 .874.328.874.938V0h.75v-2.953c0-.672.485-1.219 1.094-1.219.563 0 .875.344.875.938V0h.75v-3.531c0-.844-.484-1.297-1.36-1.297-.624 0-1 .187-1.437.719-.281-.516-.656-.72-1.265-.72-.625 0-1.047.235-1.454.798v-.672zm0 0"/>
+  </symbol>
+  <symbol id="f" overflow="visible">
+    <path d="M.625-4.703V0h.75v-2.594c0-.953.516-1.578 1.281-1.578.594 0 .969.344.969.922V0h.75v-3.547c0-.781-.594-1.281-1.5-1.281-.703 0-1.14.266-1.563.922v-.797zm0 0"/>
+  </symbol>
+  <symbol id="g" overflow="visible">
+    <path d="M4.672 0l2.031-6.094V0h.89v-7.266H6.298L4.187-.937 2.031-7.266H.75V0h.875v-6.094L3.688 0zm0 0"/>
+  </symbol>
+  <symbol id="h" overflow="visible">
+    <path d="M2.719-5.375c-1.469 0-2.36 1.047-2.36 2.797C.36-.813 1.234.234 2.72.234c1.469 0 2.36-1.046 2.36-2.765 0-1.813-.86-2.844-2.36-2.844zm0 .766c.937 0 1.5.765 1.5 2.062 0 1.235-.578 2.016-1.5 2.016s-1.5-.781-1.5-2.047c0-1.25.578-2.031 1.5-2.031zm0 0"/>
+  </symbol>
+  <symbol id="i" overflow="visible">
+    <path d="M4.938-7.266h-.829v2.704c-.343-.532-.906-.813-1.609-.813-1.36 0-2.234 1.094-2.234 2.75 0 1.766.859 2.86 2.265 2.86.719 0 1.219-.282 1.672-.922V0h.734zM2.64-4.594c.89 0 1.468.797 1.468 2.047 0 1.203-.578 2-1.453 2-.922 0-1.531-.812-1.531-2.031 0-1.203.61-2.016 1.516-2.016zm0 0"/>
+  </symbol>
+  <symbol id="j" overflow="visible">
+    <path d="M5.11-2.328c0-.797-.063-1.281-.204-1.672-.343-.86-1.14-1.375-2.11-1.375-1.468 0-2.39 1.125-2.39 2.828 0 1.719.906 2.781 2.36 2.781C3.969.234 4.796-.453 5-1.578h-.828c-.234.687-.703 1.047-1.375 1.047a1.44 1.44 0 01-1.25-.688c-.203-.297-.266-.593-.281-1.11zm-3.83-.688c.078-.968.657-1.593 1.5-1.593.813 0 1.453.687 1.453 1.53 0 .032 0 .048-.015.063zm0 0"/>
+  </symbol>
+  <symbol id="k" overflow="visible">
+    <path d="M1.516-7.266H.672V0h.844zm0 0"/>
+  </symbol>
+  <symbol id="l" overflow="visible">
+    <path d="M1.938-7.266H1V0h.938zm0 0"/>
+  </symbol>
+  <symbol id="m" overflow="visible">
+    <path d="M.703-5.219V0h.828v-2.875c0-1.078.563-1.766 1.422-1.766.656 0 1.078.391 1.078 1.016V0h.828v-3.953c0-.86-.656-1.422-1.656-1.422-.781 0-1.281.297-1.734 1.031v-.875zm0 0"/>
+  </symbol>
+  <symbol id="n" overflow="visible">
+    <path d="M4.36-3.766c0-1.03-.688-1.609-1.891-1.609-1.219 0-2 .625-2 1.594 0 .828.422 1.203 1.656 1.515l.781.188c.578.14.797.344.797.719 0 .484-.484.828-1.203.828-.453 0-.828-.14-1.047-.36-.125-.14-.187-.296-.234-.671H.344C.375-.345 1.063.234 2.422.234c1.312 0 2.156-.656 2.156-1.656 0-.781-.437-1.203-1.484-1.453l-.797-.203c-.672-.156-.969-.375-.969-.735 0-.484.438-.796 1.11-.796s1.03.296 1.046.843zm0 0"/>
+  </symbol>
+  <symbol id="o" overflow="visible">
+    <path d="M.688-5.219V0h.843v-2.719c0-.734.188-1.234.578-1.515.266-.188.516-.25 1.094-.266v-.844c-.14-.015-.219-.031-.328-.031-.531 0-.938.328-1.422 1.094v-.938zm0 0"/>
+  </symbol>
+  <symbol id="p" overflow="visible">
+    <path d="M2.531-5.219h-.86v-1.437H.845v1.437H.14v.672h.703v3.953c0 .531.36.828 1.015.828.188 0 .391-.03.672-.078V-.53c-.11.015-.234.031-.39.031-.36 0-.47-.094-.47-.469v-3.578h.86zm0 0"/>
+  </symbol>
+  <symbol id="u" overflow="visible">
+    <path d="M1.86-3.125h2.39c.828 0 1.188.39 1.188 1.297v.64c0 .454.078.891.203 1.188h1.125v-.234c-.344-.235-.422-.5-.438-1.454-.016-1.203-.203-1.562-.984-1.906.812-.39 1.14-.906 1.14-1.734 0-1.25-.78-1.938-2.203-1.938H.921V0h.938zm0-.828v-2.5h2.234c.515 0 .828.078 1.047.281.25.203.375.547.375.984 0 .844-.438 1.235-1.422 1.235zm0 0"/>
+  </symbol>
+  <symbol id="v" overflow="visible">
+    <path d="M5.328-.484c-.078.015-.125.015-.172.015-.297 0-.453-.156-.453-.406v-3.078c0-.922-.672-1.422-1.969-1.422-.75 0-1.375.219-1.734.61-.234.265-.328.562-.36 1.093h.844c.079-.64.454-.937 1.235-.937.734 0 1.156.28 1.156.78v.22c0 .343-.203.5-.86.578-1.187.156-1.359.187-1.687.312-.594.25-.906.719-.906 1.406 0 .938.656 1.547 1.719 1.547.656 0 1.171-.234 1.765-.765.063.515.328.765.86.765.171 0 .296-.03.562-.093zM3.875-1.641c0 .282-.078.438-.328.672-.344.313-.75.469-1.235.469-.64 0-1.03-.313-1.03-.828 0-.563.374-.828 1.265-.969.875-.11 1.047-.156 1.328-.281zm0 0"/>
+  </symbol>
+  <symbol id="A" overflow="visible">
+    <path d="M1.828-3.313h3.953v-.812H1.828v-2.328h4.11v-.813H.89V0h5.218v-.813H1.83zm0 0"/>
+  </symbol>
+  <symbol id="B" overflow="visible">
+    <path d="M2.844 0l2-5.219h-.938L2.437-.984 1.032-5.22H.094L1.937 0zm0 0"/>
+  </symbol>
+  <symbol id="q" overflow="visible">
+    <path d="M6.594-5.016C6.312-6.609 5.39-7.39 3.797-7.39c-.969 0-1.766.313-2.297.907C.844-5.766.484-4.72.484-3.547c0 1.188.36 2.219 1.047 2.922.563.578 1.282.86 2.235.86 1.765 0 2.765-.97 2.984-2.891h-.953c-.078.5-.188.844-.328 1.125-.313.61-.922.937-1.703.937-1.438 0-2.36-1.156-2.36-2.969 0-1.859.875-3 2.282-3 .593 0 1.14.172 1.437.454.266.25.422.562.531 1.093zm0 0"/>
+  </symbol>
+  <symbol id="r" overflow="visible">
+    <path d="M5.328-.484c-.078.015-.125.015-.172.015-.297 0-.453-.156-.453-.406v-3.078c0-.922-.672-1.422-1.969-1.422-.75 0-1.375.219-1.734.61-.234.265-.328.562-.36 1.093h.844c.079-.64.454-.937 1.235-.937.734 0 1.156.28 1.156.78v.22c0 .343-.203.5-.86.578-1.187.156-1.359.187-1.687.312-.594.25-.906.719-.906 1.406 0 .938.656 1.547 1.719 1.547.656 0 1.171-.234 1.765-.765.063.515.328.765.86.765.171 0 .296-.03.562-.093zM3.875-1.641c0 .282-.078.438-.328.672-.344.313-.75.469-1.235.469-.64 0-1.03-.313-1.03-.828 0-.563.374-.828 1.265-.969.875-.11 1.047-.156 1.328-.281zm0 0"/>
+  </symbol>
+  <symbol id="s" overflow="visible">
+    <path d="M.703-5.219V0h.828v-2.875c0-1.078.563-1.766 1.422-1.766.656 0 1.078.391 1.078 1.016V0h.828v-3.953c0-.86-.656-1.422-1.656-1.422-.781 0-1.281.297-1.734 1.031v-.875zm0 0"/>
+  </symbol>
+  <symbol id="t" overflow="visible">
+    <path d="M2.719-5.375c-1.469 0-2.36 1.047-2.36 2.797C.36-.813 1.234.234 2.72.234c1.469 0 2.36-1.046 2.36-2.765 0-1.813-.86-2.844-2.36-2.844zm0 .766c.937 0 1.5.765 1.5 2.062 0 1.235-.578 2.016-1.5 2.016s-1.5-.781-1.5-2.047c0-1.25.578-2.031 1.5-2.031zm0 0"/>
+  </symbol>
+  <symbol id="w" overflow="visible">
+    <path d="M5.797-6.531H5v5.343L1.594-6.53H.687V0h.782v-5.297L4.859 0h.938zm0 0"/>
+  </symbol>
+  <symbol id="x" overflow="visible">
+    <path d="M2.438-4.828c-1.313 0-2.11.937-2.11 2.516S1.11.203 2.453.203c1.313 0 2.125-.937 2.125-2.484 0-1.625-.781-2.547-2.14-2.547zm.015.687c.844 0 1.344.688 1.344 1.86 0 1.094-.516 1.797-1.344 1.797-.844 0-1.344-.688-1.344-1.829 0-1.124.5-1.828 1.344-1.828zm0 0"/>
+  </symbol>
+  <symbol id="y" overflow="visible">
+    <path d="M4.438-6.531h-.75v2.422c-.313-.47-.813-.72-1.438-.72-1.219 0-2.016.97-2.016 2.47 0 1.593.782 2.562 2.047 2.562.64 0 1.094-.234 1.5-.828V0h.656zm-2.063 2.39c.813 0 1.313.72 1.313 1.844C3.688-1.203 3.171-.5 2.39-.5c-.829 0-1.375-.719-1.375-1.813s.547-1.827 1.36-1.827zm0 0"/>
+  </symbol>
+  <symbol id="z" overflow="visible">
+    <path d="M4.594-2.094c0-.719-.047-1.156-.188-1.5-.297-.781-1.015-1.234-1.89-1.234-1.313 0-2.157 1-2.157 2.547C.36-.75 1.172.203 2.5.203c1.063 0 1.813-.61 2-1.625h-.75c-.203.61-.625.938-1.234.938-.47 0-.875-.22-1.125-.61-.188-.265-.25-.531-.25-1zm-3.438-.61C1.22-3.577 1.75-4.14 2.5-4.14c.734 0 1.297.61 1.297 1.375v.063zm0 0"/>
+  </symbol>
+  <use x="177" xlink:href="#a" y="28.23"/>
+  <use x="182.981" xlink:href="#b" y="28.23"/>
+  <use x="185.473" xlink:href="#c" y="28.23"/>
+  <use x="190.459" xlink:href="#b" y="28.23"/>
+  <use x="192.951" xlink:href="#d" y="28.23"/>
+  <use x="197.937" xlink:href="#e" y="28.23"/>
+  <use x="205.406" xlink:href="#d" y="28.23"/>
+  <use x="210.391" xlink:href="#f" y="28.23"/>
+  <use x="215.376" xlink:href="#b" y="28.23"/>
+  <path d="M173 17v76h48V17zm0 0" fill="none" stroke="#000" stroke-linejoin="round" stroke-miterlimit="10" stroke-width=".8"/>
+  <use x="191.436" xlink:href="#g" y="12.517"/>
+  <use x="199.735" xlink:href="#h" y="12.517"/>
+  <use x="205.274" xlink:href="#i" y="12.517"/>
+  <use x="210.813" xlink:href="#j" y="12.517"/>
+  <use x="216.352" xlink:href="#k" y="12.517"/>
+  <path d="M169 1v96h68V1zm0 0" fill="none" stroke="#000" stroke-linejoin="round" stroke-miterlimit="10" stroke-width=".8"/>
+  <use x="115.915" xlink:href="#l" y="52.517"/>
+  <use x="118.684" xlink:href="#m" y="52.517"/>
+  <use x="124.223" xlink:href="#n" y="52.517"/>
+  <use x="129.205" xlink:href="#j" y="52.517"/>
+  <use x="134.744" xlink:href="#o" y="52.517"/>
+  <use x="138.46" xlink:href="#p" y="52.517"/>
+  <use x="141.229" xlink:href="#j" y="52.517"/>
+  <use x="146.769" xlink:href="#o" y="52.517"/>
+  <path d="M113 41v16h40V41zm40 8h16" fill="none" stroke="#000" stroke-linejoin="round" stroke-miterlimit="10" stroke-width=".8"/>
+  <use x="62.325" xlink:href="#q" y="52.59"/>
+  <use x="69.518" xlink:href="#r" y="52.59"/>
+  <use x="75.057" xlink:href="#s" y="52.59"/>
+  <use x="80.596" xlink:href="#t" y="52.59"/>
+  <use x="86.136" xlink:href="#s" y="52.59"/>
+  <g stroke="#000" stroke-linejoin="round" stroke-miterlimit="10" stroke-width=".8">
+    <path d="M57 41v16h40V41zm0 0" fill="none"/>
+    <path d="M97 49h16" fill="none" stroke-dasharray="1 1"/>
+    <path d="M113 49l-5-1.664v3.328zm0 0" fill-rule="evenodd"/>
+    <path d="M41 49h16" fill="none" stroke-dasharray="1 1"/>
+    <path d="M57 49l-5-1.664v3.328zm0 0" fill-rule="evenodd"/>
+  </g>
+  <use x="4.667" xlink:href="#u" y="52.517"/>
+  <use x="11.859" xlink:href="#j" y="52.517"/>
+  <use x="17.399" xlink:href="#v" y="52.517"/>
+  <use x="22.938" xlink:href="#i" y="52.517"/>
+  <use x="28.477" xlink:href="#j" y="52.517"/>
+  <use x="34.016" xlink:href="#o" y="52.517"/>
+  <path d="M1 41v16h40V41zm0 0" fill="none" stroke="#000" stroke-linejoin="round" stroke-miterlimit="10" stroke-width=".8"/>
+  <use x="185" xlink:href="#w" y="44.165"/>
+  <use x="191.474" xlink:href="#x" y="44.165"/>
+  <use x="196.459" xlink:href="#y" y="44.165"/>
+  <use x="201.444" xlink:href="#z" y="44.165"/>
+  <path d="M181 33v16h32V33zm0 20v16h32V53zm0 20v16h32V73zm0 0" fill="none" stroke="#000" stroke-linejoin="round" stroke-miterlimit="10" stroke-width=".8"/>
+  <use x="185" xlink:href="#w" y="64.165"/>
+  <use x="191.474" xlink:href="#x" y="64.165"/>
+  <use x="196.459" xlink:href="#y" y="64.165"/>
+  <use x="201.444" xlink:href="#z" y="64.165"/>
+  <use x="185" xlink:href="#w" y="84.165"/>
+  <use x="191.474" xlink:href="#x" y="84.165"/>
+  <use x="196.459" xlink:href="#y" y="84.165"/>
+  <use x="201.444" xlink:href="#z" y="84.165"/>
+  <path d="M226.2 53c0-1.602-2.4-1.602-2.4 0s2.4 1.602 2.4 0zm4 0c0-1.602-2.4-1.602-2.4 0s2.4 1.602 2.4 0zm4 0c0-1.602-2.4-1.602-2.4 0s2.4 1.602 2.4 0zm0 0" fill-rule="evenodd"/>
+  <use x="12.517" xlink:href="#A" y="12.599"/>
+  <use x="19.162" xlink:href="#m" y="12.599"/>
+  <use x="24.502" xlink:href="#B" y="12.599"/>
+  <g stroke="#000" stroke-linejoin="round" stroke-miterlimit="10" stroke-width=".8">
+    <path d="M1 1v16h40V1zm20 40V17" fill="none"/>
+    <path d="M21 17l-1.664 5h3.328zm0 0" fill-rule="evenodd"/>
+  </g>
+</svg>