danieltslz commited on
Commit
a8a0b3f
·
verified ·
1 Parent(s): 3821308

Simplify contribution fields and metadata

Browse files
Files changed (2) hide show
  1. index.html +12 -5
  2. submission.yaml +37 -17
index.html CHANGED
@@ -171,11 +171,18 @@
171
  the matrix rows.
172
  </li>
173
  <li>
174
- <code>submission.yaml</code> supplies the descriptive
175
- metadata. Dimensions, dtype, gene count, coverage and
176
- checksums are measured automatically. A consolidated
177
- <code>metadata.json</code> is generated only after the
178
- submission is accepted.
 
 
 
 
 
 
 
179
  </li>
180
 
181
  <li>
 
171
  the matrix rows.
172
  </li>
173
  <li>
174
+ <code>submission.yaml</code> supplies the description
175
+ and the provenance needed to interpret
176
+ <code>genes.tsv</code>. Species, original identifier
177
+ type and mapping method are required. Contributor,
178
+ method, checkpoint, source, release, pooling, license
179
+ and terms URL fields are optional.
180
+ </li>
181
+
182
+ <li>
183
+ Dimensions, dtype, gene count and coverage are measured
184
+ automatically. A compact <code>metadata.json</code> is
185
+ generated after acceptance.
186
  </li>
187
 
188
  <li>
submission.yaml CHANGED
@@ -1,36 +1,56 @@
1
  schema_version: 1
2
  embedding_id: replace_with_unique_embedding_id
3
  display_name: Replace with the displayed embedding name
4
- contributor:
5
- name: Replace with contributor name
6
- affiliation: Replace with institution or organization
 
 
 
7
  scientific:
8
  # Broad catalog group. Recommended values: DNA, Expression,
9
  # Functional Genomics, Knowledge, Literature, Multimodal,
10
  # Network, Protein, RNA, Regulatory, or Single-cell.
11
  # Other values are accepted but displayed under "Other".
12
  category: Replace with the category
 
13
  # Specific free-text description of the representation,
14
  # e.g. protein sequence, single-cell transcriptomics,
15
- # or regulatory activity.
16
  modality: Replace with the modality
17
- original_method: Replace with the model or generation method
18
- model_checkpoint: Replace with checkpoint/version or not-applicable
19
- source_publication: ''
20
- description: Replace this text with a clear description of the embedding, how it
21
- was generated, and its intended use.
 
 
 
 
 
22
  provenance:
23
- embedding_generated_by: Replace with model, software, or authors
24
- input_data_source: Replace with the original data source
25
- input_data_release: Replace with version or release
26
  species: Homo sapiens
27
- pooling_strategy: Replace with pooling strategy or not-applicable
28
- identifier_before_mapping: Replace with original identifier type
29
- mapping_method: Replace with the identifier mapping procedure
 
 
 
 
 
 
 
 
 
30
  licensing:
31
- source_license: cc-by-4.0
32
  redistribution_allowed: true
33
- terms_url: Replace with the applicable license or terms URL
 
 
 
 
34
  attestations:
35
  information_is_accurate: true
36
  rights_to_redistribute: true
 
1
  schema_version: 1
2
  embedding_id: replace_with_unique_embedding_id
3
  display_name: Replace with the displayed embedding name
4
+
5
+ # Optional. The Hugging Face username is recorded automatically.
6
+ # contributor:
7
+ # name: Replace with contributor name
8
+ # affiliation: Replace with institution or organization
9
+
10
  scientific:
11
  # Broad catalog group. Recommended values: DNA, Expression,
12
  # Functional Genomics, Knowledge, Literature, Multimodal,
13
  # Network, Protein, RNA, Regulatory, or Single-cell.
14
  # Other values are accepted but displayed under "Other".
15
  category: Replace with the category
16
+
17
  # Specific free-text description of the representation,
18
  # e.g. protein sequence, single-cell transcriptomics,
19
+ # regulatory activity, or a biological knowledge graph.
20
  modality: Replace with the modality
21
+
22
+ description: >
23
+ Replace this text with a clear description of the embedding
24
+ and the biological information it represents.
25
+
26
+ # Optional scientific details:
27
+ # original_method: Replace with the model or generation method
28
+ # model_checkpoint: Replace with checkpoint or version
29
+ # source_publication: https://doi.org/example
30
+
31
  provenance:
32
+ # Required because these fields explain how genes.tsv was made.
 
 
33
  species: Homo sapiens
34
+ identifier_before_mapping: Replace with the original identifier type
35
+ mapping_method: >
36
+ Explain how the original identifiers were converted or aligned
37
+ to the unversioned Ensembl gene IDs stored in genes.tsv,
38
+ including how missing or duplicate mappings were handled.
39
+
40
+ # Optional provenance details:
41
+ # embedding_generated_by: Replace with model, software, or authors
42
+ # input_data_source: Replace with the original data source
43
+ # input_data_release: Replace with version or release
44
+ # pooling_strategy: Replace with pooling strategy
45
+
46
  licensing:
47
+ # Mandatory confirmation.
48
  redistribution_allowed: true
49
+
50
+ # Optional when known:
51
+ # source_license: cc-by-4.0
52
+ # terms_url: https://creativecommons.org/licenses/by/4.0/
53
+
54
  attestations:
55
  information_is_accurate: true
56
  rights_to_redistribute: true