Deployed 0e3e844 with MkDocs version: 1.5.3

Striveworks · Feb 27, 2024 · 336bc73 · 336bc73
1 parent 680d174
commit 336bc73
Show file tree

Hide file tree

Showing 28 changed files with 33 additions and 32 deletions.
diff --git a/404.html b/404.html
@@ -12,7 +12,7 @@
 
 
       <link rel="icon" href="/assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.10">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.11">
 
 
 

diff --git a/basic_usage/index.html b/basic_usage/index.html
@@ -8,7 +8,7 @@
 <link href="../installation/" rel="prev"/>
 <link href="../metadata_and_filtering/" rel="next"/>
 <link href="../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Basic Usage - Valor</title>
 <link href="../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Annotation/index.html b/client_api/Annotation/index.html
@@ -8,7 +8,7 @@
 <link href="../../contributing/" rel="prev"/>
 <link href="../Client/" rel="next"/>
 <link href="../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Annotation - Valor</title>
 <link href="../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Client/index.html b/client_api/Client/index.html
@@ -8,7 +8,7 @@
 <link href="../Annotation/" rel="prev"/>
 <link href="../Data%20Generation/" rel="next"/>
 <link href="../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Client - Valor</title>
 <link href="../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Data Generation/index.html b/client_api/Data Generation/index.html
@@ -8,7 +8,7 @@
 <link href="../Client/" rel="prev"/>
 <link href="../Dataset/" rel="next"/>
 <link href="../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Data Generation - Valor</title>
 <link href="../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Dataset/index.html b/client_api/Dataset/index.html
@@ -8,7 +8,7 @@
 <link href="../Data%20Generation/" rel="prev"/>
 <link href="../Datum/" rel="next"/>
 <link href="../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Dataset - Valor</title>
 <link href="../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Datum/index.html b/client_api/Datum/index.html
@@ -8,7 +8,7 @@
 <link href="../Dataset/" rel="prev"/>
 <link href="../Evaluation/" rel="next"/>
 <link href="../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Datum - Valor</title>
 <link href="../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Evaluation/index.html b/client_api/Evaluation/index.html
@@ -8,7 +8,7 @@
 <link href="../Datum/" rel="prev"/>
 <link href="../Groundtruth/" rel="next"/>
 <link href="../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Evaluation - Valor</title>
 <link href="../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Groundtruth/index.html b/client_api/Groundtruth/index.html
@@ -8,7 +8,7 @@
 <link href="../Evaluation/" rel="prev"/>
 <link href="../ImageMetadata/" rel="next"/>
 <link href="../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Groundtruth - Valor</title>
 <link href="../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/ImageMetadata/index.html b/client_api/ImageMetadata/index.html
@@ -8,7 +8,7 @@
 <link href="../Groundtruth/" rel="prev"/>
 <link href="../Label/" rel="next"/>
 <link href="../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>ImageMetadata - Valor</title>
 <link href="../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Label/index.html b/client_api/Label/index.html
@@ -8,7 +8,7 @@
 <link href="../ImageMetadata/" rel="prev"/>
 <link href="../Model/" rel="next"/>
 <link href="../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Label - Valor</title>
 <link href="../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Model/index.html b/client_api/Model/index.html
@@ -8,7 +8,7 @@
 <link href="../Label/" rel="prev"/>
 <link href="../Prediction/" rel="next"/>
 <link href="../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Model - Valor</title>
 <link href="../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Prediction/index.html b/client_api/Prediction/index.html
@@ -8,7 +8,7 @@
 <link href="../Model/" rel="prev"/>
 <link href="../VideoFrameMetadata/" rel="next"/>
 <link href="../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Prediction - Valor</title>
 <link href="../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Schemas/Evaluation/index.html b/client_api/Schemas/Evaluation/index.html
@@ -8,7 +8,7 @@
 <link href="../../Viz/" rel="prev"/>
 <link href="../Filters/" rel="next"/>
 <link href="../../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Evaluation - Valor</title>
 <link href="../../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Schemas/Filters/index.html b/client_api/Schemas/Filters/index.html
@@ -8,7 +8,7 @@
 <link href="../Evaluation/" rel="prev"/>
 <link href="../Geometries/" rel="next"/>
 <link href="../../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Filters - Valor</title>
 <link href="../../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Schemas/Geometries/index.html b/client_api/Schemas/Geometries/index.html
