Community contribution
Submit a gene embedding
Prepare one standardized package and upload it directly to the library-owned Hugging Face Dataset as a Pull Request.
Prepare one folder
<embedding_id>/
├── embeddings.npz
├── genes.tsv
├── README.md
└── submission.yaml
The embedding ID must contain 3–80 lowercase letters, numbers, dots, underscores, or hyphens and must begin with a letter or number.
A metadata.json file is automatically
generated and saved in the embedding's folder after
acceptance.
Check the package contract
-
embeddings.npzcontains exactly one two-dimensionalfloat32array namedembeddings. -
genes.tsvcontains one uniqueensembl_gene_idcolumn whose rows match the matrix rows. -
submission.yamlprovides the scientific context and provenance needed to understand the embedding and how it was produced. -
README.mddocuments how the representation was produced.
Complete the submission template
Download submission.yaml, replace every
placeholder and keep the embedding ID identical to the
folder name. Submitted values are checked automatically
against the package.
Upload as a Pull Request
- Open the Hugging Face uploader using the button below.
-
Upload the folder
<embedding_id>. - Select Open as a pull request.
Automatic validation and publication
The package structure, metadata consistency, Ensembl identifiers, matrix shape, numeric validity, licensing, provenance, and attestations are checked automatically.
A strict PASS is stored in the central Dataset and added to this catalog.
Command-line alternative example
Before running this example, replace
esm2_v1_1 with the name of your existing
local embedding folder in both path arguments.
hf upload \
embeddingsSSRF/gene_embeddings_staging \
./esm2_v1_1 \
esm2_v1_1 \
--repo-type dataset \
--create-pr \
--commit-message "Submit gene embedding"