write README.md

README.md

@@ -6,4 +6,51 @@ size_categories:
 - 10M<n<100M
 ---
 # Mouse-Genecorpus-20M
-Mouse-Genecorpus-20M
+Updating now...
+
+Comming soon!
+
+
+Write: Keita Ito
+
+## Abstract
+This repository contains the datasets of mouse-Genecorpus-20M and evaluation datasets to analysis. Mouse-Genecorpus-20M is large-scale pretraining corpus comprised of ~21 million mosue single cell transcriptomes from a broad range of tissues from publicly available data. This corpus is used for pretraining mouse-Geneformer, a pretrained transformer model that enables context-aware predictions in settings with limited data in network biology.
+
+<!-- PLOS Genetics の URL を載せる-->
+<!-- [[PLOS Genetics](hhttps://journals.plos.org/plosgenetics/...)]-->
+
+<!-- bioRxiv の URL を記載-->
+<!-- [[bioRxiv]()] -->
+
+## Citation
+If you find this repository is useful. Please cite the following references.
+
+<!-- PLOS Genetics の bibtex を載せる -->
+
+<!--bioRxiv の bibtex を載せる -->
+```bibtex
+@article{aaaaaaa,
+    author = {Keita Ito and Tsubasa Hirakawa and Shuji Shigenobu and Takayoshi Yamashita and Hironobu Fujiyoshi},
+    title = {Mouse-Geneformer: A Deep Leaning Model for Mouse Single-Cell Transcriptome and Its Cross-Species Utility},
+    journal = {xxxx},
+    year = {20yy},
+    pages = {zzzz-zzzz}
+}
+```
+
+## How to use
+Python program to use this dataset (Python version:3.8.10) :
+```bash
+# How to use mosue-Genecorpus-20M dataset
+from datasets import load_dataset
+dataset = load_dataset("MPRG/Mouse-Genecorpus-20M/MLM-re_All_mouse_tokenize_dataset.dataset")
+```
+or
+```bash
+$ git clone https://huggingface.co/datasets/MPRG/Mouse-Genecorpus-20M
+```
+After executing the above command:
+```bash
+from datasets inport load_from_disk
+dataset = load_from_disk("/path/to/mouse-Genecorpus-20M/MLM-re_All_mouse_tokenize_dataset.dataset/")
+```