LucaGroup commited on
Commit
609f291
·
verified ·
1 Parent(s): 669ab3b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +59 -48
README.md CHANGED
@@ -12,93 +12,104 @@ tags:
12
  - Protein
13
  - Foundation Model
14
  - LucaVirus
 
15
  - AI4Bio
16
  - AI4Science
17
  - Nucleotide-Protein
18
  task_categories:
19
- - feature-extraction
20
  size_categories:
21
- - 10M<n<100M
22
  ---
23
 
24
- # Dataset Card for LucaVirus-OpenVirus-Gene-Prot
25
 
26
  ## 1. Dataset Summary
27
 
28
- **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.
29
 
30
- The corpus comprises **15.7 million** non-redundant viral sequences, providing a robust foundation for learning the complex language of viral evolution and the "central dogma" of viral biology.
31
 
32
  ## 2. Dataset Statistics
33
 
34
- | Data Type | Count | `obj_type` Identifier |
35
- | :--- | :--- | :--- |
36
- | **Nucleotide (Genomes)** | 10.4 Million | `gene` |
37
- | **Protein (Amino Acids)** | 5.2 Million | `prot` |
38
- | **Total Sequences** | **15.7 Million** | - |
39
 
40
- ## 3. Data Structure
 
 
 
 
 
41
 
42
- The dataset is provided as a compressed **`.tar`** archive. Once extracted, the directory structure follows a standard machine-learning split:
 
 
 
43
 
44
  ```text
45
- LucaVirus-OpenVirus-Gene-Prot/
46
- ├── train/ # Training set (primary corpus for pre-training)
47
- ├── dev/ # Validation set (for hyperparameter tuning)
48
- └── test/ # Test set (for final evaluation)
49
  ```
50
 
51
- Each directory contains one or more **CSV files with headers**.
52
 
53
- ### Data Schema
54
- Each CSV file includes the following columns:
55
 
56
  | Column Name | Description | Details |
57
  | :--- | :--- |:-------------------------------------------------------------------------------------------------------|
58
- | **`obj_id`** | Sample ID | Unique identifier for the sample. |
59
- | **`obj_type`** | Sequence Type | Sequence modality: `gene` (nucleotide) or `prot` (protein). |
60
- | **`obj_seq`** | Sequence Content | The raw biological sequence (ATGC for gene; Amino Acids for prot). |
61
- | **`obj_label`** | Label | Metadata, taxonomic info, or functional labels associated with the genome and proteins (Annotation, Bio Knowledge) |
62
 
63
- ## 4. Dataset Intent
64
 
65
- This dataset is specifically designed for:
66
- - **Foundation Model Pre-training**: Building models that can process both DNA/RNA and Protein sequences.
67
- - **Cross-modal Learning**: Understanding the translation and structural relationships within viral biology.
68
- - **Viral Research**: A large-scale benchmark for viral sequence classification, functional annotation, and mutation analysis.
69
 
70
- ## 5. Usage
71
 
72
- ### Loading with Python
73
- You can use standard Python libraries to process the data:
74
 
75
  ```python
76
- import pandas as pd
77
  import tarfile
 
78
  import os
79
 
80
- # Example: Extracting and reading a file
81
- with tarfile.open("LucaVirus-OpenVirus-Gene-Prot.tar.gz", "r:gz") as tar:
82
- tar.extractall(path="./LucaVirus-OpenVirus-Gene-Prot/")
 
 
 
83
 
84
- with tarfile.open("./LucaVirus-OpenVirus-Gene-Prot/dataset.tar.gz", "r:gz") as tar:
85
- tar.extractall(path="./LucaVirus-OpenVirus-Gene-Prot/dataset/")
 
86
 
87
- # Read a specific CSV from the train set
88
- df = pd.read_csv("../LucaVirus-OpenVirus-Gene-Prot/dataset/v1.0/train/3072_train_1.csv")
89
- print(df.head())
 
 
 
 
90
  ```
91
 
