Skip to content

Commit

Permalink
docs: updated recipes
Browse files Browse the repository at this point in the history
  • Loading branch information
@danellecline
danellecline committed Nov 15, 2024
1 parent c118d35 commit a0bb70c
Showing 1 changed file with 29 additions and 27 deletions.
56 changes: 29 additions & 27 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,33 +69,35 @@ Recipes are available to run the pipelines. To see the available recipes, run t
```shell
just list
```

| Recipe | Description |
|----------------------------------------------|---------------------------------------------------------------------------------------------------------|
| `list` | List recipes |
| `install` | Setup the environment |
| `update` | Update the environment. Run this command after checking out any code changes |
| `plot-tsne-vss project='uav'` | Generate a tsne plot of the VSS database |
| `optimize-vss project='uav' *more_args=""` | Optimize the VSS database |
| `calc-acc-vss project='uav'` | Calculate the accuracy of the VSS database; run after download, then optimize |
| `reset-vss-all` | Reset the VSS database, removing all data. Proceed with caution!! |
| `reset-vss project='uav'` | Reset the VSS database, removing all data. Run before init-vss or when creating the database. |
| `remove-vss project='uav' *more_args=""` | Remove an entry from the VSS database, e.g. j remove-vss i2map --doc \'doc:boat:\*\' |
| `init-vss project='uav' *more_args=""` | Initialize the VSS database for a project |
| `load-vss project='uav'` | Load already computed exemplars into the VSS database |
| `cluster-uav` | Cluster mission in `aipipeline/projects/uav/data/missions2process.txt` |
| `detect-uav *more_args=""` | Detect mission in `aipipeline/projects/uav/data/missions2process.txt`, add `--vss` to classify with VSS |
| `detect-uav-test` | Detect mission data in `aipipeline/projects/uav/data/missions2process.txt` |
| `load-uav-images` | Load UAV mission images in `aipipeline/projects/uav/data/missions2process.txt` |
| `load-uav type="cluster"` | Load UAV detections/clusters in `aipipeline/projects/uav/data/missions2process.txt` |
| `fix-uav-metadata` | Fix UAV metadata lat/lon/alt |
| `compute-saliency project='uav' *more_args=""`| Compute saliency for downloaded VOC data and update the Tator database |
| `crop project='uav' *more_args=""` | Crop detections from VOC formatted downloads |
| `download-crop-unknowns project='uav' label='Unknown' download_dir='/tmp/download'`| Download and crop Unknown detections |
| `download project='uav'` | Download only |
| `predict-vss project='uav' image_dir='/tmp/download' *more_args=""` | Predict images using the VSS database |
| `run-ctenoA-test` | Run the strided inference on a single video |
| `run-ctenoA-prod` | Run the strided inference on a collection of videos in a TSV file |
| Recipe | Description |
|-----------------------------------------|--------------------------------------------------------------------------------------------------------------|
| `list` | List recipes |
| `install` | Setup the environment |
| `update_trackers` | Update the environment. Run this command after checking out any code changes |
| `plot-tsne-vss project='uav'` | Generate a tsne plot of the VSS database |
| `optimize-vss project='uav' *more_args=""` | Optimize the VSS database |
| `calc-acc-vss project='uav'` | Calculate the accuracy of the VSS database; run after download, then optimize |
| `reset-vss-all` | Reset the VSS database, removing all data. Proceed with caution!! |
| `reset-vss project='uav'` | Reset the VSS database, removing all data. Run before init-vss or when creating the database. Run with e.g. `uav` |
| `remove-vss project='uav' *more_args=""` | Remove an entry from the VSS database, e.g., `remove-vss i2map --doc 'doc:marine organism:*'` |
| `init-vss project='uav' *more_args=""` | Initialize the VSS database for a project |
| `load-vss project='uav'` | Load already computed exemplars into the VSS database |
| `cluster-uav *more_args=""` | Cluster mission in `aipipeline/projects/uav/data/missions2process.txt`, add `--vss` to classify clusters with VSS |
| `detect-uav *more_args=""` | Detect mission in `aipipeline/projects/uav/data/missions2process.txt` |
| `detect-uav-test` | Detect mission data in `aipipeline/projects/uav/data/missions2process.txt` |
| `load-uav-images` | Load UAV mission images in `aipipeline/projects/uav/data/missions2process.txt` |
| `load-uav type="cluster"` | Load UAV detections/clusters in `aipipeline/projects/uav/data/missions2process.txt` |
| `fix-uav-metadata` | Fix UAV metadata lat/lon/alt |
| `compute-saliency project='uav' *more_args=""` | Compute saliency for downloaded VOC data and update the Tator database |
| `crop project='uav' *more_args=""` | Crop detections from VOC formatted downloads |
| `download-crop-unknowns project='uav' labels='Unknown' download-dir='/tmp/download' *more_args=""` | Download and crop Unknown detections |
| `download project='uav'` | Download only |
| `predict-vss project='uav' image_dir='/tmp/download' *more_args=""` | Predict images using the VSS database |
| `run-ctenoA-test` | Run the strided inference on a single video |
| `run-ctenoA-prod` | Run the strided inference on a collection of videos in a TSV file |
| `run-mega-inference` | Run the mega strided inference only on a single video |
| `run-mega-track-bio` | Run the mega strided tracking pipeline on a single video for the bio project |
| `run-mega-track-i2map` | Run the mega strided tracking pipeline on a single video for the i2map project |

--

Expand Down

0 comments on commit a0bb70c

Please sign in to comment.