Skip to content

Commit

Permalink
Fix typos and update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Eve-ning
Eve-ning committed Oct 25, 2023
1 parent 5c1be99 commit 2019a29
Show file tree
Hide file tree
Showing 10 changed files with 38 additions and 35 deletions.
11 changes: 7 additions & 4 deletions Writerside/topics/load.dataset.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,15 @@ This doesn't immediately download the dataset, but only when you call the
<code>get_*</code> functions.<br/>
The site, date, version must match the dataset path on GCS. For example
if the dataset is at
<code>gs://frdc-scan/my-site/date/90deg/map</code>,
<code>gs://frdc-scan/my-site/20201218/90deg/map</code>,
<list>
<li>site: <code>'my-site'</code></li>
<li>date: <code>'20201218'</code></li>
<li>version: <code>'90deg/map'</code></li>
<li><code>site='my-site'</code></li>
<li><code>date='20201218'</code></li>
<li><code>version='90deg/map'</code></li>
</list>
If the dataset doesn't have a "version", for example:
<code>gs://frdc-scan/my-site/20201218</code>,
then you can pass in <code>version=None</code>.<br/>
<note>
If you don't want to search up GCS, you can use FRDCDownloader to list all
datasets, and their versions with
Expand Down
4 changes: 2 additions & 2 deletions Writerside/topics/preprocessing.extract_segments.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,14 +121,14 @@ For example, the label 1 and 2 extracted images will be
</tab>
</tabs>

## Usage

- If **cropped is False**, the segments are padded with 0s to the
original image size. While this can ensure shape consistency, it can consume
more memory for large images.
- If **cropped is True**, the segments are cropped to the minimum bounding box.
This can save memory, but the shape of the segments will be inconsistent.

## Usage

### Extract from Bounds and Labels

