docs

Jordan-Pierce · Dec 3, 2024 · 3900792 · 3900792
1 parent 189891c
commit 3900792
Show file tree

Hide file tree

Showing 8 changed files with 129 additions and 201 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -20,6 +20,5 @@ Tell us what happened, what went wrong, and what you expected to happen.
 ### What I Did
 
 ```
-Paste the command(s) you ran and the output.
 If there was a crash, please include the traceback here.
 ```
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,10 +0,0 @@
-contact_links:
-    - name: Ask questions
-      url: https://github.com/Jordan-Pierce/CoralNet-Toolbox/discussions/categories/q-a
-      about: Please ask and answer questions here.
-    - name: Ideas
-      url: https://github.com/Jordan-Pierce/CoralNet-Toolbox/discussions/categories/ideas
-      about: Please share your ideas here.
-    - name: Ask questions from the GIS community
-      url: https://gis.stackexchange.com
-      about: To get answers from questions in the GIS community, please ask and answer questions here.

diff --git a/README.md b/README.md
@@ -7,6 +7,34 @@
 [![image](https://img.shields.io/pypi/v/CoralNet-Toolbox.svg)](https://pypi.python.org/pypi/CoralNet-Toolbox)
 
 
+## Quick Start
+
+Running the following command will install the `coralnet-toolbox`, which you can then run from the command line:
+```bash
+# cmd
+
+# Install
+pip install coralnet-toolbox
+
+# Run
+coralnet-toolbox
+```
+
+For further instructions please see the following:
+- [Installation](https://jordan-pierce.github.io/CoralNet-Toolbox/installation)
+- [Usage](https://jordan-pierce.github.io/CoralNet-Toolbox/usage)
+
+<details open>
+  <summary><h2><b>Watch the Video Demos</b></h2></summary>
+  <p align="center">
+    <a href="https://youtube.com/playlist?list=PLG5z9IbwhS5NQT3B2jrg3hxQgilDeZak9&feature=shared">
+      <img src="https://raw.githubusercontent.com/Jordan-Pierce/CoralNet-Toolbox/refs/heads/main/figures/toolbox_qt.PNG" alt="Video Title" width="50%">
+    </a>
+  </p>
+</details>
+
+## TL;Dr
+
 The `CoralNet-Toolbox` is an unofficial codebase that can be used to augment processes associated with those on
 [CoralNet](https://coralnet.ucsd.edu/).
 
@@ -23,26 +51,6 @@ The `toolbox` also uses the following to create rectangle and polygon annotation
 - [`AutoDistill`](https://github.com/autodistill)
   - [`GroundingDino`]()
 
-## Quick Start
-
-Running the following command will install the `coralnet-toolbox`, which you can then run from the command line:
-```bash
-# cmd
-
-# Install
-pip install coralnet-toolbox
-
-# Run
-coralnet-toolbox
-```
-
-<p align="center">
-  <img src="https://github.com/Jordan-Pierce/CoralNet-Toolbox/blob/main/figures/SegmentEverything.gif?raw=true" alt="CoralNet-Toolbox">
-</p>
-
-
-For further instructions, see [How to Install](https://github.com/Jordan-Pierce/CoralNet-Toolbox?tab=readme-ov-file#how-to-install); 
-for information on how to use, check out the [Documentation](https://jordan-pierce.github.io/CoralNet-Toolbox/).
 
 ## Tools
 
@@ -70,15 +78,6 @@ Enhance your CoralNet experience with these tools:
 - 📦 Toolshed: Access tools from the old repository
 
 
-<details open>
-  <summary><h2><b>Watch the Video Demos</b></h2></summary>
-  <p align="center">
-    <a href="https://youtube.com/playlist?list=PLG5z9IbwhS5NQT3B2jrg3hxQgilDeZak9&feature=shared">
-      <img src="https://raw.githubusercontent.com/Jordan-Pierce/CoralNet-Toolbox/refs/heads/main/figures/toolbox_qt.PNG" alt="Video Title" width="50%">
-    </a>
-  </p>
-</details>
-
 ## **How to Install**
 
 ### Anaconda

diff --git a/docs/changelog.md b/docs/changelog.md
diff --git a/docs/contributing.md b/docs/contributing.md
diff --git a/docs/index.md b/docs/index.md
@@ -7,6 +7,34 @@
 [![image](https://img.shields.io/pypi/v/CoralNet-Toolbox.svg)](https://pypi.python.org/pypi/CoralNet-Toolbox)
 
 
+## Quick Start
+
+Running the following command will install the `coralnet-toolbox`, which you can then run from the command line:
+```bash
+# cmd
+
+# Install
+pip install coralnet-toolbox
+
+# Run
+coralnet-toolbox
+```
+
+For further instructions please see the following:
+- [Installation](https://jordan-pierce.github.io/CoralNet-Toolbox/installation)
+- [Usage](https://jordan-pierce.github.io/CoralNet-Toolbox/usage)
+
+<details open>
+  <summary><h2><b>Watch the Video Demos</b></h2></summary>
+  <p align="center">
+    <a href="https://youtube.com/playlist?list=PLG5z9IbwhS5NQT3B2jrg3hxQgilDeZak9&feature=shared">
+      <img src="https://raw.githubusercontent.com/Jordan-Pierce/CoralNet-Toolbox/refs/heads/main/figures/toolbox_qt.PNG" alt="Video Title" width="50%">
+    </a>
+  </p>
+</details>
+
+## TL;Dr
+
 The `CoralNet-Toolbox` is an unofficial codebase that can be used to augment processes associated with those on
 [CoralNet](https://coralnet.ucsd.edu/).
 
@@ -23,26 +51,6 @@ The `toolbox` also uses the following to create rectangle and polygon annotation
 - [`AutoDistill`](https://github.com/autodistill)
   - [`GroundingDino`]()
 
-## Quick Start
-
-Running the following command will install the `coralnet-toolbox`, which you can then run from the command line:
-```bash
-# cmd
-
-# Install
-pip install coralnet-toolbox
-
-# Run
-coralnet-toolbox
-```
-
-<p align="center">
-  <img src="https://github.com/Jordan-Pierce/CoralNet-Toolbox/blob/main/figures/SegmentEverything.gif?raw=true" alt="CoralNet-Toolbox">
-</p>
-
-
-For further instructions, see [How to Install](https://github.com/Jordan-Pierce/CoralNet-Toolbox?tab=readme-ov-file#how-to-install); 
-for information on how to use, check out the [Documentation](https://jordan-pierce.github.io/CoralNet-Toolbox/).
 
 ## Tools
 
@@ -67,14 +75,4 @@ Enhance your CoralNet experience with these tools:
 - 🔍 API: Get predictions from any CoralNet source model
 - 📥 Download: Retrieve source data from CoralNet
 - 📤 Upload: Add images and annotations to CoralNet
-- 📦 Toolshed: Access tools from the old repository
-
-
-<details open>
-  <summary><h2><b>Watch the Video Demos</b></h2></summary>
-  <p align="center">
-    <a href="https://youtube.com/playlist?list=PLG5z9IbwhS5NQT3B2jrg3hxQgilDeZak9&feature=shared">
-      <img src="https://raw.githubusercontent.com/Jordan-Pierce/CoralNet-Toolbox/refs/heads/main/figures/toolbox_qt.PNG" alt="Video Title" width="50%">
-    </a>
-  </p>
-</details>
+- 📦 Toolshed: Access tools from the old repository
diff --git a/docs/installation.md b/docs/installation.md
@@ -1,21 +1,84 @@
-# Installation
+## **How to Install**
 
-## Stable release
+### Anaconda
 
-To install `CoralNet-Toolbox`, run this command in your terminal:
+It's recommended to use `Anaconda` to create an environment for the `toolbox`:
+```bash
+# cmd
 
+# Create and activate an environment
+conda create --name coralnet-toolbox python=3.10 -y
+conda activate coralnet-toolbox
 ```
+
+### Install
+
+Once this has finished, install the `toolbox`:
+```bash
+# cmd
+
+# Install
 pip install coralnet-toolbox
 ```
 
-This is the preferred method to install `CoralNet-Toolbox`, as it will always install the most recent stable release.
+### CUDA
 
-If you don't have [pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process.
+If you have `CUDA`, you should install the versions of `cuda-nvcc` and `cudatoolkit` that you
+need, and then install the corresponding versions of `torch` and `torchvision`. Below is an example of how that can be
+done using `CUDA` version 11.8:
+```bash
+# cmd
 
-## From sources
-
-To install `CoralNet-Toolbox` from sources, run this command in your terminal:
+# Example for CUDA 11.8
+conda install nvidia/label/cuda-11.8.0::cuda-nvcc -y
+conda install nvidia/label/cuda-11.8.0::cuda-toolkit -y
 
+# Example for torch w/ CUDA 11.8
+pip install torch torchvision --index-url https://download.pytorch.org/whl/cu118 --upgrade
 ```
-pip install git+https://github.com/Jordan-Pierce/CoralNet-Toolbox
+
+If `CUDA` is installed on your computer, and `torch` was built with it properly, you should see a `🐇` icon in the
+`toolbox` instead of a `🐢`; if you have multiple `CUDA` devices available, you should see a `🚀` icon,
+and if you're using a Mac with `Metal`, you should see an `🍎` icon (click on the icon to see the device information).
+
+See here for more details on [`cuda-nvcc`](https://anaconda.org/nvidia/cuda-nvcc),
+[`cudatoolkit`](https://anaconda.org/nvidia/cuda-toolkit), and [`torch`](https://pytorch.org/get-started/locally/)
+versions.
+
+### Run
+Finally, you can run the `toolbox` from the command line:
+```bash
+# cmd
+
+# Run
+coralnet-toolbox
 ```
+
+## GitHub Repository
+
+If you prefer to clone the repository and run the `toolbox` from the source code, you can do so with the following:
+
+```bash
+# cmd
+
+# Create and activate an environment
+conda create --name coralnet-toolbox python=3.10 -y
+conda activate coralnet-toolbox
+
+# Clone and enter the repository
+git clone https://github.com/Jordan-Pierce/CoralNet-Toolbox.git
+cd CoralNet-Toolbox
+
+# Install the latest
+pip install -e .
+
+# Install CUDA requirements (if applicable)
+conda install nvidia/label/cuda-11.8.0::cuda-nvcc -y
+conda install nvidia/label/cuda-11.8.0::cuda-toolkit -y
+
+# Example for torch w/ CUDA 11.8
+pip install torch torchvision --index-url https://download.pytorch.org/whl/cu118 --upgrade
+
+# Run
+coralnet-toolbox
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -75,6 +75,4 @@ nav:
     - Home: index.md
     - Installation: installation.md
     - Usage: usage.md
-    - Contributing: contributing.md
-    - Changelog: changelog.md
     - Report Issues: https://github.com/Jordan-Pierce/CoralNet-Toolbox/issues