Merge pull request #10 from WildMeOrg/doc-update-240

Doc update 2.4.0

docs/administration/delete.md

@@ -0,0 +1,11 @@
+# Delete Data
+
+
+## Delete Users
+At present, there is no way to delete users.
+
+## Delete Images
+At present, there is no way through the UI to delete images from the system. Instead, you must make edits to the mongoDB directly.
+
+## Delete Tasks
+When you delete a task, the associated annotations are removed from the system. When you delete a task that has been through ground truth, the ground truth confirmations are removed from the system, which can impact annotation export analysis. When you delete a task that has the last instance of a tag on it, the tag is not removed from the system. To remove tags, you must delete them individually.

docs/lab-lead/first-scout-login.md → docs/administration/index.md

@@ -1,4 +1,8 @@
-# Creating the First Login on Scout
+# Administration
+
+Once Scout is running on your server, you can set up the system to be ready for data processing. You'll need to create the first login to do any other administration.
+
+## Create the First Login
 
 As a Lab Lead, your first contact with **Scout** is after the System Administrator installed it and provided you with a link. Open the link using the **Google Chrome browser** and create your Lab Lead account. *(Note: This step is not needed if the System Administrator provided you with login credentials.)*
 
@@ -13,3 +17,12 @@ Here's how to create your Lab Lead account:
 ```{note}
 While you can perform all of the Lab Lead duties in Scout from any Chrome browser that can access it, you may also want to obtain access to the Scout Server laptop to be able to add aerial survey images to Scout’s image ingestion folder (see the Add survey images to Scout section of this document). Ask your System Administrator for an Ubuntu Desktop account to log into the server. Your account also needs access to the image ingestion folder created by the System Administrator.
 ```
+
+```{toctree}
+:maxdepth: 1
+
+manage-users
+manage-labels
+manage-task
+delete
+```

docs/lab-lead/hot-keys.md → docs/administration/manage-labels.md

@@ -1,4 +1,4 @@
-# Hot Keys
+# Labels and Hot Keys
 
 Lab Leads should set up hot keys and labels before assigning tasks to annotators.
 

docs/lab-lead/manage-users.md → docs/administration/manage-users.md

@@ -1,4 +1,5 @@
-# Creating User Accounts
+# Manage Users
+## Creating User Accounts
 
 Only a Lab Lead can create Annotator and other Lab Lead user accounts. Here's how to create a new user account:
 
@@ -8,16 +9,16 @@ Only a Lab Lead can create Annotator and other Lab Lead user accounts. Here's ho
     * A unique username *(Note: case sensitive)*
     * A unique password *(Note: case sensitive and needs to be confirmed on the **Confirm password** field )*
     * The role for the new user in the **Role** field. Your options are:
-        * **Annotator** \- an account that only let the user draw and label bounding boxes on images in assigned tasks\.
-        * **Lab Lead** \- an account that can also manage users and tasks\, provide ground truth for annotated data\, draw division lines\, and export data\.
+        * **Annotator** - an account that only let the user draw and label bounding boxes on images in assigned tasks.
+        * **Lab Lead** - an account that can also manage users and tasks, provide ground truth for annotated data, draw division lines, and export data.
 4. Your password to ensure that new users cannot be created without your consent.
 5. Click **Submit** to create a new user account. To make sure that it's successful, the new username will be listed on the Users page.
 
 ```{note}
 Make sure to convey the new username and password to the new user so that they may begin using the account.
 ```
 
-# Editing User Accounts
+## Editing User Accounts
 
 Here's how to edit an existing user account:
 

docs/all-users/annotate-task.md → docs/annotate-task.md

@@ -1,20 +1,20 @@
-# Annotating Your Assigned Tasks
+# Manually Annotate Tasks
 
 If an unfinished task is assigned to you directly, you can click the **Annotate button** next to the task on the **Tasks table** to begin annotating randomly presented images. The annotation screen allows you to *click-drag* to create a bounding box. Use the down arrow key or begin typing to select the correct label for the annotation. In addition to the *click-drag* motion for creating annotations, the following tools are available to you in the annotation interface:
 
-* zoom in button ![zoomin](../assets/images/zoom-plus.png)
-* zoom out button ![zoomout](../assets/images/zoom-minus.png)
+* zoom in button ![zoomin](assets/images/zoom-plus.png)
+* zoom out button ![zoomout](assets/images/zoom-minus.png)
 * **scroll bars** to pan across the image to look for parts to annotate
-* back button ![back](../assets/images/back-button.png)
+* back button ![back](assets/images/back-button.png)
 * **Done** to finish the ground truth stage of this image, making it as completely and accurately done. If any annotations were created, modified, or destroyed, they are now saved as ground truth. If no annotations were present when Done was clicked, the image is considered empty.
 
 ```{note}
 If you refresh your Chrome browser, the interface presents a new random image, and your work on the image you saw before is not stored.
 ```
