From 3900792a049d5a7d63e6567331fe43cc1eea3703 Mon Sep 17 00:00:00 2001
From: Jordan Pierce <115024024+Jordan-Pierce@users.noreply.github.com>
Date: Tue, 3 Dec 2024 15:05:00 -0500
Subject: [PATCH] docs
---
.github/ISSUE_TEMPLATE/bug_report.md | 1 -
.github/ISSUE_TEMPLATE/config.yml | 10 ---
README.md | 57 +++++++-------
docs/changelog.md | 11 ---
docs/contributing.md | 108 ---------------------------
docs/index.md | 60 +++++++--------
docs/installation.md | 81 +++++++++++++++++---
mkdocs.yml | 2 -
8 files changed, 129 insertions(+), 201 deletions(-)
delete mode 100644 docs/changelog.md
delete mode 100644 docs/contributing.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index f6b07a4d..ed791cff 100644
--- 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
index 7f6b2e31..e69de29b 100644
--- 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
index 1606bf4b..807a47e7 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,34 @@
[](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)
+
+
+ Watch the Video Demos
+
+
+ 
+
+
+
+
+## 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
-```
-
-
- 
-
-
-
-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
-
- Watch the Video Demos
-
-
-
-
-
-
-
## **How to Install**
### Anaconda
diff --git a/docs/changelog.md b/docs/changelog.md
deleted file mode 100644
index 289e2c52..00000000
--- a/docs/changelog.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# Changelog
-
-## v0.0.1 - Date
-
-**Improvement**:
-
-- TBD
-
-**New Features**:
-
-- TBD
diff --git a/docs/contributing.md b/docs/contributing.md
deleted file mode 100644
index 932f5e51..00000000
--- a/docs/contributing.md
+++ /dev/null
@@ -1,108 +0,0 @@
-# Contributing
-
-Contributions are welcome, and they are greatly appreciated! Every
-little bit helps, and credit will always be given.
-
-You can contribute in many ways:
-
-## Types of Contributions
-
-### Report Bugs
-
-Report bugs at .
-
-If you are reporting a bug, please include:
-
-- Your operating system name and version.
-- Any details about your local setup that might be helpful in troubleshooting.
-- Detailed steps to reproduce the bug.
-
-### Fix Bugs
-
-Look through the GitHub issues for bugs. Anything tagged with `bug` and
-`help wanted` is open to whoever wants to implement it.
-
-### Implement Features
-
-Look through the GitHub issues for features. Anything tagged with
-`enhancement` and `help wanted` is open to whoever wants to implement it.
-
-### Write Documentation
-
-CoralNet-Toolbox could always use more documentation,
-whether as part of the official CoralNet-Toolbox docs,
-in docstrings, or even on the web in blog posts, articles, and such.
-
-### Submit Feedback
-
-The best way to send feedback is to file an issue at
-.
-
-If you are proposing a feature:
-
-- Explain in detail how it would work.
-- Keep the scope as narrow as possible, to make it easier to implement.
-- Remember that this is a volunteer-driven project, and that contributions are welcome :)
-
-## Get Started!
-
-Ready to contribute? Here's how to set up CoralNet-Toolbox for local development.
-
-1. Fork the CoralNet-Toolbox repo on GitHub.
-
-2. Clone your fork locally:
-
- ```shell
- $ git clone git@github.com:your_name_here/CoralNet-Toolbox.git
- ```
-
-3. Install your local copy into a virtualenv. Assuming you have
- virtualenvwrapper installed, this is how you set up your fork for
- local development:
-
- ```shell
- $ mkvirtualenv CoralNet-Toolbox
- $ cd CoralNet-Toolbox/
- $ python setup.py develop
- ```
-
-4. Create a branch for local development:
-
- ```shell
- $ git checkout -b name-of-your-bugfix-or-feature
- ```
-
- Now you can make your changes locally.
-
-5. When you're done making changes, check that your changes pass flake8
- and the tests, including testing other Python versions with tox:
-
- ```shell
- $ flake8 CoralNet-Toolbox tests
- $ python setup.py test or pytest
- $ tox
- ```
-
- To get flake8 and tox, just pip install them into your virtualenv.
-
-6. Commit your changes and push your branch to GitHub:
-
- ```shell
- $ git add .
- $ git commit -m "Your detailed description of your changes."
- $ git push origin name-of-your-bugfix-or-feature
- ```
-
-7. Submit a pull request through the GitHub website.
-
-## Pull Request Guidelines
-
-Before you submit a pull request, check that it meets these guidelines:
-
-1. The pull request should include tests.
-2. If the pull request adds functionality, the docs should be updated.
- Put your new functionality into a function with a docstring, and add
- the feature to the list in README.rst.
-3. The pull request should work for Python 3.8 and later, and
- for PyPy. Check and make sure that the tests pass for all
- supported Python versions.
diff --git a/docs/index.md b/docs/index.md
index 506f5b8d..3dbcd4ec 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -7,6 +7,34 @@
[](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)
+
+
+ Watch the Video Demos
+
+
+
+
+
+
+
+## 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
-```
-
-
-
-
-
-
-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
-
-
-
- Watch the Video Demos
-
-
-
-
-
-
+- 📦 Toolshed: Access tools from the old repository
\ No newline at end of file
diff --git a/docs/installation.md b/docs/installation.md
index b992b60c..876eb9bf 100644
--- 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
+```
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 854c0879..4d44dcca 100644
--- 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