haneulpark commited on
Commit
60a2727
·
verified ·
1 Parent(s): 48b611c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +55 -14
README.md CHANGED
@@ -39,23 +39,45 @@ The **PISCES dataset** provides curated sets of protein sequences from the Prote
39
 
40
  - **Server:** [PISCES](https://dunbrack.fccc.edu/pisces/)
41
  - **Reference:** Wang, G., & Dunbrack, R. L. Jr. (2003). *Bioinformatics* 19(12), 1589–1591.
 
42
 
43
- ## Citation
 
44
 
45
- ```bibtex
46
- @article{wang2003pisces,
47
- title={PISCES: a protein sequence culling server},
48
- author={Wang, Guoying and Dunbrack, Roland L. Jr.},
49
- journal={Bioinformatics},
50
- volume={19},
51
- number={12},
52
- pages={1589--1591},
53
- year={2003},
54
- publisher={Oxford University Press}
55
- }
56
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
57
 
58
- *Recurated for Hugging Face by Akshaya Narayanasamy akshayanarayanasamy[at]gmail.com.*
59
 
60
  ## Uses
61
 
@@ -125,3 +147,22 @@ Subset filenames follow:
125
  ## License
126
 
127
  Apache-2.0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
39
 
40
  - **Server:** [PISCES](https://dunbrack.fccc.edu/pisces/)
41
  - **Reference:** Wang, G., & Dunbrack, R. L. Jr. (2003). *Bioinformatics* 19(12), 1589–1591.
42
+ -
43
 
44
+ ## Quickstart Usage
45
+ ### Install HuggingFace Datasets package
46
 
47
+ Each subset can be loaded into python using the Huggingface [datasets](https://huggingface.co/docs/datasets/index) library.
48
+ First, from the command line install the `datasets` library
49
+
50
+ $ pip install datasets
51
+
52
+ then, from within python load the datasets library
53
+
54
+ >>> import datasets
55
+
56
+ ### Load Dataset
57
+
58
+ Load PISCES-CulledPDB dataset.
59
+
60
+ >>> pisces_culledpdb = datasets.load_dataset('RosettaCommons/PISCES-CulledPDB')
61
+ Downloading readme: 4.02kB [00:00, 1.08MB/s]
62
+ Downloading data: 100%|█████████████████████████████████████████████████████████████████████████████████████████████████| 69.3M/69.3M [00:13<00:00, 5.10MB/s]
63
+ Generating train split: 100%|██████████████████████████████████████████████████████████████████████████| 3632659/3632659 [00:02<00:00, 1637871.99 examples/s]
64
+
65
+ and the dataset is loaded as a `datasets.arrow_dataset.Dataset`
66
+
67
+ >>> pisces_culledpdb
68
+ DatasetDict({
69
+ train: Dataset({
70
+ features: ['pdb_chain', 'cluster_id', 'split'],
71
+ num_rows: 3632659
72
+ })
73
+ })
74
+
75
+ which is a column oriented format that can be accessed directly, converted in to a `pandas.DataFrame`, or `parquet` format, e.g.
76
+
77
+ >>> pisces_culledpdb.data.column('pdb_chain')
78
+ >>> pisces_culledpdb.to_pandas()
79
+ >>> pisces_culledpdb.to_parquet("dataset.parquet")
80
 
 
81
 
82
  ## Uses
83
 
 
147
  ## License
148
 
149
  Apache-2.0
150
+
151
+
152
+ ## Citation
153
+
154
+ ```
155
+ bibtex
156
+ @article{wang2003pisces,
157
+ title={PISCES: a protein sequence culling server},
158
+ author={Wang, Guoying and Dunbrack, Roland L. Jr.},
159
+ journal={Bioinformatics},
160
+ volume={19},
161
+ number={12},
162
+ pages={1589--1591},
163
+ year={2003},
164
+ publisher={Oxford University Press}
165
+ }
166
+ ```
167
+
168
+ *Recurated for Hugging Face by Akshaya Narayanasamy akshayanarayanasamy[at]gmail.com.*