@@ -7,7 +7,7 @@
 <meta content="width=device-width,initial-scale=1" name="viewport"/>
 <link href="../Filters/" rel="prev"/>
 <link href="../../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Geometries - Valor</title>
 <link href="../../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/VideoFrameMetadata/index.html b/client_api/VideoFrameMetadata/index.html
@@ -8,7 +8,7 @@
 <link href="../Prediction/" rel="prev"/>
 <link href="../Viz/" rel="next"/>
 <link href="../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>VideoFrameMetadata - Valor</title>
 <link href="../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/client_api/Viz/index.html b/client_api/Viz/index.html
@@ -8,7 +8,7 @@
 <link href="../VideoFrameMetadata/" rel="prev"/>
 <link href="../Schemas/Evaluation/" rel="next"/>
 <link href="../../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Viz - Valor</title>
 <link href="../../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/contributing/index.html b/contributing/index.html
@@ -8,7 +8,7 @@
 <link href="../technical_concepts/" rel="prev"/>
 <link href="../client_api/Annotation/" rel="next"/>
 <link href="../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Contributing &amp; Development - Valor</title>
 <link href="../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>
@@ -595,8 +595,9 @@ <h4 id="makefile-requires-docker">Makefile (requires Docker)</h4>
 </span><span id="__span-1-2"><a href="#__codelineno-1-2" id="__codelineno-1-2" name="__codelineno-1-2"></a>
 </span><span id="__span-1-3"><a href="#__codelineno-1-3" id="__codelineno-1-3" name="__codelineno-1-3"></a><span class="nb">export</span><span class="w"> </span><span class="nv">POSTGRES_PASSWORD</span><span class="o">=</span>password
 </span><span id="__span-1-4"><a href="#__codelineno-1-4" id="__codelineno-1-4" name="__codelineno-1-4"></a><span class="nb">export</span><span class="w"> </span><span class="nv">POSTGRES_HOST</span><span class="o">=</span>localhost
-</span><span id="__span-1-5"><a href="#__codelineno-1-5" id="__codelineno-1-5" name="__codelineno-1-5"></a>make<span class="w"> </span>start-postgis<span class="w"> </span><span class="c1"># Start the postgis service in Docker</span>
-</span><span id="__span-1-6"><a href="#__codelineno-1-6" id="__codelineno-1-6" name="__codelineno-1-6"></a>make<span class="w"> </span>start-server<span class="w"> </span><span class="c1"># Start the API service locally</span>
+</span><span id="__span-1-5"><a href="#__codelineno-1-5" id="__codelineno-1-5" name="__codelineno-1-5"></a>make<span class="w"> </span>start-postgis-docker<span class="w"> </span><span class="c1"># Start the postgis service in Docker</span>
+</span><span id="__span-1-6"><a href="#__codelineno-1-6" id="__codelineno-1-6" name="__codelineno-1-6"></a>make<span class="w"> </span>run-migrations<span class="w"> </span><span class="c1"># Instantiate the table schemas in Postgres</span>
+</span><span id="__span-1-7"><a href="#__codelineno-1-7" id="__codelineno-1-7" name="__codelineno-1-7"></a>make<span class="w"> </span>start-server<span class="w"> </span><span class="c1"># Start the API service locally</span>
 </span></code></pre></div>
 <h3 id="setting-up-your-environment">Setting Up Your Environment</h3>
 <p>Creating a Valor-specific Python environment at the start of development can help you avoid dependency and versioning issues later on. To start, we'd recommend activating a new Python environment:</p>
@@ -614,10 +615,10 @@ <h3 id="setting-up-your-environment">Setting Up Your Environment</h3>
 </span></code></pre></div>
 <p>Finally, you're ready to install your client and API modules:</p>
 <div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1"><a href="#__codelineno-4-1" id="__codelineno-4-1" name="__codelineno-4-1"></a><span class="c1"># Install the Client module</span>
