Skip to content

Commit

Permalink
add RYOS dataset
Browse files Browse the repository at this point in the history
Signed-off-by: Zhiyuan Chen <[email protected]>
  • Loading branch information
ZhiyuanChen committed Oct 8, 2024
1 parent 5586a33 commit 64b9e6f
Show file tree
Hide file tree
Showing 5 changed files with 225 additions and 1 deletion.
9 changes: 9 additions & 0 deletions docs/docs/datasets/ryos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
authors:
- Zhiyuan Chen
date: 2024-05-04
---

# RYOS

--8<-- "multimolecule/datasets/ryos/README.md:21:"
1 change: 1 addition & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ nav:
- bpRNA-1m: datasets/bprna.md
- bpRNA-spot: datasets/bprna-spot.md
- bpRNA-new: datasets/bprna-new.md
- RYOS: datasets/ryos.md
- module:
- module/index.md
- heads: module/heads.md
Expand Down
2 changes: 1 addition & 1 deletion multimolecule/datasets/conversion_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ def write_data(
elif isinstance(data, dict):
data = Table.from_pydict(data)
elif isinstance(data, DataFrame):
data = Table.from_pandas(data)
data = Table.from_pandas(data, preserve_index=False)
if not isinstance(data, Table):
raise ValueError("Data must be a list, dict, pandas DataFrame, or pyarrow Table.")

Expand Down
132 changes: 132 additions & 0 deletions multimolecule/datasets/ryos/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
---
language: rna
tags:
- Biology
- RNA
license:
- agpl-3.0
size_categories:
- 1K<n<10K
task_categories:
- text-generation
- fill-mask
task_ids:
- language-modeling
- masked-language-modeling
pretty_name: RYOS
library_name: multimolecule
---

# RYOS

![RYOS](https://eternagame.org/sites/default/files/hero-covid.jpg)

RYOS is a database of RNA backbone stability in aqueous solution.

RYOS focuses on exploring the stability of mRNA molecules for vaccine applications.
This dataset is part of a broader effort to address one of the key challenges of mRNA vaccines: degradation during shipping and storage.

## Statement

_Deep learning models for predicting RNA degradation via dual crowdsourcing_ is published in [Nature Machine Intelligence](https://doi.org/10.1038/s42256-022-00571-8), which is a Closed Access / Author-Fee journal.

> Machine learning has been at the forefront of the movement for free and open access to research.
>
> We see no role for closed access or author-fee publication in the future of machine learning research and believe the adoption of these journals as an outlet of record for the machine learning community would be a retrograde step.
The MultiMolecule team is committed to the principles of open access and open science.

We do NOT endorse the publication of manuscripts in Closed Access / Author-Fee journals and encourage the community to support Open Access journals and conferences.

Please consider signing the [Statement on Nature Machine Intelligence](https://openaccess.engineering.oregonstate.edu).

## Disclaimer

This is an UNOFFICIAL release of the [RYOS](https://www.kaggle.com/competitions/stanford-covid-vaccine) by Hannah K. Wayment-Steele, et al.

**The team releasing RYOS did not write this dataset card for this dataset so this dataset card has been written by the MultiMolecule team.**

## Dataset Description

- **Homepage**: https://multimolecule.danling.org/datasets/ryos
- **Point of Contact**: [Rhiju Das](https://biochemistry.stanford.edu/people/rhiju-das/)
- **Kaggle Challenge**: https://www.kaggle.com/competitions/stanford-covid-vaccine
- **Eterna Round 1**: https://eternagame.org/labs/9830365
- **Eterna Round 2**: https://eternagame.org/labs/10207059

## Example Entry

| ID | design_name | sequence | structure | reactivity | signal_to_noise_reactivity | errors_reactivity | deg_pH10 | signal_to_noise_deg_pH10 | errors_deg_pH10 | deg_50C | signal_to_noise_deg_50C | errors_deg_50C | deg_Mg_pH10 | signal_to_noise_deg_Mg_pH10 | errors_deg_Mg_pH10 | deg_Mg_50C | signal_to_noise_deg_Mg_50C | errors_deg_Mg_50C | SN_filter |
| ------- | ----------- | ------------- | ------------- | ----------------------------- | -------------------------- | ---------------------------- | ----------------------------- | ------------------------ | ---------------------------- | --------------------------- | ----------------------- | ---------------------------- | ----------------------------- | --------------------------- | ---------------------------- | --------------------------- | -------------------------- | ---------------------------- | --------- |
| 9830366 | testing | GGAAAUUUGC... | .......(((... | [0.4167, 1.5941, 1.2359, ...] | 5.326 | [0.1689, 0.2323, 0.193, ...] | [1.5966, 2.6482, 1.3761, ...] | 4.198 | [0.3058, 0.3294, 0.233, ...] | [0.7885, 1.93, 2.0423, ...] | 3.746 | [0.2773, 0.328, 0.3048, ...] | [1.5966, 2.6482, 1.3761, ...] | 4.198 | [0.3058, 0.3294, 0.233, ...] | [0.7885, 1.93, 2.0423, ...] | 3.746 | [0.2773, 0.328, 0.3048, ...] | True |

## Column Description

The RYOS dataset consists of the following columns, providing crucial insights for understanding RNA stability for vaccine design:

- **ID**:
A unique identifier for each RNA sequence entry.

- **design_name**:
The name given to each RNA design by contributors, used for easy reference.

- **sequence**:
The nucleotide sequence of the RNA, using standard bases:

- **A**: Adenine
- **C**: Cytosine
- **G**: Guanine
- **U**: Uracil

- **structure**:
The predicted secondary structure of the RNA, represented using dot-bracket notation.
The structure helps determine the likely secondary interactions within each RNA molecule.

- **reactivity**:
A list of floating-point values that provide an estimate of the likelihood of the RNA backbone being cut at each nucleotide position.
These values help determine the stability of the RNA structure under various experimental conditions.

- **deg_pH10** and **deg_Mg_pH10**:
Arrays of degradation rates observed under two conditions: incubation at pH 10 without and with magnesium, respectively.
These values provide insight into how different conditions affect the stability of RNA molecules.

- **deg_50C** and **deg_Mg_50C**:
Arrays of degradation rates after incubation at 50°C, without and with magnesium.
These values capture how RNA sequences respond to elevated temperatures, which is relevant for storage and transportation conditions.

- **\*\_error\_\* Columns**:
Arrays of floating-point numbers indicating the experimental errors corresponding to the measurements in the **reactivity** and **deg\_** columns. These values help quantify the uncertainty in the degradation rates and reactivity measurements.

- **SN_filter**:
A filter applied to the dataset based on the signal-to-noise ratio, indicating whether a specific sequence meets the dataset’s quality criteria.

If the SN_filter is `True`, the sequence meets the quality criteria; otherwise, it does not.

Note that due to technical limitations, the ground truth measurements are not available for the final bases of each RNA sequence, resulting in a shorter length for the provided labels compared to the full sequence.

## Variations

This dataset is available in two subsets:

- [RYOS-1](https://huggingface.co/datasets/multimolecule/ryos-1): The RYOS dataset from round 1 of the Eterna RYOS lab. The sequence length for RYOS-1 is 107, and the label length is 68.
- [RYOS-2](https://huggingface.co/datasets/multimolecule/ryos-2): The RYOS dataset from round 2 of the Eterna RYOS lab. The sequence length for RYOS-2 is 130, and the label length is 102.

## License

This dataset is licensed under the [AGPL-3.0 License](https://www.gnu.org/licenses/agpl-3.0.html).

```spdx
SPDX-License-Identifier: AGPL-3.0-or-later
```

## Citation

```bibtex
@article{waymentsteele2021,
author = {Wayment-Steele, Hannah K and Kladwang, Wipapat and Watkins, Andrew M and Kim, Do Soon and Tunguz, Bojan and Reade, Walter and Demkin, Maggie and Romano, Jonathan and Wellington-Oguri, Roger and Nicol, John J and Gao, Jiayang and Onodera, Kazuki and Fujikawa, Kazuki and Mao, Hanfei and Vandewiele, Gilles and Tinti, Michele and Steenwinckel, Bram and Ito, Takuya and Noumi, Taiga and He, Shujun and Ishi, Keiichiro and Lee, Youhan and {\"O}zt{\"u}rk, Fatih and Chiu, Anthony and {\"O}zt{\"u}rk, Emin and Amer, Karim and Fares, Mohamed and Participants, Eterna and Das, Rhiju},
journal = {ArXiv},
month = oct,
title = {Deep learning models for predicting {RNA} degradation via dual crowdsourcing},
year = 2021
}
```
82 changes: 82 additions & 0 deletions multimolecule/datasets/ryos/ryos.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# MultiMolecule
# Copyright (C) 2024-Present MultiMolecule

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

from __future__ import annotations

import os

import danling as dl
import torch

from multimolecule.datasets.conversion_utils import ConvertConfig as ConvertConfig_
from multimolecule.datasets.conversion_utils import save_dataset

torch.manual_seed(1016)

cols = [
"ID",
"design_name",
"sequence",
"structure",
"reactivity",
"signal_to_noise_reactivity",
"errors_reactivity",
"deg_pH10",
"signal_to_noise_deg_pH10",
"errors_deg_pH10",
"deg_50C",
"signal_to_noise_deg_50C",
"errors_deg_50C",
"deg_Mg_pH10",
"signal_to_noise_deg_Mg_pH10",
"errors_deg_Mg_pH10",
"deg_Mg_50C",
"signal_to_noise_deg_Mg_50C",
"errors_deg_Mg_50C",
"SN_filter",
]


def convert_dataset(convert_config):
df = dl.load_pandas(convert_config.dataset_path)
df.SN_filter = df.SN_filter.astype(bool)
ryos1 = df[df["RYOS"] == 1]
ryos2 = df[df["RYOS"] == 2]
data1 = {
"train": ryos1[ryos1["split"] == "public_train"][cols],
"validation": ryos1[ryos1["split"] == "public_test"][cols],
"test": ryos1[ryos1["split"] == "private_test"][cols],
}
data2 = {
"train": ryos2[ryos2["split"] != "private_test"][cols],
"test": ryos2[ryos2["split"] == "private_test"][cols],
}
repo_id, output_path = convert_config.repo_id, convert_config.output_path
convert_config.repo_id, convert_config.output_path = repo_id + "-1", output_path + "-1"
save_dataset(convert_config, data1)
convert_config.repo_id, convert_config.output_path = repo_id + "-2", output_path + "-2"
save_dataset(convert_config, data2)


class ConvertConfig(ConvertConfig_):
root: str = os.path.dirname(__file__)
output_path: str = os.path.basename(os.path.dirname(__file__))


if __name__ == "__main__":
config = ConvertConfig()
config.parse() # type: ignore[attr-defined]
convert_dataset(config)

0 comments on commit 64b9e6f

Please sign in to comment.