-![annotate](../assets/images/annotation-interface.png)
+![annotate](assets/images/annotation-interface.png)
 
 Once you finish annotating the images, a page noting the successful completion of annotation for the task appears. Click the **Tasks button** on the menu to return to the **Tasks view and start** your next assigned task.
-![success](../assets/images/annotation-complete-success.png)
+![success](assets/images/annotation-complete-success.png)
 
 ## Annotation Toggle
 

docs/contribute/code-guide.md

@@ -13,7 +13,7 @@ Generally speaking, we want to avoid in-line styling to allow for greater consis
 ## Internationalization
 All Wild Me tools are intended for an international audience, so we want to provide translated versions. An active goal for 2024 is to get ensure that all product copy has been internationalized according to the following standard.
 
-At present, in Wildbook, all copy except for site name, notification messages, and species names are wrapped and localized to 4 languages: english, french, spanish, and italian.
+At present, Scout is not internationalized for any language.
 
 ## EXIF data handling
 EXIF data is notoriously inconsistent between different cameras. Unless we want to provide an entire suite of EXIF management tools (we do not), we must make assumptions about the data coming in, prepare for those assumptions to be wrong, and fail gracefully. Any development focused on EXIF data management should catch exceptions for the following cases:

docs/contribute/dev-setup.md

@@ -1,5 +1,5 @@
 # Dev Environment Setup
-Pre-reqs and system setup are covered in [server setup](../system-administrators/server-system-setup.md). You will then need to [fork and clone the repo](pr-workflow.md).
+Pre-reqs and system setup are covered in [server setup](../setup-and-maintenance/server-system-setup.md). You will then need to [fork and clone the repo](pr-workflow.md).
 
 ## Local Testing
 
@@ -18,7 +18,7 @@ The following instructions are for once you've made changes to your local forked
     ```
     docker run --privileged -p 1337:1337 --rm -it --gpus all --mount type=bind,source=/data,target=/data -e ENV_IP="`ip route get 1 | sed 's/^.*src \([^ ]*\).*$/\1/;q'`" -v /data/scout/db:/data/db -v /data/scout/tmp:/tmp/scout-tmp yourimage:latest
     ```
-1. Provide the image directory information you created in [server setup](../system-administrators/server-system-setup.md). This will only be necessary for your first setup.
+1. Provide the image directory information you created in [server setup](../setup-and-maintenance/server-system-setup.md). This will only be necessary for your first setup.
 1. Check your work! Use your browser to access `localhost:1337` and see if your changes are working as desired.
 1. Continue making changes or create your [PR](pr-workflow.md).
 

docs/contribute/index.md

@@ -17,14 +17,10 @@ Wild Me provides open source software intended to combat extinction. Historicall
 
 If you want to help, there's any number of ways that contribute directly to the mission.
 
-* Provide data: If you have relevant species data that you want to provide to researchers, check out the available Wildbooks and see if there's a match. We're also putting together a list of high-interest data deficient species
+* Provide data: If you have relevant species data that you want to provide to researchers, contact us through the Development Server or via email. Data can be included as just training material for models or can be added to public data sets to further conservation more broadly, whatever works for you!
 * Develop code: unit tests, tech debt, new features, bug fixes. All of our products are available for direct contribution. See [](pr-workflow.md) for more information.
 * Donate: As a non-profit, we are working to provide maximum value at minimum cost. However, we must still cover the costs of things such as storage and processing for our various platforms. 
-
-## Add to documentation
-All Wild Me documentation, be it community, user, or developer docs, is hosted on GitHub. As such, you can contribute to the docunentation through the standard PR flow.
-
-_Guidelines coming soon_
+* Contribute to documentation: All Wild Me documentation, be it community, user, or developer docs, is hosted on GitHub. As such, you can contribute to the docunentation through the standard PR flow.
 
 ## Coming soon...
 * Test and issue reporting

docs/lab-lead/division-lines.md → docs/division-lines.md

@@ -1,4 +1,4 @@
-# Drawing Division Lines
+# Draw Division Lines
 
 Division Lines allow you to note a single area of overlap between two images that meet the following criteria:
 
@@ -8,17 +8,17 @@ Division Lines allow you to note a single area of overlap between two images tha
 Division Lines are intended to help note areas of overlap in successive images so that overcounting can be minimized. Division Lines are drawn on a task-by-task basis, and drawing Division Lines is only possible after a task has achieved 100% annotation and growth truth review. *(Note: Drawing division lines is optional.)*
 
 To draw **Division Lines,** go to the Tasks view and select a task from the table. If the task is ready for Division Lines, the **Division Lines** button becomes clickable.
