greipinto commited on
Commit
c230121
·
verified ·
1 Parent(s): b85e882

Upload embpy static embedding package (13 prefixes)

Browse files
Files changed (1) hide show
  1. README.md +99 -0
README.md ADDED
@@ -0,0 +1,99 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ pretty_name: Embpy Static Embeddings
3
+ license: other
4
+ tags:
5
+ - embpy
6
+ - biology
7
+ - genomics
8
+ - gene-embeddings
9
+ - protein-embeddings
10
+ - zarr
11
+ ---
12
+
13
+ # Embpy Static Embeddings
14
+
15
+ This dataset contains static gene and protein embeddings packaged with embpy. Embedding values are stored in Zarr arrays, while row identifiers, provenance, species metadata, and AnnData-like `.uns` metadata are stored in sidecar metadata files.
16
+
17
+ ## Summary
18
+
19
+ - Repository: `theislab/Embpy_Data`
20
+ - Schema version: `embpy.static_embedding_package.v1`
21
+ - Generated at: `2026-06-01T15:07:46+00:00`
22
+ - Number of embeddings: `11`
23
+ - Total indexed entities: `201,717`
24
+ - Species keys: `human_9606`
25
+ - NCBI taxonomy IDs: `9606`
26
+ - Default gene identifier policy: `ensembl_id`
27
+ - Unresolved gene identifier policy: `drop`
28
+
29
+ ## Available Embeddings
30
+
31
+ | key | entity | species | id type | rows | dims | description |
32
+ | --- | --- | --- | --- | --- | --- | --- |
33
+ | crispr_gene_effect | gene | human_9606 | ensembl_id | 17,087 | 1,178 | DepMap CRISPR gene effect matrix, genes as rows after transposition. |
34
+ | crispr_gene_effect_1178 | gene | human_9606 | ensembl_id | 17,087 | 1,178 | DepMap CRISPR gene effect embedding, scaled, 1178d. |
35
+ | crispr_gene_effect_205 | gene | human_9606 | ensembl_id | 17,916 | 205 | DepMap CRISPR gene effect embedding, scaled, 205d. |
36
+ | gene2vec | gene | human_9606 | ensembl_id | 18,795 | 200 | Gene2Vec co-expression embedding, 200d. |
37
+ | genept | gene | human_9606 | ensembl_id | 18,807 | 3,072 | GenePT GPT-3.5 text embedding, 3072d, Ensembl-keyed. |
38
+ | genept_scaled | gene | human_9606 | ensembl_id | 17,728 | 3,072 | GenePT GPT-3.5 text embedding, z-scored, 3072d. |
39
+ | omics | gene | human_9606 | ensembl_id | 19,385 | 256 | Omics 256d static gene embedding, Ensembl-keyed. |
40
+ | pops | gene | human_9606 | ensembl_id | 18,383 | 256 | PoPS 256d gene features, Ensembl-keyed. |
41
+ | string_functional_9606 | protein | human_9606 | string_protein_id | 19,699 | 512 | STRING/SPACE functional PPI embedding for human proteins, species 9606, 512d. |
42
+ | string_node2vec_9606 | protein | human_9606 | string_protein_id | 19,622 | 128 | STRING node2vec PPI embedding for human proteins, species 9606, 128d. |
43
+ | wikicrow | gene | human_9606 | ensembl_id | 17,208 | 4,096 | WikiCrow text embedding, scaled, 4096d. |
44
+
45
+ ## File Layout
46
+
47
+ ```text
48
+ manifest.json
49
+ embeddings/<model_key>/
50
+ values.zarr/
51
+ metadata/
52
+ index.parquet
53
+ index.csv
54
+ metadata.json
55
+ uns.json
56
+ ```
57
+
58
+ The dense matrix is stored under `values.zarr`. The `metadata/index.parquet` file maps row positions to `entity_id` values and any preserved aliases such as source IDs or gene symbols.
59
+
60
+ ## Loading With embpy
61
+
62
+ ```python
63
+ from embpy.pp import HFHandler
64
+
65
+ hf = HFHandler("theislab/Embpy_Data")
66
+ embedding = hf.download_embedding("crispr_gene_effect")
67
+ matrix = embedding["embeddings"]
68
+ ids = embedding["ids"]
69
+ ```
70
+
71
+ For a local checkout or downloaded snapshot:
72
+
73
+ ```python
74
+ from embpy import load_static_embedding_package
75
+
76
+ store = load_static_embedding_package("/path/to/package", key="crispr_gene_effect")
77
+ tp53 = store.get("ENSG00000141510")
78
+ tp53_by_symbol = store.get("TP53", id_type="symbol")
79
+ ```
80
+
81
+ Missing identifiers raise by default. Use `missing="drop"` or `missing="nan"` when a partial result is acceptable.
82
+
83
+ ## Metadata And Species
84
+
85
+ This card reports species using package-level defaults. Regenerate the package with a current embpy build to also write per-embedding `species`, `taxonomy_id`, and `species_key` fields into `metadata/metadata.json`.
86
+
87
+ ## Validation
88
+
89
+ The package was designed to be validated locally before upload:
90
+
91
+ ```bash
92
+ python -m embpy.scripts.package_static_embeddings validate --package /path/to/package
93
+ ```
94
+
95
+ This package intentionally skips 2 source collection(s) containing 2642 file(s). Those collections usually contain per-species artifacts and should be packaged only when a species/taxonomy ID is selected explicitly.
96
+
97
+ ## License And Attribution
98
+
99
+ This repository aggregates embeddings derived from multiple upstream resources. Please check the per-embedding metadata and upstream sources for the applicable licenses and citation terms.