Skip to content

Commit

Permalink
docs: added sahi example and constrain python to 3.9-3.11
Browse files Browse the repository at this point in the history
  • Loading branch information
danellecline committed Feb 27, 2024
1 parent 4371400 commit 240d630
Show file tree
Hide file tree
Showing 6 changed files with 805 additions and 8 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,23 @@ The algorithm workflow looks like this:

# Installation

This code can be run from a command-line or from a jupyter notebook. The following instructions are for running from the command-line.

```shell
git clone https://github.com/mbari/sdcat.git
cd sdcat
conda env create -f environment.yml
```

Or, from a jupyter notebook.

```
conda activate sdcat
pip install ipykernel
python -m ipykernel install --user --name=sdcat
jupyter notebook
```

A GPU is recommended for clustering and detection. If you don't have a GPU, you can still run the code, but it will be slower.
If running on a CPU, multiple cores are recommended and will speed up processing.
For large datasets, the RapidsAI cuDF library is recommended for faster processing, although it does not currently support
Expand Down
4 changes: 2 additions & 2 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: sdcat
channels:
- conda-forge
dependencies:
- python>=3.9
- python >=3.9,<3.12
- pip
- pip:
- -r requirements.txt
- -r requirements.txt
Loading

0 comments on commit 240d630

Please sign in to comment.