Merge pull request #80 from HakaiInstitute/update-docs

Update docs
HakaiInstitute · Dec 11, 2023 · e9adea8 · e9adea8
2 parents 1a33917 + 606a6ec
commit e9adea8
Show file tree

Hide file tree

Showing 7 changed files with 73 additions and 21 deletions.
diff --git a/docs/cli.md b/docs/cli.md
@@ -45,6 +45,27 @@ $ kom find-kelp --help
     kom find-kelp --species --crop-size=1024 ./some/image_with_kelp.tif ./some/place_to_write_output.tif
     ```
 
+???+ tip "Tip: Reduce windowed processing artifacts"
+
+    To reduce artifacts caused by Kelp-O-Matic's moving window classification, use the largest `crop_size` that you can.
+    Try starting with a crop_size around 3200 pixels and reduce it if your computer is unable to load that much data at once and the application crashes.
+
+    We hope to improve Kelp-O-Matic in the future such that the maximum crop size for your computer can be determined automatically.
+
+    CLI Example:
+
+    ```bash
+    kom --crop-size=3200 your-input-image.tif output-image.tif
+    ```
+
+    <div style="display:flex;">
+        <img alt="Small window output" src="../images/kom-small-window.png" width="50%"/>
+        <img alt="Big window output" src="../images/kom-big-window.png" width="50%"/>
+    </div>
+
+    Also worth noting is that the `crop_size` parameter will change the outputs. 
+    If you need to reproduce a result, make sure to use the same `crop_size` as the original run.
+
 [//]: # (??? info "Info: Misclassifications over land")
 
 [//]: # ()

diff --git a/docs/images/kom-big-window.png b/docs/images/kom-big-window.png
diff --git a/docs/images/kom-small-window.png b/docs/images/kom-small-window.png
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,2 @@
-mkdocs-material==9.0.12
+mkdocs-material==9.5.2
 mkdocstrings-python
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -31,8 +31,8 @@ extra:
     provider: google
     property: G-RSSQERRJ3Q
   social:
-    - icon: fontawesome/brands/twitter
-      link: https://twitter.com/HakaiGeospatial
+    - icon: fontawesome/brands/x-twitter
+      link: https://x.com/HakaiGeospatial
     - icon: fontawesome/brands/instagram
       link: https://www.instagram.com/hakaiinstitute
     - icon: fontawesome/brands/linkedin
@@ -56,8 +56,8 @@ markdown_extensions:
   - pymdownx.arithmatex:
       generic: true
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.superfences:
       custom_fences:
         - name: mermaid

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -28,7 +28,7 @@ pytest = "^7.3.2"
 
 [tool.poetry.group.docs.dependencies]
 mkdocs = "^1.5.3"
-mkdocs-material = "9.0.12"
+mkdocs-material = "^9.5.2"
 mkdocstrings-python = "^1.7.5"
 
 [build-system]