Update Model Metadata

README.md

@@ -1,5 +1,7 @@
 ---
-license: mit
+license: 
+- mit
+- bigscience-openrail-m
 language:
 - en
 library_name: open_clip
@@ -21,6 +23,7 @@ datasets:
 - TreeOfLife-10M
 - iNat21
 - BIOSCAN-1M
+- EOL
 ---
 
 
@@ -46,14 +49,16 @@ In this way, BioCLIP offers potential to aid biologists in discovery of new and
 
 - **Developed by:** Samuel Stevens, Jiaman Wu, Matthew J. Thompson, Elizabeth G. Campolongo, Chan Hee Song, David Edward Carlyn, Li Dong, Wasila M. Dahdul, Charles Stewart, Tanya Berger-Wolf, Wei-Lun Chao, and Yu Su
 - **Model type:** Vision Transformer (ViT-B/16)
-- **License:** MIT
+- **License:** MIT, OpenRAIL-M
 - **Fine-tuned from model:** OpenAI CLIP, ViT-B/16
 
+This model was developed for the benefit of the community as an open-source product, thus we request that any derivative products are also open-source.
+
 ### Model Sources
 
 - **Repository:** [BioCLIP](https://github.com/Imageomics/BioCLIP)
-- **Paper:** Coming Soon
-- **Demo:** [BioCLIP Demo](https://huggingface.co/spaces/imageomics/BioCLIP)
+- **Paper:** BioCLIP: A Vision Foundation Model for the Tree of Life ([arXiv](https://doi.org/10.48550/arXiv.2311.18803))
+- **Demo:** [BioCLIP Demo](https://huggingface.co/spaces/imageomics/bioclip-demo)
 
 ## Uses
 
@@ -63,8 +68,8 @@ The ViT-B/16 vision encoder is recommended as a base model for any computer visi
 
 ### Direct Use
 
-See the demo [here](https://huggingface.co/spaces/imageomics/BioCLIP) for examples of zero-shot classification.
-It can also be used in a few-shot setting with a KNN; please see [our paper]() for details for both few-shot and zero-shot settings without fine-tuning.
+See the demo [here](https://huggingface.co/spaces/imageomics/bioclip-demo) for examples of zero-shot classification.
+It can also be used in a few-shot setting with a KNN; please see [our paper](https://doi.org/10.48550/arXiv.2311.18803) for details for both few-shot and zero-shot settings without fine-tuning.
 
 
 ## Bias, Risks, and Limitations
@@ -119,7 +124,7 @@ We tested BioCLIP on the following collection of 10 biologically-relevant tasks.
  - [Birds 525](https://www.kaggle.com/datasets/gpiosenka/100-bird-species): We evaluated on the 2,625 test images provided with the dataset.
  - [Rare Species](https://huggingface.co/datasets/imageomics/rare-species): A new dataset we curated for the purpose of testing this model and to contribute to the ML for Conservation community. It consists of 400 species labeled Near Threatened through Extinct in the Wild by the [IUCN Red List](https://www.iucnredlist.org/), with 30 images per species. For more information, see our dataset, [Rare Species](https://huggingface.co/datasets/imageomics/rare-species).
 
-For more information about the contents of these datasets, see Table 2 and associated sections of [our paper]().
+For more information about the contents of these datasets, see Table 2 and associated sections of [our paper](https://doi.org/10.48550/arXiv.2311.18803).
 
 ### Metrics
 
@@ -129,7 +134,7 @@ We use top-1 and top-5 accuracy to evaluate models, and validation loss to choos
 
 We compare BioCLIP to OpenAI's CLIP and OpenCLIP's LAION-2B checkpoint.
 Here are the zero-shot classification results on our benchmark tasks. 
-Please see [our paper]() for few-shot results.
+Please see [our paper](https://doi.org/10.48550/arXiv.2311.18803) for few-shot results.
 
 <table cellpadding="0" cellspacing="0">
   <thead>
@@ -219,7 +224,7 @@ BioCLIP outperforms general-domain baselines by 18% on average.
 
 ### Model Examination
 
-We encourage readers to see Section 4.6 of [our paper]().
+We encourage readers to see Section 4.6 of [our paper](https://doi.org/10.48550/arXiv.2311.18803).
 In short, BioCLIP forms representations that more closely align to the taxonomic hierarchy compared to general-domain baselines like CLIP or OpenCLIP.
 
 
@@ -238,39 +243,47 @@ In short, BioCLIP forms representations that more closely align to the taxonomic
 }
 ```
 
-Please also cite our paper: (Coming Soon)
-<!--
+Please also cite our paper:
+
 ```
 @article{stevens2023bioclip,
-  title    = "BioCLIP: A Vision Foundation Model for the Tree of Life",
-  author   = "Samuel Stevens and Jiaman Wu and Matthew J. Thompson and Elizabeth G. Campolongo and Chan Hee Song and David Edward Carlyn and Li Dong and Wasila M. Dahdul and Charles Stewart and Tanya Berger-Wolf and Wei-Lun Chao and Yu Su",
-  journal  = "<journal_name>",
-  year     =  <year>,
-  url      = "<DOI_URL>",
-  doi      = "<DOI>"
+  title = {BIOCLIP: A Vision Foundation Model for the Tree of Life}, 
+  author = {Samuel Stevens and Jiaman Wu and Matthew J Thompson and Elizabeth G Campolongo and Chan Hee Song and David Edward Carlyn and Li Dong and Wasila M Dahdul and Charles Stewart and Tanya Berger-Wolf and Wei-Lun Chao and Yu Su},
+  year = {2023},
+  eprint = {2311.18803},
+  archivePrefix = {arXiv},
+  primaryClass = {cs.CV}
 }
+
 ```
--->
 
-Please also cite OpenCLIP:
+
+Please also consider citing OpenCLIP, iNat21 and BIOSCAN-1M:
 ```
-@software{ilharco2021openclip,
-  author = {Ilharco, Gabriel and Wortsman, Mitchell and Wightman, Ross and Gordon, Cade and Carlini, Nicholas and Taori, Rohan and Dave, Achal and Shankar, Vaishaal and Namkoong, Hongseok and Miller, John and Hajishirzi, Hannaneh and Farhadi, Ali and Schmidt, Ludwig},
-  doi = {10.5281/zenodo.5143773},
-  month = jul,
-  title = {{OpenCLIP}},
-  version = {v0.1},
-  year = {2021}
+@software{ilharco_gabriel_2021_5143773,
+  author={Ilharco, Gabriel and Wortsman, Mitchell and Wightman, Ross and Gordon, Cade and Carlini, Nicholas and Taori, Rohan and Dave, Achal and Shankar, Vaishaal and Namkoong, Hongseok and Miller, John and Hajishirzi, Hannaneh and Farhadi, Ali and Schmidt, Ludwig},
+  title={OpenCLIP},
+  year={2021},
+  doi={10.5281/zenodo.5143773},
+}
+```
+```
+@misc{inat2021,
+  author={Van Horn, Grant and Mac Aodha, Oisin},
+  title={iNat Challenge 2021 - FGVC8},
+  publisher={Kaggle},
+  year={2021},
+  url={https://kaggle.com/competitions/inaturalist-2021}
+}
+```
+```
+@inproceedings{gharaee2023step,
+  author={Gharaee, Z. and Gong, Z. and Pellegrino, N. and Zarubiieva, I. and Haurum, J. B. and Lowe, S. C. and McKeown, J. T. A. and Ho, C. Y. and McLeod, J. and Wei, Y. C. and Agda, J. and Ratnasingham, S. and Steinke, D. and Chang, A. X. and Taylor, G. W. and Fieguth, P.},
+  title={A Step Towards Worldwide Biodiversity Assessment: The {BIOSCAN-1M} Insect Dataset},
+  booktitle={Advances in Neural Information Processing Systems ({NeurIPS}) Datasets \& Benchmarks Track},
+  year={2023},
 }
 ```
-
-**APA:**
-
-Stevens, S, Wu, J., Thompson, M. J., Campolongo, E. G., Song, C. H., Carlyn, D. E., Dong, L., Dahdul, W. M., Stewart, C., Berger-Wolf, T., Chao, W.L., & Su, Y. (2023) BioCLIP (Version v0.1) [Computer software]. https://doi.org/
-
-Please also cite OpenCLIP:
-
-Ilharco, G., Wortsman, M., Wightman, R., Gordon, C., Carlini, N., Taori, R., Dave, A., Shankar, V., Namkoong, H., Miller, J., Hajishirzi, H., Farhadi, A., & Schmidt, L. (2021). OpenCLIP (Version v0.1) [Computer software]. https://doi.org/10.5281/zenodo.5143773
 
 ## Acknowledgements