yairschiff commited on
Commit
770904a
1 Parent(s): 0857cc8

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +71 -0
README.md ADDED
@@ -0,0 +1,71 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ ---
4
+
5
+ ## Overview
6
+ This dataset consists of reference genomes for 10 species:
7
+
8
+ | Species | Assembly Accession |
9
+ |--------------------------|-----------------------------------------------------|
10
+ | *Arabidopsis thaliana* | `GCF_000001735.4_TAIR10.1` |
11
+ | *Caenorhabditis elegans* | `GCF_000002985.6_WBcel235` |
12
+ | *Danio rerio* | `GCF_000002035.6_GRCz11` |
13
+ | *Drosophila melanogaster*| `GCF_000001215.4_Release_6_plus_ISO1_MT` |
14
+ | *Felis catus* | `GCF_018350175.1_F.catus_Fca126_mat1.0` |
15
+ | *Gallus gallus* | `GCF_016699485.2_bGalGal1.mat.broiler.GRCg7b` |
16
+ | *Gorilla gorilla* | `GCF_029281585.2_NHGRI_mGorGor1-v2.0_pri` |
17
+ | *Homo sapiens* | `GCF_000001405.40_GRCh38.p14` |
18
+ | *Mus musculus* | `GCF_000001635.27_GRCm39` |
19
+ | *Salmo trutta* | `GCF_901001165.1_fSalTru1.1` |
20
+
21
+ Each item in the dataset contains the following fields:
22
+ ```
23
+ "sequence": datasets.Value("string"),
24
+ "species_label": datasets.ClassLabel() # See below
25
+ "description": datasets.Value("string"),
26
+ "start_pos": datasets.Value("int32"),
27
+ "end_pos": datasets.Value("int32"),
28
+ "fasta_url": datasets.Value("string")
29
+ ```
30
+
31
+ The class labels are as follows:
32
+ | Class | Label |
33
+ |-----------------------------|-------|
34
+ | `'Homo_sapiens'` | 0 |
35
+ | `'Mus_musculus'` | 1 |
36
+ | `'Drosophila_melanogaster'` | 2 |
37
+ | `'Danio_rerio'` | 3 |
38
+ | `'Caenorhabditis_elegans'` | 4 |
39
+ | `'Gallus_gallus'` | 5 |
40
+ | `'Gorilla_gorilla'` | 6 |
41
+ | `'Felis_catus'` | 7 |
42
+ | `'Salmo_trutta'` | 8 |
43
+ | `'Arabidopsis_thaliana'` | 9 |
44
+
45
+
46
+ ## Usage
47
+ To use this dataset, set the `chunk_length` (length of each sequence, in base-pairs) and the `overlap` (amount each sequence overlaps, in base-pairs).
48
+ The dataset only contains a `train` split.
49
+ We recommend randomly splitting the dataset to create validation/test sets.
50
+ See below for example usage:
51
+
52
+ ```python
53
+ import datasets
54
+
55
+ max_length = 32_768
56
+ overlap = 0
57
+
58
+ dataset = datasets.load_dataset(
59
+ 'yairschiff/ten_species',
60
+ split='train', # original dataset only has `train` split
61
+ chunk_length=max_length,
62
+ overlap=overlap,
63
+ trust_remote_code=True
64
+ )
65
+ self.dataset = dataset.train_test_split(
66
+ test_size=0.05, seed=42)[split]
67
+ ```
68
+
69
+
70
+ ## Acknowledgments
71
+ Code for dataset processing is derived from https://huggingface.co/datasets/InstaDeepAI/multi_species_genomes.