-![rowdivision](../assets/images/tasktable-row-division.png)
+![rowdivision](assets/images/tasktable-row-division.png)
 
 ```{note}
 Not all images are made available for division lines. Division lines only need to be set between successive pairs of images that might have overlapping areas, and both must have annotations to be considered for division lines.
 ```
 
 The Division Lines screen provides you with a side-by-side view of two successive images in a sequence. Drawing Division Lines is a stage that requires the side of the plane (Left or Right) to be accurately set on the task to ensure the images are sequenced correctly. The tools available in the Division Lines screen are:
 
-* Back button ![back](../assets/images/back-button.png)
+* Back button ![back](assets/images/back-button.png)
 * **Done** - completes the division line stage of this image pair, making it as completely and accurately *done*.
 * **Sliders** - the top and button sliders control the start, end, and slope of the line. To the best of your ability, use the slider to define the overlap area between the left and right images.
 
-![divisionlinedefault](../assets/images/divisionline-default.png)
+![divisionlinedefault](assets/images/divisionline-default.png)
 

docs/lab-lead/evaluate-annotator-performance.md → docs/evaluate-annotator-performance.md

@@ -1,4 +1,4 @@
-# How to Evaluate Annotator Performance
+# Evaluate Annotator Performance
 
 Use both the Image and Annotation CSV exports allows evaluation of the whole image classifier (WIC). For this performance method, we use the following definition of ground truth:
 

docs/export-data.md

@@ -0,0 +1,46 @@
+# Data Exports
+
+## Exporting Task Annotation and Image Data for Analysis
+
+Data can be exported for third-party application analysis and modeling by generating image and annotation data as `CSV` for one or more tasks selected in the Tasks view. Here's how to export data:
+
+1. Click **Tasks** in the header navigation menu to open the Tasks view.
+2. In the Tasks view, use the filters to filter the table down to only those tasks that you want to export.
+3. Click the **Export Filtered Results** button and then select **Export Annotations** or **Export Images** options to choose the content of the `CSV` file to export.
+4. A progress bar indicates the compilation progress of the downloadable `CSV` file. When the progress bar completes, click Download to download the `CSV` file.
+
+![ttexport](assets/images/tasktable-exportoptions.png)
+
+## Export Images CSV Data
+
+The following fields are available in the Export Images CSV file:
+
+* **Task Name** - Name of the task this image was included in. An image may be included in multiple tasks, and if so, the task name is repeated on multiple lines in this file.
+* **Task ID** - The **Scout internal ID** of the task this image belongs to.
+* **Image Filename** - Original filename of the image.
+* **WIC Confidence** - *Machine learning score* predicting confidence of one or more labels present in the image. The score ranges from 0 (nothing predicted in the image) to 1 (maximum confidence that at least one ML model category would be found in the image). *If ML has not been run on this image, the WIC Confidence is empty.*
+* **Ground Truth Status** - True/False value indicating whether review of this image has been completed in the Ground Truth task stage.
+* **Exclusion Side** - The side of the Division Line that is exclude in counts of animals in overlapping images. This value is always: **right.**
+* **Inclusion Top X Fraction** - The decimal fraction (0 to 1) of the top insertion point of the division line. This is the fraction of the image width from the left-side of the image at which the top of the division line intersects the bottom of the image.
+* **Inclusion Bottom X Fraction** - The decimal fraction (0 to 1) of the bottom insertion point of the division line. This is the fraction of the image width from the left-side of the image at which the bottom of the division line intersects the bottom of the image.
+
+## Export Annotation CSV Data
+
+The following fields are available in the Export Annotations CSV file:
+
+* **Task Name** - The name of the task that the annotation is included.
+* **Task ID** - The *Scout internal ID* of the task this annotation belongs to.
+* **Image Filename** - Original filename of the image.
+* **Image ID** - *Scout internal ID* of the image.
+* **Box X** - *X coordinate* of the annotation bounding box’s top left corner.
+* **Box Y** - *Y coordinate* of the annotation bounding box’s top left corner.
+* **Box W** - Pixel width of the bounding box.
+* **Box H** - Pixel height of the bounding box.
+* **Box Confidence** - If machine learning created an annotation, this is the confidence score of the bounding box of this annotation. The score ranges from 0 *(no confidence)* to 1 *(maximum confidence that the box is correctly predicted)*.
+* **Classification** - The predicted classification (i.e. *type*) of the bounding box, such as *elephant* or *buffalo*.
+* **Classification Confidence** - If machine learning created this annotation, this is the confidence score of the classification (e.g., *elephant*) assigned to this annotation. The score ranges from 0 *(no confidence)* to 1 *(maximum confidence that the classification is correct)*.
+* **Assignee** - The Scout user that drew the bounding box.
+* **Timestamp** - Timestamp of annotation creation.
+* **Is Ground Truth** - Whether this annotation has been approved in the Ground Truth process. Annotations that have this field as True are likely to be more reliably accurate as they have been reviewed independently.
+* **Excluded By Line** - Whether the centroid of this bounding box falls outside or inside the division line.
+