Skip to content

Commit 6ae16d4

Browse files
authored
Docs updates refs and acknowledgements (#108)
* Point to general KABR page and clarify citation limit number of places to update as new papers, versions, etc. are produced * Fix repo name and URL to not include '-paper' * Add missing paper and note to cite package and its paper * Add page for grant acknowledgements+
1 parent 3aea1f2 commit 6ae16d4

File tree

4 files changed

+26
-15
lines changed

4 files changed

+26
-15
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,13 @@ Please refer to our papers for details on the data collection process and machin
9494
- [KABR: In-Situ Dataset for Kenyan Animal Behavior Recognition](https://openaccess.thecvf.com/content/WACV2024W/CV4Smalls/papers/Kholiavchenko_KABR_In-Situ_Dataset_for_Kenyan_Animal_Behavior_Recognition_From_Drone_WACVW_2024_paper.pdf)
9595
- [Deep dive into KABR: a dataset for understanding ungulate behavior from in-situ drone video](https://link.springer.com/article/10.1007/s11042-024-20512-4)
9696
- [Integrating Biological Data into Autonomous Remote Sensing Systems for In Situ Imageomics: A Case Study for Kenyan Animal Behavior Sensing with Unmanned Aerial Vehicles (UAVs)](https://arxiv.org/abs/2407.16864)
97+
- [A Framework for Autonomic Computing for In Situ Imageomics](https://ieeexplore.ieee.org/abstract/document/10336017)
9798

9899
## Citation
99100

100-
If you use this toolkit in your research, please cite:
101+
If you use this toolkit in your research, please cite both this package and the associated paper:
101102

103+
**Package citation:**
102104
```bibtex
103105
@software{kabr-tools,
104106
author = {Kline, Jenna and Zhong, Alison and Campolongo, Elizabeth and Kholiavchenko, Maksim},
@@ -110,6 +112,10 @@ If you use this toolkit in your research, please cite:
110112
}
111113
```
112114

115+
**Paper citation:**
116+
```bibtex
117+
```
118+
113119
## 💬 Feedback & Issues
114120

115121
Open issues on [GitHub](https://github.com/Imageomics/kabr-tools/issues).

docs/acknowledgements.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
This work was supported by the [Imageomics Institute](https://imageomics.org), which is funded by the US National Science Foundation's Harnessing the Data Revolution (HDR) program under [Award #2118240](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2118240) (Imageomics: A New Frontier of Biological Information Powered by Knowledge-Guided Machine Learning). Additional support was provided by the [AI Institute for Intelligent Cyberinfrastructure with Computational Learning in the Environment (ICICLE)](https://icicle.osu.edu/), funded by the US National Science Foundation under [Award #2112606](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2112606).
2+
 
3+
4+
Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.
5+
6+
 
7+
The [raw data](https://huggingface.co/datasets/imageomics/KABR-raw-videoss) fed into the [KABR tools pipeline](https://github.com/Imageomics/kabr-tools) to produce this worked example was collected at the [Mpala Research Centre](https://mpala.org/) in Kenya, in accordance with Research License No. NACOSTI/P/22/18214. The data collection protocol adhered strictly to the guidelines set forth by the Institutional Animal Care and Use Committee under permission No. IACUC 1835F.

docs/index.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The KABR tools used in this process can be installed with:
2626

2727
```bash
2828
pip install torch torchvision
29-
pip install git+https://github.com/Imageomics/kabr-tools-paper
29+
pip install git+https://github.com/Imageomics/kabr-tools
3030
```
3131

3232
!!! note "PyTorch Installation"
@@ -51,14 +51,11 @@ To get started with KABR tools, follow the pipeline steps in order:
5151

5252
## Additional Resources
5353

54-
- [KABR Project Page](https://kabrdata.xyz/) for additional details on the dataset and original paper
55-
- [KABR Dataset on Hugging Face](https://huggingface.co/datasets/imageomics/KABR)
56-
- [Pre-trained Models](https://huggingface.co/imageomics/x3d-kabr-kinetics)
54+
- [KABR Project Page](https://imageomics.github.io/KABR/) for additional details on the dataset and original paper.
55+
- [KABR Mini-Scene Dataset on Hugging Face](https://huggingface.co/datasets/imageomics/KABR)
56+
- [Pre-trained Model](https://huggingface.co/imageomics/x3d-kabr-kinetics)
57+
- [KABR Collection on Hugging Face](https://huggingface.co/collections/imageomics/kabr-664dff304d29e6cd7b8e1a00): All datasets and models associated to the KABR Project.
5758

5859
## Citation
5960

60-
If you use KABR tools in your research, please cite our papers:
61-
62-
- [KABR: In-Situ Dataset for Kenyan Animal Behavior Recognition from Drone Videos](https://openaccess.thecvf.com/content/WACV2024W/CV4Smalls/papers/Kholiavchenko_KABR_In-Situ_Dataset_for_Kenyan_Animal_Behavior_Recognition_From_Drone_WACVW_2024_paper.pdf)
63-
- [A Framework for Autonomic Computing for In Situ Imageomics](https://ieeexplore.ieee.org/abstract/document/10336017)
64-
- [Integrating Biological Data into Autonomous Remote Sensing Systems for In Situ Imageomics](https://arxiv.org/abs/2407.16864)
61+
If you use KABR tools in your research, please follow the [citation guidance in the repo](https://github.com/Imageomics/kabr-tools?tab=readme-ov-file#citation).

mkdocs.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
site_name: KABR Tools Documentation
22
site_description: Tools for working with data for annotating animal behavior
3-
site_author: KABR Team
4-
site_url: https://imageomics.github.io/kabr-tools-paper
3+
site_author: Imageomics KABR Team
4+
site_url: https://imageomics.github.io/kabr-tools
55

6-
repo_name: Imageomics/kabr-tools-paper
7-
repo_url: https://github.com/Imageomics/kabr-tools-paper
6+
repo_name: Imageomics/kabr-tools
7+
repo_url: https://github.com/Imageomics/kabr-tools
88
edit_uri: edit/main/docs/
99

1010
theme:
@@ -110,8 +110,9 @@ nav:
110110
- "Linear Regression": case_studies/1_grevys_landscape/grevys_landscape_lr.ipynb
111111
- "2: Zebra Behavior Transitions": case_studies/2_zebra_transition/behaviortransitionsheatmap.ipynb
112112
- "3: Mixed Species Social": case_studies/3_mixed_species_social/mixed_species_overlap.ipynb
113+
- Acknowledgements: acknowledgements.md
113114

114115
extra:
115116
social:
116117
- icon: fontawesome/brands/github
117-
link: https://github.com/Imageomics/kabr-tools-paper
118+
link: https://github.com/Imageomics/kabr-tools

0 commit comments

Comments
 (0)