fix_readme (#3)

- Fix readme and .gitattributes (0c1ed33bac671268b3fba77c05f4f6417ddd123f)

.gitattributes

@@ -1,3 +1,61 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:694981c975d0061427a5983a2a1ce262963a3f2b16a2bc09afcfe25459734bd2
-size 2634
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.lz4 filter=lfs diff=lfs merge=lfs -text
+*.mds filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+# Audio files - uncompressed
+*.pcm filter=lfs diff=lfs merge=lfs -text
+*.sam filter=lfs diff=lfs merge=lfs -text
+*.raw filter=lfs diff=lfs merge=lfs -text
+# Audio files - compressed
+*.aac filter=lfs diff=lfs merge=lfs -text
+*.flac filter=lfs diff=lfs merge=lfs -text
+*.mp3 filter=lfs diff=lfs merge=lfs -text
+*.ogg filter=lfs diff=lfs merge=lfs -text
+*.wav filter=lfs diff=lfs merge=lfs -text
+# Image files - uncompressed
+*.bmp filter=lfs diff=lfs merge=lfs -text
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.tiff filter=lfs diff=lfs merge=lfs -text
+# Image files - compressed
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text
+# Video files - compressed
+*.mp4 filter=lfs diff=lfs merge=lfs -text
+*.webm filter=lfs diff=lfs merge=lfs -text
+*.h5ad.gz filter=lfs diff=lfs merge=lfs -text
+*.h5ad filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,3 +1,22 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:c6df38cbbfc289ea8013bbb87406dc23d09916fab785c8040f82a3973d3a83b8
-size 2544
+---
+license: cc-by-4.0
+---
+
+The dataset contains data used in work:
+"Perturbench: Benchmarking machine learning models for cellular perturbation analysis."
+
+The data comes from the following publications:
+
+-  Norman, T. M., Horlbeck, M. A., Replogle, J. M., Ge, A. Y., Xu, A., Jost, M., Gilbert, L. A., and Weissman, J. S. (2019). *Exploring genetic interaction manifolds constructed from rich single-cell phenotypes.* Science, 365(6455):786–793.
+-  Srivatsan, S. R., McFaline-Figueroa, J. L., Ramani, V., Saunders, L., Cao, J., Packer, J., Pliner, H. A., Jackson, D. L., Daza, R. M., Christiansen, L., Zhang, F., Steemers, F., Shendure, J., and Trapnell, C. (2020). *Massively multiplex chemical transcriptomics at single-cell resolution.* Science, 367(6473):45–51.
+-  Frangieh, C. J., Melms, J. C., Thakore, P. I., Geiger-Schuller, K. R., Ho, P., Luoma, A. M., Cleary, B., Jerby-Arnon, L., Malu, S., Cuoco, M. S., Zhao, M., Ager, C. R., Rogava, M., Hovey,
+L., Rotem, A., Bernatchez, C., Wucherpfennig, K. W., Johnson, B. E., Rozenblatt-Rosen, O.,
+Schadendorf, D., Regev, A., and Izar, B. (2021). *Multimodal pooled Perturb-CITE-seq screens in
+patient models define mechanisms of cancer immune evasion*. Nat. Genet., 53(3):332–341.
+- Jiang, L., Dalgarno, C., Papalexi, E., Mascio, I., Wessels, H.-H., Yun, H., Iremadze, N., Lithwick Yanai, G., Lipson, D., and Satija, R. (2024a). *Systematic reconstruction of molecular pathway signatures using scalable single-cell perturbation screens.* bioRxiv, page 2024.01.29.576933.
+- McFaline-Figueroa, J. L., Srivatsan, S., Hill, A. J., Gasperini, M., Jackson, D. L., Saunders,
+L., Domcke, S., Regalado, S. G., Lazarchuck, P., Alvarez, S., et al.
+(2024). *Multiplex single cell chemical genomics reveals the kinase dependence of the response to targeted therapy*. Cell Genomics, 4(2)
+- Szałata, A., Benz, A., Cannoodt, R., Cortes, M., Fong, J., Kuppasani, S., Lieberman, R., Liu, T., Mas-Rosario, J. A., Meinl, R., Nourisa, J., Tumiel, J., Tunjic, T. M., Wang, M., Weber, N., Zhao, H., Anchang, B., Theis, F. J., Luecken, M. D., Burkhardt, D. B. (2024). *A benchmark for prediction of transcriptomic responses to chemical perturbations across cell types.* NeurIPS, (38).
+
+Datasets with fixed splits have their splits included as `.csv` files with two colums: the first corresponds to the cell ID (which is the `.obs_names` of the respective h5ad file) and second to the split value (`train`, `val`, `test`). Some datasets contain multiple splits in which case the split files are in a `tar.gz`.