Add notes pointing to proper revision for BioCLIP 2
Browse files- embeddings/README.md +2 -2
embeddings/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
| 1 |
# Text Embeddings
|
| 2 |
|
| 3 |
-
[BioCLIP 2 text embeddings of TreeOfLife-200M](txt_emb_species.npy) were generated with [`make_txt_embedding.py`](https://github.com/Imageomics/TreeOfLife-toolbox/blob/main/processing/scripts/make_txt_embedding.py), using the [`txt_emb_species.json`](txt_emb_species.json) to provide the 7-rank Linnean taxonomic names.
|
| 4 |
|
| 5 |
## Taxonomic JSON Construction
|
| 6 |
|
| 7 |
-
The `JSON` was created from the [TreeOfLife-200M catalog](../catalog.parquet) and [`VernacularName.tsv` component of the GBIF Backbone Taxonomy](https://doi.org/10.15468/39omei) using [`make_txt_embedding_json.py`](https://github.com/Imageomics/TreeOfLife-toolbox/blob/main/processing/scripts/make_txt_embedding_json.py) through the following process:
|
| 8 |
* **Null Value Filtering:** Remove records where `kingdom` or `species` are `null`.
|
| 9 |
* **Deduplication:** Rows are deduplicated based on the combination of `kingdom`, `phylum`, `class`, `order`, `family`, `genus`, and `species`. This ensures that each unique taxonomic combination appears exactly once.
|
| 10 |
* **Common Name Handling:** Currently, the catalog metadata often contains multiple common names for a single unique taxonomic combination. During processing, **the first English common name encountered** for a given unique taxonomic combination is retained. If English is not available, the first option of any language is used. We plan future improvements to establish a definitive 1-to-1 mapping or a more comprehensive common name strategy.
|
|
|
|
| 1 |
# Text Embeddings
|
| 2 |
|
| 3 |
+
[BioCLIP 2 text embeddings of TreeOfLife-200M](txt_emb_species.npy) were generated with [`make_txt_embedding.py`](https://github.com/Imageomics/TreeOfLife-toolbox/blob/main/processing/scripts/make_txt_embedding.py), using the [`txt_emb_species.json`](txt_emb_species.json) to provide the 7-rank Linnean taxonomic names. These text embeddings match to the BioCLIP 2 training dataset, specified by the [catalog parquet from Revision a8f38b4](https://huggingface.co/datasets/imageomics/TreeOfLife-200M/blob/a8f38b4388579862c56ae57d6f094c2ac0e92e12/dataset/catalog.parquet).
|
| 4 |
|
| 5 |
## Taxonomic JSON Construction
|
| 6 |
|
| 7 |
+
The `JSON` was created from the [TreeOfLife-200M catalog](../catalog.parquet) (if reproducing the process, be sure to use the correct revision for the intended model) and [`VernacularName.tsv` component of the GBIF Backbone Taxonomy](https://doi.org/10.15468/39omei) using [`make_txt_embedding_json.py`](https://github.com/Imageomics/TreeOfLife-toolbox/blob/main/processing/scripts/make_txt_embedding_json.py) through the following process:
|
| 8 |
* **Null Value Filtering:** Remove records where `kingdom` or `species` are `null`.
|
| 9 |
* **Deduplication:** Rows are deduplicated based on the combination of `kingdom`, `phylum`, `class`, `order`, `family`, `genus`, and `species`. This ensures that each unique taxonomic combination appears exactly once.
|
| 10 |
* **Common Name Handling:** Currently, the catalog metadata often contains multiple common names for a single unique taxonomic combination. During processing, **the first English common name encountered** for a given unique taxonomic combination is retained. If English is not available, the first option of any language is used. We plan future improvements to establish a definitive 1-to-1 mapping or a more comprehensive common name strategy.
|