LucaGroup commited on
Commit
b3e6035
·
verified ·
1 Parent(s): 15ac2d4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +52 -61
README.md CHANGED
@@ -17,100 +17,90 @@ tags:
17
  - AI4Science
18
  - Nucleotide-Protein
19
  task_categories:
 
20
  - feature-extraction
21
  size_categories:
22
  - 10M<n<100M
23
  ---
24
 
25
- # Dataset Card for LucaVirus-OpenVirus-Gene
26
 
27
  ## 1. Dataset Summary
28
 
29
- **LucaVirus-OpenVirus-Gene** is a large-scale genomic dataset consisting exclusively of viral nucleotide sequences. It is a specialized subset of the **OpenVirus** corpus, curated specifically for the pre-training of the **LucaVirus-Gene** foundation model.
30
 
31
- By focusing purely on viral genomes, this dataset provides a high-density corpus of 10.4 million sequences, enabling models to capture the intricate evolutionary patterns, regulatory motifs, and genomic architectures of DNA and RNA viruses.
32
 
33
  ## 2. Dataset Statistics
34
 
35
- The dataset focuses solely on nucleotide sequences (genomes, genes, and fragments):
 
 
 
 
36
 
37
- | Feature | Count / Description |
38
- | :--- | :--- |
39
- | **Total Sequences** | 10.4 Million |
40
- | **Sequence Type** | Nucleotide (DNA/RNA) |
41
- | **`obj_type` Identifier** | `gene` (Exclusive) |
42
- | **Primary Use** | Pre-training for LucaVirus-Gene |
43
 
44
- ## 3. Data Structure & Format
45
-
46
- ### 3.1 File Organization
47
- The dataset is provided as a compressed **`.tar`** archive. Upon extraction, the data is partitioned into three standard machine-learning subsets:
48
 
49
  ```text
50
- LucaVirus-OpenVirus-Gene/
51
- ├── train/ # Training set (primary corpus for genomic pre-training)
52
- ├── dev/ # Validation set (for model selection and tuning)
53
- └── test/ # Test set (for final evaluation and benchmarking)
54
  ```
55
 
56
- Each directory (`train`, `dev`, `test`) contains one or more **CSV files** with headers.
57
-
58
- ### 3.2 CSV Schema
59
- All CSV files follow a consistent four-column schema:
60
 
61
- | Column Name | Description | Details |
62
- | :--- | :--- |:-------------------------------------------------------------------------------------------------------|
63
- | **`obj_id`** | Sample ID | Unique identifier for each viral sequence. |
64
- | **`obj_type`** | Sequence Type | Set to `gene` for all entries in this dataset (Nucleotide). |
65
- | **`obj_seq`** | Sequence Content | Raw nucleotide string (A, T(U), C, G, N). |
66
- | **`obj_label`** | Label | Metadata, taxonomic info, or functional labels associated with the genome (Annotation, Bio Knowledge). |
67
 
 
 
 
 
 
 
68
 
69
- ## 4. Intended Use
70
 
71
- - **Genomic Foundation Modeling**: Building models like **LucaVirus-Gene** that specialize in the "language of genomes."
72
- - **Viral Evolution Studies**: Analyzing conserved nucleotide patterns across divergent viral lineages.
73
- - **Regulatory Element Discovery**: Identifying viral gene boundaries, promoters, and other non-coding functional motifs.
 
74
 
75
- ## 5. Usage Example
76
 
77
- You can extract the archive and load the genomic data using the following Python snippet:
 
78
 
79
  ```python
80
- import tarfile
81
  import pandas as pd
 
82
  import os
83
 
84
- # 1. Extract the genomic dataset
85
- with tarfile.open("LucaVirus-OpenVirus-Gene.tar.gz", "r:gz") as tar:
86
- tar.extractall(path="./LucaVirus-OpenVirus-Gene")
87
-
88
- with tarfile.open("LucaVirus-OpenVirus-Gene/dataset.tar.gz", "r:gz") as tar:
89
- tar.extractall(path="./LucaVirus-OpenVirus-Gene/dataset")
90
-
91
- # 2. Load a sample from the training set
92
- train_path = "./LucaVirus-OpenVirus-Gene/dataset/v1.0/train"
93
- csv_files = [f for f in os.listdir(train_path) if f.endswith('.csv')]
94
-
95
- if csv_files:
96
- # Load the first CSV file
97
- df = pd.read_csv(os.path.join(train_path, csv_files[0]))
98
-
99
- # Verify the sequence type
100
- print(f"Loaded {len(df)} genomic sequences.")
101
- print(df[['obj_id', 'obj_seq']].head())
102
- ```
103
 
104
- ## 6. Related Resources
 
 
 
105
 
