Update README

README.md

@@ -7,13 +7,17 @@ tags:
 - traits
 - processed
 - RGB
+- biology
+- image
+- animals
+- CV
 pretty_name: Fish-Vista
 size_categories:
 - 10K<n<100K
 language:
 - en
 configs:
-- config_name: classification_fv_419
+- config_name: species_classification
   data_files:
   - split: train
     path: classification_train.csv
@@ -21,7 +25,7 @@ configs:
     path: classification_test.csv
   - split: val
     path: classification_val.csv
-- config_name: identification_fv_682
+- config_name: species_trait_identification
   data_files:
   - split: train
     path: identification_train.csv
@@ -31,37 +35,64 @@ configs:
     path: identification_test_lvsp.csv
   - split: val
     path: identification_val.csv
-- config_name: segmentation_fv_1200
+- config_name: trait_segmentation
   data_files:
   - split: all
     path: segmentation_data.csv
 ---
-# Dataset Card for Fish-Vista
 
-## Dataset Description
+<!--
+Image with caption:
+|![Figure #](https://huggingface.co/imageomics/datasets/<data-repo>/resolve/main/<filename>)|
+|:--|
+|**Figure #.** [Image of <>](https://huggingface.co/datasets/imageomics/<data-repo>/raw/main/<filename>) <caption description>.|
+-->
+
+# Dataset Card for Fish-Visual Trait Analysis (Fish-Vista)
+
+## Dataset Deetails
 
+### Dataset Description
+
+<!--
+- **Curated by:** list curators (authors for _data_ citation, moved up)
+- **Language(s) (NLP):** [More Information Needed]
+<!-- Provide the basic links for the dataset. These will show up on the sidebar to the right of your dataset card ("Curated by" too). -->
 <!--
 - **Homepage:** 
-- **Repository:** 
+- **Repository:** [related project repo]
 - **Paper:** 
-- **Leaderboard:** 
-- **Point of Contact:** 
 -->
 
-### Dataset Summary
+<!-- Provide a longer summary of what this dataset is. -->
+
+The Fish-Visual Trait Analysis (Fish-Vista) dataset is a large, annotated collection of 60K fish images spanning 1900 different species; it supports several challenging and biologically relevant tasks including species classification, trait identification, and trait segmentation. These images have been curated through a sophisticated data processing pipeline applied to a cumulative set of images obtained from various museum collections. Fish-Vista provides fine-grained labels of various visual traits present in each image. It also offers pixel-level annotations of 9 different traits for 2427 fish images, facilitating additional trait segmentation and localization tasks.
+
+The Fish Vista dataset consists of museum fish images from [Great Lakes Invasives Network (GLIN)](https://greatlakesinvasives.org/portal/index.php), [iDigBio](https://www.idigbio.org/), and [Morphbank](https://www.morphbank.net/) databases. We acquired these images, along with associated metadata including the scientific species names, the taxonomical family the species belong to, and licensing information, from the [Fish-AIR repository](https://fishair.org/). 
 
-The Fish-Visual Trait Analysis (Fish-Vista) dataset—a large, annotated collection of 60K fish images spanning 1900 different species,  supporting several challenging and biologically relevant tasks including species classification, trait identification, and trait segmentation. These images have been curated through a sophisticated data processing pipeline applied to a cumulative set of images obtained from various museum collections. Fish-Vista provides fine-grained labels of various visual traits present in each image. It also offers pixel-level annotations of 9 different traits for 2427 fish images, facilitating additional trait segmentation and localization tasks.
+|![Figure 1](https://huggingface.co/datasets/imageomics/fish-vista/resolve/main/metadata/figures/FishVista.png)|
+|:--|
+|**Figure 1.** A schematic representation of the different tasks in Fish-Vista Dataset. |
 
-The Fish Vista dataset consists of museum fish images from (GLIN), IDigBio, Morphbank databases. We acquired these images, along with associated metadata including the scientific species names, the taxonomical family the species belong to, and licensing information, from the FishAIR repository. 
+<!--This dataset card has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1), and further altered to suit Imageomics Institute needs.-->
+
+
+### Supported Tasks and Leaderboards
+<!--[Add some more description. could replace graphs with tables]-->
+
+|![Figure 2](https://huggingface.co/datasets/imageomics/fish-vista/resolve/main/metadata/figures/clf_imbalance.png)|
+|:--|
+|**Figure 2.** Comparison of the fine-grained classification performance of different imbalanced classification methods. |
+
+|![Figure 3](https://huggingface.co/datasets/imageomics/fish-vista/resolve/main/metadata/figures/IdentificationOriginalResults.png)|
+|:--|
+|**Figure 3.** Trait identification performance of different multi-label classification methods. |
 
 
 <!---
 This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
 --->
-<!--
-### Supported Tasks and Leaderboards
 
-[More Information Needed] -->
 
 ### Languages
 
@@ -69,35 +100,59 @@ English
 
 ## Dataset Structure
 
-* **classification_train.csv:** Information for the approximately x image files.
-
-* **classification_test.csv:** Information for the approximately x image files.
+```
+/dataset/
+    segmentation_masks/
+        annotations/
+        images/
+    sample_images/
+        filename 1
+        filename 2
+        ...
+        filename n
+    classification_train.csv
+    classification_test.csv
+    classification_val.csv
+    identification_train.csv
+    identification_test.csv
+    identification_val.csv
+    segmentation_data.csv
+    metadata/
+        figures/
+            # figures included in README
+        data-bib.bib
+```
 
-* **classification_val.csv:** Information for the approximately x image files.
-
-* **identification_train.csv:** Information for the approximately x image files.
-
-* **identification_test_insp.csv:** Information for the approximately x image files.
-
-* **identification_test_lvsp.csv:** Information for the approximately x image files.
+**Notes:**
+[Add instructions for downloading images here]
+* When all images are downloaded and processed, they are contained within a flat directory structure (as demonstrated in `sample_images`).
 
-* **identification_val.csv:** Information for the approximately x image files.
+### Data Instances
 
-* **segmentation_data.csv:** Information for the approximately x image files.
+<!-- Add information about each of these (task, number of images per split, etc.). Perhaps reformat as <task>_<split>.csv.
+-->
 
+* **Species Classification:** `classification_<split>.csv`
+  * Approximately 48K images of 419 species for species classification tasks.
+  * There are about 35K training, 7.6K test, and 5K validation images.
 
-**Notes:**
+* **Trait Identification:** `identification_<split>.csv`
+  * Approximately 53K images of 682 species for trait identification based on _species-level trait labels_ (i.e., presence/absence of traits based on trait labels for the species from information provided by [Phenoscape]() and [FishBase](https://www.fishbase.se/)).
+  * About 38K training, 8K `test_insp` (species in training set), 1.6K `test_lvsp` (species not in training), and 5.3K validation images.
+  * Train, test, and validation splits are generated based on traits, so there are 628 species in train, 471 species in `test_insp`, 51 species in `test_lvsp`, and 452 in the validation set (4 species only in val). 
 
+* **Trait Segmentation:** `segmentation_data.csv`
+  * Pixel-level annotations of 9 different traits for 2,427 fish images.
+  * About x training, y test and z validation images for the segmentation task
+  * These are also used as manually annotated test set for Trait Identification.
 
-### Data Instances
 
-* **Type:** JPG
-* **Size (x pixels by y pixels):** Variable
-* **Background (color or none):** Uniform (White)
+* **Image Information**
+  * **Type:** JPG
+  * **Size (x pixels by y pixels):** Variable
+  * **Background (color or none):** Uniform (White)
 
 
-#### Preprocessing steps:
-
 ### Data Fields
 
 CSV Columns are as follows:
@@ -117,24 +172,85 @@ CSV Columns are as follows:
 - `adipose_fin`: Presence/absence of the adipose fin trait. NA for the classification (FV-419) dataset, since it is only used for identification. 1 indicates presence and 0 indicates absence. This is used for trait identification.
 - `pelvic_fin`: Presence/absence of the pelvic trait. NA for the classification (FV-419) dataset, since it is only used for identification. 1 indicates presence and 0 indicates absence. This is only used for trait identification.
 - `barbel`: Presence/absence of the barbel trait. NA for the classification (FV-419) dataset, since it is only used for identification. 1 indicates presence and 0 indicates absence. This is used for trait identification.
-- `multiple_dorsal_fin`: Presence/absence of the barbel trait. NA for the classification (FV-419) dataset, since it is only used for identification. 1 indicates presence, 0 indicates absence and -1 indicates unknown. This is used for trait identification.
+- `multiple_dorsal_fin`: Presence/absence of the dorsal fin trait. NA for the classification (FV-419) dataset, since it is only used for identification. 1 indicates presence, 0 indicates absence and -1 indicates unknown. This is used for trait identification.
 
 **Note:**
 
-<!--
+
 ### Data Splits
 
-[More Information Needed]
--->
+For each task (or subset), the split is indicated by the CSV name (e.g., `classification_<split>.csv`). More information is provided in [Data Instances](#data-instances), above.
       
 ## Dataset Creation
 
 ### Curation Rationale
+<!-- Motivation for the creation of this dataset. For instance, what you intended to study and why that required curation of a new dataset (or if it's newly collected data and why the data was collected (intended use)), etc. -->
+
+Fishes are integral to both ecological systems and economic sectors, and studying fish traits is crucial for understanding biodiversity patterns and macro-evolution trends.
+Currently available fish datasets tend to focus on species classification. They lack finer-grained labels for traits. When segmentation annotations are available in existing datasets, they tend to be for the entire specimen, allowing for segmenation of background, but not trait segmentation. 
+The ultimate goal of Fish-Vista is to provide a clean, carefully curated, high-resolution dataset that can serve as a foundation for accelerating biological discoveries using advances in AI.
+
 
 ### Source Data
 
+<!-- This section describes the source data (e.g., news text and headlines, social media posts, translated sentences, ...). As well as an original source it was created from (e.g., sampling from Zenodo records, compiling images from different aggregators, etc.) -->
+Images and taxonomic labels were aggregated by [Fish-AIR](https://fishair.org/) from 
+- [Great Lakes Invasives Network (GLIN)](https://greatlakesinvasives.org/portal/index.php)
+- [iDigBio](https://www.idigbio.org/)
+- [Morphbank](https://www.morphbank.net/)
+- [Illinois Natural History Survey (INHS)](https://biocoll.inhs.illinois.edu/portal/index.php)
+- [Minnesota Biodiversity Atlas, Bell Museum](https://bellatlas.umn.edu/index.php)
+- [University of Michigan Museum of Zoology (UMMZ), Division of Fishes](https://ipt.lsa.umich.edu/resource?r=ummz\_fish)
+- [University of Wisconsin-Madison Zoological Museum - Fish](http://zoology.wisc.edu/uwzm/)
+- [Field Museum of Natural History (Zoology, FMNH) Fish Collection](https://fmipt.fieldmuseum.org/ipt/resource?r=fmnh_fishes)
+- [The Ohio State University Fish Division, Museum of Biological Diversity (OSUM), Occurrence dataset](https://doi.org/10.15468/subsl8)
 
-#### Initial Data Collection and Annotation
+[Phenoscape](https://kb.phenoscape.org/about/phenoscape/kb) and [FishBase](https://www.fishbase.se/search.php) were used to provide the information on traits at the species level.
+
+[Open Tree Taxonomy](https://tree.opentreeoflife.org/) was used to standardize the species names provided by Fish-AIR.
+
+
+#### Data Collection and Processing
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, re-sizing of images, tools and libraries used, etc. 
+This is what _you_ did to it following collection from the original source; it will be overall processing if you collected the data initially.
+-->
+
+|![Figure 4](https://huggingface.co/datasets/imageomics/fish-vista/resolve/main/figures/DataProcessingPipelineFishVista.png)|
+|:--|
+|**Figure 4.** An overview of the data processing and filtering pipeline used to obtain Fish-Vista. |
+
+We carefully curated a set of
+60K images sourced from various museum collections through [Fish-AIR](https://fishair.org/), including [Great Lakes Invasives Network (GLIN)](https://greatlakesinvasives.org/portal/index.php), [iDigBio](https://www.idigbio.org/), and [Morphbank](https://www.morphbank.net/).
+Our pipeline incorporates rigorous stages such as duplicate removal, metadata-driven filtering, cropping, background removal using the [Segment Anything Model (SAM)](https://github.com/facebookresearch/segment-anything), and a final
+manual filtering phase. Fish-Vista supports several biologically meaningful tasks such as species
+classification, trait identification, and trait segmentation. 
+
+
+
+### Annotations
+<!-- 
+If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. 
+
+Ex: We standardized the taxonomic labels provided by the various data sources to conform to a uniform 7-rank Linnean structure. (Then, under annotation process, describe how this was done: Our sources used different names for the same kingdom (both _Animalia_ and _Metazoa_), so we chose one for all (_Animalia_). -->
+
+#### Annotation process
+<!-- This section describes the annotation process such as annotation tools used, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
+[Phenoscape](https://kb.phenoscape.org/about/phenoscape/kb) and [FishBase](https://www.fishbase.se/search.php) were used to provide the information on species-level traits (the species-trait matrix).
+
+[Open Tree Taxonomy](https://tree.opentreeoflife.org/) was used to standardize the species names provided by Fish-AIR.
+
+Image-level trait segmentations were manually annotated as described below.
+
+The annotation process for the segmentation subset was led by Wasila Dahdul. She provided guidance and oversight to a team of three people from [NEON](https://www.neonscience.org/about), who used [CVAT](https://zenodo.org/records/7863887) to label nine external traits in the images. These traits correspond to the following terms for anatomical structures in the UBERON anatomy ontology:
+1. Eye, [UBERON_0000019](http://purl.obolibrary.org/obo/UBERON_0000019)
+2. Head, [UBERON_0000033](http://purl.obolibrary.org/obo/UBERON_0000033)
+3. Barbel, [UBERON_2000622](http://purl.obolibrary.org/obo/UBERON_2000622)
+4. Dorsal fin, [UBERON_0003097](http://purl.obolibrary.org/obo/UBERON_0003097)
+5. Adipose fin, [UBERON_2000251](http://purl.obolibrary.org/obo/UBERON_2000251)
+6. Pectoral fin, [UBERON_0000151](http://purl.obolibrary.org/obo/UBERON_0000151)
+7. Pelvic fin, [UBERON_0000152](http://purl.obolibrary.org/obo/UBERON_0000152)
+8. Anal fin, [UBERON_4000163](http://purl.obolibrary.org/obo/UBERON_4000163)
+9. Caudal fin, [UBERON_4000164](http://purl.obolibrary.org/obo/UBERON_4000164)
 
 
 ### Personal and Sensitive Information
@@ -148,24 +264,84 @@ None
 - This dataset is imbalanced.  
 - There are multiple images of the same specimen for many specimens; sometimes this is due to different views (eg., dorsal or ventral side)
   - The master files contain only images that were determined to be unique (at the pixel level) through MD5 checksum.
+^This seems to be a holdover from something else--[More Information Needed]
+
+
+### Recommendations
+[More Information Needed]
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+## Licensing Information
+[More Information Needed]
+
+<!-- See notes at top of file about selecting a license. 
+If you choose CC0: This dataset is dedicated to the public domain for the benefit of scientific pursuits. We ask that you cite the dataset and journal paper using the below citations if you make use of it in your research.
+
+Be sure to note different licensing of images if they have a different license from the compilation.
+ex: 
+The data (images and text) contain a variety of licensing restrictions mostly within the CC family. Each image and text in this dataset is provided under the least restrictive terms allowed by its licensing requirements as provided to us (i.e, we impose no additional restrictions past those specified by licenses in the license file).
+
+EOL images contain a variety of licenses ranging from [CC0](https://creativecommons.org/publicdomain/zero/1.0/) to [CC BY-NC-SA](https://creativecommons.org/licenses/by-nc-sa/4.0/).
+For license and citation information by image, see our [license file](https://huggingface.co/datasets/imageomics/treeoflife-10m/blob/main/metadata/licenses.csv).
+
+This dataset (the compilation) has been marked as dedicated to the public domain by applying the [CC0 Public Domain Waiver](https://creativecommons.org/publicdomain/zero/1.0/). However, images may be licensed under different terms (as noted above).
+-->
+
+## Citation
+[More Information Needed]
+
+**BibTeX:**
+
+**Data**
+```
+@misc{<ref_code>,
+  author = {Kazi Sajeed Mehrab and M. Maruf and Arka Daw and Harish Babu Manogaran and Abhilash Neog and Mridul Khurana and Bahadir Altintas and Yasin Bakış and Elizabeth G Campolongo and Matthew J Thompson and Xiaojun Wang and Hilmar Lapp and Wei-Lun Chao and Paula M. Mabee and Henry L. Bart Jr. and Wasila Dahdul and Anuj Karpatne},
+  title = {Fish-Vista: A Multi-Purpose Dataset for Understanding \& Identification of Traits from Images},
+  year = {2024},
+  url = {https://huggingface.co/datasets/imageomics/fish-vista},
+  doi = {<doi once generated>},
+  publisher = {Hugging Face}
+}
+```
+<!--
+-for an associated paper:
+**Paper**
+```
+@article{<ref_code>,
+  title    = {Fish-Vista: A Multi-Purpose Dataset for Understanding \& Identification of Traits from Images},
+  author   = {Kazi Sajeed Mehrab and M. Maruf and Arka Daw and Harish Babu Manogaran and Abhilash Neog and Mridul Khurana and Bahadir Altintas and Yasin Bakış and Elizabeth G Campolongo and Matthew J Thompson and Xiaojun Wang and Hilmar Lapp and Wei-Lun Chao and Paula M. Mabee and Henry L. Bart Jr. and Wasila Dahdul and Anuj Karpatne},
+  journal  = {<journal_name>},
+  year     =  <year>,
+  url      = {<DOI_URL>},
+  doi      = {<DOI>}
+}
+```
+-->
+
+
+Please be sure to also cite the original data sources using the citations provided in [metadata/data-bib.bib](https://huggingface.co/datasets/imageomics/fish-vista/blob/main/metadata/data-bib.bib).
 
 
 
-## Additional Information
+## Acknowledgements
 
-### Dataset Curators
+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). 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.
 
-**Original Images:**
+<!-- You may also want to credit the source of your data, i.e., if you went to a museum or nature preserve to collect it. -->
 
-**This Collection:**
+## Glossary 
 
+<!-- [optional] If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
 
-### Licensing Information
+## More Information 
 
+<!-- [optional] Any other relevant information that doesn't fit elsewhere. -->
 
-### Citation Information
+## Dataset Card Authors 
 
+Kazi Sajeed Mehrab and Elizabeth G. Campolongo
 
-### Contributions
+## Dataset Card Contact
 
-The [Imageomics Institute](https://imageomics.org) 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). 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.
+[More Information Needed--optional]
+<!-- Could include who to contact with questions, but this is also what the "Discussions" tab is for. -->