92
- ## 6. Pre-training with LucaVirus
93
- This dataset is the primary source for the **LucaVirus** model family.
94
- - **Full Corpus (Gene + Prot)**: [LucaVirus-OpenVirus-Gene](https://huggingface.co/datasets/LucaGroup/LucaVirus-OpenVirus-Gene)
95
- - **Protein Subset**: [LucaVirus-OpenVirus-Prot](https://huggingface.co/datasets/LucaGroup/LucaVirus-OpenVirus-Prot)
96
- - **Models**: Visit the [LucaVirus Collection](https://huggingface.co/collections/LucaGroup/lucavirus).
97
 
 
 
 
 
98
 
99
  ## 7. Citation
100
 
101
- If you use this dataset in your research, please cite the following:
102
 
103
  ```bibtex
104
  @article{lucavirus2025,
@@ -111,10 +122,10 @@ If you use this dataset in your research, please cite the following:
111
  ```
112
 
113
  ## 8. License
114
- This dataset is released under the **Apache License 2.0**.
 
115
 
116
  ## 9. Contact
117
 
118
  *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.*
119
 
120
-
 
12
  - Protein
13
  - Foundation Model
14
  - LucaVirus
15
+ - LucaVirus-Prot
16
  - AI4Bio
17
  - AI4Science
18
  - Nucleotide-Protein
19
  task_categories:
20
+ - feature-extraction
21
  size_categories:
22
+ - 1M<n<10M
23
  ---
24
 
25
+ # Dataset Card for LucaVirus-OpenVirus-Prot
26
 
27
  ## 1. Dataset Summary
28
 
29
+ **LucaVirus-OpenVirus-Prot** is a large-scale proteomics dataset consisting exclusively of viral protein sequences. It is a specialized subset of the **OpenVirus** corpus, specifically curated for the pre-training of the **LucaVirus-Prot** (or LucaVirus-Protein) foundation model.
30
 
31
+ This dataset provides a comprehensive representation of the viral proteosphere, comprising **5.2 million** protein sequences. It is designed to enable biological models to learn the "language of proteins," capturing structural motifs, functional domains, and evolutionary signatures across a vast array of viral families.
32
 
33
  ## 2. Dataset Statistics
34
 
35
+ The dataset focuses strictly on amino acid sequences:
 
 
 
 
36
 
37
+ | Feature | Count / Description |
38
+ | :--- | :--- |
39
+ | **Total Sequences** | 5.2 Million |
40
+ | **Sequence Type** | Protein (Amino Acids) |
41
+ | **`obj_type` Identifier** | `prot` (Exclusive) |
42
+ | **Primary Use** | Pre-training for LucaVirus-Prot |
43
 
44
+ ## 3. Data Structure & Format
45
+
46
+ ### 3.1 File Organization
47
+ The dataset is distributed as a compressed **`.tar`** archive. Upon extraction, the data is partitioned into three standard machine-learning subsets:
48
 
49
  ```text
50
+ LucaVirus-OpenVirus-Prot/
51
+ ├── train/ # Training set (primary corpus for protein 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 protein sequence. |
64
+ | **`obj_type`** | Sequence Type | Set to `prot` for all entries in this dataset. |
65
+ | **`obj_seq`** | Sequence Content | Raw amino acid string (standard IUPAC codes). |
66
+ | **`obj_label`** | Annotations | Metadata, taxonomic info, or functional labels associated with the protein (Annotation, Bio Knowledge) |
67
 
68
+ ## 4. Intended Use
69
 
70
+ - **Protein Foundation Modeling**: Building models like **LucaVirus-Prot** that specialize in understanding protein sequences and their biophysical properties.
71
+ - **Functional Annotation**: Developing tools to predict viral protein functions, domains, and active sites.
72
+ - **Virus-Host Interaction**: Studying how viral proteins interact with host cellular machinery based on sequence patterns.
 
73
 
74
+ ## 5. Usage Example
75
 
76
+ You can extract the archive and load the protein data using the following Python snippet:
 
77
 
78
  ```python
 
79
  import tarfile
80
+ import pandas as pd
81
  import os
82
 
83
+ # 1. Extract the protein dataset
84
+ with tarfile.open("LucaVirus-OpenVirus-Prot.tar.gz", "r:gz") as tar:
85
+ tar.extractall(path="./LucaVirus-OpenVirus-Prot")
86
+
87
+ with tarfile.open("LucaVirus-OpenVirus-Prot/dataset.tar.gz", "r:gz") as tar:
88
+ tar.extractall(path="./LucaVirus-OpenVirus-Prot/dataset")
89
 
90
+ # 2. Load a sample from the training set
91
+ train_path = "./LucaVirus-OpenVirus-Prot/dataset/v1.0/train"
92
+ csv_files = [f for f in os.listdir(train_path) if f.endswith('.csv')]
93
 
94
+ if csv_files:
95
+ # Load the first CSV file
96
+ df = pd.read_csv(os.path.join(train_path, csv_files[0]))
97
+
98
+ # Verify the sequence type
99
+ print(f"Loaded {len(df)} protein sequences.")
100
+ print(df[['obj_id', 'obj_seq', 'obj_label']].head())
101
  ```
102
 
103
+ ## 6. Related Resources
 
 
 
 
104
 
105
+ This dataset is a core component of the **LucaGroup** biological modeling ecosystem.
106
+ - **Full Corpus (Gene + Prot)**: [LucaVirus-OpenVirus-Gene-Prot](https://huggingface.co/datasets/LucaGroup/LucaVirus-OpenVirus-Gene-Prot)
107
+ - **Genomic Subset**: [LucaVirus-OpenVirus-Gene](https://huggingface.co/datasets/LucaGroup/LucaVirus-OpenVirus-Gene)
108
+ - **Models**: Visit the [LucaVirus Collection](https://huggingface.co/collections/LucaGroup/lucavirus).
109
 
110
  ## 7. Citation
111
 
112
+ If you use this dataset in your research, please cite:
113
 
114
  ```bibtex
115
  @article{lucavirus2025,
 
122
  ```
123
 
124
  ## 8. License
125
+
126
+ This dataset is released under the **MIT License**.
127
 
128
  ## 9. Contact
129
 
130
  *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.*
131