Extract segments from bounds and labels.
Expand Down
4 changes: 2 additions & 2 deletions Writerside/topics/preprocessing.scale.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ ar_norm = scale_normal_per_band(ar)
ar_static = scale_static_per_band(ar, order, BAND_MAX_CONFIG)
```

> The static scaling has a default config infers the max bit depth from the
> capturing device.
> The static scaling has a default config, which was inferred by our capturing
> device.
## API

Expand Down
18 changes: 9 additions & 9 deletions docs/getting-started.html
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/load-dataset.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/overview.html
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html SYSTEM "about:legacy-compat"><html lang="en-US" data-colors-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"> <meta name="built-on" content="2023-10-25T17:57:20.5857123"><meta name="build-number" content="${buildNumber}"> <title>Overview | Documentation</title><script id="virtual-toc-data" type="application/json">[{"id":"other-projects","level":0,"title":"Other Projects","anchor":"#other-projects"}]</script><script id="topic-shortcuts" type="application/json"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.1.5-b176/app.css" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><link rel="manifest" href="https://jetbrains.com/site.webmanifest"><link rel="mask-icon" href="https://jetbrains.com/safari-pinned-tab.svg" color="#000000"><meta name="msapplication-TileColor" content="#000000"/><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"/><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"/><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"/><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"/><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"/> <meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Overview | Documentation"/><meta property="og:description" content=""/><meta property="og:image" content=""/><meta property="og:site_name" content="Documentation Help"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:url" content="/d/0.0.4/overview.html"/><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Overview | Documentation"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json"> { "@context": "http://schema.org", "@type": "WebPage", "@id": "/d/0.0.4/overview.html#webpage", "url": "/d/0.0.4/overview.html", "name": "Overview | Documentation", "description": "", "image": "", "inLanguage":"en-US" }</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json"> { "@type": "WebSite", "@id": "/d/#website", "url": "/d/", "name": "Documentation Help" }</script><!-- End Schema.org --> <!-- Mermaid light/dark themes --> <link rel="stylesheet" type="text/css" href="mermaid.css"> </head> <body data-id="Overview" data-main-title="Overview" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs="" > <div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Documentation 0.0.4 Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="Overview" id="Overview.md" >Overview</h1> <p id="8aa9237a_5370">Forest Recovery Digital Companion (FRDC) is a ML-assisted companion for ecologists to automatically classify surveyed trees via an Unmanned Aerial Vehicle (UAV).</p><p id="8aa9237a_5371">This package, FRDC-ML is the Machine Learning backbone of this project, a centralized repository of tools and model architectures to be used in the FRDC pipeline.</p><p id="8aa9237a_5372"><a href="getting-started.html" id="8aa9237a_5373" data-tooltip="Before starting development, take a look at our repository structure. This will help you understand where to put your code." ><span class="control" id="8aa9237a_5374">Get started here</span></a></p><section class="chapter"><h2 id="other-projects" data-toc="other-projects">Other Projects</h2><dl id="8aa9237a_5375" data-style="title-top"><dt id="8aa9237a_5376" data-expandable="false">FRDC-UI</dt><dd><p id="8aa9237a_5378"><a href="https://github.com/Forest-Recovery-Digital-Companion/FRDC-UI/" id="8aa9237a_5379" data-external="true" rel="noopener noreferrer" >The User Interface Repository</a> for FRDC, a WebApp GUI for ecologists to adjust annotations.</p></dd></dl></section><div class="last-modified"> Last modified: 25 October 2023</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"> <a class="navigation-links__next" href="getting-started.html">Getting Started</a> </div></article><div id="disqus_thread"></div></div></section></main></div> <script src="https://resources.jetbrains.com/writerside/apidoc/6.1.5-b176/app.js"></script></body></html>
<!DOCTYPE html SYSTEM "about:legacy-compat"><html lang="en-US" data-colors-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"> <meta name="built-on" content="2023-10-25T18:04:11.701805"><meta name="build-number" content="${buildNumber}"> <title>Overview | Documentation</title><script id="virtual-toc-data" type="application/json">[{"id":"other-projects","level":0,"title":"Other Projects","anchor":"#other-projects"}]</script><script id="topic-shortcuts" type="application/json"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.1.5-b176/app.css" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><link rel="manifest" href="https://jetbrains.com/site.webmanifest"><link rel="mask-icon" href="https://jetbrains.com/safari-pinned-tab.svg" color="#000000"><meta name="msapplication-TileColor" content="#000000"/><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"/><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"/><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"/><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"/><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"/> <meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Overview | Documentation"/><meta property="og:description" content=""/><meta property="og:image" content=""/><meta property="og:site_name" content="Documentation Help"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:url" content="/d/0.0.4/overview.html"/><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Overview | Documentation"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json"> { "@context": "http://schema.org", "@type": "WebPage", "@id": "/d/0.0.4/overview.html#webpage", "url": "/d/0.0.4/overview.html", "name": "Overview | Documentation", "description": "", "image": "", "inLanguage":"en-US" }</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json"> { "@type": "WebSite", "@id": "/d/#website", "url": "/d/", "name": "Documentation Help" }</script><!-- End Schema.org --> <!-- Mermaid light/dark themes --> <link rel="stylesheet" type="text/css" href="mermaid.css"> </head> <body data-id="Overview" data-main-title="Overview" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs="" > <div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Documentation 0.0.4 Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="Overview" id="Overview.md" >Overview</h1> <p id="8aa9237a_5506">Forest Recovery Digital Companion (FRDC) is a ML-assisted companion for ecologists to automatically classify surveyed trees via an Unmanned Aerial Vehicle (UAV).</p><p id="8aa9237a_5507">This package, FRDC-ML is the Machine Learning backbone of this project, a centralized repository of tools and model architectures to be used in the FRDC pipeline.</p><p id="8aa9237a_5508"><a href="getting-started.html" id="8aa9237a_5509" data-tooltip="Before starting development, take a look at our repository structure. This will help you understand where to put your code." ><span class="control" id="8aa9237a_5510">Get started here</span></a></p><section class="chapter"><h2 id="other-projects" data-toc="other-projects">Other Projects</h2><dl id="8aa9237a_5511" data-style="title-top"><dt id="8aa9237a_5512" data-expandable="false">FRDC-UI</dt><dd><p id="8aa9237a_5514"><a href="https://github.com/Forest-Recovery-Digital-Companion/FRDC-UI/" id="8aa9237a_5515" data-external="true" rel="noopener noreferrer" >The User Interface Repository</a> for FRDC, a WebApp GUI for ecologists to adjust annotations.</p></dd></dl></section><div class="last-modified"> Last modified: 25 October 2023</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"> <a class="navigation-links__next" href="getting-started.html">Getting Started</a> </div></article><div id="disqus_thread"></div></div></section></main></div> <script src="https://resources.jetbrains.com/writerside/apidoc/6.1.5-b176/app.js"></script></body></html>
Loading

0 comments on commit 2019a29

Please sign in to comment.