danieltslz commited on
Commit
ba3c497
·
verified ·
1 Parent(s): b012c9b

Normalize and restore PROBE Gene2Vec package

Browse files

Restore the complete probe_gene2vec_uniprot package. Reduce genes.tsv to its ordered Ensembl gene ID column, compact metadata.json, update README provenance, and restore embeddings.npz byte-identically.

data/embeddings/probe_gene2vec_uniprot/README.md ADDED
@@ -0,0 +1,177 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Embedding name: PROBE-GENE2VEC-UNIPROT
2
+
3
+ - Modality: Protein-associated representation
4
+ - Algorithm: Official PROBE human UniProt representation table, standardized by UniProt-to-master mapping
5
+ - Embedding source URL: https://huggingface.co/spaces/HUBioDataLab/PROBE
6
+ - Original model/code URL: https://github.com/HUBioDataLab/PROBE
7
+
8
+ ## Public files
9
+
10
+ - `embeddings.npz`: compressed NumPy archive containing the embedding matrix under key `embeddings`.
11
+ - `genes.tsv`: row metadata table. Row order matches the embedding matrix.
12
+ - `metadata.json`: machine-readable provenance and processing metadata.
13
+
14
+ ## Matrix
15
+
16
+ - Shape: `17,564 genes × 200 dimensions`
17
+ - Dtype: `float32`
18
+
19
+
20
+
21
+ ## Detailed processing notes
22
+
23
+ ### Source and interpretation
24
+
25
+ This embedding is one PROBE human UniProt representation table standardized into the shared gene-embedding resource.
26
+
27
+ This is a Gene2Vec-associated UniProt-keyed representation from the PROBE archive.
28
+
29
+ The source file used for this component was `GENE2VEC_UNIPROT_HUMAN.csv` from the official PROBE human UniProt representation archive. The raw vectors were not regenerated locally. The local work here was identifier cleaning, UniProt-to-gene mapping, duplicate handling, QC, and conversion into the shared public resource format.
30
+
31
+ ### Provenance fields
32
+
33
+ source_name: PROBE-GENE2VEC-UNIPROT
34
+ original_model_or_method: PROBE human UniProt representation archive
35
+ input_data_type: official PROBE human UniProt CSV representation table
36
+ input_source_file: GENE2VEC_UNIPROT_HUMAN.csv
37
+ source_download_or_app_page: https://huggingface.co/spaces/HUBioDataLab/PROBE
38
+ source_code_page: https://github.com/HUBioDataLab/PROBE
39
+ raw_source_folder: ~/data/raw_embeddings/probe_official/human_representation_vectors/revision-1/
40
+ processing_script: ~/scripts/process_embeddings/process_probe_all_v1_1.py
41
+ preferred_batch_summary_report: ~/reports/mapping_reports/probe_all_v1_1_summary.tsv
42
+ source_identifier_type: UniProt Entry accession
43
+ mapping_identifier_type: UniProt accession matched to enriched master_gene_table.csv UniProt fields
44
+ source_rows: 18,407
45
+ final_mapped_genes: 17,564
46
+ model_or_feature_dimension: 200
47
+ training_or_finetuning: none
48
+ final_embedding_dtype: float32
49
+
50
+ ### Mapping and processing decisions
51
+
52
+ Each PROBE CSV uses a UniProt accession in the `Entry` column. Source entries were cleaned to their canonical accession base by removing isoform suffixes when present.
53
+
54
+ Cleaned UniProt accessions were mapped to master_gene_table.csv using `uniprot_id`, `hgnc_uniprot_ids`, and `map_uniprot_ids_all`. Only unique UniProt-to-master mappings were accepted. Ambiguous UniProt accessions were excluded. Duplicate source proteins mapping to the same final master-table gene were averaged within that gene.
55
+
56
+ The exact underlying UniProt/protein sequence database snapshot is inherited from the PROBE archive and should be checked against the official PROBE release documentation if a strict sequence-database timestamp is required.
57
+
58
+ ### Processing workflow
59
+
60
+ For this PROBE embedding:
61
+
62
+ 1. Read `GENE2VEC_UNIPROT_HUMAN.csv` from the PROBE human representation archive.
63
+ 2. Use the `Entry` column as the source UniProt accession.
64
+ 3. Remove isoform suffixes where present to obtain the canonical UniProt accession base.
65
+ 4. Map source UniProt accessions to master_gene_table.csv through enriched UniProt fields.
66
+ 5. Exclude unmapped and ambiguous UniProt accessions.
67
+ 6. Average duplicate source rows only when they map to the same final master-table gene.
68
+ 7. Save the final matrix as float32.
69
+
70
+ ### Important implementation decisions
71
+
72
+ The PROBE vectors were taken directly from the official archive rather than recomputed. This keeps the PROBE batch aligned with the released human UniProt representation files.
73
+
74
+ All PROBE embeddings use the same mapping logic, so differences between PROBE outputs reflect the source representation type rather than different gene-mapping rules.
75
+
76
+ ### Summary of final mapping:
77
+
78
+ Source identifiers / source rows: 18,407
79
+ Dimensions: 200
80
+ Final mapped genes: 17,564
81
+ Master table rows: 20,097
82
+ Master coverage: 87.40%
83
+ Mapping strategy: UniProt Entry accession mapping through enriched master table
84
+ Ambiguous UniProt accessions: excluded
85
+ Duplicate final mappings averaged: yes
86
+
87
+ <!-- BEGIN CATALOG NORMALIZATION: LEGACY METADATA -->
88
+
89
+ ## Processing and provenance metadata
90
+
91
+ This section preserves information moved out of `metadata.json` during catalog normalization. The loading-facing metadata is intentionally compact; detailed source, mapping, processing, quality-control, and reproducibility records remain here.
92
+
93
+ Source catalog commit: `b012c9b6cb302f5b559a8ab3dba3aabf9f6b3e91`.
94
+
95
+ ### Canonicalized field names
96
+
97
+ | Previous field | Compact metadata field |
98
+ | --- | --- |
99
+ | `embedding_name` | `display_name` |
100
+ | `source_identifier_type` | `original_identifier_type` |
101
+ | `mapping_strategy` | `mapping_method` |
102
+ | `num_genes` | `n_genes` |
103
+ | `embedding_dimension` | `n_dimensions` |
104
+ | `matrix_shape[0]` | `n_genes` |
105
+ | `matrix_shape[1]` | `n_dimensions` |
106
+ | `coverage.master_gene_coverage_fraction` | `master_coverage_fraction` |
107
+ | `original_model_or_method` | `original_method` |
108
+ | `download_source` | `input_data_source` |
109
+
110
+ ### Derived and verified fields
111
+
112
+ - `species` was standardized to `Homo sapiens` from the validated human Ensembl `ENSG` identifier namespace.
113
+ - `dtype` and `npz_key` were read directly from the validated `embeddings.npz` archive.
114
+ - `publication` uses the verified free-access publication link `https://rdcu.be/cJAKN` for *Learning functional properties of proteins with language models*.
115
+
116
+ ### Legacy processing and provenance record
117
+
118
+ ```json
119
+ {
120
+ "all_zero_rows": {
121
+ "count": 0,
122
+ "documented": true,
123
+ "expected": false,
124
+ "reason": "No exact all-zero rows were detected in embeddings.npz.",
125
+ "report_file": null
126
+ },
127
+ "counts": {
128
+ "ambiguous_source_rows": 169,
129
+ "duplicate_final_mappings_averaged": 27,
130
+ "final_dimensions": 200,
131
+ "final_mapped_genes": 17564,
132
+ "mapped_source_rows_before_duplicate_collapse": 17593,
133
+ "master_rows": 20097,
134
+ "source_dimensions": 200,
135
+ "source_rows": 18407,
136
+ "unmapped_source_rows": 645
137
+ },
138
+ "coverage": {
139
+ "master_gene_coverage_fraction": 0.8739612877543912,
140
+ "source_row_mapping_fraction": 0.9557776932688651
141
+ },
142
+ "download_source": "Official PROBE human_representation_vectors.tar.gz archive from Zenodo record 5795850 plus official HUBioDataLab/PROBE repository",
143
+ "embedding_dimension": 200,
144
+ "embedding_generated_by": "PROBE authors / original PROBE human representation archive",
145
+ "embedding_id": "probe_gene2vec_uniprot",
146
+ "embedding_name": "probe_gene2vec_uniprot_v1_1",
147
+ "former_processing_embedding_id": "probe_gene2vec_uniprot_v1_1",
148
+ "mapping_method_counts": {
149
+ "uniprot_accession_exact_unique": 17564
150
+ },
151
+ "mapping_strategy": "Exact UniProt accession mapping to master_gene_table_v1_1_enriched.csv using uniprot_id, hgnc_uniprot_ids, and map_uniprot_ids_all. Only unique mappings are accepted. Duplicate source rows mapping to the same final master gene are averaged.",
152
+ "matrix_shape": [
153
+ 17564,
154
+ 200
155
+ ],
156
+ "modality": "protein sequence / protein representation from PROBE human UniProt archive",
157
+ "num_genes": 17564,
158
+ "original_model_or_method": "GENE2VEC",
159
+ "public_file_structure": {
160
+ "embeddings": "embeddings.npz",
161
+ "genes": "genes.tsv",
162
+ "metadata": "metadata.json",
163
+ "readme": "README.md"
164
+ },
165
+ "sequence_and_reference_provenance": {
166
+ "input_sequence_source": "PROBE human UniProt representation archive",
167
+ "input_sequence_type": "protein sequence-derived representation",
168
+ "sequence_reference_status": "PROBE archive provenance recorded; exact UniProt release to verify from original PROBE documentation if needed",
169
+ "source_identifier": "UniProt accession in Entry column",
170
+ "species": "human"
171
+ },
172
+ "source_embedding": "PROBE_GENE2VEC",
173
+ "source_identifier_type": "UniProt accession"
174
+ }
175
+ ```
176
+
177
+ <!-- END CATALOG NORMALIZATION: LEGACY METADATA -->
data/embeddings/probe_gene2vec_uniprot/embeddings.npz ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:a52a9f963c9fe041ee0b89f305d0f7bdb9c267b2db48702578bf2d20ed7fafb8
3
+ size 13029054
data/embeddings/probe_gene2vec_uniprot/genes.tsv ADDED
The diff for this file is too large to render. See raw diff
 