106
- This dataset is a core component of the **LucaGroup** biological modeling ecosystem.
107
- - **Full Corpus (Gene + Prot)**: [LucaVirus-OpenVirus-Gene-Prot](https://huggingface.co/datasets/LucaGroup/LucaVirus-OpenVirus-Gene-Prot)
 
108
  - **Protein Subset**: [LucaVirus-OpenVirus-Prot](https://huggingface.co/datasets/LucaGroup/LucaVirus-OpenVirus-Prot)
109
  - **Models**: Visit the [LucaVirus Collection](https://huggingface.co/collections/LucaGroup/lucavirus).
110
- -
 
111
  ## 7. Citation
112
 
113
- If you use this dataset in your research, please cite:
114
 
115
  ```bibtex
116
  @article{lucavirus2025,
@@ -123,9 +113,10 @@ If you use this dataset in your research, please cite:
123
  ```
124
 
125
  ## 8. License
126
-
127
- This dataset is released under the **MIT License**.
128
 
129
  ## 9. Contact
130
 
131
  *For further information, please visit the [LucaGroup GitHub](https://github.com/LucaOne), email to: [sanyuan.hy@alibaba-inc.com/heyongcsat@gmail.com], or contact the team via the Hugging Face organization profile.*
 
 
 
17
  - AI4Science
18
  - Nucleotide-Protein
19
  task_categories:
20
+ - sequence-modeling
21
  - feature-extraction
22
  size_categories:
23
  - 10M<n<100M
24
  ---
25
 
26
+ # Dataset Card for LucaVirus-OpenVirus-Gene-Prot
27
 
28
  ## 1. Dataset Summary
29
 
30
+ **LucaVirus-OpenVirus-Gene-Prot** is the complete, multi-modal **OpenVirus** corpus, curated for the pre-training of the **LucaVirus** biological foundation model. This dataset provides a massive-scale collection of viral sequences, bridging the gap between genomic (nucleotide) and proteomic (protein) data.
31
 
32
+ The corpus comprises **15.7 million(10.4M nucleotide sequences and 5.2M protein sequences)** non-redundant viral sequences, providing a robust foundation for learning the complex language of viral evolution and the "central dogma" of viral biology.
33
 
34
  ## 2. Dataset Statistics
35
 
36
+ | Data Type | Count | `obj_type` Identifier |
37
+ | :--- | :--- | :--- |
38
+ | **Nucleotide (Genomes)** | 10.4 Million | `gene` |
39
+ | **Protein (Amino Acids)** | 5.2 Million | `prot` |
40
+ | **Total Sequences** | **15.7 Million** | - |
41
 
42
+ ## 3. Data Structure
 
 
 
 
 
43
 
44
+ The dataset is provided as a compressed **`.tar`** archive. Once extracted, the directory structure follows a standard machine-learning split:
 
 
 
45
 
46
  ```text
47
+ LucaVirus-OpenVirus-Gene-Prot/
48
+ ├── train/ # Training set (primary corpus for pre-training)
49
+ ├── dev/ # Validation set (for hyperparameter tuning)
50
+ └── test/ # Test set (for final evaluation)
51
  ```
52
 
53
+ Each directory contains one or more **CSV files with headers**.
 
 
 
54
 
55
+ ### Data Schema
56
+ Each CSV file includes the following columns:
 
 
 
 
57
 
58
+ | Column Name | Description | Details |
59
+ | :--- | :--- |:-------------------------------------------------------------------------------------------------------------------|
60
+ | **`obj_id`** | Sample ID | Unique identifier for the sample. |
61
+ | **`obj_type`** | Sequence Type | Sequence modality: `gene` (nucleotide) or `prot` (protein). |
62
+ | **`obj_seq`** | Sequence Content | The raw biological sequence (AT(U)GCN for gene; Amino Acids for prot). |
63
+ | **`obj_label`** | Label | Metadata, taxonomic info, or functional labels associated with the genome and proteins (Annotation, Bio Knowledge) |
64
 
65
+ ## 4. Dataset Intent
66
 
67
+ This dataset is specifically designed for:
68
+ - **Foundation Model Pre-training**: Building models that can process both DNA/RNA and Protein sequences.
69
+ - **Cross-modal Learning**: Understanding the translation and structural relationships within viral biology.
70
+ - **Viral Research**: A large-scale benchmark for viral sequence classification, functional annotation, and mutation analysis.
71
 
72
+ ## 5. Usage
73
 
74
+ ### Loading with Python
75
+ You can use standard Python libraries to process the data:
76
 
77
  ```python
 
78
  import pandas as pd
79
+ import tarfile
80
  import os
81
 
82
+ # Example: Extracting and reading a file
83
+ with tarfile.open("LucaVirus-OpenVirus-Gene-Prot.tar.gz", "r:gz") as tar:
84
+ tar.extractall(path="./LucaVirus-OpenVirus-Gene-Prot/")
85
+
86
+ with tarfile.open("./LucaVirus-OpenVirus-Gene-Prot/dataset.tar.gz", "r:gz") as tar:
87
+ tar.extractall(path="./LucaVirus-OpenVirus-Gene-Prot/dataset/")
 
 
 
 
 
 
 
 
 
 
 
 
 
88
 
89
+ # Read a specific CSV from the train set
90
+ df = pd.read_csv("../LucaVirus-OpenVirus-Gene-Prot/dataset/v1.0/train/3072_train_1.csv")
91
+ print(df.head())
92
+ ```
93
 
94
+ ## 6. Pre-training with LucaVirus
95
+ This dataset is the primary source for the **LucaVirus** model family.
96
+ - **Full Corpus (Gene + Prot)**: [LucaVirus-OpenVirus-Gene](https://huggingface.co/datasets/LucaGroup/LucaVirus-OpenVirus-Gene)
97
  - **Protein Subset**: [LucaVirus-OpenVirus-Prot](https://huggingface.co/datasets/LucaGroup/LucaVirus-OpenVirus-Prot)
98
  - **Models**: Visit the [LucaVirus Collection](https://huggingface.co/collections/LucaGroup/lucavirus).
99
+
100
+
101
  ## 7. Citation
102
 
103
+ If you use this dataset in your research, please cite the following:
104
 
105
  ```bibtex
106
  @article{lucavirus2025,
 
113
  ```
114
 
115
  ## 8. License
116
+ This dataset is released under the **Apache License 2.0**.
 
117
 
118
  ## 9. Contact
119
 
120
  *For further information, please visit the [LucaGroup GitHub](https://github.com/LucaOne), email to: [sanyuan.hy@alibaba-inc.com/heyongcsat@gmail.com], or contact the team via the Hugging Face organization profile.*
121
+
122
+