|
23 | 23 |
|
24 | 24 |
|
25 | 25 | <link rel="icon" href="https://media.roboflow.com/roboflow_logomark_white.png"> |
26 | | - <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1"> |
| 26 | + <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.3"> |
27 | 27 |
|
28 | 28 |
|
29 | 29 |
|
|
326 | 326 | </span> |
327 | 327 | </a> |
328 | 328 |
|
| 329 | + <nav class="md-nav" aria-label="Quickstart"> |
| 330 | + <ul class="md-nav__list"> |
| 331 | + |
| 332 | + <li class="md-nav__item"> |
| 333 | + <a href="#search-and-export" class="md-nav__link"> |
| 334 | + <span class="md-ellipsis"> |
| 335 | + |
| 336 | + Search and Export |
| 337 | + |
| 338 | + </span> |
| 339 | + </a> |
| 340 | + |
| 341 | +</li> |
| 342 | + |
| 343 | + <li class="md-nav__item"> |
| 344 | + <a href="#upload-with-metadata" class="md-nav__link"> |
| 345 | + <span class="md-ellipsis"> |
| 346 | + |
| 347 | + Upload with Metadata |
| 348 | + |
| 349 | + </span> |
| 350 | + </a> |
| 351 | + |
| 352 | +</li> |
| 353 | + |
| 354 | + </ul> |
| 355 | + </nav> |
| 356 | + |
329 | 357 | </li> |
330 | 358 |
|
331 | 359 | <li class="md-nav__item"> |
|
885 | 913 | </span> |
886 | 914 | </a> |
887 | 915 |
|
| 916 | + <nav class="md-nav" aria-label="Quickstart"> |
| 917 | + <ul class="md-nav__list"> |
| 918 | + |
| 919 | + <li class="md-nav__item"> |
| 920 | + <a href="#search-and-export" class="md-nav__link"> |
| 921 | + <span class="md-ellipsis"> |
| 922 | + |
| 923 | + Search and Export |
| 924 | + |
| 925 | + </span> |
| 926 | + </a> |
| 927 | + |
| 928 | +</li> |
| 929 | + |
| 930 | + <li class="md-nav__item"> |
| 931 | + <a href="#upload-with-metadata" class="md-nav__link"> |
| 932 | + <span class="md-ellipsis"> |
| 933 | + |
| 934 | + Upload with Metadata |
| 935 | + |
| 936 | + </span> |
| 937 | + </a> |
| 938 | + |
| 939 | +</li> |
| 940 | + |
| 941 | + </ul> |
| 942 | + </nav> |
| 943 | + |
888 | 944 | </li> |
889 | 945 |
|
890 | 946 | <li class="md-nav__item"> |
@@ -1016,6 +1072,40 @@ <h2 id="quickstart">Quickstart<a class="headerlink" href="#quickstart" title="Pe |
1016 | 1072 |
|
1017 | 1073 | <span class="nb">print</span><span class="p">(</span><span class="n">predictions</span><span class="p">)</span> |
1018 | 1074 | </code></pre></div> |
| 1075 | +<h3 id="search-and-export">Search and Export<a class="headerlink" href="#search-and-export" title="Permanent link">¶</a></h3> |
| 1076 | +<p>Search for images across your workspace and export matching results as a ready-to-use dataset:</p> |
| 1077 | +<div class="highlight"><pre><span></span><code><span class="n">workspace</span> <span class="o">=</span> <span class="n">rf</span><span class="o">.</span><span class="n">workspace</span><span class="p">()</span> |
| 1078 | + |
| 1079 | +<span class="c1"># Export images matching a search query</span> |
| 1080 | +<span class="n">workspace</span><span class="o">.</span><span class="n">search_export</span><span class="p">(</span> |
| 1081 | + <span class="n">query</span><span class="o">=</span><span class="s2">"class:person"</span><span class="p">,</span> <span class="c1"># search query (e.g. "tag:review", "class:dog", "*")</span> |
| 1082 | + <span class="nb">format</span><span class="o">=</span><span class="s2">"coco"</span><span class="p">,</span> <span class="c1"># annotation format: coco, yolov8, yolov5, voc, etc.</span> |
| 1083 | + <span class="n">dataset</span><span class="o">=</span><span class="s2">"my-project"</span><span class="p">,</span> <span class="c1"># optional: limit to a specific project</span> |
| 1084 | + <span class="n">location</span><span class="o">=</span><span class="s2">"./my-export"</span><span class="p">,</span> <span class="c1"># optional: output directory</span> |
| 1085 | +<span class="p">)</span> |
| 1086 | +</code></pre></div> |
| 1087 | +<p>Or from the CLI:</p> |
| 1088 | +<div class="highlight"><pre><span></span><code>roboflow<span class="w"> </span>search-export<span class="w"> </span><span class="s2">"class:person"</span><span class="w"> </span>-f<span class="w"> </span>coco<span class="w"> </span>-d<span class="w"> </span>my-project<span class="w"> </span>-l<span class="w"> </span>./my-export |
| 1089 | +</code></pre></div> |
| 1090 | +<h3 id="upload-with-metadata">Upload with Metadata<a class="headerlink" href="#upload-with-metadata" title="Permanent link">¶</a></h3> |
| 1091 | +<p>Attach custom key-value metadata to images during upload:</p> |
| 1092 | +<div class="highlight"><pre><span></span><code><span class="n">project</span> <span class="o">=</span> <span class="n">workspace</span><span class="o">.</span><span class="n">project</span><span class="p">(</span><span class="s2">"my-project"</span><span class="p">)</span> |
| 1093 | + |
| 1094 | +<span class="c1"># Upload a local image with metadata</span> |
| 1095 | +<span class="n">project</span><span class="o">.</span><span class="n">upload</span><span class="p">(</span> |
| 1096 | + <span class="n">image_path</span><span class="o">=</span><span class="s2">"./image.jpg"</span><span class="p">,</span> |
| 1097 | + <span class="n">metadata</span><span class="o">=</span><span class="p">{</span><span class="s2">"camera_id"</span><span class="p">:</span> <span class="s2">"cam001"</span><span class="p">,</span> <span class="s2">"location"</span><span class="p">:</span> <span class="s2">"warehouse-3"</span><span class="p">},</span> |
| 1098 | +<span class="p">)</span> |
| 1099 | + |
| 1100 | +<span class="c1"># Upload a hosted image with metadata</span> |
| 1101 | +<span class="n">project</span><span class="o">.</span><span class="n">upload</span><span class="p">(</span> |
| 1102 | + <span class="n">image_path</span><span class="o">=</span><span class="s2">"https://example.com/image.jpg"</span><span class="p">,</span> |
| 1103 | + <span class="n">metadata</span><span class="o">=</span><span class="p">{</span><span class="s2">"camera_id"</span><span class="p">:</span> <span class="s2">"cam002"</span><span class="p">,</span> <span class="s2">"shift"</span><span class="p">:</span> <span class="s2">"night"</span><span class="p">},</span> |
| 1104 | +<span class="p">)</span> |
| 1105 | +</code></pre></div> |
| 1106 | +<p>Or from the CLI:</p> |
| 1107 | +<div class="highlight"><pre><span></span><code>roboflow<span class="w"> </span>upload<span class="w"> </span>image.jpg<span class="w"> </span>-p<span class="w"> </span>my-project<span class="w"> </span>-M<span class="w"> </span><span class="s1">'{"camera_id":"cam001","location":"warehouse-3"}'</span> |
| 1108 | +</code></pre></div> |
1019 | 1109 | <h2 id="library-structure">Library Structure<a class="headerlink" href="#library-structure" title="Permanent link">¶</a></h2> |
1020 | 1110 | <p>The Roboflow Python library is structured using the same Workspace, Project, and Version ontology that you will see in the Roboflow application.</p> |
1021 | 1111 | <div class="highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">roboflow</span> |
|
0 commit comments