data/embeddings/probe_gene2vec_uniprot/metadata.json CHANGED
@@ -1,56 +1,17 @@
1
  {
2
- "embedding_name": "probe_gene2vec_uniprot_v1_1",
3
- "source_embedding": "PROBE_GENE2VEC",
4
  "modality": "protein sequence / protein representation from PROBE human UniProt archive",
5
- "source_identifier_type": "UniProt accession",
6
- "download_source": "Official PROBE human_representation_vectors.tar.gz archive from Zenodo record 5795850 plus official HUBioDataLab/PROBE repository",
7
- "original_model_or_method": "GENE2VEC",
 
 
 
 
 
 
 
8
  "embedding_generated_by": "PROBE authors / original PROBE human representation archive",
9
- "sequence_and_reference_provenance": {
10
- "input_sequence_type": "protein sequence-derived representation",
11
- "input_sequence_source": "PROBE human UniProt representation archive",
12
- "source_identifier": "UniProt accession in Entry column",
13
- "species": "human",
14
- "sequence_reference_status": "PROBE archive provenance recorded; exact UniProt release to verify from original PROBE documentation if needed"
15
- },
16
- "mapping_strategy": "Exact UniProt accession mapping to master_gene_table_v1_1_enriched.csv using uniprot_id, hgnc_uniprot_ids, and map_uniprot_ids_all. Only unique mappings are accepted. Duplicate source rows mapping to the same final master gene are averaged.",
17
- "counts": {
18
- "source_rows": 18407,
19
- "source_dimensions": 200,
20
- "mapped_source_rows_before_duplicate_collapse": 17593,
21
- "unmapped_source_rows": 645,
22
- "ambiguous_source_rows": 169,
23
- "final_mapped_genes": 17564,
24
- "final_dimensions": 200,
25
- "master_rows": 20097,
26
- "duplicate_final_mappings_averaged": 27
27
- },
28
- "coverage": {
29
- "source_row_mapping_fraction": 0.9557776932688651,
30
- "master_gene_coverage_fraction": 0.8739612877543912
31
- },
32
- "mapping_method_counts": {
33
- "uniprot_accession_exact_unique": 17564
34
- },
35
- "embedding_id": "probe_gene2vec_uniprot",
36
- "former_processing_embedding_id": "probe_gene2vec_uniprot_v1_1",
37
- "public_file_structure": {
38
- "embeddings": "embeddings.npz",
39
- "genes": "genes.tsv",
40
- "metadata": "metadata.json",
41
- "readme": "README.md"
42
- },
43
- "num_genes": 17564,
44
- "embedding_dimension": 200,
45
- "matrix_shape": [
46
- 17564,
47
- 200
48
- ],
49
- "all_zero_rows": {
50
- "count": 0,
51
- "documented": true,
52
- "expected": false,
53
- "reason": "No exact all-zero rows were detected in embeddings.npz.",
54
- "report_file": null
55
- }
56
  }
 
1
  {
2
+ "embedding_id": "probe_gene2vec_uniprot",
3
+ "display_name": "probe_gene2vec_uniprot_v1_1",
4
  "modality": "protein sequence / protein representation from PROBE human UniProt archive",
5
+ "species": "Homo sapiens",
6
+ "original_identifier_type": "UniProt accession",
7
+ "mapping_method": "Exact UniProt accession mapping to master_gene_table_v1_1_enriched.csv using uniprot_id, hgnc_uniprot_ids, and map_uniprot_ids_all. Only unique mappings are accepted. Duplicate source rows mapping to the same final master gene are averaged.",
8
+ "n_genes": 17564,
9
+ "n_dimensions": 200,
10
+ "dtype": "float32",
11
+ "npz_key": "embeddings",
12
+ "master_coverage_fraction": 0.8739612877543912,
13
+ "original_method": "GENE2VEC",
14
+ "publication": "https://rdcu.be/cJAKN",
15
  "embedding_generated_by": "PROBE authors / original PROBE human representation archive",
16
+ "input_data_source": "Official PROBE human_representation_vectors.tar.gz archive from Zenodo record 5795850 plus official HUBioDataLab/PROBE repository"
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
17
  }