-</span><span id="__span-4-2"><a href="#__codelineno-4-2" id="__codelineno-4-2" name="__codelineno-4-2"></a>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>client/.<span class="o">[</span>test<span class="o">]</span>
+</span><span id="__span-4-2"><a href="#__codelineno-4-2" id="__codelineno-4-2" name="__codelineno-4-2"></a>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>client/.
 </span><span id="__span-4-3"><a href="#__codelineno-4-3" id="__codelineno-4-3" name="__codelineno-4-3"></a>
 </span><span id="__span-4-4"><a href="#__codelineno-4-4" id="__codelineno-4-4" name="__codelineno-4-4"></a><span class="c1"># Install the API module</span>
-</span><span id="__span-4-5"><a href="#__codelineno-4-5" id="__codelineno-4-5" name="__codelineno-4-5"></a>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>api/.<span class="o">[</span>test<span class="o">]</span>
+</span><span id="__span-4-5"><a href="#__codelineno-4-5" id="__codelineno-4-5" name="__codelineno-4-5"></a>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>api/.
 </span></code></pre></div>
 <h3 id="use-pgadmin-to-debug-postgis">Use pgAdmin to Debug PostGIS</h3>
 <p>You can use the pgAdmin utility to debug your PostGIS tables as you code. Start by <a href="https://www.pgadmin.org/download/">installing pgAdmin</a>, and then select <code>Object &gt; Register &gt; Server</code> to connect to your PostGIS container. The default connection details are listed below for convenience:</p>

diff --git a/endpoints/index.html b/endpoints/index.html
@@ -8,7 +8,7 @@
 <link href="../metrics/" rel="prev"/>
 <link href="../technical_concepts/" rel="next"/>
 <link href="../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Endpoints - Valor</title>
 <link href="../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>
@@ -345,7 +345,7 @@
 <div class="md-content" data-md-component="content">
 <article class="md-content__inner md-typeset">
 <h1 id="endpoints">Endpoints</h1>
-<p><iframe class="swagger-ui-iframe" frameborder="0" id="f6994930" src="swagger-f6994930.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
+<p><iframe class="swagger-ui-iframe" frameborder="0" id="b91e4c56" src="swagger-b91e4c56.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
 </article>
 </div>
 <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>

diff --git a/endpoints/swagger-f6994930.html → endpoints/swagger-b91e4c56.html b/endpoints/swagger-f6994930.html → endpoints/swagger-b91e4c56.html
@@ -58,7 +58,7 @@
     }
 
     const resize_ob = new ResizeObserver(function(entries) {
-      parent.update_swagger_ui_iframe_height("f6994930");
+      parent.update_swagger_ui_iframe_height("b91e4c56");
     });
 
     // start observing for resizing

diff --git a/index.html b/index.html
@@ -7,7 +7,7 @@
 <meta content="width=device-width,initial-scale=1" name="viewport"/>
 <link href="installation/" rel="next"/>
 <link href="assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Valor</title>
 <link href="assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/installation/index.html b/installation/index.html
@@ -8,7 +8,7 @@
 <link href=".." rel="prev"/>
 <link href="../basic_usage/" rel="next"/>
 <link href="../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Installation - Valor</title>
 <link href="../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/metadata_and_filtering/index.html b/metadata_and_filtering/index.html
@@ -8,7 +8,7 @@
 <link href="../basic_usage/" rel="prev"/>
 <link href="../metrics/" rel="next"/>
 <link href="../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Metadata &amp; Filtering - Valor</title>
 <link href="../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/metrics/index.html b/metrics/index.html
@@ -8,7 +8,7 @@
 <link href="../metadata_and_filtering/" rel="prev"/>
 <link href="../endpoints/" rel="next"/>
 <link href="../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Metrics - Valor</title>
 <link href="../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

diff --git a/search/search_index.json b/search/search_index.json
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
diff --git a/technical_concepts/index.html b/technical_concepts/index.html
@@ -8,7 +8,7 @@
 <link href="../endpoints/" rel="prev"/>
 <link href="../contributing/" rel="next"/>
 <link href="../assets/images/favicon.png" rel="icon"/>
-<meta content="mkdocs-1.5.3, mkdocs-material-9.5.10" name="generator"/>
+<meta content="mkdocs-1.5.3, mkdocs-material-9.5.11" name="generator"/>
 <title>Technical Concepts - Valor</title>
 <link href="../assets/stylesheets/main.7e359304.min.css" rel="stylesheet"/>
 <link href="../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,7 +12,7 @@


		<link rel="icon" href="/assets/images/favicon.png">
		<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.10">
		<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.11">



Expand Down